* 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
* 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
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"}}}
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.
* 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
* 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
* 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
* Fix bug that changed brightness at each hsv update
The HSV setter should accept a percentage for the brightness
value but actually assumed the brightness to be in absolute values
between 1 and 255.
This resulted in brightness reductions at each HSV update, in
steps of 100% -> 100/255=39% -> 39/255=15% -> ... (see also
https://github.com/home-assistant/home-assistant/issues/15582,
where I originally reported this bug).
* Modify HSV property to return brightness in percent
Switch from reported brightness values of 1..255 to percentage
values, for consistency with the apidoc and 8761dd8.
* Add checks and tests for the hsv setter
- make sure that new (hue, saturation, brightness) values are
within their valid ranges (0..255, 0..100, 0..100) and raise
SmartDeviceException if they are not
- add test function for the hsv setter
* Added option to control devices by device name
* set unused ip address to dont-care
* spend less time discovering by devicename, removed command
* consistent use of alias instead of device name
* processed review comments
* Return when no device with alias has been found
* add 'alias' command for querying and setting the alias
* calculate coverage only on library files, e.g., ignoring cli and test files
* remove py34 and add py37
* readd py33, remove it from travis as it seems to be a travis limitation only
* use xenial dist for travis, regular does not support py37..
* Add support for new-style emeter
This commit adds a straightforward dict-extending container,
which converts between the old and new keys of the get_emeter_realtime()
Furthermore the unit tests are converted to base on HS100
instead of HS110.
This is the first step to fix#103, other emeter-using functionality
has not yet been converted, only getting the current consumption.
* fix a couple of linting issues
* Convert new-style emeter values also for get_emeter_daily() and get_emeter_monthly()
* Adds a new 'kwh' parameter for those calls, which defaults to True
* This changes the behavior of bulbs emeter reporting, use False if you prefer the preciser values
* Update smartplug.py to support dimming in HS220
Switch functions essentially as a "plug" with the addition to support for dimming, for which can be test for by verifying existence of 'brightness' array value.
* Attempt at updates to pass validator
* Maybe this time? :-)
* Add more detail to comment blocks
Make clear in requests for current brightness level the expected return values, and note that light will turn on when setting a brightness level, if not already on. This makes clear that a state change request (turn_on) does NOT have to be made first when setting brightness.
* Update smartplug.py
* Update smartplug.py
Fixes#114
* move has_emeter implementation from SmartDevice to SmartPlug, avoid using features() internally
* add stacklevel to deprecation warnings to see where they are really called
* make tests pass on a real device. if PLUG_IP is not None, the tests will be run on a device at the defined IP address
