CHANGELOG.md

Change Log

0.4.8

This release adds support for the following new devices:

• Xiaomi Mijia STYJ02YM vacuum (viomi.vacuum.v7)
• Xiaomi Mi Smart Humidifier (deerma.humidifier.mjjsq)
• Xiaomi Mi Fresh Air Ventilator (dmaker.airfresh.t2017)
• Xiaomi Philips Desk Lamp RW Read (philips.light.rwread)
• Xiaomi Philips LED Ball Lamp White (philips.light.hbulb)

Fixes & Enhancements:

• Improve Xiaomi Tinymu Smart Toilet Cover support
• Remove UTF-8 encoding definition from source files
• Azure pipeline for tests
• Pre-commit hook to enforce black, flake8 and isort
• Pre-commit hook to check-manifest, check for pypi-description, flake8-docstrings

Full Changelog

Implemented enhancements:

• Support for new vaccum Xiaomi Mijia STYJ02YM #550
• Support for Mi Smart Humidifier (deerma.humidifier.mjjsq) #533
• Support for Mi Fresh Air Ventilator dmaker.airfresh.t2017 #502

Closed issues:

• The voice pack does not change in Xiaomi Vacuum 1S #583
• Support for chuangmi.plug.hmi206 #574
• miplug crash in macos catalina 10.15.1 #573
• Roborock S50 not responding to handshake anymore #572
• Cannot control my Roborock S50 through my home wifi network #570
• I can not get load_power with my set is Xiaomi Smart WiFi with two usb (chuangmi.plug.v3) #549

Merged pull requests:

• Add Xiaomi Mi Fresh Air (dmaker.airfresh.t2017) support #591 (syssi)
• Add philips.light.rwread support #589 (syssi)
• Add philips.light.hbulb support #587 (syssi)
• Add support for deerma.humidifier.mjjsq #586 (syssi)
• Improve toiletlid various parameters #579 (scp10011)
• Add support for Xiaomi Mijia STYJ02YM (viomi.vacuum.v7) #576 (rytilahti)
• Add check-manifest, check for pypi-description, flake8-docstrings #575 (rytilahti)
• Remove UTF-8 encoding comment #569 (quamilek)
• Improve the contribution process with better checks and docs #568 (rytilahti)
• add azure pipeline for tests, and enforce black, flake8 and isort for commits #566 (rytilahti)

0.4.7

This release adds support for the following new devices:

• Widetech WDH318EFW1 dehumidifier (nwt.derh.wdh318efw1)
• Xiaomi Xiao AI Smart Alarm Clock (zimi.clock.myk01)
• Xiaomi Air Quality Monitor 2gen (cgllc.airmonitor.b1)
• Xiaomi ZNCZ05CM EU Smart Socket (chuangmi.plug.hmi206)

Fixes & Enhancements:

• Air Humidifier: Parsing of the firmware version improved
• Add travis build for python 3.7
• Use black for source code formatting
• Require python >=3.6

Full Changelog

Implemented enhancements:

• Add support for WIDETECH WDH318EFW1 dehumidifier (nwt.derh.wdh318efw1) #534
• Support for Xiaomi Xiao AI Smart Alarm Clock (zimi.clock.myk01) #505
• Add support for the cgllc.airmonitor.b1 #562 (fwestenberg)

Fixed bugs:

• Air Humidifier #529

Closed issues:

• mirobo updater -- No request was made #557
• What‘s the plan to release 0.4.6? #553
• does this support aqara water leak sensor? #551
• Unsupported device chuangmi.plug.hmi206 #545
• python-miio not compatible with Python <=3.5.1 #494
• Support for Xiaomi Air Quality Monitor 2gen #419

Merged pull requests:

• Add travis build for python 3.7 #561 (syssi)
• bump required python version to 3.6+ #560 (rytilahti)
• Use black for source code formatting #559 (rytilahti)
• Add initial support for Xiao AI Smart Alarm Clock (zimi.clock.myk01) #558 (rytilahti)
• Improve firmware version parser of the Air Humidifier (Closes: #529) #556 (syssi)
• Bring cgllc.airmonitor.s1 into line #555 (syssi)
• Add Xiaomi ZNCZ05CM EU Smart Socket (chuangmi.plug.hmi206) support #554 (syssi)

0.4.6

This release adds support for the following new devices:

• Xiaomi Air Quality Monitor S1 (cgllc.airmonitor.s1)
• Xiaomi Mi Dehumidifier V1 (nwt.derh.wdh318efw1)
• Xiaomi Mi Roborock M1S and Mi Robot S1
• Xiaomi Mijia 360 1080p camera (chuangmi.camera.ipc009)
• Xiaomi Mi Smart Fan (zhimi.fan.za3, zhimi.fan.za4, dmaker.fan.p5)
• Xiaomi Smartmi Pure Evaporative Air Humidifier (zhimi.humidifier.cb1)
• Xiaomi Tinymu Smart Toilet Cover
• Xiaomi 16 Relays Module

Fixes & Enhancements:

• Air Conditioning Companion: Add particular swing mode values of a chigo air conditioner
• Air Humidifier: Handle poweroff exception on set_mode
• Chuangmi IR controller: Add indicator led support
• Chuangmi IR controller: Add discovery of the Xiaomi IR remote 2gen (chuangmi.remote.h102a03)
• Chuangmi Plug: Fix set_wifi_led cli command
• Vacuum: Add state 18 as "segment cleaning"
• Device: Add easily accessible properties to DeviceError exception
• Always import DeviceError exception
• Require click version >=7
• Remove pretty_cron and typing dependencies from requirements.txt

Full Changelog

Closed issues:

• Roborock Vacuum Bin full #546
• Add support for Xiao AI Smart Alarm Clock #538
• rockrobo.vacuum.v1 Error: No response from the device #536
• Assistance #532
• Unsupported device found - roborock.vacuum.s5 #527
• Discovery mode to chuangmi_camera. #522
• 新款小米1X电风扇不支持 #520
• Add swing mode of a Chigo Air Conditioner #518
• Discover not working with Mi AirHumidifier CA1 #514
• Question about vacuum errors_codes duration #511
• Support device model dmaker.fan.p5 #510
• Roborock S50: ERROR:miio.updater:No request was made.. #508
• Roborock S50: losing connection with mirobo #507
• Support for Xiaomi IR Remote (chuangmi.remote.v2) #506
• Support for Humidifier new model: zhimi.humidifier.cb1 #492
• impossible to get the last version (0.4.5) or even the 0.4.4 #489
• Getting the token of Air Purifier Pro v7 #461
• Moonlight sync with HA #452
• Replace pretty-cron dependency with cron_descriptor #423

Merged pull requests:

• remove pretty_cron and typing dependencies from requirements.txt #548 (rytilahti)
• Add tinymu smart toiletlid #544 (scp10011)
• Add support for Air Quality Monitor S1 (cgllc.airmonitor.s1) #539 (zhumuht)
• Add pwzn relay #537 (SchumyHao)
• add mi dehumidifier v1 (nwt.derh.wdh318efw1) #535 (stkang)
• add mi robot s1 (m1s) to discovery #531 (rytilahti)
• Add preliminary Roborock M1S / Mi Robot S1 support #526 (syssi)
• Add state 18 as "segment cleaning" #525 (syssi)
• Add particular swing mode values of a chigo air conditioner #519 (syssi)
• Add chuangmi.camera.ipc009 support #516 (impankratov)
• Add zhimi.fan.za3 support #515 (syssi)
• Add dmaker.fan.p5 support #513 (syssi)
• Add zhimi.fan.za4 support #512 (syssi)
• Require click version >=7 #503 (fvollmer)
• Add indicator led support of the chuangmi.remote.h102a03 and chuangmi.remote.v2 #500 (syssi)
• Chuangmi Plug: Fix set_wifi_led cli command #499 (syssi)
• Add discovery of the Xiaomi IR remote 2gen (chuangmi.remote.h102a03) #497 (syssi)
• Air Humidifier: Handle poweroff exception on set_mode #496 (syssi)
• Add zhimi.humidifier.cb1 support #493 (antylama)
• Add easily accessible properties to DeviceError exception #488 (syssi)
• Always import DeviceError exception #487 (syssi)

0.4.5

This release adds support for the following new devices:

• Xiaomi Chuangmi Plug M3
• Xiaomi Chuangmi Plug HMI205
• Xiaomi Air Purifier Pro V7
• Xiaomi Air Quality Monitor 2gen
• Xiaomi Aqara Camera

Fixes & Enhancements:

• Handle "resp invalid json" error
• Drop pretty_cron dependency
• Make android_backup an optional dependency
• Docs: Add troubleshooting guide for cross-subnet communications
• Docs: Fix link in discovery.rst
• Docs: Sphinx config fix
• Docs: Token extraction for Apple users
• Docs: Add a troubleshooting entry for vacuum timeouts
• Docs: New method to obtain tokens
• miio-extract-tokens: Allow extraction from Yeelight app db
• miio-extract-tokens: Fix for devices without tokens

API changes:

• Air Conditioning Partner: Add swing mode 7 with unknown meaning
• Air Conditioning Partner: Extract the return value of the plug_state request properly
• Air Conditioning Partner: Expose power_socket property
• Air Conditioning Partner: Fix some conversion issues
• Air Humidifier: Add set_led method
• Air Humidifier: Rename speed property to avoid a name clash at HA
• Air Humidifier CA1: Fix led brightness command
• Air Purifier: Add favorite level 17
• Moonlight: Align signature of set_brightness_and_rgb
• Moonlight: Fix parameters of the set_rgb api call
• Moonlight: Night mode support and additional scenes
• Vacuum: Add control for persistent maps, no-go zones and barriers
• Vacuum: Add resume_zoned_clean() and resume_or_start() helper
• Vacuum: Additional error descriptions
• Yeelight Bedside: Fix set_name and set_color_temp

Full Changelog

Fixed bugs:

• miio-extract-tokens raises a TypeError when running against extracted SQLite database #467
• Do not crash on last_clean_details when no history available #457
• install-sound command not working on Xiaowa vacuum (roborock.vacuum.c1 v1.3.0) #418
• DeviceError code -30001 (Resp Invalid JSON) - Philips Bulb #205

Closed issues:

• Issues adding roborock s50 vacuum to HA and controlling from mirobo #456
• Support for chuangmi plug m3 #454
• Xiaomi Phillips Smart LED Ball Lamp and API token for Home Assistant (yaml) #445
• xiaomi ir control #444
• Mirobo does not start on raspberry pi #442
• Add mi band 3 watch to your library #441
• Unsupported Device: chuangmi.plug.hmi205 #440
• Air Purifier zhimi.airpurifier.m1 set_mode isn't working #436
• Can't make it work in a Domoticz plugin #433
• chuangmi.plug.hmi205 unsupported device #427
• Some devices not responding across subnets. #422

Merged pull requests:

• Add missing error description #483 (oncleben31)
• Enable the night mode (scene 6) by calling "go_night" #481 (syssi)
• Philips Moonlight: Support up to 6 fixed scenes #478 (syssi)
• Remove duplicate paragraph about "Tokens from Mi Home logs" #477 (syssi)
• Make android_backup an optional dependency #476 (rytilahti)
• Drop pretty_cron dependency #475 (rytilahti)
• Vacuum: add resume_zoned_clean() and resume_or_start() helper #473 (rytilahti)
• Check for empty clean_history instead of crashing on it #472 (rytilahti)
• Fix miio-extract-tokens for devices without tokens #469 (domibarton)
• Rename speed property to avoid a name clash at HA #466 (syssi)
• Corrected link in discovery.rst and Xiaomi Air Purifier Pro fix #465 (swiergot)
• New method to obtain tokens #464 (swiergot)
• Add a troubleshooting entry for vacuum timeouts #463 (rytilahti)
• Extend miio-extract-tokens to allow extraction from yeelight app db #462 (rytilahti)
• Docs for token extraction for Apple users #460 (domibarton)
• Add troubleshooting guide for cross-subnet communications #459 (domibarton)
• Sphinx config fix #458 (domibarton)
• Add Xiaomi Chuangmi Plug M3 support (Closes: #454) #455 (syssi)
• Add a "Reviewed by Hound" badge #453 (salbertson)
• Air Humidifier: Add set_led method #451 (syssi)
• Air Humidifier CA1: Fix led brightness command #450 (syssi)
• Handle "resp invalid json" error (Closes: #205) #449 (syssi)
• Air Conditioning Partner: Extract the return value of the plug_state request properly #448 (syssi)
• Expose power_socket property at AirConditioningCompanionStatus.__repr__() #447 (syssi)
• Air Conditioning Companion: Fix some conversion issues #446 (syssi)
• Add support v7 version for Xiaomi AirPurifier PRO #443 (quamilek)
• Add control for persistent maps, no-go zones and barriers #438 (rytilahti)
• Moonlight: Fix parameters of the set_rgb api call #435 (syssi)
• yeelight bedside: fix set_name and set_color_temp #434 (rytilahti)
• AC Partner: Add swing mode 7 with unknown meaning #431 (syssi)
• Philips Moonlight: Align signature of set_brightness_and_rgb #430 (syssi)
• Add support for next generation of the Xiaomi Mi Smart Plug #428 (syssi)
• Add Xiaomi Air Quality Monitor 2gen (cgllc.airmonitor.b1) support #420 (syssi)
• Add initial support for aqara camera (lumi.camera.aq1) #375 (rytilahti)

0.4.4 (2018-12-03)

This release adds support for the following new devices:

• Air Purifier 2s
• Vacuums roborock.vacuum.e2 and roborock.vacuum.c1 (limited features, sound packs are known not to be working)

Fixes & Enhancements:

• AC Partner V3: Add socket support
• AC Parner & AirHumidifer: improved autodetection
• Cooker: fixed model confusion
• Vacuum: add last_clean_details() to directly access the information from latest cleaning
• Yeelight: RGB support
• Waterpurifier: improved support

API changes:

• Vacuum: returning a list for clean_details() is deprecated and to be removed in the future.
• Philips Moonlight: RGB values are expected and delivered as tuples instead of an integer

Full Changelog

Implemented enhancements:

• Not working with Rockrobo Xiaowa (roborock.vacuum.e2) #364
• Support for new vacuum model Xiaowa E20 #348

Fixed bugs:

• No working with Xiaowa (roborock.vacuum.c1 v1.3.0) #370
• Send multiple params broken result #73

Closed issues:

• Add lumi.gateway.aqhm01 as unsuppported gateway #424
• Unsupported device zhimi.airpurifier.mc1 #403
• xiaomi repeater v1 #396
• Control Air Conditioner Companion like Xiaomi Mi Smart WiFi Socket #337

Merged pull requests:

• Improve discovery a specific device models #421 (syssi)
• Fix PEP8 lint issue: unexpected spaces around keyword / parameter equals #416 (syssi)
• AC Partner V3: Add socket support (Closes #337) #415 (syssi)
• Moonlight: Provide property rgb as tuple #414 (syssi)
• fix last_clean_details to return the latest, not the oldest #413 (rytilahti)
• generate docs for more modules #412 (rytilahti)
• Use pause instead of stop for home command #411 (rytilahti)
• Add .readthedocs.yml #410 (rytilahti)
• Fix serial number reporting for some devices, add locale command #409 (rytilahti)
• Force parameters to be an empty list if none is given #408 (rytilahti)
• Cooker: Fix mixed model name #406 (syssi)
• Waterpurifier: Divide properties into multiple requests (Closes: #73) #405 (syssi)
• Add Xiaomi Air Purifier 2s support #404 (syssi)
• Fixed typo in log message #402 (microraptor)

0.4.3

This is a bugfix release which provides improved compatibility.

Full Changelog

Closed issues:

• unsupported device zhimi airmonitor v1 #393
• Unsupported device found: chuangmi.ir.v2 #392
• TypeError: not all arguments converted during string formatting #385
• Status not worked for AirHumidifier CA1 #383
• Xiaomi Rice Cooker Normal5: get_prop only works if "all" properties are requested #380
• python-construct-2.9.45 #374

Merged pull requests:

• Update commands in manual #398 (olskar)
• Add cli interface for yeelight devices #397 (rytilahti)
• Add last_clean_details to return information from the last clean #395 (rytilahti)
• Add discovery of the Xiaomi Air Quality Monitor (PM2.5) (Closes: #393) #394 (syssi)
• Add miiocli support for the Air Humidifier CA1 #391 (syssi)
• Add property LED to the Xiaomi Air Fresh #390 (syssi)
• Fix Cooker Normal5: get_prop only works if "all" properties are requested (Closes: #380) #389 (syssi)
• Improve the support of the Air Humidifier CA1 (Closes: #383) #388 (syssi)

0.4.2

This release removes the version pinning for "construct" library as its API has been stabilized and we don't want to force our downstreams for our version choices. Another notable change is dropping the "mirobo" package which has been deprecated for a very long time, and everyone using it should have had converted to use "miio" already. Furthermore the client tools work now with click's version 7+.

This release also changes the behavior of vacuum's got_error property to signal properly if an error has occured. The previous behavior was based on checking the state instead of the error number, which changed after an error to 'idle' after a short while.

Full Changelog

Fixed bugs:

• Zoned cleanup start and stops imediately #355

Closed issues:

• STATE not supported: Updating, state_code: 14 #381
• cant get it to work with xiaomi robot vacuum cleaner s50 #378
• airfresh problem #377
• get device token is 000000000000000000 #366
• Rockrobo firmware 3.3.9_003254 #358
• No response from the device on Xiaomi Roborock v2 #349
• Information : Xiaomi Aqara Smart Camera Hack #347

Merged pull requests:

• Fix click7 compatibility #387 (rytilahti)
• Expand documentation for token from Android backup #382 (sgtio)
• vacuum's got_error: compare against error code, not against the state #379 (rytilahti)
• Add tqdm to requirements list #369 (pluehne)
• Improve repr format #368 (syssi)

0.4.1

This release provides support for some new devices, improved support of existing devices and various fixes.

New devices:

• Xiaomi Mijia Smartmi Fresh Air System Wall-Mounted (@syssi)
• Xiaomi Philips Zhirui Bedside Lamp (@syssi)

Improvements:

• Vacuum: Support of multiple zones for app_zoned_cleaning added (@ciB89)
• Fan: SA1 and ZA1 support added as well as various fixes and improvements (@syssi)
• Chuangmi Plug V3: Measurement unit of the power consumption fixed (@syssi)
• Air Humidifier: Strong mode property added (@syssi)

Full Changelog

Closed issues:

• Xiaomi Rice Cooker component not working #365
• vacuum refuses to answer if the access to internet is blocked #353
• Xiaomi Philips Zhirui Bedside Lamp #351
• Unable to get Xiaomi miplug working on HA #350
• Error codes #346
• miiocli plug does not show the USB power status #344
• could you pls add support to gateway's functions of security and light? #340
• miplug discover throws exception #339
• miioclio: raw_command() got an unexpected keyword argument 'parameters' #335
• qmi.powerstrip.v1 no longer working on 0.40 #334
• Starting the vacuum clean up after remote control #235

Merged pull requests:

• Fan: Fix broken model names #363 (syssi)
• Xiaomi Mi Smart Pedestal Fan: Add ZA1 (zimi.fan.za1) support #362 (syssi)
• ignore cli and test files from test coverage to get correct coverage percentage #361 (rytilahti)
• Add Xiaomi Airfresh VA2 support #360 (syssi)
• Add basic Philips Moonlight support (Closes: #351) #359 (syssi)
• Xiaomi Mi Smart Pedestal Fan: Add SA1 (zimi.fan.sa1) support #354 (syssi)
• Fix "miplug discover" method (Closes: #339) #342 (syssi)
• Fix ChuangmiPlugStatus repr format #341 (syssi)
• Chuangmi Plug V3: Fix measurement unit (W) of the power consumption (load_power) #338 (syssi)
• miiocli: Fix raw_command parameters (Closes: #335) #336 (syssi)
• Fan: Fix a KeyError if button_pressed isn't available #333 (syssi)
• Fan: Add test for the natural speed setter #332 (syssi)
• Fan: Divide the retrieval of properties into multiple requests #331 (syssi)
• Support of multiple zones for app_zoned_cleaning #311 (ciB89)
• Air Humidifier: Strong mode property added and docstrings updated #300 (syssi)

0.4.0

The highlight of this release is a crisp, unified and scalable command line interface called miiocli (thanks @yawor). Each supported device of this library is already integrated.

New devices:

• Xiaomi Mi Smart Electric Rice Cooker (@syssi)

Improvements:

• Unified and scalable command line interface (@yawor)
• Air Conditioning Companion: Support for captured infrared commands added (@syssi)
• Air Conditioning Companion: LED property fixed (@syssi)
• Air Quality Monitor: Night mode added (@syssi)
• Chuangi Plug V3 support fixed (@syssi)
• Pedestal Fan: Improved support of both versions
• Power Strip: Both versions are fully supported now (@syssi)
• Vacuum: New commands app_goto_target and app_zoned_clean added (@ciB89)
• Vacuum: Carpet mode support (@rytilahti)
• WiFi Repeater: WiFi roaming and signal strange indicator added (@syssi)

Full Changelog

Implemented enhancements:

• Extend the Air Quality Monitor PM2.5 support #283
• Support for Xiaomi Mi Smart Electric Rice Cooker #282
• Improved support of the Xiaomi Smart Fan #244
• Extended support of the Philips LED Ceiling Lamp #209
• Add JSON output for easier integration with other tools #98
• Xiaomi Mi Water Purifier support #71
• Xiaomi WiFi Speaker support #69
• Air Quality Monitor: Full support of the night mode #294 (syssi)

Fixed bugs:

• Unable to extract token from Android backup #138
• Xiaomi-Philips Eyecare control fail #74
• Working with water purifier #48

Closed issues:

• miiocli: Provide an error message for unknown commands #327
• miplug status crash #326
• IR remote chuangmiir module #325
• Qing Mi Smart Power Strip cannot be setup，device id is 04b8824e #318
• I can not start mirobo #316
• acpartner-v3 #312
• Vacuum v1 new firmware #305
• Xiaomi Power Strip V1 is unable to handle some V2 properties #302
• TypeError: isinstance() arg 2 must be a type or tuple of types #296
• Extend the Power Strip support #286
• when i try to send a command #277
• Obtain token for given IP address #263
• Unable to discover the device #259
• xiaomi vaccum cleaner not responding #92
• xiaomi vacuum, manual moving mode: duration definition incorrect #62

Merged pull requests:

• Chuangmi Plug V3: Make a local copy of the available properties #330 (syssi)
• miiocli: Handle unknown commands (Closes: #327) #329 (syssi)
• Fix a name clash of click_common and the argument "command" #328 (syssi)
• Update README #324 (syssi)
• Migrate miplug cli to the new ChuangmiPlug class (Fixes: #296) #323 (syssi)
• Link to the Home Assistant custom component "xiaomi_cooker" added #320 (syssi)
• Improve the Xiaomi Rice Cooker support #319 (syssi)
• Air Conditioning Companion: Rewrite a captured command before replay #317 (syssi)
• Air Conditioning Companion: Led property fixed #315 (syssi)
• mDNS names of the cooker fixed #314 (syssi)
• mDNS names of the Air Conditioning Companion (AC partner) added #313 (syssi)
• Added new commands app_goto_target and app_zoned_clean #310 (ciB89)
• Link to the Home Assistant custom component "xiaomi_raw" added #309 (syssi)
• Improved support of the Xiaomi Smart Fan #306 (syssi)
• mDNS discovery: Xiaomi Smart Fans added #304 (syssi)
• Xiaomi Power Strip V1 is unable to handle some V2 properties #303 (syssi)
• mDNS discovery: Additional Philips Candle Light added #301 (syssi)
• Add support for vacuum's carpet mode, which requires a recent firmware version #299 (rytilahti)
• Air Conditioning Companion: Extended parsing of model and state #297 (syssi)
• Air Quality Monitor: Type and payload example of the time_state property updated #293 (syssi)
• WiFi Speaker support improved #291 (syssi)
• Imports optimized #290 (syssi)
• Support of the unified command line interface for all devices #289 (syssi)
• Power Strip support extended by additional attributes #288 (syssi)
• Basic support for Xiaomi Mi Smart Electric Rice Cooker #287 (syssi)
• WiFi Repeater: Wifi roaming and signal strange indicator added #285 (syssi)
• Preparation of release 0.3.9 #281 (syssi)
• Unified and scalable command line interface #191 (yawor)

0.3.9

This release provides support for some new devices, improved support of existing devices and various fixes.

New devices:

• Xiaomi Mi WiFi Repeater 2 (@syssi)
• Xiaomi Philips Zhirui Smart LED Bulb E14 Candle Lamp (@syssi)

Improvements:

• Repr of the AirPurifierStatus fixed (@sq5gvm)
• Chuangmi Plug V1, V2, V3 and M1 merged into a common class (@syssi)
• Water Purifier: Some properties added (@syssi)
• Air Conditioning Companion: LED status fixed (@syssi)
• Air Conditioning Companion: Target temperature property renamed (@syssi)
• Air Conditioning Companion: Swing mode property returns the enum now (@syssi)
• Move some generic util functions from vacuumcontainers to utils module (@rytilahti)
• Construct version bumped (@syssi)

Full Changelog

Closed issues:

• Xiaomi Mi WiFi Amplifier 2 support #275
• TypeError: not enough arguments for format string in airpurifier.py #264
• Issue vaccum gen 2 - HA 0.64 -> 0.65 Python 3.6.0 -> 3.7.0 #261
• Add support for Xiaomi Philips Zhirui Smart LED Bulb E14 Candle Lamp #243
• Basic support for the Yeelight LED Ceiling Lamp v4 #240
• from Construct developer, a note #222

Merged pull requests:

• construct version bumped #280 (syssi)
• Support for the Xiaomi Mi WiFi Repeater 2 added #278 (syssi)
• Move some generic util functions from vacuumcontainers to utils module #276 (rytilahti)
• Air Conditioning Companion: Swing mode property returns the enum now #274 (syssi)
• Air Conditioning Companion: Target temperature property properly named #273 (syssi)
• Air Conditioning Companion: LED status fixed #272 (syssi)
• Water Purifier: Some properties added #271 (syssi)
• Merge of the Chuangmi Plug V1, V2, V3 and M1 #270 (syssi)
• Improve test coverage #269 (syssi)
• Support for Xiaomi Philips Zhirui Smart LED Bulb E14 Candle Lamp #268 (syssi)
• Air Purifier: Duplicate property removed from __repr__ #267 (syssi)
• Tests for reprs of the status classes #266 (syssi)
• Repr of the AirPurifierStatus fixed #265 (sq5gvm)

0.3.8

Goodbye Python 3.4! This release marks end of support for python versions older than 3.5, paving a way for cleaner code and a nicer API for a future asyncio support. Highlights of this release:

• Support for several new devices, improvements to existing devices and various fixes thanks to @syssi.

• Firmware updates for vacuums (@rytilahti), the most prominent use case being installing custom firmwares (e.g. for rooting your device). Installing sound packs is also streamlined with a self-hosting server.

• The protocol quirks handling was extended to handle invalid messages from the cloud (thanks @jschmer), improving interoperability for Dustcloud.

New devices:

• Chuangmi Plug V3 (@syssi)
• Xiaomi Air Humidifier CA (@syssi)
• Xiaomi Air Purifier V3 (@syssi)
• Xiaomi Philips LED Ceiling Light 620mm (@syssi)

Improvements:

• Provide the mac address as property of the device info (@syssi)
• Air Purifier: button_pressed property added (@syssi)
• Generalize and move configure_wifi to the Device class (@rytilahti)
• Power Strip: The wifi led and power price can be controlled now (@syssi)
• Try to fix decrypted payload quirks if it fails to parse as json (@jschmer)
• Air Conditioning Companion: Turn on/off and LED property added, load power fixed (@syssi)
• Strict check for version equality of construct (@arekbulski)
• Firmware update functionality (@rytilahti)

Full Changelog

Closed issues:

• Can't retrieve token from Android app #246
• Unsupported device found! chuangmi.ir.v2 #242
• Improved support of the Air Humidifier #241
• Add support for the Xiaomi Philips LED Ceiling Light 620mm (philips.light.zyceiling) #234
• Support Xiaomi Air Purifier v3 #231

Merged pull requests:

• Add --ip for install_sound, update_firmware & update docs #262 (rytilahti)
• Provide the mac address as property of the device info #260 (syssi)
• Tests: Non-essential code removed #258 (syssi)
• Support of the Chuangmi Plug V3 #257 (syssi)
• Air Purifier V3: Response example updated #255 (syssi)
• Support of the Air Purifier V3 added (Closes: #231) #254 (syssi)
• Air Purifier: Property "button_pressed" added #253 (syssi)
• Respond with an error after the retry counter is down to zero, log retries into debug logger #252 (rytilahti)
• Drop python 3.4 support, which paves a way for nicer API for asyncio among other things #251 (rytilahti)
• Generalize and move configure_wifi to the Device class #250 (rytilahti)
• Support of the Xiaomi Air Humidifier CA (zhimi.humidifier.ca1) #249 (syssi)
• Xiaomi AC Companion: LED property added #248 (syssi)
• Some misleading docstrings updated #245 (syssi)
• Powerstrip support improved #239 (syssi)
• Repr of the AirQualityMonitorStatus fixed #238 (syssi)
• mDNS discovery: Additional philips light added #237 (syssi)
• Try to fix decrypted payload quirks if it fails to parse as json #236 (jschmer)
• Device support of the Xiaomi Air Conditioning Companion improved #233 (syssi)
• Construct related, strict check for version equality #232 (arekbulski)
• Implement firmware update functionality #153 (rytilahti)

0.3.7

This is a bugfix release which provides improved stability and compatibility.

Full Changelog

Closed issues:

• construct.core.StreamError: could not write bytes, expected 4, found 8 #227
• yeelink.light.color1 unsupported #225
• Cant decode token (invalid start byte) #224
• from Construct developer, a note #222

Merged pull requests:

• Proper handling of the device_id representation #228 (syssi)
• Construct related, support upto 2.9.31 #226 (arekbulski)

0.3.6

This is a bugfix release because of further breaking changes of the underlying library construct.

Improvements:

• Lazy discovery on demand (@syssi)
• Support of construct 2.9.23 to 2.9.30 (@yawor, @syssi)
• Avoid device crash on wrap around of the sequence number (@syssi)
• Extended support of the Philips Ceiling Lamp (@syssi)

Full Changelog

Closed issues:

• Unable to discover a device #217
• AirPurifier set_mode #213
• Construct 2.9.28 breaks the Chuangmi IR packet assembly #212
• Set mode for Air Purifier 2 not working #207
• Trying to get map data without rooting #206
• Unknown miio device found #204
• Supporting raw and pronto optional parameter without type specifier. #199

Merged pull requests:

• Fixes for the API change of construct v2.9.30 #220 (syssi)
• Philips Ceiling Lamp: New setter "bricct" added #216 (syssi)
• Lazy discovery on demand #215 (syssi)
• Chuangmi IR: Fix Construct 2.9.28 regression #214 (yawor)
• Philips Bulb crashs if _id is 0 #211 (syssi)

0.3.5

This release provides major improvements for various supported devices. Special thanks goes to @yawor for his awesome work!

Additionally, a compatibility issue when using construct version 2.9.23 and greater -- causing timeouts and inability to control devices -- has been fixed again.

Device errors are now wrapped in a exception (DeviceException) for easier handling.

New devices:

• Air Purifier: Some additional models added to the list of supported and discovered devices by mDNS (@syssi)
• Air Humidifier CA added to the list of supported and discovered devices by mDNS (@syssi)

Improvements:

• Air Conditioning Companion: Extended device support (@syssi)
• Air Humidifier: Device support tested and improved (@syssi)
• Air Purifier Pro: Second motor speed and filter type detection added (@yawor)
• Air Purifier: Some additional properties added (@syssi)
• Air Quality Monitor: Additional property "time_state" added (@syssi)
• Revise error handling to be more consistent for library users (@rytilahti)
• Chuangmi IR: Ability to send any Pronto Hex encoded IR command added (@yawor)
• Chuangmi IR: Command type autodetection added (@yawor)
• Philips Bulb: New command "bricct" added (@syssi)
• Command line interface: Make discovery to work with no IP addr and token, courtesy of @M0ses (@rytilahti)

Full Changelog

Fixed bugs:

• TypeError: build() takes 2 positional arguments but 3 were given #201
• Error on build message #197

Closed issues:

• Control Air purifier and Humidifier? #177
• Construct error, "subcon should be a Construct field" #167

Merged pull requests:

• mDNS discovery: Additional air humidifier model (zhimi-humidifier-ca1) added #200 (syssi)
• Make discovery to work with no IP addr and token, courtesy of M0ses #198 (rytilahti)
• Minimum supported version of construct specified #196 (syssi)
• Chuangmi IR command type autodetection #195 (yawor)
• Point hound-ci to the flake8 configuration. Second try. #193 (syssi)
• Fix a breaking change of construct 2.9.23 #192 (syssi)
• Air Purifier: SleepMode enum added. SleepMode isn't a subset of OperationMode #190 (syssi)
• Point hound-ci to the flake8 configuration #189 (syssi)
• Features of mixed air purifier models added #188 (syssi)
• Air Quality Monitor: New property "time_state" added #187 (syssi)
• Philips Bulb: New setter "bricct" added #186 (syssi)
• Tests for the Chuangmi IR controller #184 (syssi)
• Chuangmi IR: Add ability to send any Pronto Hex encoded IR command. #183 (yawor)
• Tests for the Xiaomi Air Conditioning Companion #182 (syssi)
• Flake8 configuration updated #181 (syssi)
• Revise error handling to be more consistent for library users #180 (rytilahti)
• All device specific exceptions should derive from DeviceException #179 (syssi)
• Air Purifier Pro second motor speed #176 (yawor)
• Tests of the Air Purifier improved #174 (syssi)
• New properties of the Xiaomi Air Humidifier added #173 (syssi)
• Return type of the property "volume" should be Optional #172 (syssi)
• Missing dependency "appdirs" added #171 (syssi)
• Xiaomi Air Humidifier: Unavailable property "led" removed. #170 (syssi)
• Extended Air Conditioning Companion support #169 (syssi)

0.3.4

The most significant change for this release is unbreaking the communication when using a recent versions of construct library (thanks to @syssi). On top of that there are various smaller fixes and improvements, e.g. support for sound packs and running python-miio on Windows.

New devices:

• Air Purifier 2S added to the list of supported and discovered devices by mDNS (@harnash)

Improvements:

• Air Purifier Pro: support for sound volume level and illuminance sensor (@yawor)
• Vacuum: added sound pack handling and ability to change the sound volume (@rytilahti)
• Vacuum: better support for status information on the 2nd gen model (@hastarin)

Full Changelog

Fixed bugs:

• Error with info command #156
• Change hard coded /tmp to cross-platform tempfile #148

Closed issues:

• mirobo vacuum sound volume control #159
• wifi signal strength #155
• xiaomi philips bulb & philips ceiling #151
• Vaccum Timer / Timezone issue #149
• Exception when displaying Power load using Plug CLI #144
• Missing states and error_codes #57

Merged pull requests:

• Use appdirs' user_cache_dir for sequence file #165 (rytilahti)
• Add a more helpful error message when info() fails with an empty payload #164 (rytilahti)
• Adding "Go to target" state description for Roborock S50. #163 (hastarin)
• Add ability to change the volume #162 (rytilahti)
• Added Air Purifier 2S to supported devices #161 (harnash)
• Modified to support zoned cleaning mode of Roborock S50. #160 (hastarin)
• Fix for a breaking change of construct 2.8.22 #158 (syssi)
• Air Purifier Pro: support for sound volume level and fix for bright propery #157 (yawor)
• Add preliminary support for managing sound files #154 (rytilahti)

0.3.3

This release brings support for Air Conditioner Companion along some improvements and an increase in the test coverage for future-proofing the code-base. Special thanks for this release goes to @syssi & to all new contributors!

A bug exposed in python-miio when using version 2.8.17 or newer of the underlying construct library -- causing timeouts and inability to control devices -- has also been fixed in this release.

New supported devices:

• Xiaomi Mi Home Air Conditioner Companion

Improvements:

• Mi Vacuum 2nd generation is now detected by discovery
• Air Purifier 2: expose additional properties
• Yeelight: parse RGB properly

Full Changelog

Implemented enhancements:

• Xiaomi Mi Home Air Conditioner Companion support #76

Closed issues:

• Philip Eye Care Lamp Got error when receiving: timed out #146
• Can't reach my mirobo #145
• installiation problems #130
• Unable to discover Xiaomi Philips LED Bulb #106
• Xiaomi Mi Robot Vacuum 2nd support #90

Merged pull requests:

• Update for Rock Robot (Mi Robot gen 2) #143 (fanthos)
• Unbreak the communication when using construct v2.8.17 #142 (rytilahti)
• fix powerstate invalid #139 (roiff)
• Unit tests for the Chuang Mi Plug V1 #137 (syssi)
• Unit tests of the Xiaomi Power Strip extended #136 (syssi)
• Unit tests for the Xiaomi Air Quality Monitor #135 (syssi)
• Unit tests for the Xiaomi Air Humidifier #134 (syssi)
• Unit tests for philips lights #133 (syssi)
• Additional properties of the Xiaomi Air Purifier 2 introduced #132 (syssi)
• Fix Yeelight RGB parsing #131 (Sduniii)
• Xiaomi Air Conditioner Companion support #129 (syssi)
• Fix manual_control error message typo #127 (skorokithakis)
• bump to 0.3.2, add RELEASING.md for describing the process #126 (rytilahti)

0.3.2

This release includes small improvements for powerstrip and vacuum support. Furthermore this is the first release with proper documentation. Generated docs are available at https://python-miio.readthedocs.io - patches to improve them are more than welcome!

Improvements:

• Powerstrip: expose correct load power, works also now without cloud connectivity
• Vacuum: added ability to reset consumable states
• Vacuum: exposes time left before next sensor clean-up

Full Changelog

Closed issues:

• philips.light.ceiling Unsupported device found! #118
• Xiaomi Philips ceiling light automation #116
• Unsupported device found #112
• PM2.5 Faster Readout #111

Merged pull requests:

• add pure text LICENSE #125 (rytilahti)
• Add GPLv3 license #124 (pluehne)
• Don’t require typing with Python 3.5 and newer #123 (pluehne)
• Powerstrip fixes #121 (rytilahti)
• Added time left for recommended sensor cleaning #119 (bbbenji)
• Load power of the PowerStrip fixed and removed from the Plug #117 (syssi)
• Reset consumable by name #115 (mrin)
• Model name of the Xiaomi Philips Ceiling Lamp updated #113 (syssi)
• Update apidocs for sphinx-generated documentation, which follows at l… #93 (rytilahti)

0.3.1 (2017-11-01)

New supported devices:

• Xioami Philips Smart LED Ball Lamp

Improvements:

• Vacuum: add ability to configure used wifi network
• Plug V1: improved discovery, add temperature reporting
• Airpurifier: setting of favorite level works now
• Eyecare: safer mapping of properties

Breaking:

• Strip has been renamed to PowerStrip to avoid confusion

Full Changelog

Fixed bugs:

• AirPurifier: set_favorite_level not working #103

Closed issues:

• Unsupported device #108
• Xiaomi Vacuum resume cleaning session from dock capability? #102

Merged pull requests:

• Chuang Mi Plug V1: Property "temperature" added & discovery fixed #109 (syssi)
• Add the ability to define a timezone for configure_wifi #107 (rytilahti)
• Make vacuum robot wifi settings configurable via CLI #105 (infinitydev)
• API call set_favorite_level (method: set_level_favorite) updated #104 (syssi)
• use upstream android_backup #101 (rytilahti)
• add some tests to vacuum #100 (rytilahti)
• Add a base to allow easier testing of devices #99 (rytilahti)
• Rename of Strip to PowerStrip to avoid confusion with led strips #97 (syssi)
• Some typing hints added and the code order aligned #96 (syssi)
• Philips Eyecare: More safety property mapping of the device status #95 (syssi)
• Device support of the Xioami Philips Smart LED Ball Lamp #94 (syssi)

0.3.0 (2017-10-21)

Good bye to python-mirobo, say hello to python-miio! As the library is getting more mature and supports so many other devices besides the vacuum sporting the miIO protocol, it was decided that the project deserves a new name. The name python-miio was previously used by a fork of python-mirobo, and we are thankful to SchumyHao for releasing the name for us.

The old "mirobo" package will continue working (and is API compatible) for the foreseeable future, however, developers using this package (if any) are encouraged to port their code over to use the the new "miio" package. The old command-line tools remain as they are.

In order to simplify the initial configuration, a tool to extract tokens from a Mi Home's backup (Android) or its database (Apple, Android) is added. It will also decrypt the tokens if needed, a change which was introduced recently how they are stored in the database of iOS devices.

Improvements:

• Vacuum: add support for configuring scheduled cleaning
• Vacuum: more user-friendly do-not-disturb reporting
• Vacuum: VacuumState's 'dnd' and 'in_cleaning' properties are deprecated in favor of 'dnd_status' and 'is_on'.
• Power Strip: load power is returned now correctly
• Yeelight: allow configuring 'developer mode', 'save state on change', and internal name
• Properties common for several devices are now named more consistently

New supported devices:

• Xiaomi PM2.5 Air Quality Monitor
• Xiaomi Water Purifier
• Xiaomi Air Humidifier
• Xiaomi Smart Wifi Speaker (incomplete, help wanted)

Full Changelog

Implemented enhancements:

• Column ZToken of the iOS app contains a 96 character token #75
• Xiaomi PM2.5 Air Quality Monitor support #70

Closed issues:

• Calling message handler 'onHeartbeat'. #82
• How do I find more features? #10

Merged pull requests:

• Device support of the Xiaomi PM2.5 Air Quality Monitor introduced #89 (syssi)
• wrap vacuum's dnd status inside an object #87 (rytilahti)
• Initial support for wifi speakers #86 (rytilahti)
• Extend yeelight support #85 (rytilahti)
• Discovery: Device name of the zimi powerstrip v2 fixed #84 (syssi)
• Rename the project to python-miio #83 (rytilahti)
• Device support of the Xiaomi Power Strip updated #81 (syssi)
• WIP: Extract Android backups, yield devices instead of just echoing #80 (rytilahti)
• add a note about miio-extract-tokens #79 (rytilahti)
• Implement adding, deleting and updating the timer #78 (rytilahti)
• Add miio-extract-tokens tool for extracting tokens from sqlite databases #77 (rytilahti)
• WIP: Avoid discovery flooding #72 (syssi)
• mDNS discovery: New air purifier model (zhimi-airpurifier-m2) #68 (syssi)
• First draft of the water purifier support #67 (syssi)
• Device support of the Xiaomi Air Humidifier #66 (syssi)
• Device info extended by two additional properties #65 (syssi)
• Abstract device model exteded by model name (identifier) #64 (syssi)
• Adjust property names of some devices #63 (syssi)

0.2.0 (2017-09-05)

Considering how far this project has evolved from being just an interface for the Xiaomi vacuum, it is time to leave 0.1 series behind and call this 0.2.0.

This release brings support to a couple of new devices, and contains fixes for some already supported ones. All thanks for the improvements in this release go to syssi!

• Extended mDNS discovery to support more devices (@syssi)
• Improved support for the following devices:
  • Air purifier (@syssi)
  • Philips ball / Ceiling lamp (@syssi)
  • Xiaomi Strip (@syssi)
• New supported devices:
  • Chuangmi IR Remote control (@syssi)
  • Xiaomi Mi Smart Fan (@syssi)

Full Changelog

Closed issues:

• Error in new mirobo/protocol.py #54
• Some element about Xiaomi Philips Bulb #43
• Philips Bulb and ceiling how to get token ? #42
• Add support for other devices using the same protocol #17
• Allow sending discovery packets to static IP address #5

Merged pull requests:

• trivial: fix typo in automatic discovery description. #61 (haim0n)
• Some typos fixed #60 (syssi)
• Fixes an AttributeError: PlugStatus object has no attribute current #59 (syssi)
• Fixes various lint issues #58 (syssi)
• Air Purifier: Set favorite level fixed #55 (syssi)
• mDNS name of the Chuangmi Infrared Controller #53 (syssi)
• Device support for the Xiaomi Mi Smart Fan #52 (syssi)
• mDNS device map extended #51 (syssi)
• Power strip: Fixes calculation of the instantaneous current #50 (syssi)
• Air purifier: defaultdict used for safety and transparency #49 (syssi)
• Device support for the Chuangmi IR Remote Controller #46 (syssi)
• Xiaomi Ceiling Lamp: Some refactoring and fault tolerance if a philips light ball is used #45 (syssi)
• New dependency "zeroconf" added. It's used for discovery now. #44 (syssi)
• Readme for firmware >= 3.3.9_003077 (Vacuum robot) #41 (mthoretton)
• Some improvements of the air purifier support #40 (syssi)

0.1.4 (2017-08-23)

Fix dependencies

Full Changelog

0.1.3 (2017-08-22)

• New commands:

  • --version to print out library version
  • info to return information about a device (requires token to be set)
  • serial_number (vacuum only)
  • timezone (getting and setting the timezone, vacuum only)
  • sound (querying)

• Supports for the following new devices thanks to syssi and kuduka:

  • Xiaomi Smart Power Strip (WiFi, 6 Ports) (@syssi)
  • Xiaomi Mi Air Purifier 2 (@syssi)
  • Xiaomi Mi Smart Socket Plug (1 Socket, 1 USB Port) (@syssi)
  • Xiaomi Philips Eyecare Smart Lamp 2 (@kuduka)
  • Xiaomi Philips LED Ceiling Lamp (@kuduka)
  • Xiaomi Philips LED Ball Lamp (@kuduka)

• Discovery now uses mDNS instead of handshake protocol. Old behavior still available with --handshake true

Full Changelog

Closed issues:

• After updating to new firmware - can #37
• CLI tool demands an IP address always #36
• Use of both app and script not possible? #30
• Moving from custom_components to HA version not working #28
• Xiaomi Robot new Device ID #27

Merged pull requests:

• Supported devices added to README.md and version bumped #39 (syssi)
• Fix Home Assistant link to doc, using new vacuum component #38 (azogue)
• Added support for Xiaomi Philips LED Ceiling Lamp #35 (kuduka)
• Added support for Xiaomi Philips Eyecare Smart Lamp 2 #34 (kuduka)
• Device support for the chuangmi plug v1 added #33 (syssi)
• Device support for the xiaomi power strip added. #32 (syssi)
• Device support for the xiaomi air purifier added. #31 (syssi)

0.1.2 (2017-07-22)

• Add support for Wifi plugs (thanks to syssi)
• Make communication more robust by retrying automatically on errors

Full Changelog

Closed issues:

• Pause not working in remote control mode #26
• geht error singe 0.1.0 #25
• Check that given token has correct length #11

Merged pull requests:

• Device support for the xiaomi smart wifi socket added #29 (syssi)

0.1.1 (2017-07-10)

add 'typing' requirement for python <3.5

Full Changelog

Closed issues:

• No module named 'typing' #24

0.1.0 (2017-07-08)

Full Changelog

Closed issues:

• Error: Invalid value for "--id-file" #23
• error on execute mirobo discover #22
• Only one command working #21
• Integration in home assistant #4

0.0.9 (2017-07-06)

fixes communication with newer firmwares

Full Changelog

Closed issues:

• Feature request: show cleaning map #20
• Command "map" and "raw_command" - what do they do? #19
• mirobo "DND enabled: 0", after change to 1 #18
• Xiaomi vaccum control from Raspberry pi + iPad Mi app at the same time - token: b'ffffffffffffffffffffffffffffffff' #16
• Not working with newest firmware version 3.3.9_003073 #14

0.0.8 (2017-06-05)

Full Changelog

Closed issues:

• WIFI Switch for HA #12
• Bug when having multiple network interfaces (discovery) #9
• Get token from android App #8
• Hello Thank you ！ #7
• WARNING:root:could not open file'/etc/apt/sources.list' #6

0.0.7 (2017-04-14)

cleanup in preparation for homeassistant inclusion

Full Changelog

0.0.6 (2017-04-14)

cli improvements, total cleaning stats, remaining time for consumables

Full Changelog

Closed issues:

• some concern about the new version #3
• can't find my robot #2
• [Error] Timout when querying for status #1

0.0.5 (2017-04-14)

* This Change Log was automatically generated by github_changelog_generator