Skip to content

add a small example script to show library usage #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rytilahti merged 2 commits into from
Jul 20, 2020
Merged

add a small example script to show library usage #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f29fd33
add a small example script to show library usage
rytilahti Jul 19, 2020
a66a883
asyncio.run++
rytilahti Jul 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/source/smartdevice.rst
View file
Open in desktop
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
View file
Open in desktop
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