Mirrored_Repos/python-kasa
1
0
Fork 0
mirror of https://github.com/python-kasa/python-kasa.git synced 2024-12-22 19:23:34 +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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
pyHS100/smartbulb.py
View File

@ -20,39 +20,47 @@ class SmartBulb(SmartDevice):
"""Representation of a TP-Link Smart Bulb.
Usage example when used as library:
```python
p = SmartBulb("192.168.1.105")
# print the devices alias
print(p.alias)
print(p.sync.get_alias())
# change state of bulb
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())
# check whether the bulb supports color changes
if p.is_color:
if p.sync.is_color():
# set the color to an HSV tuple
p.set_hsv(180, 100, 100)
p.sync.set_hsv(180, 100, 100)
# get the current HSV value
print(p.hsv)
print(p.sync.get_hsv())
# check whether the bulb supports setting color temperature
if p.is_variable_color_temp:
# set the color temperature in Kelvin
p.set_color_temp(3000)
# get the current color temperature
print(p.color_temp)
if p.sync.is_variable_color_temp():
# set the color temperature in Kelvin
p.sync.set_color_temp(3000)
# get the current color temperature
print(p.sync.get_color_temp())
# check whether the bulb is dimmable
if p.is_dimmable:
if p.sync.is_dimmable():
# set the bulb to 50% brightness
p.set_brightness(50)
p.sync.set_brightness(50)
# check the current brightness
print(p.brightness)
print(p.sync.get_brightness())
```
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.

3
pyHS100/smartdevice.py
View File

@ -571,8 +571,7 @@ class SmartDevice:
"""Return True if the device is dimmable."""
return False
@property
def is_variable_color_temp(self) -> bool:
async def is_variable_color_temp(self) -> bool:
"""Return True if the device supports color temperature."""
return False

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.

4
pyHS100/smartstrip.py
View File

@ -18,6 +18,7 @@ class SmartStrip(SmartPlug):
"""Representation of a TP-Link Smart Power Strip.
Usage example when used as library:
```python
p = SmartStrip("192.168.1.105")
# query the state of the strip
@ -33,6 +34,9 @@ class SmartStrip(SmartPlug):
# change state of a single outlet
p.plugs[0].sync.turn_on()
```
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.