PyMammotion - Python API for Mammotion Mowers

💬 Join us on Discord

PyMammotion is a Python API for controlling and monitoring Mammotion devices (Luba, Yuka, spino etc) via MQTT, Cloud, and Bluetooth.

[!WARNING] Use at your own risk. Mammotion's Terms of Service prohibit unofficial API access. Using this library may result in a permanent ban of your Mammotion account. The authors are not responsible for any consequences, including loss of access to your device or account.

⚠️ Please note: This API is still under active development. You may encounter unfinished features or bugs. If you come across any issues, please open an issue on the GitHub repository. 🐛

Home Assistant Integration

This library is the foundation for the Mammotion Home Assistant integration. If you're looking to control your Mammotion mower through Home Assistant, check out the integration repository for installation and setup instructions.

Installation 🛠️

You can install PyMammotion using pip:

pip install pymammotion

Development 🔧

PyMammotion uses betterproto2 and protoc for generating protobuf models. To set up the development environment:

1. Clone the repository
2. poetry install --with=dev
3. Profit

Contributing 🤝

Contributions are welcome! Please check the issues for ways you can help improve PyMammotion.

Troubleshooting 🔍

If you encounter any issues:

• Check the wiki for known issues and solutions
• Ensure you're using the latest version of PyMammotion
• If the problem persists, please open an issue on GitHub

Credits 👥

License 📄

This project is licensed under the MIT License - see the LICENSE file for details.

Trademark Notice

The trademarks "Mammotion," "Luba,", "Yuka" and "Spino" referenced herein are registered trademarks of their respective owners. The author of this software repository is not affiliated with, endorsed by, or connected to these trademark owners in any way.