Skip to content

jaidenlabelle/tuya-vacuum-maps

Repository files navigation

Tuya Vacuum Maps

🏠 View Real-Time Vacuum Maps In Home Assistant.
This component adds a new camera which polls the Tuya Cloud API for the latest realtime map data.
This project is primarily focused on Lefant vacuums, but aims to support all Tuya vacuums.

Installation

Installing Manually

To install this integration manually, add the contents of custom_components to your Home Assistants custom_components folder and reboot.

Installing using HACS

  1. Install HACS if its not already installed.
  2. Add this repository to HACS by following this guide: HACS: Add Custom Repository.
  3. Search for this integration using the HACS browser inside Home Assistant, and install.

Compatability List

This is a list of tested devices. Create a new issue to add your device.

Device Support
Lefant M1 $${\color{lightgreen}Supported}$$

Development Environment

It's recommended to set up a development environment if you want to make changes to this component.

Prerequisites

Getting Started

  1. Once the devcontainer is created, fork this repository.
  2. Go to the folder containing the homeassistant-core folder, it should be called workspaces.
  3. Once your fork is created, make sure your terminal path is set to /workspaces and run git clone <url>.
  4. To make testing easier, create a symlink to the component in your Home Assistant devcontainer.
    • Example: ln -s /workspaces/tuya-vacuum-maps/custom_components/tuya_vacuum_maps /workspaces/homeassistant-core/config/custom_components
  5. For development, it's recommended you use a virtual environment.
    1. Create a new virtual environment (Run in the root /tuya-vacuum-maps folder):
      • python -m venv venv
    2. Activate the virtual environment:
      • source ./venv/bin/activate

Special Thanks