Metadata-Version: 2.1
Name: python-miio
Version: 0.4.4
Summary: Python library for interfacing with Xiaomi smart appliances
Home-page: https://github.com/rytilahti/python-miio
Author: Teemu Rytilahti
Author-email: tpr@iki.fi
License: GPLv3
Keywords: xiaomi miio vacuum
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.5
Requires-Dist: construct
Requires-Dist: click
Requires-Dist: cryptography
Requires-Dist: pretty-cron
Requires-Dist: zeroconf
Requires-Dist: attrs
Requires-Dist: android-backup
Requires-Dist: pytz
Requires-Dist: appdirs
Requires-Dist: tqdm
Requires-Dist: netifaces

python-miio
===========

|PyPI version| |Build Status| |Code Health| |Coverage Status| |Docs|

This library (and its accompanying cli tool) is used to interface with devices using Xiaomi's `miIO protocol <https://github.com/OpenMiHome/mihome-binary-protocol/blob/master/doc/PROTOCOL.md>`__.


Supported devices
-----------------

-  Xiaomi Mi Robot Vacuum (miio.vacuum)
-  Xiaomi Mi Home Air Conditioner Companion (miio.airconditioningcompanion)
-  Xiaomi Mi Air Purifier (miio.airpurifier)
-  Xiaomi Mi Smart WiFi Socket (miio.chuangmi_plug)
-  Xiaomi Chuangmi Plug V1 (1 Socket, 1 USB Port) (miio.chuangmi_plug)
-  Xiaomi Chuangmi Plug V3 (1 Socket, 2 USB Ports) (miio.chuangmi_plug)
-  Xiaomi Smart Power Strip V1 and V2 (WiFi, 6 Ports) (miio.powerstrip)
-  Xiaomi Philips Eyecare Smart Lamp 2 (miio.philips_eyecare)
-  Xiaomi Philips LED Ceiling Lamp (miio.ceil)
-  Xiaomi Philips LED Ball Lamp (miio.philips_bulb)
-  Xiaomi Philips Zhirui Smart LED Bulb E14 Candle Lamp (miio.philips_bulb)
-  Xiaomi Philips Zhirui Bedroom Smart Lamp (miio.philips_moonlight)
-  Xiaomi Universal IR Remote Controller (Chuangmi IR) (miio.chuangmi_ir)
-  Xiaomi Mi Smart Pedestal Fan V2, V3, SA1 and ZA1 (miio.fan)
-  Xiaomi Mi Air Humidifier (miio.airhumidifier)
-  Xiaomi Mi Water Purifier (Basic supportmiio.waterpurifier)
-  Xiaomi PM2.5 Air Quality Monitor (miio.airqualitymonitor)
-  Xiaomi Smart WiFi Speaker (miio.wifispeaker) (incomplete, please `feel free to help improve the support <https://github.com/rytilahti/python-miio/issues/69>`__)
-  Xiaomi Mi WiFi Repeater 2 (miio.wifirepeater)
-  Xiaomi Mi Smart Rice Cooker (miio.cooker)
-  Xiaomi Smartmi Fresh Air System (miio.airfresh)
-  Yeelight light bulbs (miio.yeelight) (only a very rudimentary support, use `python-yeelight <https://gitlab.com/stavros/python-yeelight/>`__ for a more complete support)

*Feel free to create a pull request to add support for new devices as
well as additional features for supported devices.*


Getting started
---------------

Refer `the manual <https://python-miio.readthedocs.io>`__ for getting started.


Home Assistant support
----------------------

-  `Xiaomi Mi Robot Vacuum <https://home-assistant.io/components/vacuum.xiaomi_miio/>`__
-  `Xiaomi Philips Light <https://home-assistant.io/components/light.xiaomi_miio/>`__
-  `Xiaomi Mi Air Purifier and Air Humidifier <https://home-assistant.io/components/fan.xiaomi_miio/>`__
-  `Xiaomi Smart WiFi Socket and Smart Power Strip <https://home-assistant.io/components/switch.xiaomi_miio/>`__
-  `Xiaomi Universal IR Remote Controller <https://home-assistant.io/components/remote.xiaomi_miio/>`__
-  `Xiaomi Mi Air Quality Monitor (PM2.5) <https://home-assistant.io/components/sensor.xiaomi_miio/>`__
-  `Xiaomi Mi Home Air Conditioner Companion <https://github.com/syssi/xiaomi_airconditioningcompanion>`__
-  `Xiaomi Mi WiFi Repeater 2 <https://www.home-assistant.io/components/device_tracker.xiaomi_miio/>`__
-  `Xiaomi Mi Smart Pedestal Fan <https://github.com/syssi/xiaomi_fan>`__
-  `Xiaomi Mi Smart Rice Cooker <https://github.com/syssi/xiaomi_cooker>`__
-  `Xiaomi Raw Sensor <https://github.com/syssi/xiaomi_raw>`__


.. |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
.. |Code Health| image:: https://landscape.io/github/rytilahti/python-miio/master/landscape.svg?style=flat
   :target: https://landscape.io/github/rytilahti/python-miio/master
.. |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