Commit Graph

1012 Commits

Author SHA1 Message Date
Bas Nijholt
09d620df01 Merge remote-tracking branch 'upstream/azure_pipelines' into asyncio 2019-11-15 14:17:00 +01:00
Bas Nijholt
190a800e77 only support >= 3.6 2019-11-11 23:15:57 +01:00
Bas Nijholt
cc900ae491 tmp: comment out 2 failing tests 2019-11-11 23:10:57 +01:00
Bas Nijholt
b2973cda6c fix the tests 2019-11-11 23:02:50 +01:00
Teemu Rytilahti
b5e585e1f8 export __version__ under the main module 2019-11-11 22:33:23 +01:00
Teemu Rytilahti
751c2445c2 add missing version.py 2019-11-11 22:30:37 +01:00
Teemu Rytilahti
8a131e1eeb Add precommit hooks & tox env to enforce code structure, add azure pipelines
Instead of leveraging hound & travis, add an option for azure pipelines,
which may replace the former in the future.

This also streamlines the contributing guidelines by:
* Adding pre-commit hooks to run isort, black, flake8, mypy
* Adding lint environment to allow checks to be run `tox -e lint`

This also contains a major cleanup to the SmartStrip handling which was due.
After seeing #184 I thought I should push this in as it is for comments before the codebase diverges too much.
2019-11-11 22:14:34 +01:00
Bas Nijholt
583c785611 prefer sync attribute over asyncio.run 2019-11-11 21:06:50 +01:00
Bas Nijholt
9907c6416b isort and black on the tests 2019-11-11 20:31:56 +01:00
Bas Nijholt
55d898b547 use absolute imports 2019-11-11 20:30:29 +01:00
Bas Nijholt
8a7d955eb7 use the "sync" attribute to call methods in the CLI 2019-11-11 20:29:18 +01:00
Bas Nijholt
e6faf9dd05 change cli.py message in according with setup.py 2019-11-11 20:29:18 +01:00
Bas Nijholt
0c1d8b6efe implement SyncSmartDevice and sort imports and use absolute imports 2019-11-11 20:29:18 +01:00
Bas Nijholt
30677b2af0 black setup.py 2019-11-11 20:29:18 +01:00
Bas Nijholt
b2d0a511a5 define __all__ ( also gets rid of flake8 issues) 2019-11-11 20:29:18 +01:00
Bas Nijholt
533c6b5ca2 pass an ioloop 2019-11-11 19:16:55 +01:00
Bas Nijholt
7d3d105e47 remove unused imports 2019-11-11 18:19:45 +01:00
Bas Nijholt
ba2600cb93 make SmartStrip use asyncio 2019-11-11 18:19:45 +01:00
Bas Nijholt
b6a0542f43 make SmartPlug use asyncio 2019-11-11 18:19:45 +01:00
Bas Nijholt
7c69d3c03a make SmartBulb use asyncio 2019-11-11 18:19:45 +01:00
Bas Nijholt
904bbe5c1a make SmartDevice use asyncio 2019-11-11 18:19:45 +01:00
Bas Nijholt
af0a1d61b1 use asyncio.run in tests instead of awaiting 2019-11-11 17:03:45 +01:00
Bas Nijholt
3b27f7d7e7 use asyncio.run on coroutines in cli.py 2019-11-11 17:01:42 +01:00
Bas Nijholt
0e0ab1dfc9 change functions that use query to await 2019-11-11 16:56:39 +01:00
Bas Nijholt
8f59d74e29 implement TPLinkSmartHomeProtocol.query with asyncio 2019-11-11 16:52:13 +01:00
Teemu R
59424d2738
Fix cli status reporting, blackify cli.py (#182)
Fixes #181
2019-10-26 14:21:08 +02:00
Ville Skyttä
752b24c4ec Python < 3.5 cleanups (#180)
* tox: remove Python < 3.5 config

* deps: drop typing, included in Python 3.5+
2019-08-13 16:55:18 -04:00
Christopher Fricke
c9280c70c0 Fix __repr__ function of SmartDevice (#178) 2019-07-26 15:21:25 -04:00
kochinc
2c79febae4 Allow specifying broadcast address for discovery (#176)
* Allow specifying broadcast address

In situations such as multiple network interfaces, it may be necessary to specify the broadcast address so that the discovery message is sent to the desired local network.

* Added the option to specify broadcast address

Sometimes it's necessary to specify what broadcast address it should send the discovery message. For instance, there are multiple network interfaces on the host.

* Get target from parent context when in subcommand

Since --target is a top-level option and we want to use it in subcommands, use ctx.parent.params['target'] to retrieve it.

* Removed the trailing space.

* Deleted commented out line
2019-07-25 00:21:24 -04:00
Daniel Berlin
fa0c2d82e8 Fix CLI for HS300 (#177) 2019-07-25 00:17:13 -04:00
Teemu R
2d60467bea
API and tests cleanup (#151)
* Add new cli commands: raw_command and dump_discover

- raw_command can be used to execute raw commands with given parameters
  * Useful for testing new calls before implementing them properly

- dump_discover can be used to dump the device discovery information (into a file)
  * The discovery is extended to request more modules and methods from devices
    * smartlife.iot.dimmer get_dimmer_parameters
    * smartlife.iot.common.emeter get_realtime
    * smartlife.iot.smartbulb.lightingservice get_light_state
  * This is used to dump more information for proper tests, and will also allow better discovery in the future

This commit contains also some documentation updates and dropping click_datetime in favor of click's built-in datetime

* Docstring fixes

* Major API cleanup

Properties shall no more change the state of the device, this work in still in progress, the main goal being making the API more user-friendly and to make implementing new features simpler.

The newly deprecated functionality will remain working and will simply warn the user about deprecation.
Previously deprecated 'features' property and 'identify' method are now finally removed.

Deprecate and replace the following property setters:
* state with turn_on() and turn_off()
* hsv with set_hsv()
* color_temp with set_color_temp()
* brightness with set_brightness()
* led with set_led()
* alias with set_alias()
* mac with set_mac()

And getters:
* state with is_on and is_off

The {BULB,PLUG}_STATE_{ON,OFF} is simplified to STATE_ON and STATE_OFF, UNKNOWN state is removed.
These are now deprecated and will be removed in the future.
* is_on and is_off can be used to check for the state
* turn_on() and turn_off() for changing the device state.

Trying to use functionality not supported by the device will cause SmartDeviceExceptions instead of failing silently and/or returning None.
This includes, e.g., trying to set a color temperature on non-supported bulb.

ValueErrors are raised instead of SmartDeviceExceptions where appropriate (e.g. when trying to set an invalid hsv or brightness).

New enum type DeviceType is added to allow detecting device types without resorting to isinstance() calling. SmartDevice class' device_type property can be used to query the type. is_plug and is_bulb helpers are added.

* Cleanup tests and improve test coverage

* Make writing tests easier by sharing code for common implementations
* Instead of storing test data inside python files, dump-discover based information is used
  * This will simplify adding new tests and remove code duplication
  * fixtures are based on https://github.com/plasticrake/tplink-smarthome-simulator

* run black on newfakes

* Add HS300 tests and update SmartStrip API according to earlier changes, still WIP

* run black and avoid wildcard imports

* Black on conftest

* bump minimum required version to 3.5

* Rename fixture_tests to test_fixtures for autocollect

* fix typoed type to _type, black

* run black on several files with -79 to fix hound issues

* Fix broken merge on hue

* Fix tests (hue update, pass context to smartdevice), add is_strip property, disable emeter tests for HS300 until a solution for API is found.

* Fix old tests

* Run black on changed files

* Add real HS220 discovery, thanks to @poiyo

* add is_dimmable and is_variable_color_temp to smartdevice class, simplifies interfacing with homeassistant

* add KL120(US) fixture

* Add a simple query cache

This commit adds a simple query cache to speed up the process for users
requesting lots of different properties from the device, as done by the
cli tool as well as homeassistant.

The logic for caching is very simple:
1. A timestamp for last fetch for each module+command is stored alongside the response.
2. If the issued command starts with `get_` and the TTL has not expired, the cache result is returned.
3. Otherwise the cache for the whole corresponding module gets invalidated, the device will be queried and the result will be stored in the cache.

* add deprecation to tox.ini

* make tests pass again

* remove old tests, add flake8 to tox reqs

* run black against pyhs100 module, add it to precommit hooks, fix flake8 configuration to conform to black standards (https://ljvmiranda921.github.io/notebook/2018/06/21/precommits-using-black-and-flake8/)

* fix syntax

* cleanup conftest
2019-06-16 17:05:00 -04:00
Teemu R
e82746da24
Fix temperature range for KL120, the device can only do up to 5000 k (#174)
* Fix temperature range for KL120, the device can only do up to 5000 kelvin

* use different temperature range for US and EU models of KL120
2019-06-09 18:28:51 -04:00
Teemu R
a475233464
Check for errors also in the command payload (#173)
For example, trying to set unsupported color temperature will cause such response.
This gets ignored at the moment completely, so there is no indication at all why the command caused no effect on the device.

> (93) {"smartlife.iot.smartbulb.lightingservice": {"transition_light_state": {"color_temp": 6000}}}
< (125) {"smartlife.iot.smartbulb.lightingservice":{"transition_light_state":{"err_code":-10000,"err_msg":"Invalid input argument"}}}
2019-06-03 09:58:03 -04:00
Teemu R
60add6fa66
Improve discovery by sending multiple UDP datagrams (#172)
As UDP datagrams may get lost in transit, e.g.,  due to poor network connectivity,
we can improve the detection rate by sending multiple datagrams and hoping some
will get through to the devices.

Confirmed to improve the detection by @scubanarc: https://github.com/home-assistant/home-assistant/issues/21966

This is a new configurable option, defaulting to three discover packets.
2019-05-20 21:56:01 -04:00
Teemu R
29f75d9566
Prepare 0.3.5 (#170) 2019-04-13 01:12:37 -04:00
Alex
461440e8b1 Fix for SmartStrip repr (#169)
* Added unit tests for repr.

* Fix repr for SmartStrip.

Fixes #165
2019-04-09 00:19:42 -04:00
Teemu R
960ec6a346
Smartstrip: return on_since state information only when the socket is on (#161)
* Smartstrip: return on_since state information only when the socket is on

Fixes #160

* add proper cli printout for hs300 child sockets

* iterate over range, not an integer
2019-03-16 21:32:59 +01:00
Teemu R
8046c96b54
bulb: add the temperature range to state_information, inform the user if the info is missing when calling temperature (#163) 2019-03-16 21:32:25 +01:00
Georgi Kirichkov
07b4eda7ae Fix Discover#discover incorrect documentation (#159)
The documentation states the timeout defaults to 5 seconds, but in the definition of the method timeout is set to 3
2019-01-30 13:28:14 +01:00
dieselrabbit
df42f59ede Add kelvin range for KL130 (#156)
* Add kelvin range for KL130 (new color bulb)

* Add kelvin range for KL120

Unable to test this personally as I don't have this bulb.
2019-01-26 21:12:22 +01:00
Teemu R
f75e2cd9b7
Add LB230
Works according to https://github.com/home-assistant/home-assistant.io/pull/8090
2019-01-22 13:23:27 +01:00
Teemu R
5a1300e3c9
add KL series of bulbs
works according to https://github.com/home-assistant/home-assistant.io/pull/8134
2019-01-22 13:19:04 +01:00
Teemu R
c4bb48979f
Prepare 0.3.4 (#154) 2019-01-17 11:39:51 +01:00
Annika Jacobs
4cb28a3b25 Updated valid range to 360 (with passing tests) (#153)
* Updated valid range to 360

with it set to 359 it will not show the color red. Just tested this with a buddies bulb - same model/fw
https://imgur.com/a/kSNZIuL

* Updated valid range to 360

with it set to 359 it will not show the color red. Just tested this with a buddies bulb - same model/fw
https://imgur.com/a/kSNZIuL

* Update valid range to 360

* Fix tests
2019-01-16 21:50:48 +01:00
jimboca
6115d96c39 Add support for HS300 power strip (#137)
* discover runs, prints on since of device 0

* added preliminary support for HS300

* forgot to add smartdevice to commit

* added index to CLI

* clean up dirty code

* added fake sysinfo_hs300

* changed device alias to match MAC

* #131 Move _id_to_index into smartstrip so everyone can pass index

* Update pyHS100/discover.py

Co-Authored-By: jimboca <jimboca3@gmail.com>

* refactoring to deduplicate code between smarplug and smartstrip

* fixing CI failures for devices without children

* incorporating feedback from pull request.

* fixing hound violation

* changed internal store from list of dicts to dict

* changed other methods to dictionary store as well

* removed unused optional type from imports

* changed plugs to Dict, remove redundant sys_info calls

* added more functionality for smart strip, added smart strip tests

* updated FakeTransportProtocol for devices with children

* corrected hound violations

* add click-datetime
2019-01-08 20:13:25 +01:00
Teemu R
ae53e8de1e
Add HS103
HS103 works according to https://www.reddit.com/r/homeassistant/comments/ad7oqk/tplink_hs103_not_on_list/edewohh/
2019-01-08 19:28:16 +01:00
Kevron Rees
8034c47b89 avoid 'referenced before assignment' exception (#150) 2019-01-07 22:28:05 +01:00
Annika Jacobs
29c91151e3 cli: show an error for incorrect hsv values (#142)
* cli: fix hsv get

Raising an exception if an incomplete HSV colour is provided.

* cli hsv: clarify error message

* cli hsv: clarify error message (again)
2018-11-23 22:39:58 +01:00
Scott Albertson
823612b32c Add a "Reviewed by Hound" badge (#139) 2018-11-16 23:18:48 +01:00
Annika Jacobs
c65d4c0b30 Change valid hue range to 0-359 (fixes #130), update README.md & test (#140)
* Change valid hue range to 0-359 (fixes #130)

Tested on LB130(EU) hardware 1.0, firmware 1.8.6 Build 180809 Rel.091659

Co-Authored-By: nkonopinski <nkonopinski@users.noreply.github.com>

* Update README.md

* Update test_bulb.py
2018-11-16 23:18:28 +01:00