The Wayback Machine - https://web.archive.org/web/20200206024603/https://github.com/rytilahti/python-miio
Skip to content

/ python-miio

Python library & console tool for controlling Xiaomi smart appliances
xiaomi vacuum python home-assistant miio mijia home-automation smart-home
Python
  1. Python 100.0%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio

If nothing happens, download the GitHub extension for Visual Studio and try again.

@petrkotek @rytilahti
petrkotek and rytilahti Refactoring: Split Device class into Device+Protocol (#592) 
* Extract command-sending functionality from Device class to new CommandSender class to separate concerns

* Rename CommandSender class to Protocol to better describe what it is
Rename do_discover() to send_handshake() & create a proxy method send_handshake() in Device class

* Device: bring back ip and token

* airfresh_t2017.py: fix tests after merge

* tests: bring back `return_values` to simplify the diff

* Device: update deprecation message

* Device: make protocol field private; don't deprecate Device.send method to keep everything compatible.
Protocol: update docstring to reflect new code.
Vacuum: expose raw_id from the Protocol.

* Rename Protocol class to MiIOProtocol
Latest commit 9a7c6c4 Jan 12, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Add check-manifest, check for pypi-description, flake8-docstrings (#575) Nov 27, 2019
miio Refactoring: Split Device class into Device+Protocol (#592) Jan 13, 2020
.gitignore Sphinx config fix (#458) Jan 20, 2019
.pre-commit-config.yaml Add check-manifest, check for pypi-description, flake8-docstrings (#575) Nov 27, 2019
.readthedocs.yml Add .readthedocs.yml (#410) Nov 14, 2018
.travis.yml Add travis build for python 3.7 (#561) Oct 11, 2019
CHANGELOG.md Prepare release 0.4.8 (#596) Dec 12, 2019
LICENSE add pure text LICENSE (#125) Nov 18, 2017
LICENSE.md Add GPLv3 license (#124) Nov 18, 2017
MANIFEST.in add azure pipeline for tests, and enforce black, flake8 and isort for… Oct 27, 2019
README.rst Add Xiaomi Mi Fresh Air (dmaker.airfresh.t2017) support (#591) Dec 12, 2019
RELEASING.md Preparation of release 0.3.6 (#221) Feb 13, 2018
azure-pipelines.yml Add check-manifest, check for pypi-description, flake8-docstrings (#575) Nov 27, 2019
requirements.txt Use black for source code formatting. Add precommit hook to make it s… Oct 10, 2019
requirements_docs.txt add requirements_docs.txt Nov 18, 2017
setup.py add azure pipeline for tests, and enforce black, flake8 and isort for… Oct 27, 2019
tox.ini Add check-manifest, check for pypi-description, flake8-docstrings (#575) Nov 27, 2019

README.rst

python-miio

PyPI version Build Status Coverage Status Documentation status Black Hound

This library (and its accompanying cli tool) is used to interface with devices using Xiaomi's miIO protocol.

Supported devices

  • Xiaomi Mi Robot Vacuum V1, S5, M1S
  • Xiaomi Mi Home Air Conditioner Companion
  • Xiaomi Mi Air Purifier
  • Xiaomi Aqara Camera
  • Xiaomi Mijia 360 1080p
  • Xiaomi Mijia STYJ02YM (Viomi)
  • Xiaomi Mi Smart WiFi Socket
  • Xiaomi Chuangmi Plug V1 (1 Socket, 1 USB Port)
  • Xiaomi Chuangmi Plug V3 (1 Socket, 2 USB Ports)
  • Xiaomi Smart Power Strip V1 and V2 (WiFi, 6 Ports)
  • Xiaomi Philips Eyecare Smart Lamp 2
  • Xiaomi Philips RW Read (philips.light.rwread)
  • Xiaomi Philips LED Ceiling Lamp
  • Xiaomi Philips LED Ball Lamp (philips.light.bulb)
  • Xiaomi Philips LED Ball Lamp White (philips.light.hbulb)
  • Xiaomi Philips Zhirui Smart LED Bulb E14 Candle Lamp
  • Xiaomi Philips Zhirui Bedroom Smart Lamp
  • Xiaomi Universal IR Remote Controller (Chuangmi IR)
  • Xiaomi Mi Smart Pedestal Fan V2, V3, SA1, ZA1, ZA3, ZA4, P5
  • Xiaomi Mi Air Humidifier V1, CA1, CB1, MJJSQ
  • Xiaomi Mi Water Purifier (Basic support: Turn on & off)
  • Xiaomi PM2.5 Air Quality Monitor V1, B1, S1
  • Xiaomi Smart WiFi Speaker
  • Xiaomi Mi WiFi Repeater 2
  • Xiaomi Mi Smart Rice Cooker
  • Xiaomi Smartmi Fresh Air System VA2 (zhimi.airfresh.va2), T2017 (dmaker.airfresh.t2017)
  • Yeelight lights (basic support, we recommend using python-yeelight)
  • Xiaomi Mi Air Dehumidifier
  • Xiaomi Tinymu Smart Toilet Cover
  • Xiaomi 16 Relays Module
  • Xiaomi Xiao AI Smart Alarm Clock

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 for getting started.

Contributing

We welcome all sorts of contributions from patches to add improvements or fixing bugs to improving the documentation. To ease the process of setting up a development environment we have prepared a short guide for getting you started.

Home Assistant support

You can’t perform that action at this time.