jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-15 13:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve the example light platform code. (#453)

Browse Source 
The code was incomplete and invalid. This PR extends the example
code with turn_on/turn_off, brightness control and a display name.

This is the piece of code I was looking for when I experimented
with adding a platform.
This commit is contained in:
Bas Stottelaar 2016-05-08 12:25:40 +02:00 committed by Fabian Affolter
parent 32dfc55b68
commit ccd3af3876
1 changed files with 29 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
source/developers/platform_example_light.markdown
View File

@ -15,7 +15,7 @@ This example is for adding support for the imaginary Awesome Lights. It shows th
import logging import logging
# Import the device class from the component that you want to support # Import the device class from the component that you want to support
from homeassistant.components.light import Light from homeassistant.components.light import ATTR_BRIGHTNESS, Light
from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
# Home Assistant depends on 3rd party packages for API specific code. # Home Assistant depends on 3rd party packages for API specific code.
@ -24,7 +24,7 @@ REQUIREMENTS = ['awesome_lights==1.2.3']
_LOGGER = logging.getLogger(__name__) _LOGGER = logging.getLogger(__name__)
setup_platform(hass, config, add_devices, discovery_info=None): def setup_platform(hass, config, add_devices, discovery_info=None):
"""Initialize Awesome Light platform.""" """Initialize Awesome Light platform."""
import awesomelights import awesomelights
@ -56,22 +56,42 @@ class AwesomeLight(Light):
"""Initialize an AwesomeLight.""" """Initialize an AwesomeLight."""
self._light = light self._light = light
def update(self): @property
"""Fetch new state data for this light. def name(self):
"""Return the display name of this light"""
This is the only method that should fetch new data for Home Assitant. return self._light.name
"""
self._light.update()
@property
def brightness(self): def brightness(self):
"""Brightness of the light. """Brightness of the light (an integer in the range 1-255).
This method is optional. Removing it indicates to Home Assistant This method is optional. Removing it indicates to Home Assistant
that brightness is not supported for this light. that brightness is not supported for this light.
""" """
return self._light.brightness return self._light.brightness
@property
def is_on(self): def is_on(self):
"""If light is on.""" """If light is on."""
return self._light.is_on() return self._light.is_on()
def turn_on(self, kwargs):
"""Instruct the light to turn on.
You can skip the brightness part if your light does not support
brightness control.
"""
self._light.brightness = kwargs.get(ATTR_BRIGHTNESS, 255)
self._light.turn_on()
def turn_off(self, kwargs):
"""Instruct the light to turn off."""
self._light.turn_off()
def update(self):
"""Fetch new state data for this light.
This is the only method that should fetch new data for Home Assitant.
"""
self._light.update()
``` ```