diff --git a/README.rst b/README.rst index 8dc189afa..6a49820b3 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ python-miio =========== -|Chat| |PyPI version| |Build Status| |Coverage Status| |Docs| |Black| |Hound| +|Chat| |PyPI version| |PyPI downloads| |Build Status| |Coverage Status| |Docs| |Black| This library (and its accompanying cli tool) can be used to interface with devices using Xiaomi's `miIO `__ and MIoT protocols. @@ -139,38 +139,53 @@ Supported devices *Feel free to create a pull request to add support for new devices as well as additional features for supported devices.* +Projects using this library +--------------------------- -Home Assistant support ----------------------- +This library is used by various projects to support MiIO/MiOT devices. +If you are using this library for your project, feel free to open a PR to get it listed here! + +Home Assistant (official) +^^^^^^^^^^^^^^^^^^^^^^^^^ + +Home Assistant uses this library to support several platforms out-of-the-box. +This list is incomplete as the platforms (in parentheses) may also support other devices listed above. + +- `Xiaomi Mi Robot Vacuum `__ (vacuum) +- `Xiaomi Philips Light `__ (light) +- `Xiaomi Mi Air Purifier and Air Humidifier `__ (fan) +- `Xiaomi Smart WiFi Socket and Smart Power Strip `__ (switch) +- `Xiaomi Universal IR Remote Controller `__ (remote) +- `Xiaomi Mi Air Quality Monitor (PM2.5) `__ (sensor) +- `Xiaomi Aqara Gateway Alarm `__ (alarm_control_panel) +- `Xiaomi Mi WiFi Repeater 2 `__ (device_tracker) + +Home Assistant (custom) +^^^^^^^^^^^^^^^^^^^^^^^ -- `Xiaomi Mi Robot Vacuum `__ -- `Xiaomi Philips Light `__ -- `Xiaomi Mi Air Purifier and Air Humidifier `__ -- `Xiaomi Smart WiFi Socket and Smart Power Strip `__ -- `Xiaomi Universal IR Remote Controller `__ -- `Xiaomi Mi Air Quality Monitor (PM2.5) `__ -- `Xiaomi Aqara Gateway Alarm `__ - `Xiaomi Mi Home Air Conditioner Companion `__ -- `Xiaomi Mi WiFi Repeater 2 `__ - `Xiaomi Mi Smart Pedestal Fan `__ - `Xiaomi Mi Smart Rice Cooker `__ - `Xiaomi Raw Sensor `__ - `Xiaomi MIoT Devices `__ +Other projects +^^^^^^^^^^^^^^ + +- `Your project here? Feel free to open a PR! `__ -.. |Chat| image:: https://matrix.to/img/matrix-badge.svg +.. |Chat| image:: https://img.shields.io/matrix/python-miio-chat:matrix.org :target: https://matrix.to/#/#python-miio-chat:matrix.org .. |PyPI version| image:: https://badge.fury.io/py/python-miio.svg :target: https://badge.fury.io/py/python-miio -.. |Build Status| image:: https://travis-ci.org/rytilahti/python-miio.svg?branch=master - :target: https://travis-ci.org/rytilahti/python-miio +.. |PyPI downloads| image:: https://img.shields.io/pypi/dw/python-miio + :target: https://pypi.org/project/python-miio/ +.. |Build Status| image:: https://img.shields.io/azure-devops/build/python-miio/608e6099-f1ed-403c-9158-8fdcb2a0e477/1 + :target: https://dev.azure.com/python-miio/python-miio/ .. |Coverage Status| image:: https://coveralls.io/repos/github/rytilahti/python-miio/badge.svg?branch=master :target: https://coveralls.io/github/rytilahti/python-miio?branch=master .. |Docs| image:: https://readthedocs.org/projects/python-miio/badge/?version=latest :alt: Documentation status :target: https://python-miio.readthedocs.io/en/latest/?badge=latest -.. |Hound| image:: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg - :alt: Hound - :target: https://houndci.com .. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black