Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2025-11-15 14:48:43 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

improve doc-strings

Browse Source
This commit is contained in:
Bas Nijholt
2019-11-15 16:05:46 +01:00
parent a7cb2cebed
commit 2976c453ac
4 changed files with 40 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
pyHS100/smartplug.py
View File

@@ -12,15 +12,22 @@ _LOGGER = logging.getLogger(__name__)
class SmartPlug(SmartDevice):
"""Representation of a TP-Link Smart Switch.
Usage example when used as library:
Usage example when used a a synchronous library:
```python
p = SmartPlug("192.168.1.105")
# print the devices alias
print(p.alias)
print(p.sync.get_alias())
# change state of plug
p.turn_on()
p.turn_off()
p.sync.turn_on()
p.sync.turn_off()
# query and print current state of plug
print(p.state)
print(p.sync.get_state_information())
```
Omit the `sync` attribute to get coroutines.
Errors reported by the device are raised as SmartDeviceExceptions,
and should be handled by the user of the library.