mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-23 11:43:34 +00:00
3490a1ef84
Add a tutorial module with examples that can be tested with `doctest`. In order to simplify the examples they can be run with doctest allowing top level await statements by adding a fixture to patch the builtins that xdoctest uses to test code. --------- Co-authored-by: Teemu R. <tpr@iki.fi>
80 lines
1.8 KiB
ReStructuredText
80 lines
1.8 KiB
ReStructuredText
Bulbs
|
|
===========
|
|
|
|
.. contents:: Contents
|
|
:local:
|
|
|
|
Supported features
|
|
******************
|
|
|
|
* Turning on and off
|
|
* Setting brightness, color temperature, and color (in HSV)
|
|
* Querying emeter information
|
|
* Transitions
|
|
* Presets
|
|
|
|
Currently unsupported
|
|
*********************
|
|
|
|
* Setting the default transitions
|
|
* Timers
|
|
|
|
.. note::
|
|
|
|
Feel free to open a pull request to add support for more features!
|
|
|
|
Transitions
|
|
***********
|
|
|
|
All commands changing the bulb state can be accompanied with a transition, e.g., to slowly fade the light off.
|
|
The transition time is in milliseconds, 0 means immediate change.
|
|
If no transition value is given, the default setting as configured for the bulb will be used.
|
|
|
|
.. note::
|
|
|
|
Accepted values are command (and potentially bulb) specific, feel free to improve the documentation on accepted values.
|
|
|
|
**Example:** While KL130 allows at least up to 15 second transitions for smooth turning off transitions, turning it on will not be so smooth.
|
|
|
|
Command-line usage
|
|
******************
|
|
|
|
All command-line commands can be used with transition period for smooth changes.
|
|
|
|
|
|
**Example:** Turn the bulb off over a 15 second time period.
|
|
|
|
.. code::
|
|
|
|
$ kasa --type bulb --host <host> off --transition 15000
|
|
|
|
**Example:** Change the bulb to red with 20% brightness over 15 seconds:
|
|
|
|
.. code::
|
|
|
|
$ kasa --type bulb --host <host> hsv 0 100 20 --transition 15000
|
|
|
|
|
|
API documentation
|
|
*****************
|
|
|
|
.. autoclass:: kasa.SmartBulb
|
|
:members:
|
|
:inherited-members:
|
|
:undoc-members:
|
|
|
|
.. autoclass:: kasa.SmartBulbPreset
|
|
:members:
|
|
:undoc-members:
|
|
|
|
.. autoclass:: kasa.iot.iotbulb.BehaviorMode
|
|
:members:
|
|
|
|
.. autoclass:: kasa.iot.iotbulb.TurnOnBehaviors
|
|
:members:
|
|
|
|
|
|
.. autoclass:: kasa.iot.iotbulb.TurnOnBehavior
|
|
:undoc-members:
|
|
:members:
|