Skip to content

Commit

Permalink
add a small example script to show library usage (#90)
Browse files Browse the repository at this point in the history
* add a small example script to show library usage

* asyncio.run++
  • Loading branch information
rytilahti committed Jul 20, 2020
1 parent d30d00a commit 6844166
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
27 changes: 27 additions & 0 deletions docs/source/smartdevice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,33 @@ These methods will return the device response, which can be useful for some use

Errors are raised as :class:`SmartDeviceException` instances for the library user to handle.

Simple example script showing some functionality:

.. code-block:: python
import asyncio
from kasa import SmartPlug
async def main():
p = SmartPlug("127.0.0.1")
await p.update()
print(p.alias)
await p.turn_off()
if __name__ == "__main__":
asyncio.run(main())
Refer to device type specific classes for more examples:

* :class:`SmartPlug`
* :class:`SmartBulb`
* :class:`SmartStrip`
* :class:`SmartDimmer`
* :class:`SmartLightStrip`

.. autoclass:: kasa.SmartDevice
:members:
Expand Down
1 change: 1 addition & 0 deletions kasa/smartdevice.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,7 @@ class SmartDevice:
* :class:`SmartBulb`
* :class:`SmartStrip`
* :class:`SmartDimmer`
* :class:`SmartLightStrip`
To initialize, you have to await :func:`update()` at least once.
This will allow accessing the properties using the exposed properties.
Expand Down

0 comments on commit 6844166

Please sign in to comment.