jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-16 17:57:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docstrings

Browse Source
This commit is contained in:
Fabian Affolter 2015-10-08 10:23:19 +02:00
parent c1899609a4
commit bf9b179441
1 changed files with 14 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
homeassistant/components/light/blinksticklight.py
View File

@ -1,34 +1,36 @@
""" """
homeassistant.components.light.blinksticklight homeassistant.components.light.blinksticklight
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Support for Blinkstick lights. Support for Blinkstick lights.
For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/light.blinksticklight.html
""" """
import logging
from blinkstick import blinkstick from blinkstick import blinkstick
import logging
from homeassistant.components.light import (Light, ATTR_RGB_COLOR)
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
from homeassistant.components.light import (Light, ATTR_RGB_COLOR)
REQUIREMENTS = ["blinkstick==1.1.7"] REQUIREMENTS = ["blinkstick==1.1.7"]
DEPENDENCIES = [] DEPENDENCIES = []
# pylint: disable=unused-argument # pylint: disable=unused-argument
def setup_platform(hass, config, add_devices_callback, discovery_info=None): def setup_platform(hass, config, add_devices_callback, discovery_info=None):
""" Add device specified by serial number """ """ Add device specified by serial number. """
stick = blinkstick.find_by_serial(config['serial']) stick = blinkstick.find_by_serial(config['serial'])
add_devices_callback([BlinkStickLight(stick, config['name'])]) add_devices_callback([BlinkStickLight(stick, config['name'])])
class BlinkStickLight(Light): class BlinkStickLight(Light):
""" Represents a BlinkStick light """ """ Represents a BlinkStick light. """
def __init__(self, stick, name): def __init__(self, stick, name):
""" Initialise """
self._stick = stick self._stick = stick
self._name = name self._name = name
self._serial = stick.get_serial() self._serial = stick.get_serial()
@ -36,20 +38,22 @@ class BlinkStickLight(Light):
@property @property
def should_poll(self): def should_poll(self):
""" Polling needed. """
return True return True
@property @property
def name(self): def name(self):
""" The name of the light. """
return self._name return self._name
@property @property
def rgb_color(self): def rgb_color(self):
""" Read back the color of the light """ """ Read back the color of the light. """
return self._rgb_color return self._rgb_color
@property @property
def is_on(self): def is_on(self):
""" Check whether any of the LEDs colors are non-zero """ """ Check whether any of the LEDs colors are non-zero. """
return sum(self._rgb_color) > 0 return sum(self._rgb_color) > 0
def update(self): def update(self):