import homeassistant.loader as loader
# The domain of your component. Should be equal to the name of your component.
-DOMAIN = "hello_mqtt"
+DOMAIN = 'hello_mqtt'
# List of component names (string) your component depends upon.
DEPENDENCIES = ['mqtt']
@@ -85,14 +85,14 @@ This example requires you to have the MQTT component
def setup(hass, config):
- """Setup the Hello MQTT component."""
+ """Set up the Hello MQTT component."""
mqtt = loader.get_component('mqtt')
topic = config[DOMAIN].get('topic', DEFAULT_TOPIC)
entity_id = 'hello_mqtt.last_message'
# Listener to be called when we receive a message.
def message_received(topic, payload, qos):
- """A new MQTT message has been received."""
+ """Handle new MQTT messages."""
hass.states.set(entity_id, payload)
# Subscribe our listener to a topic.
diff --git a/cookbook/python_component_simple_alarm/index.html b/cookbook/python_component_simple_alarm/index.html
index 791936fc2e..9f3ccaf55f 100644
--- a/cookbook/python_component_simple_alarm/index.html
+++ b/cookbook/python_component_simple_alarm/index.html
@@ -89,35 +89,35 @@
from homeassistant.helpers.event import track_state_change
from homeassistant.const import STATE_ON, STATE_OFF, STATE_HOME, STATE_NOT_HOME
-DOMAIN = "simple_alarm"
+_LOGGER = logging.getLogger(__name__)
+
+DOMAIN = 'simple_alarm"'
DEPENDENCIES = ['group', 'device_tracker', 'light']
# Attribute to tell which light has to flash when a known person comes home
# If omitted will flash all.
-CONF_KNOWN_LIGHT = "known_light"
+CONF_KNOWN_LIGHT = 'known_light'
# Attribute to tell which light has to flash when an unknown person comes home
# If omitted will flash all.
-CONF_UNKNOWN_LIGHT = "unknown_light"
+CONF_UNKNOWN_LIGHT = 'unknown_light'
# Services to test the alarms
-SERVICE_TEST_KNOWN_ALARM = "test_known"
-SERVICE_TEST_UNKNOWN_ALARM = "test_unknown"
+SERVICE_TEST_KNOWN_ALARM = 'test_known'
+SERVICE_TEST_UNKNOWN_ALARM = 'test_unknown'
def setup(hass, config):
- """ Sets up the simple alarms. """
- logger = logging.getLogger(__name__)
-
+ """Set up the simple alarms."""
light_ids = []
for conf_key in (CONF_KNOWN_LIGHT, CONF_UNKNOWN_LIGHT):
light_id = config[DOMAIN].get(conf_key, light.ENTITY_ID_ALL_LIGHTS)
if hass.states.get(light_id) is None:
- logger.error(
- 'Light id %s could not be found in state machine', light_id)
+ _LOGGER.error(
+ "Light id %s could not be found in state machine", light_id)
return False
@@ -127,7 +127,7 @@
known_light_id, unknown_light_id = light_ids
if hass.states.get(device_tracker.ENTITY_ID_ALL_DEVICES) is None:
- logger.error('No devices are being tracked, cannot setup alarm')
+ _LOGGER.error("No devices are being tracked, cannot setup alarm")
return False
@@ -152,7 +152,7 @@
DOMAIN, SERVICE_TEST_UNKNOWN_ALARM, lambda call: unknown_alarm())
def unknown_alarm_if_lights_on(entity_id, old_state, new_state):
- """ Called when a light has been turned on. """
+ """Called when a light has been turned on."""
if not device_tracker.is_on(hass):
unknown_alarm()
@@ -161,7 +161,7 @@
unknown_alarm_if_lights_on, STATE_OFF, STATE_ON)
def ring_known_alarm(entity_id, old_state, new_state):
- """ Called when a known person comes home. """
+ """Called when a known person comes home."""
if light.is_on(hass, known_light_id):
known_alarm()
diff --git a/developers/platform_example_light/index.html b/developers/platform_example_light/index.html
index 0b0401e274..4e438b178f 100644
--- a/developers/platform_example_light/index.html
+++ b/developers/platform_example_light/index.html
@@ -114,13 +114,14 @@
# Verify that passed in configuration works
if not hub.is_valid_login():
- _LOGGER.error('Could not connect to AwesomeLight hub')
+ _LOGGER.error("Could not connect to AwesomeLight hub")
return False
# Add devices
add_devices(AwesomeLight(light) for light in hub.lights())
+
class AwesomeLight(Light):
"""Representation of an Awesome Light."""
@@ -138,7 +139,7 @@
@property
def brightness(self):
- """Brightness of the light (an integer in the range 1-255).
+ """Return the brightness of the light.
This method is optional. Removing it indicates to Home Assistant
that brightness is not supported for this light.
diff --git a/developers/platform_example_sensor/index.html b/developers/platform_example_sensor/index.html
index 6d87e98825..22804ca3f9 100644
--- a/developers/platform_example_sensor/index.html
+++ b/developers/platform_example_sensor/index.html
@@ -69,7 +69,7 @@
This is a minimum implementation of a platform for the sensor component.
Installation
Copy the code below and create it as a file in <config_dir>/custom_components/sensor/example.py.
-Add the following to your configuration.yaml:
+Add the following to your configuration.yaml file:
# Example configuration.yaml entry
sensor:
platform: example
diff --git a/sitemap.xml b/sitemap.xml
index 8a16e0b692..17f9d9c0f3 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -3216,62 +3216,62 @@
https://home-assistant.io/demo/frontend.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/index.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-event.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-info.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-service.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-state.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/panels/ha-panel-dev-template.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/panels/ha-panel-history.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/panels/ha-panel-iframe.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/panels/ha-panel-logbook.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/demo/panels/ha-panel-map.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/googlef4f3693c209fe788.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/static/fonts/roboto/DESCRIPTION.en_us.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/static/fonts/robotomono/DESCRIPTION.en_us.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00
https://home-assistant.io/static/mdi-demo.html
-2017-04-30T19:59:15+00:00
+2017-04-30T21:16:38+00:00