mirror of
https://github.com/python-kasa/python-kasa.git
synced 2024-12-22 19:23:34 +00:00
add a small example script to show library usage (#90)
* add a small example script to show library usage * asyncio.run++
This commit is contained in:
parent
d30d00a3ff
commit
6844166c0d
@ -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.
|
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
|
.. autoclass:: kasa.SmartDevice
|
||||||
:members:
|
:members:
|
||||||
|
@ -128,6 +128,7 @@ class SmartDevice:
|
|||||||
* :class:`SmartBulb`
|
* :class:`SmartBulb`
|
||||||
* :class:`SmartStrip`
|
* :class:`SmartStrip`
|
||||||
* :class:`SmartDimmer`
|
* :class:`SmartDimmer`
|
||||||
|
* :class:`SmartLightStrip`
|
||||||
|
|
||||||
To initialize, you have to await :func:`update()` at least once.
|
To initialize, you have to await :func:`update()` at least once.
|
||||||
This will allow accessing the properties using the exposed properties.
|
This will allow accessing the properties using the exposed properties.
|
||||||
|
Loading…
Reference in New Issue
Block a user