Python API for communicating with Eufy RoboVac 11c devices
Project description
PyRobovac
Python library for controlling the Eufy RoboVac 11c.
Requirements
PyRobovac requires Python 3.6+. All other requirements should be installed by Pip.
Usage
from robovac import Robovac my_robovac = Robovac('ROBOVAC_IP', 'ROBOVAC_LOCAL_CODE') # Cleaning modes my_robovac.start_auto_clean() my_robovac.start_edge_clean() my_robovac.start_single_room_clean() my_robovac.start_spot_clean() # Set cleaning speed my_robovac.use_normal_speed() my_robovac.use_max_speed() # Stop cleaning my_robovac.stop() # Return to charging base my_robovac.go_home() # Activate "find me" mode, plays a tone until deactivated my_robovac.start_find_me() my_robovac.stop_find_me() # Move in a given direction my_robovac.go_forward() my_robovac.go_backward() my_robovac.go_left() my_robovac.go_right() # Get RoboVac status my_robovac.get_status()
Local code
The API authenticates with the Robovac using a unique local code.
This is a 16 character string that's unique to the RoboVac. In order to
retrieve this code, the Eufy API can be used. The get_local_code
function
has been implemented for this purpose
Currently, the IP address provided must match the RoboVac's IP in order to find the local code.
get_local_code
from robovac import get_local_code my_robovac_local_code = get_local_code(my_eufy_username, my_eufy_password, ip_of_my_robovac)
Notes & Acknowledgements
This library can only be used when on the same LAN as the RoboVac. The library has only been tested with the Eufy RoboVac 11c. It may or may not work with other models.
Thanks to @mjg59 for his work on decrypting packets received from Eufy devices. See it here: google/python-lakeside
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size robovac-0.0.9.tar.gz (9.0 kB) | File type Source | Python version None | Upload date | Hashes View |