Merge pull request #1807 from balloob/release-0.17.3

0.17.3

.coveragerc

@@ -6,21 +6,33 @@ omit =
 
     # omit pieces of code that rely on external devices being present
     homeassistant/components/alarm_control_panel/alarmdotcom.py
+    homeassistant/components/alarm_control_panel/nx584.py
 
     homeassistant/components/arduino.py
     homeassistant/components/*/arduino.py
 
+    homeassistant/components/apcupsd.py
+    homeassistant/components/*/apcupsd.py
+
+    homeassistant/components/bloomsky.py
+    homeassistant/components/*/bloomsky.py
+
+    homeassistant/components/insteon_hub.py
+    homeassistant/components/*/insteon_hub.py
+
     homeassistant/components/isy994.py
     homeassistant/components/*/isy994.py
 
     homeassistant/components/modbus.py
     homeassistant/components/*/modbus.py
 
+    homeassistant/components/tellstick.py
     homeassistant/components/*/tellstick.py
 
     homeassistant/components/tellduslive.py
     homeassistant/components/*/tellduslive.py
 
+    homeassistant/components/vera.py
     homeassistant/components/*/vera.py
 
     homeassistant/components/ecobee.py
@@ -29,25 +41,38 @@ omit =
     homeassistant/components/verisure.py
     homeassistant/components/*/verisure.py
 
+    homeassistant/components/wemo.py
+    homeassistant/components/*/wemo.py
+
     homeassistant/components/wink.py
     homeassistant/components/*/wink.py
 
+    homeassistant/components/zigbee.py
+    homeassistant/components/*/zigbee.py
+
     homeassistant/components/zwave.py
     homeassistant/components/*/zwave.py
 
-    homeassistant/components/rfxtrx.py
-    homeassistant/components/*/rfxtrx.py
-
     homeassistant/components/mysensors.py
     homeassistant/components/*/mysensors.py
 
+    homeassistant/components/nest.py
+    homeassistant/components/*/nest.py
+
     homeassistant/components/rpi_gpio.py
     homeassistant/components/*/rpi_gpio.py
 
+    homeassistant/components/scsgate.py
+    homeassistant/components/*/scsgate.py
+
     homeassistant/components/binary_sensor/arest.py
     homeassistant/components/binary_sensor/rest.py
     homeassistant/components/browser.py
-    homeassistant/components/camera/*
+    homeassistant/components/camera/bloomsky.py
+    homeassistant/components/camera/foscam.py
+    homeassistant/components/camera/generic.py
+    homeassistant/components/camera/mjpeg.py
+    homeassistant/components/camera/rpi_camera.py
     homeassistant/components/device_tracker/actiontec.py
     homeassistant/components/device_tracker/aruba.py
     homeassistant/components/device_tracker/asuswrt.py
@@ -57,7 +82,6 @@ omit =
     homeassistant/components/device_tracker/luci.py
     homeassistant/components/device_tracker/netgear.py
     homeassistant/components/device_tracker/nmap_tracker.py
-    homeassistant/components/device_tracker/owntracks.py
     homeassistant/components/device_tracker/snmp.py
     homeassistant/components/device_tracker/thomson.py
     homeassistant/components/device_tracker/tomato.py
@@ -65,12 +89,13 @@ omit =
     homeassistant/components/device_tracker/ubus.py
     homeassistant/components/discovery.py
     homeassistant/components/downloader.py
+    homeassistant/components/garage_door/wink.py
     homeassistant/components/ifttt.py
-    homeassistant/components/influxdb.py
     homeassistant/components/keyboard.py
     homeassistant/components/light/blinksticklight.py
     homeassistant/components/light/hue.py
     homeassistant/components/light/hyperion.py
+    homeassistant/components/light/lifx.py
     homeassistant/components/light/limitlessled.py
     homeassistant/components/media_player/cast.py
     homeassistant/components/media_player/denon.py
@@ -79,32 +104,52 @@ omit =
     homeassistant/components/media_player/kodi.py
     homeassistant/components/media_player/mpd.py
     homeassistant/components/media_player/plex.py
+    homeassistant/components/media_player/samsungtv.py
+    homeassistant/components/media_player/snapcast.py
     homeassistant/components/media_player/sonos.py
     homeassistant/components/media_player/squeezebox.py
+    homeassistant/components/media_player/onkyo.py
+    homeassistant/components/media_player/panasonic_viera.py
+    homeassistant/components/media_player/yamaha.py
     homeassistant/components/notify/free_mobile.py
+    homeassistant/components/notify/googlevoice.py
+    homeassistant/components/notify/gntp.py
     homeassistant/components/notify/instapush.py
+    homeassistant/components/notify/message_bird.py
     homeassistant/components/notify/nma.py
     homeassistant/components/notify/pushbullet.py
     homeassistant/components/notify/pushetta.py
     homeassistant/components/notify/pushover.py
+    homeassistant/components/notify/rest.py
+    homeassistant/components/notify/sendgrid.py
     homeassistant/components/notify/slack.py
     homeassistant/components/notify/smtp.py
     homeassistant/components/notify/syslog.py
     homeassistant/components/notify/telegram.py
+    homeassistant/components/notify/twitter.py
     homeassistant/components/notify/xmpp.py
+    homeassistant/components/scene/hunterdouglas_powerview.py
     homeassistant/components/sensor/arest.py
     homeassistant/components/sensor/bitcoin.py
     homeassistant/components/sensor/cpuspeed.py
+    homeassistant/components/sensor/deutsche_bahn.py
     homeassistant/components/sensor/dht.py
     homeassistant/components/sensor/dweet.py
     homeassistant/components/sensor/efergy.py
     homeassistant/components/sensor/eliqonline.py
     homeassistant/components/sensor/forecast.py
     homeassistant/components/sensor/glances.py
+    homeassistant/components/sensor/gtfs.py
     homeassistant/components/sensor/netatmo.py
+    homeassistant/components/sensor/nzbget.py
+    homeassistant/components/sensor/loopenergy.py
+    homeassistant/components/sensor/neurio_energy.py
+    homeassistant/components/sensor/onewire.py
     homeassistant/components/sensor/openweathermap.py
     homeassistant/components/sensor/rest.py
     homeassistant/components/sensor/sabnzbd.py
+    homeassistant/components/sensor/speedtest.py
+    homeassistant/components/sensor/steam_online.py
     homeassistant/components/sensor/swiss_public_transport.py
     homeassistant/components/sensor/systemmonitor.py
     homeassistant/components/sensor/temper.py
@@ -112,19 +157,20 @@ omit =
     homeassistant/components/sensor/torque.py
     homeassistant/components/sensor/transmission.py
     homeassistant/components/sensor/twitch.py
+    homeassistant/components/sensor/uber.py
     homeassistant/components/sensor/worldclock.py
     homeassistant/components/switch/arest.py
+    homeassistant/components/switch/dlink.py
     homeassistant/components/switch/edimax.py
     homeassistant/components/switch/hikvisioncam.py
     homeassistant/components/switch/mystrom.py
     homeassistant/components/switch/orvibo.py
+    homeassistant/components/switch/pulseaudio_loopback.py
     homeassistant/components/switch/rest.py
     homeassistant/components/switch/transmission.py
-    homeassistant/components/switch/wemo.py
+    homeassistant/components/switch/wake_on_lan.py
     homeassistant/components/thermostat/heatmiser.py
     homeassistant/components/thermostat/homematic.py
-    homeassistant/components/thermostat/honeywell.py
-    homeassistant/components/thermostat/nest.py
     homeassistant/components/thermostat/proliphix.py
     homeassistant/components/thermostat/radiotherm.py
 

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,33 @@
+Feature requests should go in the forum: https://community.home-assistant.io/c/feature-requests
+
+**Home Assistant release (`hass --version`):**
+
+
+**Python release (`python3 --version`):**
+
+
+**Component/platform:**
+
+
+**Description of problem:**
+
+
+**Expected:**
+
+
+**Problem-relevant `configuration.yaml` entries and steps to reproduce:**
+```yaml
+
+```
+
+1. 
+2. 
+3. 
+
+**Traceback (if applicable):**
+```bash
+
+```
+
+**Additional info:**
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+**Description:**
+
+
+**Related issue (if applicable):** #
+
+**Example entry for `configuration.yaml` (if applicable):**
+```yaml
+
+```
+
+**Checklist:**
+
+If code communicates with devices:
+  - [ ] Local tests with `tox` run successfully. **Your PR cannot be merged unless tests pass**
+  - [ ] New dependencies have been added to the `REQUIREMENTS` variable ([example][ex-requir]).
+  - [ ] New dependencies are only imported inside functions that use them ([example][ex-import]).
+  - [ ] New dependencies have been added to `requirements_all.txt` by running `script/gen_requirements_all.py`.
+  - [ ] New files were added to `.coveragerc`.
+
+If the code does not interact with devices:
+  - [ ] Local tests with `tox` run successfully. **Your PR cannot be merged unless tests pass**
+  - [ ] Tests have been added to verify that the new code works.
+
+[fork]: http://stackoverflow.com/a/7244456
+[squash]: https://github.com/ginatrapani/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit
+[ex-requir]: https://github.com/balloob/home-assistant/blob/dev/homeassistant/components/keyboard.py#L16
+[ex-import]: https://github.com/balloob/home-assistant/blob/dev/homeassistant/components/keyboard.py#L51
+

.gitignore

@@ -1,6 +1,5 @@
 config/*
 !config/home-assistant.conf.default
-homeassistant/components/frontend/www_static/polymer/bower_components/*
 
 # There is not a better solution afaik..
 !config/custom_components
@@ -69,6 +68,16 @@ nosetests.xml
 
 .python-version
 
+# emacs auto backups
+*~
+*#
+*.orig
+
 # venv stuff
 pyvenv.cfg
 pip-selfcheck.json
+venv
+
+# vimmy stuff
+*.swp
+*.swo

.travis.yml

@@ -1,15 +1,19 @@
 sudo: false
-language: python
+matrix:
+  fast_finish: true
+  include:
+    - python: "3.4"
+      env: TOXENV=py34
+    - python: "3.4"
+      env: TOXENV=requirements
+    - python: "3.5"
+      env: TOXENV=lint
+    - python: "3.5"
+      env: TOXENV=py35
 cache:
   directories:
     - $HOME/.cache/pip
-    # - "$HOME/virtualenv/python$TRAVIS_PYTHON_VERSION"
-python:
-  - 3.4
-  - 3.5
-install:
-  - "true"
-script:
-  - script/cibuild
-matrix:
-  fast_finish: true
+install: pip install -U tox coveralls
+language: python
+script: tox
+after_success: coveralls

CONTRIBUTING.md

@@ -6,7 +6,7 @@ The process is straight-forward.
 
  - Fork the Home Assistant [git repository](https://github.com/balloob/home-assistant).
  - Write the code for your device, notification service, sensor, or IoT thing.
- - Check it with ``pylint`` and ``flake8``.
+ - Ensure tests work.
  - Create a Pull Request against the [**dev**](https://github.com/balloob/home-assistant/tree/dev) branch of Home Assistant.
 
 Still interested? Then you should read the next sections and get more details. 
@@ -17,12 +17,13 @@ For help on building your component, please see the [developer documentation](ht
 
 After you finish adding support for your device:
 
+ - Check that all dependencies are included via the `REQUIREMENTS` variable in your platform/component and only imported inside functions that use them.
  - Add any new dependencies to `requirements_all.txt` if needed. Use `script/gen_requirements_all.py`.
- - Update the `.coveragerc` file to exclude your platform if there are no tests available.
+ - Update the `.coveragerc` file to exclude your platform if there are no tests available or your new code uses a 3rd party library for communication with the device/service/sensor.
  - Provide some documentation for [home-assistant.io](https://home-assistant.io/). It's OK to just add a docstring with configuration details (sample entry for `configuration.yaml` file and alike) to the file header as a start. Visit the [website documentation](https://home-assistant.io/developers/website/) for further information on contributing to [home-assistant.io](https://github.com/balloob/home-assistant.io).
- - Make sure all your code passes ``pylint`` and ``flake8`` (PEP8 and some more) validation. To check your repository, run `./script/lint`.
+ - Make sure all your code passes ``pylint`` and ``flake8`` (PEP8 and some more) validation. To check your repository, run `tox` or `script/lint`.
  - Create a Pull Request against the [**dev**](https://github.com/balloob/home-assistant/tree/dev) branch of Home Assistant.
- - Check for comments and suggestions on your Pull Request and keep an eye on the [Travis output](https://travis-ci.org/balloob/home-assistant/).
+ - Check for comments and suggestions on your Pull Request and keep an eye on the [CI output](https://travis-ci.org/balloob/home-assistant/).
 
 If you add a platform for an existing component, there is usually no need for updating the frontend. Only if you've added a new component that should show up in the frontend, there are more steps needed:
 
@@ -66,6 +67,21 @@ The frontend is composed of [Polymer](https://www.polymer-project.org) web-compo
 
 When you are done with development and ready to commit your changes, run `build_frontend`, set `development=0` in your config and validate that everything still works.
 
+## Testing your code
+
+To test your code before submission, used the `tox` tool.
+
+```bash
+> pip install -U tox
+> tox
+```
+
+This will run unit tests against python 3.4 and 3.5 (if both are available locally), as well as run a set of tests which validate `pep8` and `pylint` style of the code.
+
+You can optionally run tests on only one tox target using the `-e` option to select an environment.
+
+For instance `tox -e lint` will run the linters only, `tox -e py34` will run unit tests only on python 3.4.
+
 ### Notes on PyLint and PEP8 validation
 
 In case a PyLint warning cannot be avoided, add a comment to disable the PyLint check for that line. This can be done using the format `# pylint: disable=YOUR-ERROR-NAME`. Example of an unavoidable PyLint warning is if you do not use the passed in datetime if you're listening for time change.

Dockerfile

@@ -6,17 +6,17 @@ VOLUME /config
 RUN mkdir -p /usr/src/app
 WORKDIR /usr/src/app
 
+RUN pip3 install --no-cache-dir colorlog cython
+
 # For the nmap tracker
 RUN apt-get update && \
-    apt-get install -y --no-install-recommends nmap net-tools && \
+    apt-get install -y --no-install-recommends nmap net-tools cython3 libudev-dev sudo && \
     apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
 COPY script/build_python_openzwave script/build_python_openzwave
-RUN apt-get update && \
-   apt-get install -y cython3 libudev-dev && \
-   apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* && \
-   pip3 install "cython<0.23" && \
-   script/build_python_openzwave
+RUN script/build_python_openzwave && \
+  mkdir -p /usr/local/share/python-openzwave && \
+  ln -sf /usr/src/app/build/python-openzwave/openzwave/config /usr/local/share/python-openzwave/config
 
 COPY requirements_all.txt requirements_all.txt
 RUN pip3 install --no-cache-dir -r requirements_all.txt

config/configuration.yaml.example

@@ -1,9 +1,9 @@
 homeassistant:
-  # Omitted values in this section will be auto detected using freegeoip.net
+  # Omitted values in this section will be auto detected using freegeoip.io
 
   # Location required to calculate the time the sun rises and sets.  
-  # Cooridinates are also used for location for weather related components. 
-  # Google Maps can be used to determine more precise GPS cooridinates.
+  # Coordinates are also used for location for weather related components.
+  # Google Maps can be used to determine more precise GPS coordinates.
   latitude: 32.87336
   longitude: 117.22743
 

config/custom_components/example.py

@@ -1,6 +1,5 @@
 """
-custom_components.example
-~~~~~~~~~~~~~~~~~~~~~~~~~
+Example of a custom component.
 
 Example component to target an entity_id to:
  - turn it on at 7AM in the morning
@@ -29,22 +28,29 @@ import time
 import logging
 
 from homeassistant.const import STATE_HOME, STATE_NOT_HOME, STATE_ON, STATE_OFF
-import homeassistant.loader as loader
 from homeassistant.helpers import validate_config
+from homeassistant.helpers.event_decorators import \
+    track_state_change, track_time_change
+from homeassistant.helpers.service import service
 import homeassistant.components as core
+from homeassistant.components import device_tracker
+from homeassistant.components import light
 
-# The domain of your component. Should be equal to the name of your component
+# The domain of your component. Should be equal to the name of your component.
 DOMAIN = "example"
 
-# List of component names (string) your component depends upon
+# List of component names (string) your component depends upon.
 # We depend on group because group will be loaded after all the components that
 # initialize devices have been setup.
-DEPENDENCIES = ['group']
+DEPENDENCIES = ['group', 'device_tracker', 'light']
 
-# Configuration key for the entity id we are targetting
+# Configuration key for the entity id we are targeting.
 CONF_TARGET = 'target'
 
-# Name of the service that we expose
+# Variable for storing configuration parameters.
+TARGET_ID = None
+
+# Name of the service that we expose.
 SERVICE_FLASH = 'flash'
 
 # Shortcut for the logger
@@ -52,85 +58,92 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def setup(hass, config):
-    """ Setup example component. """
+    """Setup example component."""
+    global TARGET_ID
 
-    # Validate that all required config options are given
+    # Validate that all required config options are given.
     if not validate_config(config, {DOMAIN: [CONF_TARGET]}, _LOGGER):
         return False
 
-    target_id = config[DOMAIN][CONF_TARGET]
+    TARGET_ID = config[DOMAIN][CONF_TARGET]
 
-    # Validate that the target entity id exists
-    if hass.states.get(target_id) is None:
-        _LOGGER.error("Target entity id %s does not exist", target_id)
+    # Validate that the target entity id exists.
+    if hass.states.get(TARGET_ID) is None:
+        _LOGGER.error("Target entity id %s does not exist",
+                      TARGET_ID)
 
-        # Tell the bootstrapper that we failed to initialize
+        # Tell the bootstrapper that we failed to initialize and clear the
+        # stored target id so our functions don't run.
+        TARGET_ID = None
         return False
 
-    # We will use the component helper methods to check the states.
-    device_tracker = loader.get_component('device_tracker')
-    light = loader.get_component('light')
-
-    def track_devices(entity_id, old_state, new_state):
-        """ Called when the group.all devices change state. """
-
-        # If anyone comes home and the core is not on, turn it on.
-        if new_state.state == STATE_HOME and not core.is_on(hass, target_id):
-
-            core.turn_on(hass, target_id)
-
-        # If all people leave the house and the core is on, turn it off
-        elif new_state.state == STATE_NOT_HOME and core.is_on(hass, target_id):
-
-            core.turn_off(hass, target_id)
-
-    # Register our track_devices method to receive state changes of the
-    # all tracked devices group.
-    hass.states.track_change(
-        device_tracker.ENTITY_ID_ALL_DEVICES, track_devices)
-
-    def wake_up(now):
-        """ Turn it on in the morning if there are people home and
-            it is not already on. """
-
-        if device_tracker.is_on(hass) and not core.is_on(hass, target_id):
-            _LOGGER.info('People home at 7AM, turning it on')
-            core.turn_on(hass, target_id)
-
-    # Register our wake_up service to be called at 7AM in the morning
-    hass.track_time_change(wake_up, hour=7, minute=0, second=0)
-
-    def all_lights_off(entity_id, old_state, new_state):
-        """ If all lights turn off, turn off. """
-
-        if core.is_on(hass, target_id):
-            _LOGGER.info('All lights have been turned off, turning it off')
-            core.turn_off(hass, target_id)
-
-    # Register our all_lights_off method to be called when all lights turn off
-    hass.states.track_change(
-        light.ENTITY_ID_ALL_LIGHTS, all_lights_off, STATE_ON, STATE_OFF)
-
-    def flash_service(call):
-        """ Service that will turn the target off for 10 seconds
-            if on and vice versa. """
-
-        if core.is_on(hass, target_id):
-            core.turn_off(hass, target_id)
-
-            time.sleep(10)
-
-            core.turn_on(hass, target_id)
-
-        else:
-            core.turn_on(hass, target_id)
-
-            time.sleep(10)
-
-            core.turn_off(hass, target_id)
-
-    # Register our service with HASS.
-    hass.services.register(DOMAIN, SERVICE_FLASH, flash_service)
-
-    # Tells the bootstrapper that the component was successfully initialized
+    # Tell the bootstrapper that we initialized successfully.
     return True
+
+
+@track_state_change(device_tracker.ENTITY_ID_ALL_DEVICES)
+def track_devices(hass, entity_id, old_state, new_state):
+    """Called when the group.all devices change state."""
+    # If the target id is not set, return
+    if not TARGET_ID:
+        return
+
+    # If anyone comes home and the entity is not on, turn it on.
+    if new_state.state == STATE_HOME and not core.is_on(hass, TARGET_ID):
+
+        core.turn_on(hass, TARGET_ID)
+
+    # If all people leave the house and the entity is on, turn it off.
+    elif new_state.state == STATE_NOT_HOME and core.is_on(hass, TARGET_ID):
+
+        core.turn_off(hass, TARGET_ID)
+
+
+@track_time_change(hour=7, minute=0, second=0)
+def wake_up(hass, now):
+    """Turn light on in the morning.
+
+    Turn the light on at 7 AM if there are people home and it is not already
+    on.
+    """
+    if not TARGET_ID:
+        return
+
+    if device_tracker.is_on(hass) and not core.is_on(hass, TARGET_ID):
+        _LOGGER.info('People home at 7AM, turning it on')
+        core.turn_on(hass, TARGET_ID)
+
+
+@track_state_change(light.ENTITY_ID_ALL_LIGHTS, STATE_ON, STATE_OFF)
+def all_lights_off(hass, entity_id, old_state, new_state):
+    """If all lights turn off, turn off."""
+    if not TARGET_ID:
+        return
+
+    if core.is_on(hass, TARGET_ID):
+        _LOGGER.info('All lights have been turned off, turning it off')
+        core.turn_off(hass, TARGET_ID)
+
+
+@service(DOMAIN, SERVICE_FLASH)
+def flash_service(hass, call):
+    """Service that will toggle the target.
+
+    Set the light to off for 10 seconds if on and vice versa.
+    """
+    if not TARGET_ID:
+        return
+
+    if core.is_on(hass, TARGET_ID):
+        core.turn_off(hass, TARGET_ID)
+
+        time.sleep(10)
+
+        core.turn_on(hass, TARGET_ID)
+
+    else:
+        core.turn_on(hass, TARGET_ID)
+
+        time.sleep(10)
+
+        core.turn_off(hass, TARGET_ID)

config/custom_components/hello_world.py

@@ -1,7 +1,7 @@
 """
-custom_components.hello_world
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Implements the bare minimum that a component should implement.
+The "hello world" custom component.
+
+This component implements the bare minimum that a component should implement.
 
 Configuration:
 
@@ -11,18 +11,17 @@ configuration.yaml file.
 hello_world:
 """
 
-# The domain of your component. Should be equal to the name of your component
+# The domain of your component. Should be equal to the name of your component.
 DOMAIN = "hello_world"
 
-# List of component names (string) your component depends upon
+# List of component names (string) your component depends upon.
 DEPENDENCIES = []
 
 
 def setup(hass, config):
-    """ Setup our skeleton component. """
-
-    # States are in the format DOMAIN.OBJECT_ID
+    """Setup our skeleton component."""
+    # States are in the format DOMAIN.OBJECT_ID.
     hass.states.set('hello_world.Hello_World', 'Works!')
 
-    # return boolean to indicate that initialization was successful
+    # Return boolean to indicate that initialization was successfully.
     return True

config/custom_components/mqtt_example.py

@@ -1,6 +1,6 @@
 """
-custom_components.mqtt_example
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Example of a custom MQTT component.
+
 Shows how to communicate with MQTT. Follows a topic on MQTT and updates the
 state of an entity to the last message received on that topic.
 
@@ -15,45 +15,41 @@ configuration.yaml file.
 
 mqtt_example:
   topic: home-assistant/mqtt_example
-
 """
 import homeassistant.loader as loader
 
-# The domain of your component. Should be equal to the name of your component
+# The domain of your component. Should be equal to the name of your component.
 DOMAIN = "mqtt_example"
 
-# List of component names (string) your component depends upon
+# List of component names (string) your component depends upon.
 DEPENDENCIES = ['mqtt']
 
-
 CONF_TOPIC = 'topic'
 DEFAULT_TOPIC = 'home-assistant/mqtt_example'
 
 
 def setup(hass, config):
-    """ Setup our mqtt_example component. """
+    """Setup the  MQTT example component."""
     mqtt = loader.get_component('mqtt')
     topic = config[DOMAIN].get('topic', DEFAULT_TOPIC)
     entity_id = 'mqtt_example.last_message'
 
-    # Listen to a message on MQTT
-
+    # Listen to a message on MQTT.
     def message_received(topic, payload, qos):
-        """ A new MQTT message has been received. """
+        """A new MQTT message has been received."""
         hass.states.set(entity_id, payload)
 
     mqtt.subscribe(hass, topic, message_received)
 
     hass.states.set(entity_id, 'No messages')
 
-    # Service to publish a message on MQTT
-
+    # Service to publish a message on MQTT.
     def set_state_service(call):
-        """ Service to send a message. """
+        """Service to send a message."""
         mqtt.publish(hass, topic, call.data.get('new_state'))
 
-    # Register our service with Home Assistant
+    # Register our service with Home Assistant.
     hass.services.register(DOMAIN, 'set_state', set_state_service)
 
-    # return boolean to indicate that initialization was successful
+    # Return boolean to indicate that initialization was successfully.
     return True

homeassistant/__init__.py

@@ -0,0 +1 @@
+"""Init file for Home Assistant."""

homeassistant/__main__.py

@@ -1,27 +1,36 @@
-""" Starts home assistant. """
+"""Starts home assistant."""
 from __future__ import print_function
 
-import sys
-import os
 import argparse
+import os
+import signal
+import sys
+import threading
+import time
+from multiprocessing import Process
 
-from homeassistant import bootstrap
-import homeassistant.config as config_util
-from homeassistant.const import __version__, EVENT_HOMEASSISTANT_START
+from homeassistant.const import (
+    __version__,
+    EVENT_HOMEASSISTANT_START,
+    REQUIRED_PYTHON_VER,
+    RESTART_EXIT_CODE,
+)
 
 
 def validate_python():
-    """ Validate we're running the right Python version. """
+    """Validate we're running the right Python version."""
     major, minor = sys.version_info[:2]
+    req_major, req_minor = REQUIRED_PYTHON_VER
 
-    if major < 3 or (major == 3 and minor < 4):
-        print("Home Assistant requires atleast Python 3.4")
+    if major < req_major or (major == req_major and minor < req_minor):
+        print("Home Assistant requires at least Python {}.{}".format(
+            req_major, req_minor))
         sys.exit(1)
 
 
 def ensure_config_path(config_dir):
-    """ Validates configuration directory. """
-
+    """Validate the configuration directory."""
+    import homeassistant.config as config_util
     lib_dir = os.path.join(config_dir, 'lib')
 
     # Test if configuration directory exists
@@ -49,7 +58,8 @@ def ensure_config_path(config_dir):
 
 
 def ensure_config_file(config_dir):
-    """ Ensure configuration file exists. """
+    """Ensure configuration file exists."""
+    import homeassistant.config as config_util
     config_path = config_util.ensure_config_exists(config_dir)
 
     if config_path is None:
@@ -60,7 +70,8 @@ def ensure_config_file(config_dir):
 
 
 def get_arguments():
-    """ Get parsed passed in arguments. """
+    """Get parsed passed in arguments."""
+    import homeassistant.config as config_util
     parser = argparse.ArgumentParser(
         description="Home Assistant: Observe, Control, Automate.")
     parser.add_argument('--version', action='version', version=__version__)
@@ -73,6 +84,11 @@ def get_arguments():
         '--demo-mode',
         action='store_true',
         help='Start Home Assistant in demo mode')
+    parser.add_argument(
+        '--debug',
+        action='store_true',
+        help='Start Home Assistant in debug mode. Runs in single process to '
+        'enable use of interactive debuggers.')
     parser.add_argument(
         '--open-ui',
         action='store_true',
@@ -120,25 +136,25 @@ def get_arguments():
 
 
 def daemonize():
-    """ Move current process to daemon process """
-    # create first fork
+    """Move current process to daemon process."""
+    # Create first fork
     pid = os.fork()
     if pid > 0:
         sys.exit(0)
 
-    # decouple fork
+    # Decouple fork
     os.setsid()
     os.umask(0)
 
-    # create second fork
+    # Create second fork
     pid = os.fork()
     if pid > 0:
         sys.exit(0)
 
 
 def check_pid(pid_file):
-    """ Check that HA is not already running """
-    # check pid file
+    """Check that HA is not already running."""
+    # Check pid file
     try:
         pid = int(open(pid_file, 'r').readline())
     except IOError:
@@ -155,7 +171,7 @@ def check_pid(pid_file):
 
 
 def write_pid(pid_file):
-    """ Create PID File """
+    """Create a PID File."""
     pid = os.getpid()
     try:
         open(pid_file, 'w').write(str(pid))
@@ -165,7 +181,7 @@ def write_pid(pid_file):
 
 
 def install_osx():
-    """ Setup to run via launchd on OS X """
+    """Setup to run via launchd on OS X."""
     with os.popen('which hass') as inp:
         hass_path = inp.read().strip()
 
@@ -197,41 +213,20 @@ def install_osx():
 
 
 def uninstall_osx():
-    """ Unload from launchd on OS X """
+    """Unload from launchd on OS X."""
     path = os.path.expanduser("~/Library/LaunchAgents/org.homeassistant.plist")
     os.popen('launchctl unload ' + path)
 
     print("Home Assistant has been uninstalled.")
 
 
-def main():
-    """ Starts Home Assistant. """
-    validate_python()
+def setup_and_run_hass(config_dir, args, top_process=False):
+    """Setup HASS and run.
 
-    args = get_arguments()
-
-    config_dir = os.path.join(os.getcwd(), args.config)
-    ensure_config_path(config_dir)
-
-    # os x launchd functions
-    if args.install_osx:
-        install_osx()
-        return
-    if args.uninstall_osx:
-        uninstall_osx()
-        return
-    if args.restart_osx:
-        uninstall_osx()
-        install_osx()
-        return
-
-    # daemon functions
-    if args.pid_file:
-        check_pid(args.pid_file)
-    if args.daemon:
-        daemonize()
-    if args.pid_file:
-        write_pid(args.pid_file)
+    Block until stopped. Will assume it is running in a subprocess unless
+    top_process is set to true.
+    """
+    from homeassistant import bootstrap
 
     if args.demo_mode:
         config = {
@@ -249,9 +244,12 @@ def main():
             config_file, daemon=args.daemon, verbose=args.verbose,
             skip_pip=args.skip_pip, log_rotate_days=args.log_rotate_days)
 
+    if hass is None:
+        return
+
     if args.open_ui:
         def open_browser(event):
-            """ Open the webinterface in a browser. """
+            """Open the webinterface in a browser."""
             if hass.config.api is not None:
                 import webbrowser
                 webbrowser.open(hass.config.api.base_url)
@@ -259,7 +257,91 @@ def main():
         hass.bus.listen_once(EVENT_HOMEASSISTANT_START, open_browser)
 
     hass.start()
-    hass.block_till_stopped()
+    exit_code = int(hass.block_till_stopped())
+
+    if not top_process:
+        sys.exit(exit_code)
+    return exit_code
+
+
+def run_hass_process(hass_proc):
+    """Run a child hass process. Returns True if it should be restarted."""
+    requested_stop = threading.Event()
+    hass_proc.daemon = True
+
+    def request_stop(*args):
+        """Request hass stop, *args is for signal handler callback."""
+        requested_stop.set()
+        hass_proc.terminate()
+
+    try:
+        signal.signal(signal.SIGTERM, request_stop)
+    except ValueError:
+        print('Could not bind to SIGTERM. Are you running in a thread?')
+
+    hass_proc.start()
+    try:
+        hass_proc.join()
+    except KeyboardInterrupt:
+        request_stop()
+        try:
+            hass_proc.join()
+        except KeyboardInterrupt:
+            return False
+
+    return (not requested_stop.isSet() and
+            hass_proc.exitcode == RESTART_EXIT_CODE,
+            hass_proc.exitcode)
+
+
+def main():
+    """Start Home Assistant."""
+    validate_python()
+
+    args = get_arguments()
+
+    config_dir = os.path.join(os.getcwd(), args.config)
+    ensure_config_path(config_dir)
+
+    # OS X launchd functions
+    if args.install_osx:
+        install_osx()
+        return 0
+    if args.uninstall_osx:
+        uninstall_osx()
+        return 0
+    if args.restart_osx:
+        uninstall_osx()
+        # A small delay is needed on some systems to let the unload finish.
+        time.sleep(0.5)
+        install_osx()
+        return 0
+
+    # Daemon functions
+    if args.pid_file:
+        check_pid(args.pid_file)
+    if args.daemon:
+        daemonize()
+    if args.pid_file:
+        write_pid(args.pid_file)
+
+    # Run hass in debug mode if requested
+    if args.debug:
+        sys.stderr.write('Running in debug mode. '
+                         'Home Assistant will not be able to restart.\n')
+        exit_code = setup_and_run_hass(config_dir, args, top_process=True)
+        if exit_code == RESTART_EXIT_CODE:
+            sys.stderr.write('Home Assistant requested a '
+                             'restart in debug mode.\n')
+        return exit_code
+
+    # Run hass as child process. Restart if necessary.
+    keep_running = True
+    while keep_running:
+        hass_proc = Process(target=setup_and_run_hass, args=(config_dir, args))
+        keep_running, exit_code = run_hass_process(hass_proc)
+    return exit_code
+
 
 if __name__ == "__main__":
-    main()
+    sys.exit(main())

homeassistant/bootstrap.py

@@ -1,46 +1,43 @@
-"""
-homeassistant.bootstrap
-~~~~~~~~~~~~~~~~~~~~~~~
-Provides methods to bootstrap a home assistant instance.
+"""Provides methods to bootstrap a home assistant instance."""
 
-Each method will return a tuple (bus, statemachine).
-
-After bootstrapping you can add your own components or
-start by calling homeassistant.start_home_assistant(bus)
-"""
-
-from collections import defaultdict
 import logging
 import logging.handlers
 import os
 import shutil
 import sys
+from collections import defaultdict
+from threading import RLock
+
+import voluptuous as vol
 
-import homeassistant.core as core
-import homeassistant.util.dt as date_util
-import homeassistant.util.package as pkg_util
-import homeassistant.util.location as loc_util
-import homeassistant.config as config_util
-import homeassistant.loader as loader
 import homeassistant.components as core_components
 import homeassistant.components.group as group
-from homeassistant.helpers.entity import Entity
+import homeassistant.config as config_util
+import homeassistant.core as core
+import homeassistant.loader as loader
+import homeassistant.util.dt as date_util
+import homeassistant.util.location as loc_util
+import homeassistant.util.package as pkg_util
 from homeassistant.const import (
-    __version__, EVENT_COMPONENT_LOADED, CONF_LATITUDE, CONF_LONGITUDE,
-    CONF_TEMPERATURE_UNIT, CONF_NAME, CONF_TIME_ZONE, CONF_CUSTOMIZE,
-    TEMP_CELCIUS, TEMP_FAHRENHEIT)
+    CONF_CUSTOMIZE, CONF_LATITUDE, CONF_LONGITUDE, CONF_NAME,
+    CONF_TEMPERATURE_UNIT, CONF_TIME_ZONE, EVENT_COMPONENT_LOADED,
+    TEMP_CELCIUS, TEMP_FAHRENHEIT, PLATFORM_FORMAT, __version__)
+from homeassistant.exceptions import HomeAssistantError
+from homeassistant.helpers import (
+    event_decorators, service, config_per_platform, extract_domain_configs)
+from homeassistant.helpers.entity import Entity
 
 _LOGGER = logging.getLogger(__name__)
+_SETUP_LOCK = RLock()
+_CURRENT_SETUP = []
 
 ATTR_COMPONENT = 'component'
 
-PLATFORM_FORMAT = '{}.{}'
 ERROR_LOG_FILENAME = 'home-assistant.log'
 
 
 def setup_component(hass, domain, config=None):
-    """ Setup a component and all its dependencies. """
-
+    """Setup a component and all its dependencies."""
     if domain in hass.config.components:
         return True
 
@@ -63,7 +60,7 @@ def setup_component(hass, domain, config=None):
 
 
 def _handle_requirements(hass, component, name):
-    """ Installs requirements for component. """
+    """Install the requirements for a component."""
     if hass.config.skip_pip or not hasattr(component, 'REQUIREMENTS'):
         return True
 
@@ -77,51 +74,116 @@ def _handle_requirements(hass, component, name):
 
 
 def _setup_component(hass, domain, config):
-    """ Setup a component for Home Assistant. """
+    """Setup a component for Home Assistant."""
+    # pylint: disable=too-many-return-statements,too-many-branches
     if domain in hass.config.components:
         return True
-    component = loader.get_component(domain)
 
-    missing_deps = [dep for dep in getattr(component, 'DEPENDENCIES', [])
-                    if dep not in hass.config.components]
+    with _SETUP_LOCK:
+        # It might have been loaded while waiting for lock
+        if domain in hass.config.components:
+            return True
 
-    if missing_deps:
-        _LOGGER.error(
-            'Not initializing %s because not all dependencies loaded: %s',
-            domain, ", ".join(missing_deps))
-        return False
-
-    if not _handle_requirements(hass, component, domain):
-        return False
-
-    try:
-        if not component.setup(hass, config):
-            _LOGGER.error('component %s failed to initialize', domain)
+        if domain in _CURRENT_SETUP:
+            _LOGGER.error('Attempt made to setup %s during setup of %s',
+                          domain, domain)
             return False
-    except Exception:  # pylint: disable=broad-except
-        _LOGGER.exception('Error during setup of component %s', domain)
-        return False
 
-    hass.config.components.append(component.DOMAIN)
+        component = loader.get_component(domain)
+        missing_deps = [dep for dep in getattr(component, 'DEPENDENCIES', [])
+                        if dep not in hass.config.components]
 
-    # Assumption: if a component does not depend on groups
-    # it communicates with devices
-    if group.DOMAIN not in getattr(component, 'DEPENDENCIES', []):
-        hass.pool.add_worker()
+        if missing_deps:
+            _LOGGER.error(
+                'Not initializing %s because not all dependencies loaded: %s',
+                domain, ", ".join(missing_deps))
+            return False
 
-    hass.bus.fire(
-        EVENT_COMPONENT_LOADED, {ATTR_COMPONENT: component.DOMAIN})
+        if hasattr(component, 'CONFIG_SCHEMA'):
+            try:
+                config = component.CONFIG_SCHEMA(config)
+            except vol.MultipleInvalid as ex:
+                _LOGGER.error('Invalid config for [%s]: %s', domain, ex)
+                return False
 
-    return True
+        elif hasattr(component, 'PLATFORM_SCHEMA'):
+            platforms = []
+            for p_name, p_config in config_per_platform(config, domain):
+                # Validate component specific platform schema
+                try:
+                    p_validated = component.PLATFORM_SCHEMA(p_config)
+                except vol.MultipleInvalid as ex:
+                    _LOGGER.error('Invalid platform config for [%s]: %s. %s',
+                                  domain, ex, p_config)
+                    return False
+
+                # Not all platform components follow same pattern for platforms
+                # Sof if p_name is None we are not going to validate platform
+                # (the automation component is one of them)
+                if p_name is None:
+                    platforms.append(p_validated)
+                    continue
+
+                platform = prepare_setup_platform(hass, config, domain,
+                                                  p_name)
+
+                if platform is None:
+                    return False
+
+                # Validate platform specific schema
+                if hasattr(platform, 'PLATFORM_SCHEMA'):
+                    try:
+                        p_validated = platform.PLATFORM_SCHEMA(p_validated)
+                    except vol.MultipleInvalid as ex:
+                        _LOGGER.error(
+                            'Invalid platform config for [%s.%s]: %s. %s',
+                            domain, p_name, ex, p_config)
+                        return False
+
+                platforms.append(p_validated)
+
+            # Create a copy of the configuration with all config for current
+            # component removed and add validated config back in.
+            filter_keys = extract_domain_configs(config, domain)
+            config = {key: value for key, value in config.items()
+                      if key not in filter_keys}
+            config[domain] = platforms
+
+        if not _handle_requirements(hass, component, domain):
+            return False
+
+        _CURRENT_SETUP.append(domain)
+
+        try:
+            if not component.setup(hass, config):
+                _LOGGER.error('component %s failed to initialize', domain)
+                return False
+        except Exception:  # pylint: disable=broad-except
+            _LOGGER.exception('Error during setup of component %s', domain)
+            return False
+        finally:
+            _CURRENT_SETUP.remove(domain)
+
+        hass.config.components.append(component.DOMAIN)
+
+        # Assumption: if a component does not depend on groups
+        # it communicates with devices
+        if group.DOMAIN not in getattr(component, 'DEPENDENCIES', []):
+            hass.pool.add_worker()
+
+        hass.bus.fire(
+            EVENT_COMPONENT_LOADED, {ATTR_COMPONENT: component.DOMAIN})
+
+        return True
 
 
 def prepare_setup_platform(hass, config, domain, platform_name):
-    """ Loads a platform and makes sure dependencies are setup. """
+    """Load a platform and makes sure dependencies are setup."""
     _ensure_loader_prepared(hass)
 
     platform_path = PLATFORM_FORMAT.format(domain, platform_name)
 
-    platform = loader.get_component(platform_path)
+    platform = loader.get_platform(domain, platform_name)
 
     # Not found
     if platform is None:
@@ -148,7 +210,7 @@ def prepare_setup_platform(hass, config, domain, platform_name):
 
 
 def mount_local_lib_path(config_dir):
-    """ Add local library to Python Path """
+    """Add local library to Python Path."""
     sys.path.insert(0, os.path.join(config_dir, 'lib'))
 
 
@@ -156,8 +218,7 @@ def mount_local_lib_path(config_dir):
 def from_config_dict(config, hass=None, config_dir=None, enable_log=True,
                      verbose=False, daemon=False, skip_pip=False,
                      log_rotate_days=None):
-    """
-    Tries to configure Home Assistant from a config dict.
+    """Try to configure Home Assistant from a config dict.
 
     Dynamically loads required components and its dependencies.
     """
@@ -168,8 +229,14 @@ def from_config_dict(config, hass=None, config_dir=None, enable_log=True,
             hass.config.config_dir = config_dir
             mount_local_lib_path(config_dir)
 
+    try:
+        process_ha_core_config(hass, config_util.CORE_CONFIG_SCHEMA(
+            config.get(core.DOMAIN, {})))
+    except vol.MultipleInvalid as ex:
+        _LOGGER.error('Invalid config for [homeassistant]: %s', ex)
+        return None
+
     process_ha_config_upgrade(hass)
-    process_ha_core_config(hass, config.get(core.DOMAIN, {}))
 
     if enable_log:
         enable_logging(hass, verbose, daemon, log_rotate_days)
@@ -199,6 +266,10 @@ def from_config_dict(config, hass=None, config_dir=None, enable_log=True,
 
     _LOGGER.info('Home Assistant core initialized')
 
+    # Give event decorators access to HASS
+    event_decorators.HASS = hass
+    service.HASS = hass
+
     # Setup the components
     for domain in loader.load_order_components(components):
         _setup_component(hass, domain, config)
@@ -208,9 +279,9 @@ def from_config_dict(config, hass=None, config_dir=None, enable_log=True,
 
 def from_config_file(config_path, hass=None, verbose=False, daemon=False,
                      skip_pip=True, log_rotate_days=None):
-    """
-    Reads the configuration file and tries to start all the required
-    functionality. Will add functionality to 'hass' parameter if given,
+    """Read the configuration file and try to start all the functionality.
+
+    Will add functionality to 'hass' parameter if given,
     instantiates a new Home Assistant object if 'hass' is not given.
     """
     if hass is None:
@@ -223,14 +294,17 @@ def from_config_file(config_path, hass=None, verbose=False, daemon=False,
 
     enable_logging(hass, verbose, daemon, log_rotate_days)
 
-    config_dict = config_util.load_config_file(config_path)
+    try:
+        config_dict = config_util.load_yaml_config_file(config_path)
+    except HomeAssistantError:
+        return None
 
     return from_config_dict(config_dict, hass, enable_log=False,
                             skip_pip=skip_pip)
 
 
 def enable_logging(hass, verbose=False, daemon=False, log_rotate_days=None):
-    """ Setup the logging for home assistant. """
+    """Setup the logging."""
     if not daemon:
         logging.basicConfig(level=logging.INFO)
         fmt = ("%(log_color)s%(asctime)s %(levelname)s (%(threadName)s) "
@@ -250,8 +324,7 @@ def enable_logging(hass, verbose=False, daemon=False, log_rotate_days=None):
                 }
             ))
         except ImportError:
-            _LOGGER.warning(
-                "Colorlog package not found, console coloring disabled")
+            pass
 
     # Log errors to a file if we have write access to file or config dir
     err_log_path = hass.config.path(ERROR_LOG_FILENAME)
@@ -283,7 +356,7 @@ def enable_logging(hass, verbose=False, daemon=False, log_rotate_days=None):
 
 
 def process_ha_config_upgrade(hass):
-    """ Upgrade config if necessary. """
+    """Upgrade config if necessary."""
     version_path = hass.config.path('.HA_VERSION')
 
     try:
@@ -308,11 +381,11 @@ def process_ha_config_upgrade(hass):
 
 
 def process_ha_core_config(hass, config):
-    """ Processes the [homeassistant] section from the config. """
+    """Process the [homeassistant] section from the config."""
     hac = hass.config
 
     def set_time_zone(time_zone_str):
-        """ Helper method to set time zone in HA. """
+        """Helper method to set time zone."""
         if time_zone_str is None:
             return
 
@@ -324,40 +397,28 @@ def process_ha_core_config(hass, config):
         else:
             _LOGGER.error('Received invalid time zone %s', time_zone_str)
 
-    for key, attr, typ in ((CONF_LATITUDE, 'latitude', float),
-                           (CONF_LONGITUDE, 'longitude', float),
-                           (CONF_NAME, 'location_name', str)):
+    for key, attr in ((CONF_LATITUDE, 'latitude'),
+                      (CONF_LONGITUDE, 'longitude'),
+                      (CONF_NAME, 'location_name')):
         if key in config:
-            try:
-                setattr(hac, attr, typ(config[key]))
-            except ValueError:
-                _LOGGER.error('Received invalid %s value for %s: %s',
-                              typ.__name__, key, attr)
+            setattr(hac, attr, config[key])
 
-    set_time_zone(config.get(CONF_TIME_ZONE))
+    if CONF_TIME_ZONE in config:
+        set_time_zone(config.get(CONF_TIME_ZONE))
 
-    customize = config.get(CONF_CUSTOMIZE)
-
-    if isinstance(customize, dict):
-        for entity_id, attrs in config.get(CONF_CUSTOMIZE, {}).items():
-            if not isinstance(attrs, dict):
-                continue
-            Entity.overwrite_attribute(entity_id, attrs.keys(), attrs.values())
+    for entity_id, attrs in config.get(CONF_CUSTOMIZE).items():
+        Entity.overwrite_attribute(entity_id, attrs.keys(), attrs.values())
 
     if CONF_TEMPERATURE_UNIT in config:
-        unit = config[CONF_TEMPERATURE_UNIT]
-
-        if unit == 'C':
-            hac.temperature_unit = TEMP_CELCIUS
-        elif unit == 'F':
-            hac.temperature_unit = TEMP_FAHRENHEIT
+        hac.temperature_unit = config[CONF_TEMPERATURE_UNIT]
 
     # If we miss some of the needed values, auto detect them
     if None not in (
             hac.latitude, hac.longitude, hac.temperature_unit, hac.time_zone):
         return
 
-    _LOGGER.info('Auto detecting location and temperature unit')
+    _LOGGER.warning('Incomplete core config. Auto detecting location and '
+                    'temperature unit')
 
     info = loc_util.detect_location_info()
 
@@ -383,6 +444,6 @@ def process_ha_core_config(hass, config):
 
 
 def _ensure_loader_prepared(hass):
-    """ Ensure Home Assistant loader is prepared. """
+    """Ensure Home Assistant loader is prepared."""
     if not loader.PREPARED:
         loader.prepare(hass)

homeassistant/components/__init__.py

@@ -1,33 +1,30 @@
 """
-homeassistant.components
-~~~~~~~~~~~~~~~~~~~~~~~~
 This package contains components that can be plugged into Home Assistant.
 
 Component design guidelines:
-
-Each component defines a constant DOMAIN that is equal to its filename.
-
-Each component that tracks states should create state entity names in the
-format "<DOMAIN>.<OBJECT_ID>".
-
-Each component should publish services only under its own domain.
+- Each component defines a constant DOMAIN that is equal to its filename.
+- Each component that tracks states should create state entity names in the
+  format "<DOMAIN>.<OBJECT_ID>".
+- Each component should publish services only under its own domain.
 """
 import itertools as it
 import logging
 
 import homeassistant.core as ha
-import homeassistant.util as util
-from homeassistant.helpers import extract_entity_ids
+from homeassistant.helpers.entity import split_entity_id
+from homeassistant.helpers.service import extract_entity_ids
 from homeassistant.loader import get_component
 from homeassistant.const import (
-    ATTR_ENTITY_ID, SERVICE_TURN_ON, SERVICE_TURN_OFF)
+    ATTR_ENTITY_ID, SERVICE_TURN_ON, SERVICE_TURN_OFF, SERVICE_TOGGLE)
 
 _LOGGER = logging.getLogger(__name__)
 
 
 def is_on(hass, entity_id=None):
-    """ Loads up the module to call the is_on method.
-    If there is no entity id given we will check all. """
+    """Load up the module to call the is_on method.
+
+    If there is no entity id given we will check all.
+    """
     if entity_id:
         group = get_component('group')
 
@@ -36,7 +33,7 @@ def is_on(hass, entity_id=None):
         entity_ids = hass.states.entity_ids()
 
     for entity_id in entity_ids:
-        domain = util.split_entity_id(entity_id)[0]
+        domain = split_entity_id(entity_id)[0]
 
         module = get_component(domain)
 
@@ -53,7 +50,7 @@ def is_on(hass, entity_id=None):
 
 
 def turn_on(hass, entity_id=None, **service_data):
-    """ Turns specified entity on if possible. """
+    """Turn specified entity on if possible."""
     if entity_id is not None:
         service_data[ATTR_ENTITY_ID] = entity_id
 
@@ -61,18 +58,25 @@ def turn_on(hass, entity_id=None, **service_data):
 
 
 def turn_off(hass, entity_id=None, **service_data):
-    """ Turns specified entity off. """
+    """Turn specified entity off."""
     if entity_id is not None:
         service_data[ATTR_ENTITY_ID] = entity_id
 
     hass.services.call(ha.DOMAIN, SERVICE_TURN_OFF, service_data)
 
 
-def setup(hass, config):
-    """ Setup general services related to homeassistant. """
+def toggle(hass, entity_id=None, **service_data):
+    """Toggle specified entity."""
+    if entity_id is not None:
+        service_data[ATTR_ENTITY_ID] = entity_id
 
+    hass.services.call(ha.DOMAIN, SERVICE_TOGGLE, service_data)
+
+
+def setup(hass, config):
+    """Setup general services related to Home Assistant."""
     def handle_turn_service(service):
-        """ Method to handle calls to homeassistant.turn_on/off. """
+        """Method to handle calls to homeassistant.turn_on/off."""
         entity_ids = extract_entity_ids(hass, service)
 
         # Generic turn on/off method requires entity id
@@ -84,7 +88,7 @@ def setup(hass, config):
 
         # Group entity_ids by domain. groupby requires sorted data.
         by_domain = it.groupby(sorted(entity_ids),
-                               lambda item: util.split_entity_id(item)[0])
+                               lambda item: split_entity_id(item)[0])
 
         for domain, ent_ids in by_domain:
             # We want to block for all calls and only return when all calls
@@ -105,5 +109,6 @@ def setup(hass, config):
 
     hass.services.register(ha.DOMAIN, SERVICE_TURN_OFF, handle_turn_service)
     hass.services.register(ha.DOMAIN, SERVICE_TURN_ON, handle_turn_service)
+    hass.services.register(ha.DOMAIN, SERVICE_TOGGLE, handle_turn_service)
 
     return True

homeassistant/components/alarm_control_panel/__init__.py

@@ -1,16 +1,18 @@
 """
-homeassistant.components.alarm_control_panel
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Component to interface with a alarm control panel.
+Component to interface with an alarm control panel.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/alarm_control_panel/
 """
 import logging
 import os
 
 from homeassistant.components import verisure
 from homeassistant.const import (
-    ATTR_ENTITY_ID, SERVICE_ALARM_TRIGGER,
+    ATTR_CODE, ATTR_CODE_FORMAT, ATTR_ENTITY_ID, SERVICE_ALARM_TRIGGER,
     SERVICE_ALARM_DISARM, SERVICE_ALARM_ARM_HOME, SERVICE_ALARM_ARM_AWAY)
 from homeassistant.config import load_yaml_config_file
+from homeassistant.helpers.config_validation import PLATFORM_SCHEMA  # noqa
 from homeassistant.helpers.entity import Entity
 from homeassistant.helpers.entity_component import EntityComponent
 
@@ -21,7 +23,7 @@ ENTITY_ID_FORMAT = DOMAIN + '.{}'
 
 # Maps discovered services to their platforms
 DISCOVERY_PLATFORMS = {
-    verisure.DISCOVER_SENSORS: 'verisure'
+    verisure.DISCOVER_ALARMS: 'verisure'
 }
 
 SERVICE_TO_METHOD = {
@@ -31,9 +33,6 @@ SERVICE_TO_METHOD = {
     SERVICE_ALARM_TRIGGER: 'alarm_trigger'
 }
 
-ATTR_CODE = 'code'
-ATTR_CODE_FORMAT = 'code_format'
-
 ATTR_TO_PROPERTY = [
     ATTR_CODE,
     ATTR_CODE_FORMAT
@@ -41,7 +40,7 @@ ATTR_TO_PROPERTY = [
 
 
 def setup(hass, config):
-    """ Track states and offer events for sensors. """
+    """Track states and offer events for sensors."""
     component = EntityComponent(
         logging.getLogger(__name__), DOMAIN, hass, SCAN_INTERVAL,
         DISCOVERY_PLATFORMS)
@@ -49,7 +48,7 @@ def setup(hass, config):
     component.setup(config)
 
     def alarm_service_handler(service):
-        """ Maps services to methods on Alarm. """
+        """Map services to methods on Alarm."""
         target_alarms = component.extract_from_service(service)
 
         if ATTR_CODE not in service.data:
@@ -61,6 +60,8 @@ def setup(hass, config):
 
         for alarm in target_alarms:
             getattr(alarm, method)(code)
+            if alarm.should_poll:
+                alarm.update_ha_state(True)
 
     descriptions = load_yaml_config_file(
         os.path.join(os.path.dirname(__file__), 'services.yaml'))
@@ -73,7 +74,7 @@ def setup(hass, config):
 
 
 def alarm_disarm(hass, code=None, entity_id=None):
-    """ Send the alarm the command for disarm. """
+    """Send the alarm the command for disarm."""
     data = {}
     if code:
         data[ATTR_CODE] = code
@@ -84,7 +85,7 @@ def alarm_disarm(hass, code=None, entity_id=None):
 
 
 def alarm_arm_home(hass, code=None, entity_id=None):
-    """ Send the alarm the command for arm home. """
+    """Send the alarm the command for arm home."""
     data = {}
     if code:
         data[ATTR_CODE] = code
@@ -95,7 +96,7 @@ def alarm_arm_home(hass, code=None, entity_id=None):
 
 
 def alarm_arm_away(hass, code=None, entity_id=None):
-    """ Send the alarm the command for arm away. """
+    """Send the alarm the command for arm away."""
     data = {}
     if code:
         data[ATTR_CODE] = code
@@ -106,7 +107,7 @@ def alarm_arm_away(hass, code=None, entity_id=None):
 
 
 def alarm_trigger(hass, code=None, entity_id=None):
-    """ Send the alarm the command for trigger. """
+    """Send the alarm the command for trigger."""
     data = {}
     if code:
         data[ATTR_CODE] = code
@@ -118,33 +119,33 @@ def alarm_trigger(hass, code=None, entity_id=None):
 
 # pylint: disable=no-self-use
 class AlarmControlPanel(Entity):
-    """ ABC for alarm control devices. """
+    """An abstract class for alarm control devices."""
 
     @property
     def code_format(self):
-        """ regex for code format or None if no code is required. """
+        """Regex for code format or None if no code is required."""
         return None
 
     def alarm_disarm(self, code=None):
-        """ Send disarm command. """
+        """Send disarm command."""
         raise NotImplementedError()
 
     def alarm_arm_home(self, code=None):
-        """ Send arm home command. """
+        """Send arm home command."""
         raise NotImplementedError()
 
     def alarm_arm_away(self, code=None):
-        """ Send arm away command. """
+        """Send arm away command."""
         raise NotImplementedError()
 
     def alarm_trigger(self, code=None):
-        """ Send alarm trigger command. """
+        """Send alarm trigger command."""
         raise NotImplementedError()
 
     @property
     def state_attributes(self):
-        """ Return the state attributes. """
+        """Return the state attributes."""
         state_attr = {
             ATTR_CODE_FORMAT: self.code_format,
-            }
+        }
         return state_attr

homeassistant/components/alarm_control_panel/alarmdotcom.py

@@ -1,7 +1,5 @@
 """
-homeassistant.components.alarm_control_panel.alarmdotcom
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Interfaces with Verisure alarm control panel.
+Interfaces with Alarm.com alarm control panels.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/alarm_control_panel.alarmdotcom/
@@ -9,24 +7,21 @@ https://home-assistant.io/components/alarm_control_panel.alarmdotcom/
 import logging
 
 import homeassistant.components.alarm_control_panel as alarm
-from homeassistant.const import CONF_USERNAME, CONF_PASSWORD
-
 from homeassistant.const import (
-    STATE_UNKNOWN,
-    STATE_ALARM_DISARMED, STATE_ALARM_ARMED_HOME, STATE_ALARM_ARMED_AWAY)
+    CONF_PASSWORD, CONF_USERNAME, STATE_ALARM_ARMED_AWAY,
+    STATE_ALARM_ARMED_HOME, STATE_ALARM_DISARMED, STATE_UNKNOWN)
 
 _LOGGER = logging.getLogger(__name__)
 
 
 REQUIREMENTS = ['https://github.com/Xorso/pyalarmdotcom'
-                '/archive/0.0.7.zip'
-                '#pyalarmdotcom==0.0.7']
+                '/archive/0.1.1.zip'
+                '#pyalarmdotcom==0.1.1']
 DEFAULT_NAME = 'Alarm.com'
 
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Setup an Alarm.com control panel. """
-
+    """Setup an Alarm.com control panel."""
     username = config.get(CONF_USERNAME)
     password = config.get(CONF_PASSWORD)
 
@@ -44,9 +39,10 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
 # pylint: disable=too-many-arguments, too-many-instance-attributes
 # pylint: disable=abstract-method
 class AlarmDotCom(alarm.AlarmControlPanel):
-    """ Represents a Alarm.com status. """
+    """Represent an Alarm.com status."""
 
     def __init__(self, hass, name, code, username, password):
+        """Initialize the Alarm.com status."""
         from pyalarmdotcom.pyalarmdotcom import Alarmdotcom
         self._alarm = Alarmdotcom(username, password, timeout=10)
         self._hass = hass
@@ -57,20 +53,22 @@ class AlarmDotCom(alarm.AlarmControlPanel):
 
     @property
     def should_poll(self):
+        """No polling needed."""
         return True
 
     @property
     def name(self):
+        """Return the name of the alarm."""
         return self._name
 
     @property
     def code_format(self):
-        """ One or more characters if code is defined. """
+        """One or more characters if code is defined."""
         return None if self._code is None else '.+'
 
     @property
     def state(self):
-        """ Returns the state of the device. """
+        """Return the state of the device."""
         if self._alarm.state == 'Disarmed':
             return STATE_ALARM_DISARMED
         elif self._alarm.state == 'Armed Stay':
@@ -81,37 +79,34 @@ class AlarmDotCom(alarm.AlarmControlPanel):
             return STATE_UNKNOWN
 
     def alarm_disarm(self, code=None):
-        """ Send disarm command. """
+        """Send disarm command."""
         if not self._validate_code(code, 'arming home'):
             return
         from pyalarmdotcom.pyalarmdotcom import Alarmdotcom
         # Open another session to alarm.com to fire off the command
         _alarm = Alarmdotcom(self._username, self._password, timeout=10)
         _alarm.disarm()
-        self.update_ha_state()
 
     def alarm_arm_home(self, code=None):
-        """ Send arm home command. """
+        """Send arm home command."""
         if not self._validate_code(code, 'arming home'):
             return
         from pyalarmdotcom.pyalarmdotcom import Alarmdotcom
         # Open another session to alarm.com to fire off the command
         _alarm = Alarmdotcom(self._username, self._password, timeout=10)
         _alarm.arm_stay()
-        self.update_ha_state()
 
     def alarm_arm_away(self, code=None):
-        """ Send arm away command. """
+        """Send arm away command."""
         if not self._validate_code(code, 'arming home'):
             return
         from pyalarmdotcom.pyalarmdotcom import Alarmdotcom
         # Open another session to alarm.com to fire off the command
         _alarm = Alarmdotcom(self._username, self._password, timeout=10)
         _alarm.arm_away()
-        self.update_ha_state()
 
     def _validate_code(self, code, state):
-        """ Validate given code. """
+        """Validate given code."""
         check = self._code is None or code == self._code
         if not check:
             _LOGGER.warning('Wrong code entered for %s', state)

homeassistant/components/alarm_control_panel/demo.py

@@ -1,13 +1,14 @@
 """
-homeassistant.components.alarm_control_panel.demo
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Demo platform that has two fake alarm control panels.
+
+For more details about this platform, please refer to the documentation
+https://home-assistant.io/components/demo/
 """
 import homeassistant.components.alarm_control_panel.manual as manual
 
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Sets up the Demo alarm control panels. """
+    """Setup the Demo alarm control panel platform."""
     add_devices([
         manual.ManualAlarm(hass, 'Alarm', '1234', 5, 10),
     ])

homeassistant/components/alarm_control_panel/manual.py

@@ -1,20 +1,18 @@
 """
-homeassistant.components.alarm_control_panel.manual
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Support for manual alarms.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/alarm_control_panel.manual/
 """
-import logging
 import datetime
-import homeassistant.components.alarm_control_panel as alarm
-from homeassistant.helpers.event import track_point_in_time
-import homeassistant.util.dt as dt_util
+import logging
 
+import homeassistant.components.alarm_control_panel as alarm
+import homeassistant.util.dt as dt_util
 from homeassistant.const import (
-    STATE_ALARM_DISARMED, STATE_ALARM_ARMED_HOME, STATE_ALARM_ARMED_AWAY,
+    STATE_ALARM_ARMED_AWAY, STATE_ALARM_ARMED_HOME, STATE_ALARM_DISARMED,
     STATE_ALARM_PENDING, STATE_ALARM_TRIGGERED)
+from homeassistant.helpers.event import track_point_in_time
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -24,8 +22,7 @@ DEFAULT_TRIGGER_TIME = 120
 
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Sets up the manual alarm platform. """
-
+    """Setup the manual alarm platform."""
     add_devices([ManualAlarm(
         hass,
         config.get('name', DEFAULT_ALARM_NAME),
@@ -47,6 +44,7 @@ class ManualAlarm(alarm.AlarmControlPanel):
     """
 
     def __init__(self, hass, name, code, pending_time, trigger_time):
+        """Initalize the manual alarm panel."""
         self._state = STATE_ALARM_DISARMED
         self._hass = hass
         self._name = name
@@ -57,17 +55,17 @@ class ManualAlarm(alarm.AlarmControlPanel):
 
     @property
     def should_poll(self):
-        """ No polling needed. """
+        """No polling needed."""
         return False
 
     @property
     def name(self):
-        """ Returns the name of the device. """
+        """Return the name of the device."""
         return self._name
 
     @property
     def state(self):
-        """ Returns the state of the device. """
+        """Return the state of the device."""
         if self._state in (STATE_ALARM_ARMED_HOME,
                            STATE_ALARM_ARMED_AWAY) and \
            self._pending_time and self._state_ts + self._pending_time > \
@@ -85,11 +83,11 @@ class ManualAlarm(alarm.AlarmControlPanel):
 
     @property
     def code_format(self):
-        """ One or more characters. """
+        """One or more characters."""
         return None if self._code is None else '.+'
 
     def alarm_disarm(self, code=None):
-        """ Send disarm command. """
+        """Send disarm command."""
         if not self._validate_code(code, STATE_ALARM_DISARMED):
             return
 
@@ -98,7 +96,7 @@ class ManualAlarm(alarm.AlarmControlPanel):
         self.update_ha_state()
 
     def alarm_arm_home(self, code=None):
-        """ Send arm home command. """
+        """Send arm home command."""
         if not self._validate_code(code, STATE_ALARM_ARMED_HOME):
             return
 
@@ -112,7 +110,7 @@ class ManualAlarm(alarm.AlarmControlPanel):
                 self._state_ts + self._pending_time)
 
     def alarm_arm_away(self, code=None):
-        """ Send arm away command. """
+        """Send arm away command."""
         if not self._validate_code(code, STATE_ALARM_ARMED_AWAY):
             return
 
@@ -126,7 +124,7 @@ class ManualAlarm(alarm.AlarmControlPanel):
                 self._state_ts + self._pending_time)
 
     def alarm_trigger(self, code=None):
-        """ Send alarm trigger command. No code needed. """
+        """Send alarm trigger command. No code needed."""
         self._state = STATE_ALARM_TRIGGERED
         self._state_ts = dt_util.utcnow()
         self.update_ha_state()
@@ -141,7 +139,7 @@ class ManualAlarm(alarm.AlarmControlPanel):
                 self._state_ts + self._pending_time + self._trigger_time)
 
     def _validate_code(self, code, state):
-        """ Validate given code. """
+        """Validate given code."""
         check = self._code is None or code == self._code
         if not check:
             _LOGGER.warning('Invalid code given for %s', state)

homeassistant/components/alarm_control_panel/mqtt.py

@@ -1,60 +1,70 @@
 """
-homeassistant.components.alarm_control_panel.mqtt
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This platform enables the possibility to control a MQTT alarm.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/alarm_control_panel.mqtt/
 """
 import logging
-import homeassistant.components.mqtt as mqtt
-import homeassistant.components.alarm_control_panel as alarm
 
+import voluptuous as vol
+
+import homeassistant.components.alarm_control_panel as alarm
+import homeassistant.components.mqtt as mqtt
 from homeassistant.const import (
-    STATE_ALARM_DISARMED, STATE_ALARM_ARMED_HOME, STATE_ALARM_ARMED_AWAY,
-    STATE_ALARM_PENDING, STATE_ALARM_TRIGGERED, STATE_UNKNOWN)
+    STATE_ALARM_ARMED_AWAY, STATE_ALARM_ARMED_HOME, STATE_ALARM_DISARMED,
+    STATE_ALARM_PENDING, STATE_ALARM_TRIGGERED, STATE_UNKNOWN,
+    CONF_NAME)
+from homeassistant.components.mqtt import (
+    CONF_STATE_TOPIC, CONF_COMMAND_TOPIC, CONF_QOS)
+import homeassistant.helpers.config_validation as cv
 
 _LOGGER = logging.getLogger(__name__)
 
-DEFAULT_NAME = "MQTT Alarm"
-DEFAULT_QOS = 0
-DEFAULT_PAYLOAD_DISARM = "DISARM"
-DEFAULT_PAYLOAD_ARM_HOME = "ARM_HOME"
-DEFAULT_PAYLOAD_ARM_AWAY = "ARM_AWAY"
-
 DEPENDENCIES = ['mqtt']
 
+CONF_PAYLOAD_DISARM = 'payload_disarm'
+CONF_PAYLOAD_ARM_HOME = 'payload_arm_home'
+CONF_PAYLOAD_ARM_AWAY = 'payload_arm_away'
+CONF_CODE = 'code'
+
+DEFAULT_NAME = "MQTT Alarm"
+DEFAULT_DISARM = "DISARM"
+DEFAULT_ARM_HOME = "ARM_HOME"
+DEFAULT_ARM_AWAY = "ARM_AWAY"
+
+PLATFORM_SCHEMA = mqtt.MQTT_BASE_PLATFORM_SCHEMA.extend({
+    vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
+    vol.Required(CONF_STATE_TOPIC): mqtt.valid_subscribe_topic,
+    vol.Required(CONF_COMMAND_TOPIC): mqtt.valid_publish_topic,
+    vol.Optional(CONF_PAYLOAD_DISARM, default=DEFAULT_DISARM): cv.string,
+    vol.Optional(CONF_PAYLOAD_ARM_HOME, default=DEFAULT_ARM_HOME): cv.string,
+    vol.Optional(CONF_PAYLOAD_ARM_AWAY, default=DEFAULT_ARM_AWAY): cv.string,
+    vol.Optional(CONF_CODE): cv.string,
+})
+
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Sets up the MQTT platform. """
-
-    if config.get('state_topic') is None:
-        _LOGGER.error("Missing required variable: state_topic")
-        return False
-
-    if config.get('command_topic') is None:
-        _LOGGER.error("Missing required variable: command_topic")
-        return False
-
+    """Setup the MQTT platform."""
     add_devices([MqttAlarm(
         hass,
-        config.get('name', DEFAULT_NAME),
-        config.get('state_topic'),
-        config.get('command_topic'),
-        config.get('qos', DEFAULT_QOS),
-        config.get('payload_disarm', DEFAULT_PAYLOAD_DISARM),
-        config.get('payload_arm_home', DEFAULT_PAYLOAD_ARM_HOME),
-        config.get('payload_arm_away', DEFAULT_PAYLOAD_ARM_AWAY),
-        config.get('code'))])
+        config[CONF_NAME],
+        config[CONF_STATE_TOPIC],
+        config[CONF_COMMAND_TOPIC],
+        config[CONF_QOS],
+        config[CONF_PAYLOAD_DISARM],
+        config[CONF_PAYLOAD_ARM_HOME],
+        config[CONF_PAYLOAD_ARM_AWAY],
+        config.get(CONF_CODE))])
 
 
 # pylint: disable=too-many-arguments, too-many-instance-attributes
 # pylint: disable=abstract-method
 class MqttAlarm(alarm.AlarmControlPanel):
-    """ represents a MQTT alarm status within home assistant. """
+    """Represent a MQTT alarm status."""
 
     def __init__(self, hass, name, state_topic, command_topic, qos,
                  payload_disarm, payload_arm_home, payload_arm_away, code):
+        """Initalize the MQTT alarm panel."""
         self._state = STATE_UNKNOWN
         self._hass = hass
         self._name = name
@@ -64,10 +74,10 @@ class MqttAlarm(alarm.AlarmControlPanel):
         self._payload_disarm = payload_disarm
         self._payload_arm_home = payload_arm_home
         self._payload_arm_away = payload_arm_away
-        self._code = str(code) if code else None
+        self._code = code
 
         def message_received(topic, payload, qos):
-            """ A new MQTT message has been received. """
+            """A new MQTT message has been received."""
             if payload not in (STATE_ALARM_DISARMED, STATE_ALARM_ARMED_HOME,
                                STATE_ALARM_ARMED_AWAY, STATE_ALARM_PENDING,
                                STATE_ALARM_TRIGGERED):
@@ -80,47 +90,47 @@ class MqttAlarm(alarm.AlarmControlPanel):
 
     @property
     def should_poll(self):
-        """ No polling needed """
+        """No polling needed."""
         return False
 
     @property
     def name(self):
-        """ Returns the name of the device. """
+        """Return the name of the device."""
         return self._name
 
     @property
     def state(self):
-        """ Returns the state of the device. """
+        """Return the state of the device."""
         return self._state
 
     @property
     def code_format(self):
-        """ One or more characters if code is defined """
+        """One or more characters if code is defined."""
         return None if self._code is None else '.+'
 
     def alarm_disarm(self, code=None):
-        """ Send disarm command. """
+        """Send disarm command."""
         if not self._validate_code(code, 'disarming'):
             return
         mqtt.publish(self.hass, self._command_topic,
                      self._payload_disarm, self._qos)
 
     def alarm_arm_home(self, code=None):
-        """ Send arm home command. """
+        """Send arm home command."""
         if not self._validate_code(code, 'arming home'):
             return
         mqtt.publish(self.hass, self._command_topic,
                      self._payload_arm_home, self._qos)
 
     def alarm_arm_away(self, code=None):
-        """ Send arm away command. """
+        """Send arm away command."""
         if not self._validate_code(code, 'arming away'):
             return
         mqtt.publish(self.hass, self._command_topic,
                      self._payload_arm_away, self._qos)
 
     def _validate_code(self, code, state):
-        """ Validate given code. """
+        """Validate given code."""
         check = self._code is None or code == self._code
         if not check:
             _LOGGER.warning('Wrong code entered for %s', state)

homeassistant/components/alarm_control_panel/nx584.py

@@ -0,0 +1,105 @@
+"""
+Support for NX584 alarm control panels.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/alarm_control_panel.nx584/
+"""
+import logging
+
+import requests
+
+import homeassistant.components.alarm_control_panel as alarm
+from homeassistant.const import (
+    STATE_ALARM_ARMED_AWAY, STATE_ALARM_ARMED_HOME, STATE_ALARM_DISARMED,
+    STATE_UNKNOWN)
+
+REQUIREMENTS = ['pynx584==0.2']
+_LOGGER = logging.getLogger(__name__)
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup nx584 platform."""
+    host = config.get('host', 'localhost:5007')
+
+    try:
+        add_devices([NX584Alarm(hass, host, config.get('name', 'NX584'))])
+    except requests.exceptions.ConnectionError as ex:
+        _LOGGER.error('Unable to connect to NX584: %s', str(ex))
+        return False
+
+
+class NX584Alarm(alarm.AlarmControlPanel):
+    """Represents the NX584-based alarm panel."""
+
+    def __init__(self, hass, host, name):
+        """Initalize the nx584 alarm panel."""
+        from nx584 import client
+        self._hass = hass
+        self._host = host
+        self._name = name
+        self._alarm = client.Client('http://%s' % host)
+        # Do an initial list operation so that we will try to actually
+        # talk to the API and trigger a requests exception for setup_platform()
+        # to catch
+        self._alarm.list_zones()
+
+    @property
+    def should_poll(self):
+        """Polling needed."""
+        return True
+
+    @property
+    def name(self):
+        """Return the name of the device."""
+        return self._name
+
+    @property
+    def code_format(self):
+        """The characters if code is defined."""
+        return '[0-9]{4}([0-9]{2})?'
+
+    @property
+    def state(self):
+        """Return the state of the device."""
+        try:
+            part = self._alarm.list_partitions()[0]
+            zones = self._alarm.list_zones()
+        except requests.exceptions.ConnectionError as ex:
+            _LOGGER.error('Unable to connect to %(host)s: %(reason)s',
+                          dict(host=self._host, reason=ex))
+            return STATE_UNKNOWN
+        except IndexError:
+            _LOGGER.error('nx584 reports no partitions')
+            return STATE_UNKNOWN
+
+        bypassed = False
+        for zone in zones:
+            if zone['bypassed']:
+                _LOGGER.debug('Zone %(zone)s is bypassed, '
+                              'assuming HOME',
+                              dict(zone=zone['number']))
+                bypassed = True
+                break
+
+        if not part['armed']:
+            return STATE_ALARM_DISARMED
+        elif bypassed:
+            return STATE_ALARM_ARMED_HOME
+        else:
+            return STATE_ALARM_ARMED_AWAY
+
+    def alarm_disarm(self, code=None):
+        """Send disarm command."""
+        self._alarm.disarm(code)
+
+    def alarm_arm_home(self, code=None):
+        """Send arm home command."""
+        self._alarm.arm('home')
+
+    def alarm_arm_away(self, code=None):
+        """Send arm away command."""
+        self._alarm.arm('auto')
+
+    def alarm_trigger(self, code=None):
+        """Alarm trigger command."""
+        raise NotImplementedError()

homeassistant/components/alarm_control_panel/verisure.py

@@ -1,96 +1,90 @@
 """
-homeassistant.components.alarm_control_panel.verisure
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Interfaces with Verisure alarm control panel.
 
 For more details about this platform, please refer to the documentation at
-https://home-assistant.io/components/verisure/
+https://home-assistant.io/components/alarm_control_panel.verisure/
 """
 import logging
 
-import homeassistant.components.verisure as verisure
 import homeassistant.components.alarm_control_panel as alarm
+from homeassistant.components.verisure import HUB as hub
 
 from homeassistant.const import (
-    STATE_UNKNOWN,
-    STATE_ALARM_DISARMED, STATE_ALARM_ARMED_HOME, STATE_ALARM_ARMED_AWAY)
+    STATE_ALARM_ARMED_AWAY, STATE_ALARM_ARMED_HOME, STATE_ALARM_DISARMED,
+    STATE_UNKNOWN)
 
 _LOGGER = logging.getLogger(__name__)
 
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Sets up the Verisure platform. """
-
-    if not verisure.MY_PAGES:
-        _LOGGER.error('A connection has not been made to Verisure mypages.')
-        return False
-
+    """Setup the Verisure platform."""
     alarms = []
-
-    alarms.extend([
-        VerisureAlarm(value)
-        for value in verisure.ALARM_STATUS.values()
-        if verisure.SHOW_ALARM
-        ])
-
+    if int(hub.config.get('alarm', '1')):
+        hub.update_alarms()
+        alarms.extend([
+            VerisureAlarm(value.id)
+            for value in hub.alarm_status.values()
+            ])
     add_devices(alarms)
 
 
 # pylint: disable=abstract-method
 class VerisureAlarm(alarm.AlarmControlPanel):
-    """ Represents a Verisure alarm status. """
+    """Represent a Verisure alarm status."""
 
-    def __init__(self, alarm_status):
-        self._id = alarm_status.id
+    def __init__(self, device_id):
+        """Initalize the Verisure alarm panel."""
+        self._id = device_id
         self._state = STATE_UNKNOWN
+        self._digits = int(hub.config.get('code_digits', '4'))
 
     @property
     def name(self):
-        """ Returns the name of the device. """
+        """Return the name of the device."""
         return 'Alarm {}'.format(self._id)
 
     @property
     def state(self):
-        """ Returns the state of the device. """
+        """Return the state of the device."""
         return self._state
 
     @property
     def code_format(self):
-        """ Four digit code required. """
-        return '^\\d{%s}$' % verisure.CODE_DIGITS
+        """The code format as regex."""
+        return '^\\d{%s}$' % self._digits
 
     def update(self):
-        """ Update alarm status """
-        verisure.update_alarm()
+        """Update alarm status."""
+        hub.update_alarms()
 
-        if verisure.ALARM_STATUS[self._id].status == 'unarmed':
+        if hub.alarm_status[self._id].status == 'unarmed':
             self._state = STATE_ALARM_DISARMED
-        elif verisure.ALARM_STATUS[self._id].status == 'armedhome':
+        elif hub.alarm_status[self._id].status == 'armedhome':
             self._state = STATE_ALARM_ARMED_HOME
-        elif verisure.ALARM_STATUS[self._id].status == 'armed':
+        elif hub.alarm_status[self._id].status == 'armed':
             self._state = STATE_ALARM_ARMED_AWAY
-        elif verisure.ALARM_STATUS[self._id].status != 'pending':
+        elif hub.alarm_status[self._id].status != 'pending':
             _LOGGER.error(
                 'Unknown alarm state %s',
-                verisure.ALARM_STATUS[self._id].status)
+                hub.alarm_status[self._id].status)
 
     def alarm_disarm(self, code=None):
-        """ Send disarm command. """
-        verisure.MY_PAGES.alarm.set(code, 'DISARMED')
+        """Send disarm command."""
+        hub.my_pages.alarm.set(code, 'DISARMED')
         _LOGGER.info('verisure alarm disarming')
-        verisure.MY_PAGES.alarm.wait_while_pending()
-        verisure.update_alarm()
+        hub.my_pages.alarm.wait_while_pending()
+        self.update()
 
     def alarm_arm_home(self, code=None):
-        """ Send arm home command. """
-        verisure.MY_PAGES.alarm.set(code, 'ARMED_HOME')
+        """Send arm home command."""
+        hub.my_pages.alarm.set(code, 'ARMED_HOME')
         _LOGGER.info('verisure alarm arming home')
-        verisure.MY_PAGES.alarm.wait_while_pending()
-        verisure.update_alarm()
+        hub.my_pages.alarm.wait_while_pending()
+        self.update()
 
     def alarm_arm_away(self, code=None):
-        """ Send arm away command. """
-        verisure.MY_PAGES.alarm.set(code, 'ARMED_AWAY')
+        """Send arm away command."""
+        hub.my_pages.alarm.set(code, 'ARMED_AWAY')
         _LOGGER.info('verisure alarm arming away')
-        verisure.MY_PAGES.alarm.wait_while_pending()
-        verisure.update_alarm()
+        hub.my_pages.alarm.wait_while_pending()
+        self.update()

homeassistant/components/alexa.py

@@ -1,7 +1,5 @@
 """
-components.alexa
-~~~~~~~~~~~~~~~~
-Component to offer a service end point for an Alexa skill.
+Support for Alexa skill service end point.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/alexa/
@@ -10,8 +8,8 @@ import enum
 import logging
 
 from homeassistant.const import HTTP_OK, HTTP_UNPROCESSABLE_ENTITY
-from homeassistant.util import template
 from homeassistant.helpers.service import call_from_config
+from homeassistant.helpers import template
 
 DOMAIN = 'alexa'
 DEPENDENCIES = ['http']
@@ -28,7 +26,7 @@ CONF_ACTION = 'action'
 
 
 def setup(hass, config):
-    """ Activate Alexa component. """
+    """Activate Alexa component."""
     _CONFIG.update(config[DOMAIN].get(CONF_INTENTS, {}))
 
     hass.http.register_path('POST', API_ENDPOINT, _handle_alexa, True)
@@ -37,7 +35,7 @@ def setup(hass, config):
 
 
 def _handle_alexa(handler, path_match, data):
-    """ Handle Alexa. """
+    """Handle Alexa."""
     _LOGGER.debug('Received Alexa request: %s', data)
 
     req = data.get('request')
@@ -99,21 +97,24 @@ def _handle_alexa(handler, path_match, data):
 
 
 class SpeechType(enum.Enum):
-    """ Alexa speech types. """
+    """The Alexa speech types."""
+
     plaintext = "PlainText"
     ssml = "SSML"
 
 
 class CardType(enum.Enum):
-    """ Alexa card types. """
+    """The Alexa card types."""
+
     simple = "Simple"
     link_account = "LinkAccount"
 
 
 class AlexaResponse(object):
-    """ Helps generating the response for Alexa. """
+    """Help generating the response for Alexa."""
 
     def __init__(self, hass, intent=None):
+        """Initialize the response."""
         self.hass = hass
         self.speech = None
         self.card = None
@@ -127,7 +128,7 @@ class AlexaResponse(object):
             self.variables = {}
 
     def add_card(self, card_type, title, content):
-        """ Add a card to the response. """
+        """Add a card to the response."""
         assert self.card is None
 
         card = {
@@ -143,7 +144,7 @@ class AlexaResponse(object):
         self.card = card
 
     def add_speech(self, speech_type, text):
-        """ Add speech to the response. """
+        """Add speech to the response."""
         assert self.speech is None
 
         key = 'ssml' if speech_type == SpeechType.ssml else 'text'
@@ -154,7 +155,7 @@ class AlexaResponse(object):
         }
 
     def add_reprompt(self, speech_type, text):
-        """ Add repromopt if user does not answer. """
+        """Add reprompt if user does not answer."""
         assert self.reprompt is None
 
         key = 'ssml' if speech_type == SpeechType.ssml else 'text'
@@ -165,7 +166,7 @@ class AlexaResponse(object):
         }
 
     def as_dict(self):
-        """ Returns response in an Alexa valid dict. """
+        """Return response in an Alexa valid dict."""
         response = {
             'shouldEndSession': self.should_end_session
         }
@@ -188,5 +189,5 @@ class AlexaResponse(object):
         }
 
     def _render(self, template_string):
-        """ Render a response, adding data from intent if available. """
+        """Render a response, adding data from intent if available."""
         return template.render(self.hass, template_string, self.variables)

homeassistant/components/apcupsd.py

@@ -0,0 +1,82 @@
+"""
+Support for status output of APCUPSd via its Network Information Server (NIS).
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/apcupsd/
+"""
+import logging
+from datetime import timedelta
+
+from homeassistant.util import Throttle
+
+DOMAIN = "apcupsd"
+REQUIREMENTS = ("apcaccess==0.0.4",)
+
+CONF_HOST = "host"
+CONF_PORT = "port"
+CONF_TYPE = "type"
+
+DEFAULT_HOST = "localhost"
+DEFAULT_PORT = 3551
+
+KEY_STATUS = "STATUS"
+
+VALUE_ONLINE = "ONLINE"
+
+MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=60)
+
+DATA = None
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def setup(hass, config):
+    """Use config values to set up a function enabling status retrieval."""
+    global DATA
+
+    host = config[DOMAIN].get(CONF_HOST, DEFAULT_HOST)
+    port = config[DOMAIN].get(CONF_PORT, DEFAULT_PORT)
+
+    DATA = APCUPSdData(host, port)
+
+    # It doesn't really matter why we're not able to get the status, just that
+    # we can't.
+    # pylint: disable=broad-except
+    try:
+        DATA.update(no_throttle=True)
+    except Exception:
+        _LOGGER.exception("Failure while testing APCUPSd status retrieval.")
+        return False
+    return True
+
+
+class APCUPSdData(object):
+    """Stores the data retrieved from APCUPSd.
+
+    For each entity to use, acts as the single point responsible for fetching
+    updates from the server.
+    """
+
+    def __init__(self, host, port):
+        """Initialize the data oject."""
+        from apcaccess import status
+        self._host = host
+        self._port = port
+        self._status = None
+        self._get = status.get
+        self._parse = status.parse
+
+    @property
+    def status(self):
+        """Get latest update if throttle allows. Return status."""
+        self.update()
+        return self._status
+
+    def _get_status(self):
+        """Get the status from APCUPSd and parse it into a dict."""
+        return self._parse(self._get(host=self._host, port=self._port))
+
+    @Throttle(MIN_TIME_BETWEEN_UPDATES)
+    def update(self, **kwargs):
+        """Fetch the latest status from APCUPSd."""
+        self._status = self._get_status()

homeassistant/components/api.py

@@ -1,31 +1,27 @@
 """
-homeassistant.components.api
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Provides a Rest API for Home Assistant.
+Rest API for Home Assistant.
 
 For more details about the RESTful API, please refer to the documentation at
 https://home-assistant.io/developers/api/
 """
-import re
-import logging
-import threading
 import json
+import logging
+import re
+import threading
 
 import homeassistant.core as ha
-from homeassistant.exceptions import TemplateError
-from homeassistant.helpers.state import TrackStates
 import homeassistant.remote as rem
-from homeassistant.util import template
 from homeassistant.bootstrap import ERROR_LOG_FILENAME
 from homeassistant.const import (
-    URL_API, URL_API_STATES, URL_API_EVENTS, URL_API_SERVICES, URL_API_STREAM,
-    URL_API_EVENT_FORWARD, URL_API_STATES_ENTITY, URL_API_COMPONENTS,
-    URL_API_CONFIG, URL_API_BOOTSTRAP, URL_API_ERROR_LOG, URL_API_LOG_OUT,
-    URL_API_TEMPLATE, EVENT_TIME_CHANGED, EVENT_HOMEASSISTANT_STOP, MATCH_ALL,
-    HTTP_OK, HTTP_CREATED, HTTP_BAD_REQUEST, HTTP_NOT_FOUND,
-    HTTP_UNPROCESSABLE_ENTITY, HTTP_HEADER_CONTENT_TYPE,
-    CONTENT_TYPE_TEXT_PLAIN)
-
+    CONTENT_TYPE_TEXT_PLAIN, EVENT_HOMEASSISTANT_STOP, EVENT_TIME_CHANGED,
+    HTTP_BAD_REQUEST, HTTP_CREATED, HTTP_HEADER_CONTENT_TYPE, HTTP_NOT_FOUND,
+    HTTP_OK, HTTP_UNPROCESSABLE_ENTITY, MATCH_ALL, URL_API, URL_API_COMPONENTS,
+    URL_API_CONFIG, URL_API_ERROR_LOG, URL_API_EVENT_FORWARD, URL_API_EVENTS,
+    URL_API_LOG_OUT, URL_API_SERVICES, URL_API_STATES, URL_API_STATES_ENTITY,
+    URL_API_STREAM, URL_API_TEMPLATE)
+from homeassistant.exceptions import TemplateError
+from homeassistant.helpers.state import TrackStates
+from homeassistant.helpers import template
 
 DOMAIN = 'api'
 DEPENDENCIES = ['http']
@@ -37,8 +33,7 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def setup(hass, config):
-    """ Register the API with the HTTP interface. """
-
+    """Register the API with the HTTP interface."""
     # /api - for validation purposes
     hass.http.register_path('GET', URL_API, _handle_get_api)
 
@@ -48,10 +43,6 @@ def setup(hass, config):
     # /api/config
     hass.http.register_path('GET', URL_API_CONFIG, _handle_get_api_config)
 
-    # /api/bootstrap
-    hass.http.register_path(
-        'GET', URL_API_BOOTSTRAP, _handle_get_api_bootstrap)
-
     # /states
     hass.http.register_path('GET', URL_API_STATES, _handle_get_api_states)
     hass.http.register_path(
@@ -63,6 +54,9 @@ def setup(hass, config):
     hass.http.register_path(
         'PUT', re.compile(r'/api/states/(?P<entity_id>[a-zA-Z\._0-9]+)'),
         _handle_post_state_entity)
+    hass.http.register_path(
+        'DELETE', re.compile(r'/api/states/(?P<entity_id>[a-zA-Z\._0-9]+)'),
+        _handle_delete_state_entity)
 
     # /events
     hass.http.register_path('GET', URL_API_EVENTS, _handle_get_api_events)
@@ -89,11 +83,13 @@ def setup(hass, config):
     hass.http.register_path(
         'GET', URL_API_COMPONENTS, _handle_get_api_components)
 
+    # /error_log
     hass.http.register_path('GET', URL_API_ERROR_LOG,
                             _handle_get_api_error_log)
 
     hass.http.register_path('POST', URL_API_LOG_OUT, _handle_post_api_log_out)
 
+    # /template
     hass.http.register_path('POST', URL_API_TEMPLATE,
                             _handle_post_api_template)
 
@@ -101,12 +97,12 @@ def setup(hass, config):
 
 
 def _handle_get_api(handler, path_match, data):
-    """ Renders the debug interface. """
+    """Render the debug interface."""
     handler.write_json_message("API running.")
 
 
 def _handle_get_api_stream(handler, path_match, data):
-    """ Provide a streaming interface for the event bus. """
+    """Provide a streaming interface for the event bus."""
     gracefully_closed = False
     hass = handler.server.hass
     wfile = handler.wfile
@@ -119,7 +115,7 @@ def _handle_get_api_stream(handler, path_match, data):
         restrict = restrict.split(',')
 
     def write_message(payload):
-        """ Writes a message to the output. """
+        """Write a message to the output."""
         with write_lock:
             msg = "data: {}\n\n".format(payload)
 
@@ -132,7 +128,7 @@ def _handle_get_api_stream(handler, path_match, data):
                 block.set()
 
     def forward_events(event):
-        """ Forwards events to the open request. """
+        """Forward events to the open request."""
         nonlocal gracefully_closed
 
         if block.is_set() or event.event_type == EVENT_TIME_CHANGED:
@@ -176,29 +172,17 @@ def _handle_get_api_stream(handler, path_match, data):
 
 
 def _handle_get_api_config(handler, path_match, data):
-    """ Returns the Home Assistant config. """
+    """Return the Home Assistant configuration."""
     handler.write_json(handler.server.hass.config.as_dict())
 
 
-def _handle_get_api_bootstrap(handler, path_match, data):
-    """ Returns all data needed to bootstrap Home Assistant. """
-    hass = handler.server.hass
-
-    handler.write_json({
-        'config': hass.config.as_dict(),
-        'states': hass.states.all(),
-        'events': _events_json(hass),
-        'services': _services_json(hass),
-    })
-
-
 def _handle_get_api_states(handler, path_match, data):
-    """ Returns a dict containing all entity ids and their state. """
+    """Return a dict containing all entity ids and their state."""
     handler.write_json(handler.server.hass.states.all())
 
 
 def _handle_get_api_states_entity(handler, path_match, data):
-    """ Returns the state of a specific entity. """
+    """Return the state of a specific entity."""
     entity_id = path_match.group('entity_id')
 
     state = handler.server.hass.states.get(entity_id)
@@ -210,7 +194,7 @@ def _handle_get_api_states_entity(handler, path_match, data):
 
 
 def _handle_post_state_entity(handler, path_match, data):
-    """ Handles updating the state of an entity.
+    """Handle updating the state of an entity.
 
     This handles the following paths:
     /api/states/<entity_id>
@@ -240,16 +224,31 @@ def _handle_post_state_entity(handler, path_match, data):
         location=URL_API_STATES_ENTITY.format(entity_id))
 
 
+def _handle_delete_state_entity(handler, path_match, data):
+    """Handle request to delete an entity from state machine.
+
+    This handles the following paths:
+    /api/states/<entity_id>
+    """
+    entity_id = path_match.group('entity_id')
+
+    if handler.server.hass.states.remove(entity_id):
+        handler.write_json_message(
+            "Entity not found", HTTP_NOT_FOUND)
+    else:
+        handler.write_json_message(
+            "Entity removed", HTTP_OK)
+
+
 def _handle_get_api_events(handler, path_match, data):
-    """ Handles getting overview of event listeners. """
-    handler.write_json(_events_json(handler.server.hass))
+    """Handle getting overview of event listeners."""
+    handler.write_json(events_json(handler.server.hass))
 
 
 def _handle_api_post_events_event(handler, path_match, event_data):
-    """ Handles firing of an event.
+    """Handle firing of an event.
 
-    This handles the following paths:
-    /api/events/<event_type>
+    This handles the following paths: /api/events/<event_type>
 
     Events from /api are threated as remote events.
     """
@@ -258,6 +257,7 @@ def _handle_api_post_events_event(handler, path_match, event_data):
     if event_data is not None and not isinstance(event_data, dict):
         handler.write_json_message(
             "event_data should be an object", HTTP_UNPROCESSABLE_ENTITY)
+        return
 
     event_origin = ha.EventOrigin.remote
 
@@ -276,16 +276,15 @@ def _handle_api_post_events_event(handler, path_match, event_data):
 
 
 def _handle_get_api_services(handler, path_match, data):
-    """ Handles getting overview of services. """
-    handler.write_json(_services_json(handler.server.hass))
+    """Handle getting overview of services."""
+    handler.write_json(services_json(handler.server.hass))
 
 
 # pylint: disable=invalid-name
 def _handle_post_api_services_domain_service(handler, path_match, data):
-    """ Handles calling a service.
+    """Handle calling a service.
 
-    This handles the following paths:
-    /api/services/<domain>/<service>
+    This handles the following paths: /api/services/<domain>/<service>
     """
     domain = path_match.group('domain')
     service = path_match.group('service')
@@ -298,8 +297,7 @@ def _handle_post_api_services_domain_service(handler, path_match, data):
 
 # pylint: disable=invalid-name
 def _handle_post_api_event_forward(handler, path_match, data):
-    """ Handles adding an event forwarding target. """
-
+    """Handle adding an event forwarding target."""
     try:
         host = data['host']
         api_password = data['api_password']
@@ -332,8 +330,7 @@ def _handle_post_api_event_forward(handler, path_match, data):
 
 
 def _handle_delete_api_event_forward(handler, path_match, data):
-    """ Handles deleting an event forwarding target. """
-
+    """Handle deleting an event forwarding target."""
     try:
         host = data['host']
     except KeyError:
@@ -356,26 +353,25 @@ def _handle_delete_api_event_forward(handler, path_match, data):
 
 
 def _handle_get_api_components(handler, path_match, data):
-    """ Returns all the loaded components. """
-
+    """Return all the loaded components."""
     handler.write_json(handler.server.hass.config.components)
 
 
 def _handle_get_api_error_log(handler, path_match, data):
-    """ Returns the logged errors for this session. """
+    """Return the logged errors for this session."""
     handler.write_file(handler.server.hass.config.path(ERROR_LOG_FILENAME),
                        False)
 
 
 def _handle_post_api_log_out(handler, path_match, data):
-    """ Log user out. """
+    """Log user out."""
     handler.send_response(HTTP_OK)
     handler.destroy_session()
     handler.end_headers()
 
 
 def _handle_post_api_template(handler, path_match, data):
-    """ Log user out. """
+    """Log user out."""
     template_string = data.get('template', '')
 
     try:
@@ -390,13 +386,13 @@ def _handle_post_api_template(handler, path_match, data):
         return
 
 
-def _services_json(hass):
-    """ Generate services data to JSONify. """
+def services_json(hass):
+    """Generate services data to JSONify."""
     return [{"domain": key, "services": value}
             for key, value in hass.services.services.items()]
 
 
-def _events_json(hass):
-    """ Generate event data to JSONify. """
+def events_json(hass):
+    """Generate event data to JSONify."""
     return [{"event": key, "listener_count": value}
             for key, value in hass.bus.listeners.items()]

homeassistant/components/arduino.py

@@ -1,22 +1,14 @@
 """
-components.arduino
-~~~~~~~~~~~~~~~~~~
-Arduino component that connects to a directly attached Arduino board which
-runs with the Firmata firmware.
+Support for Arduino boards running with the Firmata firmware.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/arduino/
 """
 import logging
 
-try:
-    from PyMata.pymata import PyMata
-except ImportError:
-    PyMata = None
-
+from homeassistant.const import (
+    EVENT_HOMEASSISTANT_START, EVENT_HOMEASSISTANT_STOP)
 from homeassistant.helpers import validate_config
-from homeassistant.const import (EVENT_HOMEASSISTANT_START,
-                                 EVENT_HOMEASSISTANT_STOP)
 
 DOMAIN = "arduino"
 REQUIREMENTS = ['PyMata==2.07a']
@@ -25,20 +17,13 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def setup(hass, config):
-    """ Setup the Arduino component. """
-
-    global PyMata  # pylint: disable=invalid-name
-    if PyMata is None:
-        from PyMata.pymata import PyMata as PyMata_
-        PyMata = PyMata_
-
-    import serial
-
+    """Setup the Arduino component."""
     if not validate_config(config,
                            {DOMAIN: ['port']},
                            _LOGGER):
         return False
 
+    import serial
     global BOARD
     try:
         BOARD = ArduinoBoard(config[DOMAIN]['port'])
@@ -51,11 +36,11 @@ def setup(hass, config):
         return False
 
     def stop_arduino(event):
-        """ Stop the Arduino service. """
+        """Stop the Arduino service."""
         BOARD.disconnect()
 
     def start_arduino(event):
-        """ Start the Arduino service. """
+        """Start the Arduino service."""
         hass.bus.listen_once(EVENT_HOMEASSISTANT_STOP, stop_arduino)
 
     hass.bus.listen_once(EVENT_HOMEASSISTANT_START, start_arduino)
@@ -64,14 +49,16 @@ def setup(hass, config):
 
 
 class ArduinoBoard(object):
-    """ Represents an Arduino board. """
+    """Representation of an Arduino board."""
 
     def __init__(self, port):
+        """Initialize the board."""
+        from PyMata.pymata import PyMata
         self._port = port
         self._board = PyMata(self._port, verbose=False)
 
     def set_mode(self, pin, direction, mode):
-        """ Sets the mode and the direction of a given pin. """
+        """Set the mode and the direction of a given pin."""
         if mode == 'analog' and direction == 'in':
             self._board.set_pin_mode(pin,
                                      self._board.INPUT,
@@ -94,31 +81,31 @@ class ArduinoBoard(object):
                                      self._board.PWM)
 
     def get_analog_inputs(self):
-        """ Get the values from the pins. """
+        """Get the values from the pins."""
         self._board.capability_query()
         return self._board.get_analog_response_table()
 
     def set_digital_out_high(self, pin):
-        """ Sets a given digital pin to high. """
+        """Set a given digital pin to high."""
         self._board.digital_write(pin, 1)
 
     def set_digital_out_low(self, pin):
-        """ Sets a given digital pin to low. """
+        """Set a given digital pin to low."""
         self._board.digital_write(pin, 0)
 
     def get_digital_in(self, pin):
-        """ Gets the value from a given digital pin. """
+        """Get the value from a given digital pin."""
         self._board.digital_read(pin)
 
     def get_analog_in(self, pin):
-        """ Gets the value from a given analog pin. """
+        """Get the value from a given analog pin."""
         self._board.analog_read(pin)
 
     def get_firmata(self):
-        """ Return the version of the Firmata firmware. """
+        """Return the version of the Firmata firmware."""
         return self._board.get_firmata_version()
 
     def disconnect(self):
-        """ Disconnects the board and closes the serial connection. """
+        """Disconnect the board and close the serial connection."""
         self._board.reset()
         self._board.close()

homeassistant/components/automation/__init__.py

@@ -1,24 +1,26 @@
 """
-homeassistant.components.automation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Allows to setup simple automation rules via the config file.
+Allow to setup simple automation rules via the config file.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/automation/
 """
 import logging
 
+import voluptuous as vol
+
 from homeassistant.bootstrap import prepare_setup_platform
 from homeassistant.const import CONF_PLATFORM
 from homeassistant.components import logbook
+from homeassistant.helpers import extract_domain_configs
 from homeassistant.helpers.service import call_from_config
+from homeassistant.loader import get_platform
+import homeassistant.helpers.config_validation as cv
 
 DOMAIN = 'automation'
 
 DEPENDENCIES = ['group']
 
 CONF_ALIAS = 'alias'
-CONF_SERVICE = 'service'
 
 CONF_CONDITION = 'condition'
 CONF_ACTION = 'action'
@@ -31,47 +33,85 @@ CONDITION_TYPE_OR = 'or'
 
 DEFAULT_CONDITION_TYPE = CONDITION_TYPE_AND
 
+METHOD_TRIGGER = 'trigger'
+METHOD_IF_ACTION = 'if_action'
+
 _LOGGER = logging.getLogger(__name__)
 
 
+def _platform_validator(method, schema):
+    """Generate platform validator for different steps."""
+    def validator(config):
+        """Validate it is a valid  platform."""
+        platform = get_platform(DOMAIN, config[CONF_PLATFORM])
+
+        if not hasattr(platform, method):
+            raise vol.Invalid('invalid method platform')
+
+        if not hasattr(platform, schema):
+            return config
+
+        print('validating config', method, config)
+
+        return getattr(platform, schema)(config)
+
+    return validator
+
+_TRIGGER_SCHEMA = vol.All(
+    cv.ensure_list,
+    [
+        vol.All(
+            vol.Schema({
+                vol.Required(CONF_PLATFORM): cv.platform_validator(DOMAIN)
+            }, extra=vol.ALLOW_EXTRA),
+            _platform_validator(METHOD_TRIGGER, 'TRIGGER_SCHEMA')
+        ),
+    ]
+)
+
+_CONDITION_SCHEMA = vol.Any(
+    CONDITION_USE_TRIGGER_VALUES,
+    vol.All(
+        cv.ensure_list,
+        [
+            vol.All(
+                vol.Schema({
+                    vol.Required(CONF_PLATFORM): cv.platform_validator(DOMAIN),
+                }, extra=vol.ALLOW_EXTRA),
+                _platform_validator(METHOD_IF_ACTION, 'IF_ACTION_SCHEMA'),
+            )
+        ]
+    )
+)
+
+PLATFORM_SCHEMA = vol.Schema({
+    CONF_ALIAS: cv.string,
+    vol.Required(CONF_TRIGGER): _TRIGGER_SCHEMA,
+    vol.Required(CONF_CONDITION_TYPE, default=DEFAULT_CONDITION_TYPE):
+        vol.All(vol.Lower, vol.Any(CONDITION_TYPE_AND, CONDITION_TYPE_OR)),
+    CONF_CONDITION: _CONDITION_SCHEMA,
+    vol.Required(CONF_ACTION): cv.SERVICE_SCHEMA,
+})
+
+
 def setup(hass, config):
-    """ Sets up automation. """
-    config_key = DOMAIN
-    found = 1
+    """Setup the automation."""
+    for config_key in extract_domain_configs(config, DOMAIN):
+        conf = config[config_key]
 
-    while config_key in config:
-        # check for one block syntax
-        if isinstance(config[config_key], dict):
-            config_block = _migrate_old_config(config[config_key])
-            name = config_block.get(CONF_ALIAS, config_key)
+        for list_no, config_block in enumerate(conf):
+            name = config_block.get(CONF_ALIAS, "{}, {}".format(config_key,
+                                                                list_no))
             _setup_automation(hass, config_block, name, config)
 
-        # check for multiple block syntax
-        elif isinstance(config[config_key], list):
-            for list_no, config_block in enumerate(config[config_key]):
-                name = config_block.get(CONF_ALIAS,
-                                        "{}, {}".format(config_key, list_no))
-                _setup_automation(hass, config_block, name, config)
-
-        # any scalar value is incorrect
-        else:
-            _LOGGER.error('Error in config in section %s.', config_key)
-
-        found += 1
-        config_key = "{} {}".format(DOMAIN, found)
-
     return True
 
 
 def _setup_automation(hass, config_block, name, config):
-    """ Setup one instance of automation """
-
+    """Setup one instance of automation."""
     action = _get_action(hass, config_block.get(CONF_ACTION, {}), name)
 
-    if action is None:
-        return False
-
-    if CONF_CONDITION in config_block or CONF_CONDITION_TYPE in config_block:
+    if CONF_CONDITION in config_block:
         action = _process_if(hass, config, config_block, action)
 
         if action is None:
@@ -83,14 +123,9 @@ def _setup_automation(hass, config_block, name, config):
 
 
 def _get_action(hass, config, name):
-    """ Return an action based on a config. """
-
-    if CONF_SERVICE not in config:
-        _LOGGER.error('Error setting up %s, no action specified.', name)
-        return None
-
+    """Return an action based on a configuration."""
     def action():
-        """ Action to be executed. """
+        """Action to be executed."""
         _LOGGER.info('Executing %s', name)
         logbook.log_entry(hass, name, 'has been triggered', DOMAIN)
 
@@ -99,43 +134,8 @@ def _get_action(hass, config, name):
     return action
 
 
-def _migrate_old_config(config):
-    """ Migrate old config to new. """
-    if CONF_PLATFORM not in config:
-        return config
-
-    _LOGGER.warning(
-        'You are using an old configuration format. Please upgrade: '
-        'https://home-assistant.io/components/automation/')
-
-    new_conf = {
-        CONF_TRIGGER: dict(config),
-        CONF_CONDITION: config.get('if', []),
-        CONF_ACTION: dict(config),
-    }
-
-    for cat, key, new_key in (('trigger', 'mqtt_topic', 'topic'),
-                              ('trigger', 'mqtt_payload', 'payload'),
-                              ('trigger', 'state_entity_id', 'entity_id'),
-                              ('trigger', 'state_before', 'before'),
-                              ('trigger', 'state_after', 'after'),
-                              ('trigger', 'state_to', 'to'),
-                              ('trigger', 'state_from', 'from'),
-                              ('trigger', 'state_hours', 'hours'),
-                              ('trigger', 'state_minutes', 'minutes'),
-                              ('trigger', 'state_seconds', 'seconds'),
-                              ('action', 'execute_service', 'service'),
-                              ('action', 'service_entity_id', 'entity_id'),
-                              ('action', 'service_data', 'data')):
-        if key in new_conf[cat]:
-            new_conf[cat][new_key] = new_conf[cat].pop(key)
-
-    return new_conf
-
-
 def _process_if(hass, config, p_config, action):
-    """ Processes if checks. """
-
+    """Process if checks."""
     cond_type = p_config.get(CONF_CONDITION_TYPE,
                              DEFAULT_CONDITION_TYPE).lower()
 
@@ -145,12 +145,9 @@ def _process_if(hass, config, p_config, action):
     if use_trigger:
         if_configs = p_config[CONF_TRIGGER]
 
-    if isinstance(if_configs, dict):
-        if_configs = [if_configs]
-
     checks = []
     for if_config in if_configs:
-        platform = _resolve_platform('if_action', hass, config,
+        platform = _resolve_platform(METHOD_IF_ACTION, hass, config,
                                      if_config.get(CONF_PLATFORM))
         if platform is None:
             continue
@@ -165,12 +162,12 @@ def _process_if(hass, config, p_config, action):
 
     if cond_type == CONDITION_TYPE_AND:
         def if_action():
-            """ AND all conditions. """
+            """AND all conditions."""
             if all(check() for check in checks):
                 action()
     else:
         def if_action():
-            """ OR all conditions. """
+            """OR all conditions."""
             if any(check() for check in checks):
                 action()
 
@@ -178,12 +175,12 @@ def _process_if(hass, config, p_config, action):
 
 
 def _process_trigger(hass, config, trigger_configs, name, action):
-    """ Setup triggers. """
+    """Setup the triggers."""
     if isinstance(trigger_configs, dict):
         trigger_configs = [trigger_configs]
 
     for conf in trigger_configs:
-        platform = _resolve_platform('trigger', hass, config,
+        platform = _resolve_platform(METHOD_TRIGGER, hass, config,
                                      conf.get(CONF_PLATFORM))
         if platform is None:
             continue
@@ -195,7 +192,7 @@ def _process_trigger(hass, config, trigger_configs, name, action):
 
 
 def _resolve_platform(method, hass, config, platform):
-    """ Find automation platform. """
+    """Find the automation platform."""
     if platform is None:
         return None
     platform = prepare_setup_platform(hass, config, DOMAIN, platform)

homeassistant/components/automation/event.py

@@ -1,7 +1,5 @@
 """
-homeassistant.components.automation.event
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Offers event listening automation rules.
+Offer event listening automation rules.
 
 For more details about this automation rule, please refer to the documentation
 at https://home-assistant.io/components/automation/#event-trigger
@@ -15,7 +13,7 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def trigger(hass, config, action):
-    """ Listen for events based on config. """
+    """Listen for events based on configuration."""
     event_type = config.get(CONF_EVENT_TYPE)
 
     if event_type is None:
@@ -25,7 +23,7 @@ def trigger(hass, config, action):
     event_data = config.get(CONF_EVENT_DATA)
 
     def handle_event(event):
-        """ Listens for events and calls the action when data matches. """
+        """Listen for events and calls the action when data matches."""
         if not event_data or all(val == event.data.get(key) for key, val
                                  in event_data.items()):
             action()

homeassistant/components/automation/mqtt.py

@@ -1,33 +1,34 @@
 """
-homeassistant.components.automation.mqtt
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Offers MQTT listening automation rules.
+Offer MQTT listening automation rules.
 
 For more details about this automation rule, please refer to the documentation
 at https://home-assistant.io/components/automation/#mqtt-trigger
 """
-import logging
+import voluptuous as vol
 
 import homeassistant.components.mqtt as mqtt
+from homeassistant.const import CONF_PLATFORM
+import homeassistant.helpers.config_validation as cv
 
 DEPENDENCIES = ['mqtt']
 
 CONF_TOPIC = 'topic'
 CONF_PAYLOAD = 'payload'
 
+TRIGGER_SCHEMA = vol.Schema({
+    vol.Required(CONF_PLATFORM): mqtt.DOMAIN,
+    vol.Required(CONF_TOPIC): mqtt.valid_subscribe_topic,
+    vol.Optional(CONF_PAYLOAD): cv.string,
+})
+
 
 def trigger(hass, config, action):
-    """ Listen for state changes based on `config`. """
-    topic = config.get(CONF_TOPIC)
+    """Listen for state changes based on configuration."""
+    topic = config[CONF_TOPIC]
     payload = config.get(CONF_PAYLOAD)
 
-    if topic is None:
-        logging.getLogger(__name__).error(
-            "Missing configuration key %s", CONF_TOPIC)
-        return False
-
     def mqtt_automation_listener(msg_topic, msg_payload, qos):
-        """ Listens for MQTT messages. """
+        """Listen for MQTT messages."""
         if payload is None or payload == msg_payload:
             action()
 

homeassistant/components/automation/numeric_state.py

@@ -1,18 +1,15 @@
 """
-homeassistant.components.automation.numeric_state
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Offers numeric state listening automation rules.
+Offer numeric state listening automation rules.
 
 For more details about this automation rule, please refer to the documentation
 at https://home-assistant.io/components/automation/#numeric-state-trigger
 """
-from functools import partial
 import logging
+from functools import partial
 
 from homeassistant.const import CONF_VALUE_TEMPLATE
 from homeassistant.helpers.event import track_state_change
-from homeassistant.util import template
-
+from homeassistant.helpers import template
 
 CONF_ENTITY_ID = "entity_id"
 CONF_BELOW = "below"
@@ -22,7 +19,7 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def _renderer(hass, value_template, state):
-    """Render state value."""
+    """Render the state value."""
     if value_template is None:
         return state.state
 
@@ -30,7 +27,7 @@ def _renderer(hass, value_template, state):
 
 
 def trigger(hass, config, action):
-    """ Listen for state changes based on `config`. """
+    """Listen for state changes based on configuration."""
     entity_id = config.get(CONF_ENTITY_ID)
 
     if entity_id is None:
@@ -51,8 +48,7 @@ def trigger(hass, config, action):
 
     # pylint: disable=unused-argument
     def state_automation_listener(entity, from_s, to_s):
-        """ Listens for state changes and calls action. """
-
+        """Listen for state changes and calls action."""
         # Fire action if we go from outside range into range
         if _in_range(above, below, renderer(to_s)) and \
            (from_s is None or not _in_range(above, below, renderer(from_s))):
@@ -65,8 +61,7 @@ def trigger(hass, config, action):
 
 
 def if_action(hass, config):
-    """ Wraps action method with state based condition. """
-
+    """Wrap action method with state based condition."""
     entity_id = config.get(CONF_ENTITY_ID)
 
     if entity_id is None:
@@ -86,7 +81,7 @@ def if_action(hass, config):
     renderer = partial(_renderer, hass, value_template)
 
     def if_numeric_state():
-        """ Test numeric state condition. """
+        """Test numeric state condition."""
         state = hass.states.get(entity_id)
         return state is not None and _in_range(above, below, renderer(state))
 
@@ -94,7 +89,7 @@ def if_action(hass, config):
 
 
 def _in_range(range_start, range_end, value):
-    """ Checks if value is inside the range """
+    """Check if value is inside the range."""
     try:
         value = float(value)
     except ValueError:

homeassistant/components/automation/state.py

@@ -1,43 +1,101 @@
 """
-homeassistant.components.automation.state
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Offers state listening automation rules.
+Offer state listening automation rules.
 
 For more details about this automation rule, please refer to the documentation
 at https://home-assistant.io/components/automation/#state-trigger
 """
-import logging
+from datetime import timedelta
 
-from homeassistant.helpers.event import track_state_change
-from homeassistant.const import MATCH_ALL
+import voluptuous as vol
 
+import homeassistant.util.dt as dt_util
+from homeassistant.const import (
+    EVENT_STATE_CHANGED, EVENT_TIME_CHANGED, MATCH_ALL, CONF_PLATFORM)
+from homeassistant.components.automation.time import (
+    CONF_HOURS, CONF_MINUTES, CONF_SECONDS)
+from homeassistant.helpers.event import track_state_change, track_point_in_time
+import homeassistant.helpers.config_validation as cv
 
 CONF_ENTITY_ID = "entity_id"
 CONF_FROM = "from"
 CONF_TO = "to"
 CONF_STATE = "state"
+CONF_FOR = "for"
+
+BASE_SCHEMA = vol.Schema({
+    vol.Required(CONF_PLATFORM): 'state',
+    vol.Required(CONF_ENTITY_ID): cv.entity_id,
+    # These are str on purpose. Want to catch YAML conversions
+    CONF_STATE: str,
+    CONF_FOR: vol.All(vol.Schema({
+        CONF_HOURS: vol.Coerce(int),
+        CONF_MINUTES: vol.Coerce(int),
+        CONF_SECONDS: vol.Coerce(int),
+    }), cv.has_at_least_one_key(CONF_HOURS, CONF_MINUTES, CONF_SECONDS)),
+})
+
+TRIGGER_SCHEMA = vol.Schema(vol.All(
+    BASE_SCHEMA.extend({
+        # These are str on purpose. Want to catch YAML conversions
+        CONF_FROM: str,
+        CONF_TO: str,
+    }),
+    vol.Any(cv.key_dependency(CONF_FOR, CONF_TO),
+            cv.key_dependency(CONF_FOR, CONF_STATE))
+))
+
+IF_ACTION_SCHEMA = vol.Schema(vol.All(
+    BASE_SCHEMA,
+    cv.key_dependency(CONF_FOR, CONF_STATE)
+))
+
+
+def get_time_config(config):
+    """Helper function to extract the time specified in the configuration."""
+    if CONF_FOR not in config:
+        return None
+
+    hours = config[CONF_FOR].get(CONF_HOURS)
+    minutes = config[CONF_FOR].get(CONF_MINUTES)
+    seconds = config[CONF_FOR].get(CONF_SECONDS)
+
+    return timedelta(hours=(hours or 0.0),
+                     minutes=(minutes or 0.0),
+                     seconds=(seconds or 0.0))
 
 
 def trigger(hass, config, action):
-    """ Listen for state changes based on `config`. """
+    """Listen for state changes based on configuration."""
     entity_id = config.get(CONF_ENTITY_ID)
-
-    if entity_id is None:
-        logging.getLogger(__name__).error(
-            "Missing trigger configuration key %s", CONF_ENTITY_ID)
-        return False
-
     from_state = config.get(CONF_FROM, MATCH_ALL)
     to_state = config.get(CONF_TO) or config.get(CONF_STATE) or MATCH_ALL
-
-    if isinstance(from_state, bool) or isinstance(to_state, bool):
-        logging.getLogger(__name__).error(
-            'Config error. Surround to/from values with quotes.')
-        return False
+    time_delta = get_time_config(config)
 
     def state_automation_listener(entity, from_s, to_s):
-        """ Listens for state changes and calls action. """
-        action()
+        """Listen for state changes and calls action."""
+        def state_for_listener(now):
+            """Fire on state changes after a delay and calls action."""
+            hass.bus.remove_listener(
+                EVENT_STATE_CHANGED, for_state_listener)
+            action()
+
+        def state_for_cancel_listener(entity, inner_from_s, inner_to_s):
+            """Fire on changes and cancel for listener if changed."""
+            if inner_to_s == to_s:
+                return
+            hass.bus.remove_listener(EVENT_TIME_CHANGED, for_time_listener)
+            hass.bus.remove_listener(
+                EVENT_STATE_CHANGED, for_state_listener)
+
+        if time_delta is not None:
+            target_tm = dt_util.utcnow() + time_delta
+            for_time_listener = track_point_in_time(
+                hass, state_for_listener, target_tm)
+            for_state_listener = track_state_change(
+                hass, entity_id, state_for_cancel_listener,
+                MATCH_ALL, MATCH_ALL)
+        else:
+            action()
 
     track_state_change(
         hass, entity_id, state_automation_listener, from_state, to_state)
@@ -46,20 +104,17 @@ def trigger(hass, config, action):
 
 
 def if_action(hass, config):
-    """ Wraps action method with state based condition. """
+    """Wrap action method with state based condition."""
     entity_id = config.get(CONF_ENTITY_ID)
     state = config.get(CONF_STATE)
-
-    if entity_id is None or state is None:
-        logging.getLogger(__name__).error(
-            "Missing if-condition configuration key %s or %s", CONF_ENTITY_ID,
-            CONF_STATE)
-        return None
-
-    state = str(state)
+    time_delta = get_time_config(config)
 
     def if_state():
-        """ Test if condition. """
-        return hass.states.is_state(entity_id, state)
+        """Test if condition."""
+        is_state = hass.states.is_state(entity_id, state)
+        return (time_delta is None and is_state or
+                time_delta is not None and
+                dt_util.utcnow() - time_delta >
+                hass.states.get(entity_id).last_changed)
 
     return if_state

homeassistant/components/automation/sun.py

@@ -1,17 +1,19 @@
 """
-homeassistant.components.automation.sun
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Offers sun based automation rules.
+Offer sun based automation rules.
 
 For more details about this automation rule, please refer to the documentation
 at https://home-assistant.io/components/automation/#sun-trigger
 """
-import logging
 from datetime import timedelta
+import logging
 
-from homeassistant.components import sun
-from homeassistant.helpers.event import track_point_in_utc_time
+import voluptuous as vol
+
+from homeassistant.const import CONF_PLATFORM
 import homeassistant.util.dt as dt_util
+from homeassistant.components import sun
+from homeassistant.helpers.event import track_sunrise, track_sunset
+import homeassistant.helpers.config_validation as cv
 
 DEPENDENCIES = ['sun']
 
@@ -28,56 +30,46 @@ EVENT_SUNRISE = 'sunrise'
 _LOGGER = logging.getLogger(__name__)
 
 
+_SUN_EVENT = vol.All(vol.Lower, vol.Any(EVENT_SUNRISE, EVENT_SUNSET))
+
+TRIGGER_SCHEMA = vol.Schema({
+    vol.Required(CONF_PLATFORM): 'sun',
+    vol.Required(CONF_EVENT): _SUN_EVENT,
+    vol.Required(CONF_OFFSET, default=timedelta(0)): cv.time_offset,
+})
+
+IF_ACTION_SCHEMA = vol.All(
+    vol.Schema({
+        vol.Required(CONF_PLATFORM): 'sun',
+        CONF_BEFORE: _SUN_EVENT,
+        CONF_AFTER: _SUN_EVENT,
+        vol.Required(CONF_BEFORE_OFFSET, default=timedelta(0)): cv.time_offset,
+        vol.Required(CONF_AFTER_OFFSET, default=timedelta(0)): cv.time_offset,
+    }),
+    cv.has_at_least_one_key(CONF_BEFORE, CONF_AFTER),
+)
+
+
 def trigger(hass, config, action):
-    """ Listen for events based on config. """
+    """Listen for events based on configuration."""
     event = config.get(CONF_EVENT)
-
-    if event is None:
-        _LOGGER.error("Missing configuration key %s", CONF_EVENT)
-        return False
-
-    event = event.lower()
-    if event not in (EVENT_SUNRISE, EVENT_SUNSET):
-        _LOGGER.error("Invalid value for %s: %s", CONF_EVENT, event)
-        return False
-
-    offset = _parse_offset(config.get(CONF_OFFSET))
-    if offset is False:
-        return False
+    offset = config.get(CONF_OFFSET)
 
     # Do something to call action
     if event == EVENT_SUNRISE:
-        trigger_sunrise(hass, action, offset)
+        track_sunrise(hass, action, offset)
     else:
-        trigger_sunset(hass, action, offset)
+        track_sunset(hass, action, offset)
 
     return True
 
 
 def if_action(hass, config):
-    """ Wraps action method with sun based condition. """
+    """Wrap action method with sun based condition."""
     before = config.get(CONF_BEFORE)
     after = config.get(CONF_AFTER)
-
-    # Make sure required configuration keys are present
-    if before is None and after is None:
-        logging.getLogger(__name__).error(
-            "Missing if-condition configuration key %s or %s",
-            CONF_BEFORE, CONF_AFTER)
-        return None
-
-    # Make sure configuration keys have the right value
-    if before not in (None, EVENT_SUNRISE, EVENT_SUNSET) or \
-       after not in (None, EVENT_SUNRISE, EVENT_SUNSET):
-        logging.getLogger(__name__).error(
-            "%s and %s can only be set to %s or %s",
-            CONF_BEFORE, CONF_AFTER, EVENT_SUNRISE, EVENT_SUNSET)
-        return None
-
-    before_offset = _parse_offset(config.get(CONF_BEFORE_OFFSET))
-    after_offset = _parse_offset(config.get(CONF_AFTER_OFFSET))
-    if before_offset is False or after_offset is False:
-        return None
+    before_offset = config.get(CONF_BEFORE_OFFSET)
+    after_offset = config.get(CONF_AFTER_OFFSET)
 
     if before is None:
         def before_func():
@@ -106,8 +98,7 @@ def if_action(hass, config):
             return sun.next_setting(hass) + after_offset
 
     def time_if():
-        """ Validate time based if-condition """
-
+        """Validate time based if-condition."""
         now = dt_util.now()
         before = before_func()
         after = after_func()
@@ -123,64 +114,3 @@ def if_action(hass, config):
         return True
 
     return time_if
-
-
-def trigger_sunrise(hass, action, offset):
-    """ Trigger action at next sun rise. """
-    def next_rise():
-        """ Returns next sunrise. """
-        next_time = sun.next_rising_utc(hass) + offset
-
-        while next_time < dt_util.utcnow():
-            next_time = next_time + timedelta(days=1)
-
-        return next_time
-
-    def sunrise_automation_listener(now):
-        """ Called when it's time for action. """
-        track_point_in_utc_time(hass, sunrise_automation_listener, next_rise())
-        action()
-
-    track_point_in_utc_time(hass, sunrise_automation_listener, next_rise())
-
-
-def trigger_sunset(hass, action, offset):
-    """ Trigger action at next sun set. """
-    def next_set():
-        """ Returns next sunrise. """
-        next_time = sun.next_setting_utc(hass) + offset
-
-        while next_time < dt_util.utcnow():
-            next_time = next_time + timedelta(days=1)
-
-        return next_time
-
-    def sunset_automation_listener(now):
-        """ Called when it's time for action. """
-        track_point_in_utc_time(hass, sunset_automation_listener, next_set())
-        action()
-
-    track_point_in_utc_time(hass, sunset_automation_listener, next_set())
-
-
-def _parse_offset(raw_offset):
-    if raw_offset is None:
-        return timedelta(0)
-
-    negative_offset = False
-    if raw_offset.startswith('-'):
-        negative_offset = True
-        raw_offset = raw_offset[1:]
-
-    try:
-        (hour, minute, second) = [int(x) for x in raw_offset.split(':')]
-    except ValueError:
-        _LOGGER.error('Could not parse offset %s', raw_offset)
-        return False
-
-    offset = timedelta(hours=hour, minutes=minute, seconds=second)
-
-    if negative_offset:
-        offset *= -1
-
-    return offset

homeassistant/components/automation/template.py

@@ -1,33 +1,37 @@
 """
-homeassistant.components.automation.template
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Offers template automation rules.
+Offer template automation rules.
 
 For more details about this automation rule, please refer to the documentation
 at https://home-assistant.io/components/automation/#template-trigger
 """
 import logging
 
-from homeassistant.const import CONF_VALUE_TEMPLATE, EVENT_STATE_CHANGED
+import voluptuous as vol
+
+from homeassistant.const import (
+    CONF_VALUE_TEMPLATE, EVENT_STATE_CHANGED, CONF_PLATFORM)
 from homeassistant.exceptions import TemplateError
-from homeassistant.util import template
+from homeassistant.helpers import template
+import homeassistant.helpers.config_validation as cv
+
 
 _LOGGER = logging.getLogger(__name__)
 
+TRIGGER_SCHEMA = IF_ACTION_SCHEMA = vol.Schema({
+    vol.Required(CONF_PLATFORM): 'template',
+    vol.Required(CONF_VALUE_TEMPLATE): cv.template,
+})
+
 
 def trigger(hass, config, action):
-    """ Listen for state changes based on `config`. """
+    """Listen for state changes based on configuration."""
     value_template = config.get(CONF_VALUE_TEMPLATE)
 
-    if value_template is None:
-        _LOGGER.error("Missing configuration key %s", CONF_VALUE_TEMPLATE)
-        return False
-
     # Local variable to keep track of if the action has already been triggered
     already_triggered = False
 
     def event_listener(event):
-        """ Listens for state changes and calls action. """
+        """Listen for state changes and calls action."""
         nonlocal already_triggered
         template_result = _check_template(hass, value_template)
 
@@ -43,23 +47,23 @@ def trigger(hass, config, action):
 
 
 def if_action(hass, config):
-    """ Wraps action method with state based condition. """
-
+    """Wrap action method with state based condition."""
     value_template = config.get(CONF_VALUE_TEMPLATE)
 
-    if value_template is None:
-        _LOGGER.error("Missing configuration key %s", CONF_VALUE_TEMPLATE)
-        return False
-
     return lambda: _check_template(hass, value_template)
 
 
 def _check_template(hass, value_template):
-    """ Checks if result of template is true """
+    """Check if result of template is true."""
     try:
         value = template.render(hass, value_template, {})
-    except TemplateError:
-        _LOGGER.exception('Error parsing template')
+    except TemplateError as ex:
+        if ex.args and ex.args[0].startswith(
+                "UndefinedError: 'None' has no attribute"):
+            # Common during HA startup - so just a warning
+            _LOGGER.warning(ex)
+        else:
+            _LOGGER.error(ex)
         return False
 
     return value.lower() == 'true'

homeassistant/components/automation/time.py

@@ -1,14 +1,11 @@
 """
-homeassistant.components.automation.time
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Offers time listening automation rules.
+Offer time listening automation rules.
 
 For more details about this automation rule, please refer to the documentation
 at https://home-assistant.io/components/automation/#time-trigger
 """
 import logging
 
-from homeassistant.util import convert
 import homeassistant.util.dt as dt_util
 from homeassistant.helpers.event import track_time_change
 
@@ -25,7 +22,7 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def trigger(hass, config, action):
-    """ Listen for state changes based on `config`. """
+    """Listen for state changes based on configuration."""
     if CONF_AFTER in config:
         after = dt_util.parse_time_str(config[CONF_AFTER])
         if after is None:
@@ -34,16 +31,16 @@ def trigger(hass, config, action):
         hours, minutes, seconds = after.hour, after.minute, after.second
     elif (CONF_HOURS in config or CONF_MINUTES in config or
           CONF_SECONDS in config):
-        hours = convert(config.get(CONF_HOURS), int)
-        minutes = convert(config.get(CONF_MINUTES), int)
-        seconds = convert(config.get(CONF_SECONDS), int)
+        hours = config.get(CONF_HOURS)
+        minutes = config.get(CONF_MINUTES)
+        seconds = config.get(CONF_SECONDS)
     else:
         _LOGGER.error('One of %s, %s, %s OR %s needs to be specified',
                       CONF_HOURS, CONF_MINUTES, CONF_SECONDS, CONF_AFTER)
         return False
 
     def time_automation_listener(now):
-        """ Listens for time changes and calls action. """
+        """Listen for time changes and calls action."""
         action()
 
     track_time_change(hass, time_automation_listener,
@@ -53,13 +50,13 @@ def trigger(hass, config, action):
 
 
 def if_action(hass, config):
-    """ Wraps action method with time based condition. """
+    """Wrap action method with time based condition."""
     before = config.get(CONF_BEFORE)
     after = config.get(CONF_AFTER)
     weekday = config.get(CONF_WEEKDAY)
 
     if before is None and after is None and weekday is None:
-        logging.getLogger(__name__).error(
+        _LOGGER.error(
             "Missing if-condition configuration key %s, %s or %s",
             CONF_BEFORE, CONF_AFTER, CONF_WEEKDAY)
         return None
@@ -77,7 +74,7 @@ def if_action(hass, config):
             return None
 
     def time_if():
-        """ Validate time based if-condition """
+        """Validate time based if-condition."""
         now = dt_util.now()
         if before is not None and now > now.replace(hour=before.hour,
                                                     minute=before.minute):
@@ -100,7 +97,7 @@ def if_action(hass, config):
 
 
 def _error_time(value, key):
-    """ Helper method to print error. """
+    """Helper method to print error."""
     _LOGGER.error(
         "Received invalid value for '%s': %s", key, value)
     if isinstance(value, int):

homeassistant/components/automation/zone.py

@@ -1,18 +1,16 @@
 """
-homeassistant.components.automation.zone
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Offers zone automation rules.
+Offer zone automation rules.
 
 For more details about this automation rule, please refer to the documentation
 at https://home-assistant.io/components/automation/#zone-trigger
 """
-import logging
+import voluptuous as vol
 
 from homeassistant.components import zone
-from homeassistant.helpers.event import track_state_change
 from homeassistant.const import (
-    ATTR_GPS_ACCURACY, ATTR_LATITUDE, ATTR_LONGITUDE, MATCH_ALL)
-
+    ATTR_GPS_ACCURACY, ATTR_LATITUDE, ATTR_LONGITUDE, MATCH_ALL, CONF_PLATFORM)
+from homeassistant.helpers.event import track_state_change
+import homeassistant.helpers.config_validation as cv
 
 CONF_ENTITY_ID = "entity_id"
 CONF_ZONE = "zone"
@@ -21,22 +19,29 @@ EVENT_ENTER = "enter"
 EVENT_LEAVE = "leave"
 DEFAULT_EVENT = EVENT_ENTER
 
+TRIGGER_SCHEMA = vol.Schema({
+    vol.Required(CONF_PLATFORM): 'zone',
+    vol.Required(CONF_ENTITY_ID): cv.entity_id,
+    vol.Required(CONF_ZONE): cv.entity_id,
+    vol.Required(CONF_EVENT, default=DEFAULT_EVENT):
+        vol.Any(EVENT_ENTER, EVENT_LEAVE),
+})
+
+IF_ACTION_SCHEMA = vol.Schema({
+    vol.Required(CONF_PLATFORM): 'zone',
+    vol.Required(CONF_ENTITY_ID): cv.entity_id,
+    vol.Required(CONF_ZONE): cv.entity_id,
+})
+
 
 def trigger(hass, config, action):
-    """ Listen for state changes based on `config`. """
+    """Listen for state changes based on configuration."""
     entity_id = config.get(CONF_ENTITY_ID)
     zone_entity_id = config.get(CONF_ZONE)
-
-    if entity_id is None or zone_entity_id is None:
-        logging.getLogger(__name__).error(
-            "Missing trigger configuration key %s or %s", CONF_ENTITY_ID,
-            CONF_ZONE)
-        return False
-
-    event = config.get(CONF_EVENT, DEFAULT_EVENT)
+    event = config.get(CONF_EVENT)
 
     def zone_automation_listener(entity, from_s, to_s):
-        """ Listens for state changes and calls action. """
+        """Listen for state changes and calls action."""
         if from_s and None in (from_s.attributes.get(ATTR_LATITUDE),
                                from_s.attributes.get(ATTR_LONGITUDE)) or \
             None in (to_s.attributes.get(ATTR_LATITUDE),
@@ -58,25 +63,19 @@ def trigger(hass, config, action):
 
 
 def if_action(hass, config):
-    """ Wraps action method with zone based condition. """
+    """Wrap action method with zone based condition."""
     entity_id = config.get(CONF_ENTITY_ID)
     zone_entity_id = config.get(CONF_ZONE)
 
-    if entity_id is None or zone_entity_id is None:
-        logging.getLogger(__name__).error(
-            "Missing condition configuration key %s or %s", CONF_ENTITY_ID,
-            CONF_ZONE)
-        return False
-
     def if_in_zone():
-        """ Test if condition. """
+        """Test if condition."""
         return _in_zone(hass, zone_entity_id, hass.states.get(entity_id))
 
     return if_in_zone
 
 
 def _in_zone(hass, zone_entity_id, state):
-    """ Check if state is in zone. """
+    """Check if state is in zone."""
     if not state or None in (state.attributes.get(ATTR_LATITUDE),
                              state.attributes.get(ATTR_LONGITUDE)):
         return False

homeassistant/components/binary_sensor/__init__.py

@@ -1,8 +1,5 @@
 """
-homeassistant.components.binary_sensor
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Component to interface with binary sensors (sensors which only know two states)
-that can be monitored.
+Component to interface with binary sensors.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/binary_sensor/
@@ -12,17 +9,48 @@ import logging
 from homeassistant.helpers.entity_component import EntityComponent
 from homeassistant.helpers.entity import Entity
 from homeassistant.const import (STATE_ON, STATE_OFF)
+from homeassistant.components import (
+    bloomsky, mysensors, zwave, vera, wemo, wink)
+from homeassistant.helpers.config_validation import PLATFORM_SCHEMA  # noqa
 
 DOMAIN = 'binary_sensor'
 SCAN_INTERVAL = 30
 
 ENTITY_ID_FORMAT = DOMAIN + '.{}'
+SENSOR_CLASSES = [
+    None,            # Generic on/off
+    'cold',          # On means cold (or too cold)
+    'connectivity',  # On means connection present, Off = no connection
+    'gas',           # CO, CO2, etc.
+    'heat',          # On means hot (or too hot)
+    'light',         # Lightness threshold
+    'moisture',      # Specifically a wetness sensor
+    'motion',        # Motion sensor
+    'moving',        # On means moving, Off means stopped
+    'opening',       # Door, window, etc.
+    'power',         # Power, over-current, etc
+    'safety',        # Generic on=unsafe, off=safe
+    'smoke',         # Smoke detector
+    'sound',         # On means sound detected, Off means no sound
+    'vibration',     # On means vibration detected, Off means no vibration
+]
+
+# Maps discovered services to their platforms
+DISCOVERY_PLATFORMS = {
+    bloomsky.DISCOVER_BINARY_SENSORS: 'bloomsky',
+    mysensors.DISCOVER_BINARY_SENSORS: 'mysensors',
+    zwave.DISCOVER_BINARY_SENSORS: 'zwave',
+    vera.DISCOVER_BINARY_SENSORS: 'vera',
+    wemo.DISCOVER_BINARY_SENSORS: 'wemo',
+    wink.DISCOVER_BINARY_SENSORS: 'wink'
+}
 
 
 def setup(hass, config):
-    """ Track states and offer events for binary sensors. """
+    """Track states and offer events for binary sensors."""
     component = EntityComponent(
-        logging.getLogger(__name__), DOMAIN, hass, SCAN_INTERVAL)
+        logging.getLogger(__name__), DOMAIN, hass, SCAN_INTERVAL,
+        DISCOVERY_PLATFORMS)
 
     component.setup(config)
 
@@ -31,19 +59,29 @@ def setup(hass, config):
 
 # pylint: disable=no-self-use
 class BinarySensorDevice(Entity):
-    """ Represents a binary sensor. """
+    """Represent a binary sensor."""
 
     @property
     def is_on(self):
-        """ True if the binary sensor is on. """
+        """Return True if the binary sensor is on."""
         return None
 
     @property
     def state(self):
-        """ Returns the state of the binary sensor. """
+        """Return the state of the binary sensor."""
         return STATE_ON if self.is_on else STATE_OFF
 
     @property
-    def friendly_state(self):
-        """ Returns the friendly state of the binary sensor. """
+    def sensor_class(self):
+        """Return the class of this sensor, from SENSOR_CLASSES."""
         return None
+
+    @property
+    def state_attributes(self):
+        """Return device specific state attributes."""
+        attr = {}
+
+        if self.sensor_class is not None:
+            attr['sensor_class'] = self.sensor_class
+
+        return attr

homeassistant/components/binary_sensor/apcupsd.py

@@ -0,0 +1,41 @@
+"""
+Support for tracking the online status of a UPS.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.apcupsd/
+"""
+from homeassistant.components import apcupsd
+from homeassistant.components.binary_sensor import BinarySensorDevice
+
+DEPENDENCIES = [apcupsd.DOMAIN]
+DEFAULT_NAME = "UPS Online Status"
+
+
+def setup_platform(hass, config, add_entities, discovery_info=None):
+    """Instantiate an OnlineStatus binary sensor entity."""
+    add_entities((OnlineStatus(config, apcupsd.DATA),))
+
+
+class OnlineStatus(BinarySensorDevice):
+    """Represent UPS online status."""
+
+    def __init__(self, config, data):
+        """Initialize the APCUPSd device."""
+        self._config = config
+        self._data = data
+        self._state = None
+        self.update()
+
+    @property
+    def name(self):
+        """Return the name of the UPS online status sensor."""
+        return self._config.get("name", DEFAULT_NAME)
+
+    @property
+    def is_on(self):
+        """Return true if the UPS is online, else false."""
+        return self._state == apcupsd.VALUE_ONLINE
+
+    def update(self):
+        """Get the status report from APCUPSd and set this entity's state."""
+        self._state = self._data.status[apcupsd.KEY_STATUS]

homeassistant/components/binary_sensor/arest.py

@@ -1,18 +1,17 @@
 """
-homeassistant.components.binary_sensor.arest
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The arest sensor will consume an exposed aREST API of a device.
+Support for exposed aREST RESTful API of a device.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/binary_sensor.arest/
 """
-from datetime import timedelta
 import logging
+from datetime import timedelta
 
 import requests
 
+from homeassistant.components.binary_sensor import (BinarySensorDevice,
+                                                    SENSOR_CLASSES)
 from homeassistant.util import Throttle
-from homeassistant.components.binary_sensor import BinarySensorDevice
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -24,11 +23,15 @@ CONF_PIN = 'pin'
 
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Get the aREST binary sensor. """
-
+    """Setup the aREST binary sensor."""
     resource = config.get(CONF_RESOURCE)
     pin = config.get(CONF_PIN)
 
+    sensor_class = config.get('sensor_class')
+    if sensor_class not in SENSOR_CLASSES:
+        _LOGGER.warning('Unknown sensor class: %s', sensor_class)
+        sensor_class = None
+
     if None in (resource, pin):
         _LOGGER.error('Not all required config keys present: %s',
                       ', '.join((CONF_RESOURCE, CONF_PIN)))
@@ -48,20 +51,24 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
 
     arest = ArestData(resource, pin)
 
-    add_devices([ArestBinarySensor(arest,
-                                   resource,
-                                   config.get('name', response['name']),
-                                   pin)])
+    add_devices([ArestBinarySensor(
+        arest,
+        resource,
+        config.get('name', response['name']),
+        sensor_class,
+        pin)])
 
 
 # pylint: disable=too-many-instance-attributes, too-many-arguments
 class ArestBinarySensor(BinarySensorDevice):
-    """ Implements an aREST binary sensor for a pin. """
+    """Implement an aREST binary sensor for a pin."""
 
-    def __init__(self, arest, resource, name, pin):
+    def __init__(self, arest, resource, name, sensor_class, pin):
+        """Initialize the aREST device."""
         self.arest = arest
         self._resource = resource
         self._name = name
+        self._sensor_class = sensor_class
         self._pin = pin
         self.update()
 
@@ -73,31 +80,37 @@ class ArestBinarySensor(BinarySensorDevice):
 
     @property
     def name(self):
-        """ The name of the binary sensor. """
+        """Return the name of the binary sensor."""
         return self._name
 
     @property
     def is_on(self):
-        """ True if the binary sensor is on. """
+        """Return true if the binary sensor is on."""
         return bool(self.arest.data.get('state'))
 
+    @property
+    def sensor_class(self):
+        """Return the class of this sensor."""
+        return self._sensor_class
+
     def update(self):
-        """ Gets the latest data from aREST API. """
+        """Get the latest data from aREST API."""
         self.arest.update()
 
 
 # pylint: disable=too-few-public-methods
 class ArestData(object):
-    """ Class for handling the data retrieval for pins. """
+    """Class for handling the data retrieval for pins."""
 
     def __init__(self, resource, pin):
+        """Initialize the aREST data object."""
         self._resource = resource
         self._pin = pin
         self.data = {}
 
     @Throttle(MIN_TIME_BETWEEN_UPDATES)
     def update(self):
-        """ Gets the latest data from aREST device. """
+        """Get the latest data from aREST device."""
         try:
             response = requests.get('{}/digital/{}'.format(
                 self._resource, self._pin), timeout=10)

homeassistant/components/binary_sensor/bloomsky.py

@@ -0,0 +1,74 @@
+"""
+Support the binary sensors of a BloomSky weather station.
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.bloomsky/
+"""
+import logging
+
+from homeassistant.components.binary_sensor import BinarySensorDevice
+from homeassistant.loader import get_component
+
+DEPENDENCIES = ["bloomsky"]
+
+# These are the available sensors mapped to binary_sensor class
+SENSOR_TYPES = {
+    "Rain": "moisture",
+    "Night": None,
+}
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup the available BloomSky weather binary sensors."""
+    logger = logging.getLogger(__name__)
+    bloomsky = get_component('bloomsky')
+    sensors = config.get('monitored_conditions', SENSOR_TYPES)
+
+    for device in bloomsky.BLOOMSKY.devices.values():
+        for variable in sensors:
+            if variable in SENSOR_TYPES:
+                add_devices([BloomSkySensor(bloomsky.BLOOMSKY,
+                                            device,
+                                            variable)])
+            else:
+                logger.error("Cannot find definition for device: %s", variable)
+
+
+class BloomSkySensor(BinarySensorDevice):
+    """Represent a single binary sensor in a BloomSky device."""
+
+    def __init__(self, bs, device, sensor_name):
+        """Initialize a BloomSky binary sensor."""
+        self._bloomsky = bs
+        self._device_id = device["DeviceID"]
+        self._sensor_name = sensor_name
+        self._name = "{} {}".format(device["DeviceName"], sensor_name)
+        self._unique_id = "bloomsky_binary_sensor {}".format(self._name)
+        self.update()
+
+    @property
+    def name(self):
+        """The name of the BloomSky device and this sensor."""
+        return self._name
+
+    @property
+    def unique_id(self):
+        """Return the unique ID for this sensor."""
+        return self._unique_id
+
+    @property
+    def sensor_class(self):
+        """Return the class of this sensor, from SENSOR_CLASSES."""
+        return SENSOR_TYPES.get(self._sensor_name)
+
+    @property
+    def is_on(self):
+        """Return true if binary sensor is on."""
+        return self._state
+
+    def update(self):
+        """Request an update from the BloomSky API."""
+        self._bloomsky.refresh_devices()
+
+        self._state = \
+            self._bloomsky.devices[self._device_id]["Data"][self._sensor_name]

homeassistant/components/binary_sensor/command_line.py

@@ -0,0 +1,81 @@
+"""
+Support for custom shell commands to to retrieve values.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.command/
+"""
+import logging
+from datetime import timedelta
+
+from homeassistant.components.binary_sensor import BinarySensorDevice
+from homeassistant.components.sensor.command_line import CommandSensorData
+from homeassistant.const import CONF_VALUE_TEMPLATE
+from homeassistant.helpers import template
+
+_LOGGER = logging.getLogger(__name__)
+
+DEFAULT_NAME = "Binary Command Sensor"
+DEFAULT_PAYLOAD_ON = 'ON'
+DEFAULT_PAYLOAD_OFF = 'OFF'
+
+# Return cached results if last scan was less then this time ago
+MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=60)
+
+
+# pylint: disable=unused-argument
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup the Command Sensor."""
+    if config.get('command') is None:
+        _LOGGER.error('Missing required variable: "command"')
+        return False
+
+    data = CommandSensorData(config.get('command'))
+
+    add_devices([CommandBinarySensor(
+        hass,
+        data,
+        config.get('name', DEFAULT_NAME),
+        config.get('payload_on', DEFAULT_PAYLOAD_ON),
+        config.get('payload_off', DEFAULT_PAYLOAD_OFF),
+        config.get(CONF_VALUE_TEMPLATE)
+    )])
+
+
+# pylint: disable=too-many-arguments
+class CommandBinarySensor(BinarySensorDevice):
+    """Represent a command line binary sensor."""
+
+    def __init__(self, hass, data, name, payload_on,
+                 payload_off, value_template):
+        """Initialize the Command line binary sensor."""
+        self._hass = hass
+        self.data = data
+        self._name = name
+        self._state = False
+        self._payload_on = payload_on
+        self._payload_off = payload_off
+        self._value_template = value_template
+        self.update()
+
+    @property
+    def name(self):
+        """Return the name of the sensor."""
+        return self._name
+
+    @property
+    def is_on(self):
+        """Return true if the binary sensor is on."""
+        return self._state
+
+    def update(self):
+        """Get the latest data and updates the state."""
+        self.data.update()
+        value = self.data.value
+
+        if self._value_template is not None:
+            value = template.render_with_possible_json_value(
+                self._hass, self._value_template, value, False)
+        if value == self._payload_on:
+            self._state = True
+        elif value == self._payload_off:
+            self._state = False

homeassistant/components/binary_sensor/demo.py

@@ -1,37 +1,45 @@
 """
-homeassistant.components.binary_sensor.demo
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Demo platform that has two fake binary sensors.
+
+For more details about this platform, please refer to the documentation
+https://home-assistant.io/components/demo/
 """
 from homeassistant.components.binary_sensor import BinarySensorDevice
 
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Sets up the Demo binary sensors. """
+    """Setup the Demo binary sensor platform."""
     add_devices([
-        DemoBinarySensor('Basement Floor Wet', False),
-        DemoBinarySensor('Movement Backyard', True),
+        DemoBinarySensor('Basement Floor Wet', False, 'moisture'),
+        DemoBinarySensor('Movement Backyard', True, 'motion'),
     ])
 
 
 class DemoBinarySensor(BinarySensorDevice):
-    """ A Demo binary sensor. """
+    """A Demo binary sensor."""
 
-    def __init__(self, name, state):
+    def __init__(self, name, state, sensor_class):
+        """Initialize the demo sensor."""
         self._name = name
         self._state = state
+        self._sensor_type = sensor_class
+
+    @property
+    def sensor_class(self):
+        """Return the class of this sensor."""
+        return self._sensor_type
 
     @property
     def should_poll(self):
-        """ No polling needed for a demo binary sensor. """
+        """No polling needed for a demo binary sensor."""
         return False
 
     @property
     def name(self):
-        """ Returns the name of the binary sensor. """
+        """Return the name of the binary sensor."""
         return self._name
 
     @property
     def is_on(self):
-        """ True if the binary sensor is on. """
+        """Return true if the binary sensor is on."""
         return self._state

homeassistant/components/binary_sensor/mqtt.py

@@ -1,61 +1,75 @@
 """
-homeassistant.components.binary_sensor.mqtt
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Allows to configure a MQTT binary sensor.
+Support for MQTT binary sensors.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/binary_sensor.mqtt/
 """
 import logging
 
-from homeassistant.const import CONF_VALUE_TEMPLATE
-from homeassistant.components.binary_sensor import BinarySensorDevice
-from homeassistant.util import template
+import voluptuous as vol
+
 import homeassistant.components.mqtt as mqtt
+from homeassistant.components.binary_sensor import (BinarySensorDevice,
+                                                    SENSOR_CLASSES)
+from homeassistant.const import CONF_NAME, CONF_VALUE_TEMPLATE
+from homeassistant.components.mqtt import CONF_STATE_TOPIC, CONF_QOS
+from homeassistant.helpers import template
+import homeassistant.helpers.config_validation as cv
 
 _LOGGER = logging.getLogger(__name__)
 
+DEPENDENCIES = ['mqtt']
+
+CONF_SENSOR_CLASS = 'sensor_class'
+CONF_PAYLOAD_ON = 'payload_on'
+CONF_PAYLOAD_OFF = 'payload_off'
+
 DEFAULT_NAME = 'MQTT Binary sensor'
-DEFAULT_QOS = 0
 DEFAULT_PAYLOAD_ON = 'ON'
 DEFAULT_PAYLOAD_OFF = 'OFF'
 
-DEPENDENCIES = ['mqtt']
+PLATFORM_SCHEMA = mqtt.MQTT_RO_PLATFORM_SCHEMA.extend({
+    vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
+    vol.Optional(CONF_SENSOR_CLASS, default=None):
+        vol.Any(vol.In(SENSOR_CLASSES), vol.SetTo(None)),
+    vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
+    vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
+})
 
 
 # pylint: disable=unused-argument
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Add MQTT binary sensor. """
-
-    if config.get('state_topic') is None:
-        _LOGGER.error('Missing required variable: state_topic')
-        return False
-
+    """Add MQTT binary sensor."""
     add_devices([MqttBinarySensor(
         hass,
-        config.get('name', DEFAULT_NAME),
-        config.get('state_topic', None),
-        config.get('qos', DEFAULT_QOS),
-        config.get('payload_on', DEFAULT_PAYLOAD_ON),
-        config.get('payload_off', DEFAULT_PAYLOAD_OFF),
-        config.get(CONF_VALUE_TEMPLATE))])
+        config[CONF_NAME],
+        config[CONF_STATE_TOPIC],
+        config[CONF_SENSOR_CLASS],
+        config[CONF_QOS],
+        config[CONF_PAYLOAD_ON],
+        config[CONF_PAYLOAD_OFF],
+        config.get(CONF_VALUE_TEMPLATE)
+    )])
 
 
 # pylint: disable=too-many-arguments, too-many-instance-attributes
 class MqttBinarySensor(BinarySensorDevice):
-    """ Represents a binary sensor that is updated by MQTT. """
-    def __init__(self, hass, name, state_topic, qos, payload_on, payload_off,
-                 value_template):
+    """Representation a binary sensor that is updated by MQTT."""
+
+    def __init__(self, hass, name, state_topic, sensor_class, qos, payload_on,
+                 payload_off, value_template):
+        """Initialize the MQTT binary sensor."""
         self._hass = hass
         self._name = name
         self._state = False
         self._state_topic = state_topic
+        self._sensor_class = sensor_class
         self._payload_on = payload_on
         self._payload_off = payload_off
         self._qos = qos
 
         def message_received(topic, payload, qos):
-            """ A new MQTT message has been received. """
+            """A new MQTT message has been received."""
             if value_template is not None:
                 payload = template.render_with_possible_json_value(
                     hass, value_template, payload)
@@ -70,15 +84,20 @@ class MqttBinarySensor(BinarySensorDevice):
 
     @property
     def should_poll(self):
-        """ No polling needed. """
+        """No polling needed."""
         return False
 
     @property
     def name(self):
-        """ The name of the binary sensor. """
+        """Return the name of the binary sensor."""
         return self._name
 
     @property
     def is_on(self):
-        """ True if the binary sensor is on. """
+        """Return true if the binary sensor is on."""
         return self._state
+
+    @property
+    def sensor_class(self):
+        """Return the class of this sensor."""
+        return self._sensor_class

homeassistant/components/binary_sensor/mysensors.py

@@ -0,0 +1,168 @@
+"""
+Support for MySensors binary sensors.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.mysensors/
+"""
+import logging
+
+from homeassistant.const import (
+    ATTR_BATTERY_LEVEL, STATE_OFF, STATE_ON)
+from homeassistant.components.binary_sensor import (
+    BinarySensorDevice, SENSOR_CLASSES)
+from homeassistant.loader import get_component
+
+_LOGGER = logging.getLogger(__name__)
+DEPENDENCIES = []
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup the mysensors platform for sensors."""
+    # Only act if loaded via mysensors by discovery event.
+    # Otherwise gateway is not setup.
+    if discovery_info is None:
+        return
+
+    mysensors = get_component('mysensors')
+
+    for gateway in mysensors.GATEWAYS.values():
+        # Define the S_TYPES and V_TYPES that the platform should handle as
+        # states. Map them in a dict of lists.
+        pres = gateway.const.Presentation
+        set_req = gateway.const.SetReq
+        map_sv_types = {
+            pres.S_DOOR: [set_req.V_TRIPPED],
+            pres.S_MOTION: [set_req.V_TRIPPED],
+            pres.S_SMOKE: [set_req.V_TRIPPED],
+        }
+        if float(gateway.version) >= 1.5:
+            map_sv_types.update({
+                pres.S_SPRINKLER: [set_req.V_TRIPPED],
+                pres.S_WATER_LEAK: [set_req.V_TRIPPED],
+                pres.S_SOUND: [set_req.V_TRIPPED],
+                pres.S_VIBRATION: [set_req.V_TRIPPED],
+                pres.S_MOISTURE: [set_req.V_TRIPPED],
+            })
+
+        devices = {}
+        gateway.platform_callbacks.append(mysensors.pf_callback_factory(
+            map_sv_types, devices, add_devices, MySensorsBinarySensor))
+
+
+class MySensorsBinarySensor(BinarySensorDevice):
+    """Represent the value of a MySensors child node."""
+
+    # pylint: disable=too-many-arguments,too-many-instance-attributes
+
+    def __init__(
+            self, gateway, node_id, child_id, name, value_type, child_type):
+        """
+        Setup class attributes on instantiation.
+
+        Args:
+        gateway (GatewayWrapper): Gateway object.
+        node_id (str): Id of node.
+        child_id (str): Id of child.
+        name (str): Entity name.
+        value_type (str): Value type of child. Value is entity state.
+        child_type (str): Child type of child.
+
+        Attributes:
+        gateway (GatewayWrapper): Gateway object.
+        node_id (str): Id of node.
+        child_id (str): Id of child.
+        _name (str): Entity name.
+        value_type (str): Value type of child. Value is entity state.
+        child_type (str): Child type of child.
+        battery_level (int): Node battery level.
+        _values (dict): Child values. Non state values set as state attributes.
+        mysensors (module): Mysensors main component module.
+        """
+        self.gateway = gateway
+        self.node_id = node_id
+        self.child_id = child_id
+        self._name = name
+        self.value_type = value_type
+        self.child_type = child_type
+        self.battery_level = 0
+        self._values = {}
+        self.mysensors = get_component('mysensors')
+
+    @property
+    def should_poll(self):
+        """Mysensor gateway pushes its state to HA."""
+        return False
+
+    @property
+    def name(self):
+        """The name of this entity."""
+        return self._name
+
+    @property
+    def device_state_attributes(self):
+        """Return device specific state attributes."""
+        attr = {
+            self.mysensors.ATTR_PORT: self.gateway.port,
+            self.mysensors.ATTR_NODE_ID: self.node_id,
+            self.mysensors.ATTR_CHILD_ID: self.child_id,
+            ATTR_BATTERY_LEVEL: self.battery_level,
+        }
+
+        set_req = self.gateway.const.SetReq
+
+        for value_type, value in self._values.items():
+            if value_type != self.value_type:
+                try:
+                    attr[set_req(value_type).name] = value
+                except ValueError:
+                    _LOGGER.error('value_type %s is not valid for mysensors '
+                                  'version %s', value_type,
+                                  self.gateway.version)
+        return attr
+
+    @property
+    def is_on(self):
+        """Return True if the binary sensor is on."""
+        if self.value_type in self._values:
+            return self._values[self.value_type] == STATE_ON
+        return False
+
+    @property
+    def sensor_class(self):
+        """Return the class of this sensor, from SENSOR_CLASSES."""
+        pres = self.gateway.const.Presentation
+        class_map = {
+            pres.S_DOOR: 'opening',
+            pres.S_MOTION: 'motion',
+            pres.S_SMOKE: 'smoke',
+        }
+        if float(self.gateway.version) >= 1.5:
+            class_map.update({
+                pres.S_SPRINKLER: 'sprinkler',
+                pres.S_WATER_LEAK: 'leak',
+                pres.S_SOUND: 'sound',
+                pres.S_VIBRATION: 'vibration',
+                pres.S_MOISTURE: 'moisture',
+            })
+        if class_map.get(self.child_type) in SENSOR_CLASSES:
+            return class_map.get(self.child_type)
+
+    @property
+    def available(self):
+        """Return True if entity is available."""
+        return self.value_type in self._values
+
+    def update(self):
+        """Update the controller with the latest values from a sensor."""
+        node = self.gateway.sensors[self.node_id]
+        child = node.children[self.child_id]
+        for value_type, value in child.values.items():
+            _LOGGER.debug(
+                "%s: value_type %s, value = %s", self._name, value_type, value)
+            if value_type == self.gateway.const.SetReq.V_TRIPPED:
+                self._values[value_type] = STATE_ON if int(
+                    value) == 1 else STATE_OFF
+            else:
+                self._values[value_type] = value
+
+        self.battery_level = node.battery_level

homeassistant/components/binary_sensor/nest.py

@@ -0,0 +1,53 @@
+"""
+Support for Nest Thermostat Binary Sensors.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.nest/
+"""
+import logging
+import socket
+
+import homeassistant.components.nest as nest
+from homeassistant.components.binary_sensor import BinarySensorDevice
+from homeassistant.components.sensor.nest import NestSensor
+
+DEPENDENCIES = ['nest']
+BINARY_TYPES = ['fan',
+                'hvac_ac_state',
+                'hvac_aux_heater_state',
+                'hvac_heater_state',
+                'hvac_heat_x2_state',
+                'hvac_heat_x3_state',
+                'hvac_alt_heat_state',
+                'hvac_alt_heat_x2_state',
+                'hvac_emer_heat_state',
+                'online']
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup Nest binary sensors."""
+    logger = logging.getLogger(__name__)
+    try:
+        for structure in nest.NEST.structures:
+            for device in structure.devices:
+                for variable in config['monitored_conditions']:
+                    if variable in BINARY_TYPES:
+                        add_devices([NestBinarySensor(structure,
+                                                      device,
+                                                      variable)])
+                    else:
+                        logger.error('Nest sensor type: "%s" does not exist',
+                                     variable)
+    except socket.error:
+        logger.error(
+            "Connection error logging into the nest web service."
+        )
+
+
+class NestBinarySensor(NestSensor, BinarySensorDevice):
+    """Represents a Nest binary sensor."""
+
+    @property
+    def is_on(self):
+        """True if the binary sensor is on."""
+        return bool(getattr(self.device, self.variable))

homeassistant/components/binary_sensor/nx584.py

@@ -0,0 +1,134 @@
+"""
+Support for exposing nx584 elements as sensors.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/sensor.nx584/
+"""
+import logging
+import threading
+import time
+
+import requests
+
+from homeassistant.components.binary_sensor import (
+    SENSOR_CLASSES, BinarySensorDevice)
+
+REQUIREMENTS = ['pynx584==0.2']
+_LOGGER = logging.getLogger(__name__)
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup nx584 sensors."""
+    from nx584 import client as nx584_client
+
+    host = config.get('host', 'localhost:5007')
+    exclude = config.get('exclude_zones', [])
+    zone_types = config.get('zone_types', {})
+
+    if not all(isinstance(zone, int) for zone in exclude):
+        _LOGGER.error('Invalid excluded zone specified (use zone number)')
+        return False
+
+    if not all(isinstance(zone, int) and ztype in SENSOR_CLASSES
+               for zone, ztype in zone_types.items()):
+        _LOGGER.error('Invalid zone_types entry')
+        return False
+
+    try:
+        client = nx584_client.Client('http://%s' % host)
+        zones = client.list_zones()
+    except requests.exceptions.ConnectionError as ex:
+        _LOGGER.error('Unable to connect to NX584: %s', str(ex))
+        return False
+
+    version = [int(v) for v in client.get_version().split('.')]
+    if version < [1, 1]:
+        _LOGGER.error('NX584 is too old to use for sensors (>=0.2 required)')
+        return False
+
+    zone_sensors = {
+        zone['number']: NX584ZoneSensor(
+            zone,
+            zone_types.get(zone['number'], 'opening'))
+        for zone in zones
+        if zone['number'] not in exclude}
+    if zone_sensors:
+        add_devices(zone_sensors.values())
+        watcher = NX584Watcher(client, zone_sensors)
+        watcher.start()
+    else:
+        _LOGGER.warning('No zones found on NX584')
+
+    return True
+
+
+class NX584ZoneSensor(BinarySensorDevice):
+    """Represents a NX584 zone as a sensor."""
+
+    def __init__(self, zone, zone_type):
+        """Initialize the nx594 binary sensor."""
+        self._zone = zone
+        self._zone_type = zone_type
+
+    @property
+    def sensor_class(self):
+        """Return the class of this sensor, from SENSOR_CLASSES."""
+        return self._zone_type
+
+    @property
+    def should_poll(self):
+        """No polling needed."""
+        return False
+
+    @property
+    def name(self):
+        """Return the name of the binary sensor."""
+        return self._zone['name']
+
+    @property
+    def is_on(self):
+        """Return true if the binary sensor is on."""
+        # True means "faulted" or "open" or "abnormal state"
+        return self._zone['state']
+
+
+class NX584Watcher(threading.Thread):
+    """Event listener thread to process NX584 events."""
+
+    def __init__(self, client, zone_sensors):
+        """Initialize nx584 watcher thread."""
+        super(NX584Watcher, self).__init__()
+        self.daemon = True
+        self._client = client
+        self._zone_sensors = zone_sensors
+
+    def _process_zone_event(self, event):
+        zone = event['zone']
+        zone_sensor = self._zone_sensors.get(zone)
+        # pylint: disable=protected-access
+        if not zone_sensor:
+            return
+        zone_sensor._zone['state'] = event['zone_state']
+        zone_sensor.update_ha_state()
+
+    def _process_events(self, events):
+        for event in events:
+            if event.get('type') == 'zone_status':
+                self._process_zone_event(event)
+
+    def _run(self):
+        """Throw away any existing events so we don't replay history."""
+        self._client.get_events()
+        while True:
+            events = self._client.get_events()
+            if events:
+                self._process_events(events)
+
+    def run(self):
+        """Run the watcher."""
+        while True:
+            try:
+                self._run()
+            except requests.exceptions.ConnectionError:
+                _LOGGER.error('Failed to reach NX584 server')
+                time.sleep(10)

homeassistant/components/binary_sensor/rest.py

@@ -1,17 +1,16 @@
 """
-homeassistant.components.binary_sensor.rest
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The rest binary sensor will consume responses sent by an exposed REST API.
+Support for RESTful binary sensors.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/binary_sensor.rest/
 """
 import logging
 
-from homeassistant.const import CONF_VALUE_TEMPLATE
-from homeassistant.util import template
+from homeassistant.components.binary_sensor import (BinarySensorDevice,
+                                                    SENSOR_CLASSES)
 from homeassistant.components.sensor.rest import RestData
-from homeassistant.components.binary_sensor import BinarySensorDevice
+from homeassistant.const import CONF_VALUE_TEMPLATE
+from homeassistant.helpers import template
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -21,12 +20,17 @@ DEFAULT_METHOD = 'GET'
 
 # pylint: disable=unused-variable
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """Setup REST binary sensors."""
+    """Setup the REST binary sensor."""
     resource = config.get('resource', None)
     method = config.get('method', DEFAULT_METHOD)
     payload = config.get('payload', None)
     verify_ssl = config.get('verify_ssl', True)
 
+    sensor_class = config.get('sensor_class')
+    if sensor_class not in SENSOR_CLASSES:
+        _LOGGER.warning('Unknown sensor class: %s', sensor_class)
+        sensor_class = None
+
     rest = RestData(method, resource, payload, verify_ssl)
     rest.update()
 
@@ -35,31 +39,40 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
         return False
 
     add_devices([RestBinarySensor(
-        hass, rest, config.get('name', DEFAULT_NAME),
+        hass,
+        rest,
+        config.get('name', DEFAULT_NAME),
+        sensor_class,
         config.get(CONF_VALUE_TEMPLATE))])
 
 
 # pylint: disable=too-many-arguments
 class RestBinarySensor(BinarySensorDevice):
-    """REST binary sensor."""
+    """Representation of a REST binary sensor."""
 
-    def __init__(self, hass, rest, name, value_template):
+    def __init__(self, hass, rest, name, sensor_class, value_template):
         """Initialize a REST binary sensor."""
         self._hass = hass
         self.rest = rest
         self._name = name
+        self._sensor_class = sensor_class
         self._state = False
         self._value_template = value_template
         self.update()
 
     @property
     def name(self):
-        """Name of the binary sensor."""
+        """Return the name of the binary sensor."""
         return self._name
 
+    @property
+    def sensor_class(self):
+        """Return the class of this sensor."""
+        return self._sensor_class
+
     @property
     def is_on(self):
-        """Return if the binary sensor is on."""
+        """Return true if the binary sensor is on."""
         if self.rest.data is None:
             return False
 

homeassistant/components/binary_sensor/rpi_gpio.py

@@ -1,16 +1,14 @@
 """
-homeassistant.components.binary_sensor.rpi_gpio
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Allows to configure a binary_sensor using RPi GPIO.
+Support for binary sensor using RPi GPIO.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/binary_sensor.rpi_gpio/
 """
-
 import logging
+
 import homeassistant.components.rpi_gpio as rpi_gpio
 from homeassistant.components.binary_sensor import BinarySensorDevice
-from homeassistant.const import (DEVICE_DEFAULT_NAME)
+from homeassistant.const import DEVICE_DEFAULT_NAME
 
 DEFAULT_PULL_MODE = "UP"
 DEFAULT_BOUNCETIME = 50
@@ -22,8 +20,7 @@ _LOGGER = logging.getLogger(__name__)
 
 # pylint: disable=unused-argument
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Sets up the Raspberry PI GPIO devices. """
-
+    """Setup the Raspberry PI GPIO devices."""
     pull_mode = config.get('pull_mode', DEFAULT_PULL_MODE)
     bouncetime = config.get('bouncetime', DEFAULT_BOUNCETIME)
     invert_logic = config.get('invert_logic', DEFAULT_INVERT_LOGIC)
@@ -38,10 +35,11 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
 
 # pylint: disable=too-many-arguments, too-many-instance-attributes
 class RPiGPIOBinarySensor(BinarySensorDevice):
-    """ Represents a binary sensor that uses Raspberry Pi GPIO. """
-    def __init__(self, name, port, pull_mode, bouncetime, invert_logic):
-        # pylint: disable=no-member
+    """Represent a binary sensor that uses Raspberry Pi GPIO."""
 
+    def __init__(self, name, port, pull_mode, bouncetime, invert_logic):
+        """Initialize the RPi binary sensor."""
+        # pylint: disable=no-member
         self._name = name or DEVICE_DEFAULT_NAME
         self._port = port
         self._pull_mode = pull_mode
@@ -52,22 +50,23 @@ class RPiGPIOBinarySensor(BinarySensorDevice):
         self._state = rpi_gpio.read_input(self._port)
 
         def read_gpio(port):
-            """ Reads state from GPIO. """
+            """Read state from GPIO."""
             self._state = rpi_gpio.read_input(self._port)
             self.update_ha_state()
+
         rpi_gpio.edge_detect(self._port, read_gpio, self._bouncetime)
 
     @property
     def should_poll(self):
-        """ No polling needed. """
+        """No polling needed."""
         return False
 
     @property
     def name(self):
-        """ The name of the sensor. """
+        """Return the name of the sensor."""
         return self._name
 
     @property
     def is_on(self):
-        """ Returns the state of the entity. """
+        """Return the state of the entity."""
         return self._state != self._invert_logic

homeassistant/components/binary_sensor/tcp.py

@@ -0,0 +1,32 @@
+"""
+Provides a binary sensor which gets its values from a TCP socket.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.tcp/
+"""
+import logging
+
+from homeassistant.components.binary_sensor import BinarySensorDevice
+from homeassistant.components.sensor.tcp import Sensor, CONF_VALUE_ON
+
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def setup_platform(hass, config, add_entities, discovery_info=None):
+    """Create the binary sensor."""
+    if not BinarySensor.validate_config(config):
+        return False
+
+    add_entities((BinarySensor(hass, config),))
+
+
+class BinarySensor(BinarySensorDevice, Sensor):
+    """A binary sensor which is on when its state == CONF_VALUE_ON."""
+
+    required = (CONF_VALUE_ON,)
+
+    @property
+    def is_on(self):
+        """True if the binary sensor is on."""
+        return self._state == self._config[CONF_VALUE_ON]

homeassistant/components/binary_sensor/template.py

@@ -0,0 +1,127 @@
+"""
+Support for exposing a templated binary sensor.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.template/
+"""
+import logging
+
+from homeassistant.components.binary_sensor import (BinarySensorDevice,
+                                                    ENTITY_ID_FORMAT,
+                                                    SENSOR_CLASSES)
+from homeassistant.const import ATTR_FRIENDLY_NAME, CONF_VALUE_TEMPLATE
+from homeassistant.core import EVENT_STATE_CHANGED
+from homeassistant.exceptions import TemplateError
+from homeassistant.helpers.entity import generate_entity_id
+from homeassistant.helpers import template
+from homeassistant.util import slugify
+
+CONF_SENSORS = 'sensors'
+_LOGGER = logging.getLogger(__name__)
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup template binary sensors."""
+    sensors = []
+    if config.get(CONF_SENSORS) is None:
+        _LOGGER.error('Missing configuration data for binary_sensor platform')
+        return False
+
+    for device, device_config in config[CONF_SENSORS].items():
+
+        if device != slugify(device):
+            _LOGGER.error('Found invalid key for binary_sensor.template: %s. '
+                          'Use %s instead', device, slugify(device))
+            continue
+
+        if not isinstance(device_config, dict):
+            _LOGGER.error('Missing configuration data for binary_sensor %s',
+                          device)
+            continue
+
+        friendly_name = device_config.get(ATTR_FRIENDLY_NAME, device)
+        sensor_class = device_config.get('sensor_class')
+        value_template = device_config.get(CONF_VALUE_TEMPLATE)
+
+        if sensor_class not in SENSOR_CLASSES:
+            _LOGGER.error('Sensor class is not valid')
+            continue
+
+        if value_template is None:
+            _LOGGER.error(
+                'Missing %s for sensor %s', CONF_VALUE_TEMPLATE, device)
+            continue
+
+        sensors.append(
+            BinarySensorTemplate(
+                hass,
+                device,
+                friendly_name,
+                sensor_class,
+                value_template)
+            )
+    if not sensors:
+        _LOGGER.error('No sensors added')
+        return False
+    add_devices(sensors)
+
+    return True
+
+
+class BinarySensorTemplate(BinarySensorDevice):
+    """A virtual binary sensor that triggers from another sensor."""
+
+    # pylint: disable=too-many-arguments
+    def __init__(self, hass, device, friendly_name, sensor_class,
+                 value_template):
+        """Initialize the Template binary sensor."""
+        self.hass = hass
+        self.entity_id = generate_entity_id(ENTITY_ID_FORMAT, device,
+                                            hass=hass)
+        self._name = friendly_name
+        self._sensor_class = sensor_class
+        self._template = value_template
+        self._state = None
+
+        self.update()
+
+        def template_bsensor_event_listener(event):
+            """Called when the target device changes state."""
+            self.update_ha_state(True)
+
+        hass.bus.listen(EVENT_STATE_CHANGED,
+                        template_bsensor_event_listener)
+
+    @property
+    def name(self):
+        """Return the name of the sensor."""
+        return self._name
+
+    @property
+    def is_on(self):
+        """Return true if sensor is on."""
+        return self._state
+
+    @property
+    def sensor_class(self):
+        """Return the sensor class of the sensor."""
+        return self._sensor_class
+
+    @property
+    def should_poll(self):
+        """No polling needed."""
+        return False
+
+    def update(self):
+        """Get the latest data and update the state."""
+        try:
+            self._state = template.render(self.hass,
+                                          self._template).lower() == 'true'
+        except TemplateError as ex:
+            if ex.args and ex.args[0].startswith(
+                    "UndefinedError: 'None' has no attribute"):
+                # Common during HA startup - so just a warning
+                _LOGGER.warning(ex)
+                return
+            _LOGGER.error(ex)
+            self._state = False

homeassistant/components/binary_sensor/vera.py

@@ -0,0 +1,69 @@
+"""
+Support for Vera binary sensors.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.vera/
+"""
+import logging
+
+import homeassistant.util.dt as dt_util
+from homeassistant.const import (
+    ATTR_ARMED, ATTR_BATTERY_LEVEL, ATTR_LAST_TRIP_TIME, ATTR_TRIPPED)
+from homeassistant.components.binary_sensor import (
+    BinarySensorDevice)
+from homeassistant.components.vera import (
+    VeraDevice, VERA_DEVICES, VERA_CONTROLLER)
+
+DEPENDENCIES = ['vera']
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def setup_platform(hass, config, add_devices_callback, discovery_info=None):
+    """Perform the setup for Vera controller devices."""
+    add_devices_callback(
+        VeraBinarySensor(device, VERA_CONTROLLER)
+        for device in VERA_DEVICES['binary_sensor'])
+
+
+class VeraBinarySensor(VeraDevice, BinarySensorDevice):
+    """Representation of a Vera Binary Sensor."""
+
+    def __init__(self, vera_device, controller):
+        """Initialize the binary_sensor."""
+        self._state = False
+        VeraDevice.__init__(self, vera_device, controller)
+
+    @property
+    def device_state_attributes(self):
+        """Return the state attributes."""
+        attr = {}
+        if self.vera_device.has_battery:
+            attr[ATTR_BATTERY_LEVEL] = self.vera_device.battery_level + '%'
+
+        if self.vera_device.is_armable:
+            armed = self.vera_device.is_armed
+            attr[ATTR_ARMED] = 'True' if armed else 'False'
+
+        if self.vera_device.is_trippable:
+            last_tripped = self.vera_device.last_trip
+            if last_tripped is not None:
+                utc_time = dt_util.utc_from_timestamp(int(last_tripped))
+                attr[ATTR_LAST_TRIP_TIME] = dt_util.datetime_to_str(
+                    utc_time)
+            else:
+                attr[ATTR_LAST_TRIP_TIME] = None
+            tripped = self.vera_device.is_tripped
+            attr[ATTR_TRIPPED] = 'True' if tripped else 'False'
+
+        attr['Vera Device Id'] = self.vera_device.vera_device_id
+        return attr
+
+    @property
+    def is_on(self):
+        """Return true if sensor is on."""
+        return self._state
+
+    def update(self):
+        """Get the latest data and update the state."""
+        self._state = self.vera_device.is_tripped

homeassistant/components/binary_sensor/wemo.py

@@ -0,0 +1,78 @@
+"""
+Support for WeMo sensors.
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.wemo/
+"""
+import logging
+
+from homeassistant.components.binary_sensor import BinarySensorDevice
+from homeassistant.loader import get_component
+
+DEPENDENCIES = ['wemo']
+
+_LOGGER = logging.getLogger(__name__)
+
+
+# pylint: disable=unused-argument, too-many-function-args
+def setup_platform(hass, config, add_devices_callback, discovery_info=None):
+    """Register discovered WeMo binary sensors."""
+    import pywemo.discovery as discovery
+
+    if discovery_info is not None:
+        location = discovery_info[2]
+        mac = discovery_info[3]
+        device = discovery.device_from_description(location, mac)
+
+        if device:
+            add_devices_callback([WemoBinarySensor(device)])
+
+
+class WemoBinarySensor(BinarySensorDevice):
+    """Represents a WeMo binary sensor."""
+
+    def __init__(self, device):
+        """Initialize the WeMo sensor."""
+        self.wemo = device
+        self._state = None
+
+        wemo = get_component('wemo')
+        wemo.SUBSCRIPTION_REGISTRY.register(self.wemo)
+        wemo.SUBSCRIPTION_REGISTRY.on(self.wemo, None, self._update_callback)
+
+    def _update_callback(self, _device, _params):
+        """Called by the wemo device callback to update state."""
+        _LOGGER.info(
+            'Subscription update for  %s',
+            _device)
+        if not hasattr(self, 'hass'):
+            self.update()
+            return
+        self.update_ha_state(True)
+
+    @property
+    def should_poll(self):
+        """No polling needed with subscriptions."""
+        return False
+
+    @property
+    def unique_id(self):
+        """Return the id of this WeMo device."""
+        return "{}.{}".format(self.__class__, self.wemo.serialnumber)
+
+    @property
+    def name(self):
+        """Return the name of the sevice if any."""
+        return self.wemo.name
+
+    @property
+    def is_on(self):
+        """True if sensor is on."""
+        return self._state
+
+    def update(self):
+        """Update WeMo state."""
+        try:
+            self._state = self.wemo.get_state(True)
+        except AttributeError:
+            _LOGGER.warning('Could not update status for %s', self.name)

homeassistant/components/binary_sensor/wink.py

@@ -0,0 +1,87 @@
+"""
+Support for Wink sensors.
+
+For more details about this platform, please refer to the documentation at
+at https://home-assistant.io/components/sensor.wink/
+"""
+import logging
+
+from homeassistant.components.binary_sensor import BinarySensorDevice
+from homeassistant.const import CONF_ACCESS_TOKEN
+from homeassistant.helpers.entity import Entity
+
+REQUIREMENTS = ['python-wink==0.6.4']
+
+# These are the available sensors mapped to binary_sensor class
+SENSOR_TYPES = {
+    "opened": "opening",
+    "brightness": "light",
+    "vibration": "vibration",
+    "loudness": "sound"
+}
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup the Wink platform."""
+    import pywink
+
+    if discovery_info is None:
+        token = config.get(CONF_ACCESS_TOKEN)
+
+        if token is None:
+            logging.getLogger(__name__).error(
+                "Missing wink access_token. "
+                "Get one at https://winkbearertoken.appspot.com/")
+            return
+
+        pywink.set_bearer_token(token)
+
+    for sensor in pywink.get_sensors():
+        if sensor.capability() in SENSOR_TYPES:
+            add_devices([WinkBinarySensorDevice(sensor)])
+
+
+class WinkBinarySensorDevice(BinarySensorDevice, Entity):
+    """Representation of a Wink sensor."""
+
+    def __init__(self, wink):
+        """Initialize the Wink binary sensor."""
+        self.wink = wink
+        self._unit_of_measurement = self.wink.UNIT
+        self.capability = self.wink.capability()
+
+    @property
+    def is_on(self):
+        """Return true if the binary sensor is on."""
+        if self.capability == "loudness":
+            return self.wink.loudness_boolean()
+        elif self.capability == "vibration":
+            return self.wink.vibration_boolean()
+        elif self.capability == "brightness":
+            return self.wink.brightness_boolean()
+        else:
+            return self.wink.state()
+
+    @property
+    def sensor_class(self):
+        """Return the class of this sensor, from SENSOR_CLASSES."""
+        return SENSOR_TYPES.get(self.capability)
+
+    @property
+    def unique_id(self):
+        """Return the ID of this wink sensor."""
+        return "{}.{}".format(self.__class__, self.wink.device_id())
+
+    @property
+    def name(self):
+        """Return the name of the sensor if any."""
+        return self.wink.name()
+
+    @property
+    def available(self):
+        """True if connection == True."""
+        return self.wink.available
+
+    def update(self):
+        """Update state of the sensor."""
+        self.wink.update_state()

homeassistant/components/binary_sensor/zigbee.py

@@ -0,0 +1,24 @@
+"""
+Contains functionality to use a ZigBee device as a binary sensor.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/binary_sensor.zigbee/
+"""
+from homeassistant.components.binary_sensor import BinarySensorDevice
+from homeassistant.components.zigbee import (
+    ZigBeeDigitalIn, ZigBeeDigitalInConfig)
+
+DEPENDENCIES = ["zigbee"]
+
+
+def setup_platform(hass, config, add_entities, discovery_info=None):
+    """Create and add an entity based on the configuration."""
+    add_entities([
+        ZigBeeBinarySensor(hass, ZigBeeDigitalInConfig(config))
+    ])
+
+
+class ZigBeeBinarySensor(ZigBeeDigitalIn, BinarySensorDevice):
+    """Use ZigBeeDigitalIn as binary sensor."""
+
+    pass

homeassistant/components/binary_sensor/zwave.py

@@ -0,0 +1,136 @@
+"""
+Interfaces with Z-Wave sensors.
+
+For more details about this platform, please refer to the documentation
+https://home-assistant.io/components/binary_sensor.zwave/
+"""
+import logging
+import datetime
+import homeassistant.util.dt as dt_util
+from homeassistant.helpers.event import track_point_in_time
+
+from homeassistant.components.zwave import (
+    ATTR_NODE_ID, ATTR_VALUE_ID,
+    COMMAND_CLASS_SENSOR_BINARY, NETWORK,
+    ZWaveDeviceEntity, get_config_value)
+from homeassistant.components.binary_sensor import (
+    DOMAIN,
+    BinarySensorDevice)
+
+_LOGGER = logging.getLogger(__name__)
+DEPENDENCIES = []
+
+PHILIO = 0x013c
+PHILIO_SLIM_SENSOR = 0x0002
+PHILIO_SLIM_SENSOR_MOTION = (PHILIO, PHILIO_SLIM_SENSOR, 0)
+WENZHOU = 0x0118
+WENZHOU_SLIM_SENSOR_MOTION = (WENZHOU, PHILIO_SLIM_SENSOR, 0)
+
+WORKAROUND_NO_OFF_EVENT = 'trigger_no_off_event'
+
+DEVICE_MAPPINGS = {
+    PHILIO_SLIM_SENSOR_MOTION: WORKAROUND_NO_OFF_EVENT,
+    WENZHOU_SLIM_SENSOR_MOTION: WORKAROUND_NO_OFF_EVENT,
+}
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup the Z-Wave platform for sensors."""
+    if discovery_info is None or NETWORK is None:
+        return
+
+    node = NETWORK.nodes[discovery_info[ATTR_NODE_ID]]
+    value = node.values[discovery_info[ATTR_VALUE_ID]]
+    value.set_change_verified(False)
+
+    # Make sure that we have values for the key before converting to int
+    if (value.node.manufacturer_id.strip() and
+            value.node.product_id.strip()):
+        specific_sensor_key = (int(value.node.manufacturer_id, 16),
+                               int(value.node.product_id, 16),
+                               value.index)
+
+        if specific_sensor_key in DEVICE_MAPPINGS:
+            if DEVICE_MAPPINGS[specific_sensor_key] == WORKAROUND_NO_OFF_EVENT:
+                # Default the multiplier to 4
+                re_arm_multiplier = (get_config_value(value.node, 9) or 4)
+                add_devices([
+                    ZWaveTriggerSensor(value, "motion",
+                                       hass, re_arm_multiplier * 8)
+                ])
+                return
+
+    if value.command_class == COMMAND_CLASS_SENSOR_BINARY:
+        add_devices([ZWaveBinarySensor(value, None)])
+
+
+class ZWaveBinarySensor(BinarySensorDevice, ZWaveDeviceEntity):
+    """Representation of a binary sensor within Z-Wave."""
+
+    def __init__(self, value, sensor_class):
+        """Initialize the sensor."""
+        self._sensor_type = sensor_class
+        # pylint: disable=import-error
+        from openzwave.network import ZWaveNetwork
+        from pydispatch import dispatcher
+
+        ZWaveDeviceEntity.__init__(self, value, DOMAIN)
+
+        dispatcher.connect(
+            self.value_changed, ZWaveNetwork.SIGNAL_VALUE_CHANGED)
+
+    @property
+    def is_on(self):
+        """Return True if the binary sensor is on."""
+        return self._value.data
+
+    @property
+    def sensor_class(self):
+        """Return the class of this sensor, from SENSOR_CLASSES."""
+        return self._sensor_type
+
+    @property
+    def should_poll(self):
+        """No polling needed."""
+        return False
+
+    def value_changed(self, value):
+        """Called when a value has changed on the network."""
+        if self._value.value_id == value.value_id:
+            self.update_ha_state()
+
+
+class ZWaveTriggerSensor(ZWaveBinarySensor):
+    """Representation of a stateless sensor within Z-Wave."""
+
+    def __init__(self, sensor_value, sensor_class, hass, re_arm_sec=60):
+        """Initialize the sensor."""
+        super(ZWaveTriggerSensor, self).__init__(sensor_value, sensor_class)
+        self._hass = hass
+        self.re_arm_sec = re_arm_sec
+        self.invalidate_after = dt_util.utcnow() + datetime.timedelta(
+            seconds=self.re_arm_sec)
+        # If it's active make sure that we set the timeout tracker
+        if sensor_value.data:
+            track_point_in_time(
+                self._hass, self.update_ha_state,
+                self.invalidate_after)
+
+    def value_changed(self, value):
+        """Called when a value has changed on the network."""
+        if self._value.value_id == value.value_id:
+            self.update_ha_state()
+            if value.data:
+                # only allow this value to be true for re_arm secs
+                self.invalidate_after = dt_util.utcnow() + datetime.timedelta(
+                    seconds=self.re_arm_sec)
+                track_point_in_time(
+                    self._hass, self.update_ha_state,
+                    self.invalidate_after)
+
+    @property
+    def is_on(self):
+        """Return True if movement has happened within the rearm time."""
+        return self._value.data and \
+            (self.invalidate_after is None or
+             self.invalidate_after > dt_util.utcnow())

homeassistant/components/bloomsky.py

@@ -0,0 +1,85 @@
+"""
+Support for BloomSky weather station.
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/bloomsky/
+"""
+import logging
+from datetime import timedelta
+
+import requests
+
+from homeassistant.components import discovery
+from homeassistant.const import CONF_API_KEY
+from homeassistant.helpers import validate_config
+from homeassistant.util import Throttle
+
+DOMAIN = "bloomsky"
+BLOOMSKY = None
+
+_LOGGER = logging.getLogger(__name__)
+
+# The BloomSky only updates every 5-8 minutes as per the API spec so there's
+# no point in polling the API more frequently
+MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=300)
+
+DISCOVER_SENSORS = 'bloomsky.sensors'
+DISCOVER_BINARY_SENSORS = 'bloomsky.binary_sensor'
+DISCOVER_CAMERAS = 'bloomsky.camera'
+
+
+# pylint: disable=unused-argument,too-few-public-methods
+def setup(hass, config):
+    """Setup BloomSky component."""
+    if not validate_config(
+            config,
+            {DOMAIN: [CONF_API_KEY]},
+            _LOGGER):
+        return False
+
+    api_key = config[DOMAIN][CONF_API_KEY]
+
+    global BLOOMSKY
+    try:
+        BLOOMSKY = BloomSky(api_key)
+    except RuntimeError:
+        return False
+
+    for component, discovery_service in (
+            ('camera', DISCOVER_CAMERAS), ('sensor', DISCOVER_SENSORS),
+            ('binary_sensor', DISCOVER_BINARY_SENSORS)):
+        discovery.discover(hass, discovery_service, component=component,
+                           hass_config=config)
+
+    return True
+
+
+class BloomSky(object):
+    """Handle all communication with the BloomSky API."""
+
+    # API documentation at http://weatherlution.com/bloomsky-api/
+    API_URL = "https://api.bloomsky.com/api/skydata"
+
+    def __init__(self, api_key):
+        """Initialize the BookSky."""
+        self._api_key = api_key
+        self.devices = {}
+        _LOGGER.debug("Initial bloomsky device load...")
+        self.refresh_devices()
+
+    @Throttle(MIN_TIME_BETWEEN_UPDATES)
+    def refresh_devices(self):
+        """Use the API to retreive a list of devices."""
+        _LOGGER.debug("Fetching bloomsky update")
+        response = requests.get(self.API_URL,
+                                headers={"Authorization": self._api_key},
+                                timeout=10)
+        if response.status_code == 401:
+            raise RuntimeError("Invalid API_KEY")
+        elif response.status_code != 200:
+            _LOGGER.error("Invalid HTTP response: %s", response.status_code)
+            return
+        # Create dictionary keyed off of the device unique id
+        self.devices.update({
+            device["DeviceID"]: device for device in response.json()
+        })

homeassistant/components/browser.py

@@ -1,21 +1,16 @@
 """
-homeassistant.components.browser
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Provides functionality to launch a webbrowser on the host machine.
+Provides functionality to launch a web browser on the host machine.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/browser/
 """
 
 DOMAIN = "browser"
-
 SERVICE_BROWSE_URL = "browse_url"
 
 
 def setup(hass, config):
-    """ Listen for browse_url events and open
-        the url in the default webbrowser. """
-
+    """Listen for browse_url events."""
     import webbrowser
 
     hass.services.register(DOMAIN, SERVICE_BROWSE_URL,

homeassistant/components/camera/__init__.py

@@ -1,8 +1,6 @@
 # pylint: disable=too-many-lines
 """
-homeassistant.components.camera
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Component to interface with various cameras.
+Component to interface with cameras.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/camera/
@@ -15,71 +13,42 @@ import requests
 
 from homeassistant.helpers.entity import Entity
 from homeassistant.helpers.entity_component import EntityComponent
-from homeassistant.const import (
-    ATTR_ENTITY_PICTURE,
-    HTTP_NOT_FOUND,
-    ATTR_ENTITY_ID,
-    )
+from homeassistant.components import bloomsky
+from homeassistant.const import HTTP_OK, HTTP_NOT_FOUND, ATTR_ENTITY_ID
+from homeassistant.helpers.config_validation import PLATFORM_SCHEMA  # noqa
 
 
 DOMAIN = 'camera'
 DEPENDENCIES = ['http']
-GROUP_NAME_ALL_CAMERAS = 'all_cameras'
 SCAN_INTERVAL = 30
 ENTITY_ID_FORMAT = DOMAIN + '.{}'
 
-SWITCH_ACTION_RECORD = 'record'
-SWITCH_ACTION_SNAPSHOT = 'snapshot'
-
-SERVICE_CAMERA = 'camera_service'
+# Maps discovered services to their platforms
+DISCOVERY_PLATFORMS = {
+    bloomsky.DISCOVER_CAMERAS: 'bloomsky',
+}
 
 STATE_RECORDING = 'recording'
-
-DEFAULT_RECORDING_SECONDS = 30
-
-# Maps discovered services to their platforms
-DISCOVERY_PLATFORMS = {}
-
-FILE_DATETIME_FORMAT = '%Y-%m-%d_%H-%M-%S-%f'
-DIR_DATETIME_FORMAT = '%Y-%m-%d_%H-%M-%S'
-
-REC_DIR_PREFIX = 'recording-'
-REC_IMG_PREFIX = 'recording_image-'
-
 STATE_STREAMING = 'streaming'
 STATE_IDLE = 'idle'
 
-CAMERA_PROXY_URL = '/api/camera_proxy_stream/{0}'
-CAMERA_STILL_URL = '/api/camera_proxy/{0}'
-ENTITY_IMAGE_URL = '/api/camera_proxy/{0}?time={1}'
+ENTITY_IMAGE_URL = '/api/camera_proxy/{0}'
 
-MULTIPART_BOUNDARY = '--jpegboundary'
+MULTIPART_BOUNDARY = '--jpgboundary'
 MJPEG_START_HEADER = 'Content-type: {0}\r\n\r\n'
 
 
 # pylint: disable=too-many-branches
 def setup(hass, config):
-    """ Track states and offer events for cameras. """
-
+    """Setup the camera component."""
     component = EntityComponent(
         logging.getLogger(__name__), DOMAIN, hass, SCAN_INTERVAL,
         DISCOVERY_PLATFORMS)
 
     component.setup(config)
 
-    # -------------------------------------------------------------------------
-    # CAMERA COMPONENT ENDPOINTS
-    # -------------------------------------------------------------------------
-    # The following defines the endpoints for serving images from the camera
-    # via the HA http server.  This is means that you can access images from
-    # your camera outside of your LAN without the need for port forwards etc.
-
-    # Because the authentication header can't be added in image requests these
-    # endpoints are secured with session based security.
-
-    # pylint: disable=unused-argument
     def _proxy_camera_image(handler, path_match, data):
-        """ Proxies the camera image via the HA server. """
+        """Serve the camera image via the HA server."""
         entity_id = path_match.group(ATTR_ENTITY_ID)
         camera = component.entities.get(entity_id)
 
@@ -95,21 +64,16 @@ def setup(hass, config):
             handler.end_headers()
             return
 
-        handler.wfile.write(response)
+        handler.send_response(HTTP_OK)
+        handler.write_content(response)
 
     hass.http.register_path(
         'GET',
         re.compile(r'/api/camera_proxy/(?P<entity_id>[a-zA-Z\._0-9]+)'),
         _proxy_camera_image)
 
-    # pylint: disable=unused-argument
     def _proxy_camera_mjpeg_stream(handler, path_match, data):
-        """
-        Proxies the camera image as an mjpeg stream via the HA server.
-        This function takes still images from the IP camera and turns them
-        into an MJPEG stream.  This means that HA can return a live video
-        stream even with only a still image URL available.
-        """
+        """Proxy the camera image as an mjpeg stream via the HA server."""
         entity_id = path_match.group(ATTR_ENTITY_ID)
         camera = component.entities.get(entity_id)
 
@@ -121,33 +85,7 @@ def setup(hass, config):
         try:
             camera.is_streaming = True
             camera.update_ha_state()
-
-            handler.request.sendall(bytes('HTTP/1.1 200 OK\r\n', 'utf-8'))
-            handler.request.sendall(bytes(
-                'Content-type: multipart/x-mixed-replace; \
-                    boundary=--jpgboundary\r\n\r\n', 'utf-8'))
-            handler.request.sendall(bytes('--jpgboundary\r\n', 'utf-8'))
-
-            # MJPEG_START_HEADER.format()
-
-            while True:
-                img_bytes = camera.camera_image()
-                if img_bytes is None:
-                    continue
-                headers_str = '\r\n'.join((
-                    'Content-length: {}'.format(len(img_bytes)),
-                    'Content-type: image/jpeg',
-                )) + '\r\n\r\n'
-
-                handler.request.sendall(
-                    bytes(headers_str, 'utf-8') +
-                    img_bytes +
-                    bytes('\r\n', 'utf-8'))
-
-                handler.request.sendall(
-                    bytes('--jpgboundary\r\n', 'utf-8'))
-
-                time.sleep(0.5)
+            camera.mjpeg_stream(handler)
 
         except (requests.RequestException, IOError):
             camera.is_streaming = False
@@ -155,44 +93,78 @@ def setup(hass, config):
 
     hass.http.register_path(
         'GET',
-        re.compile(
-            r'/api/camera_proxy_stream/(?P<entity_id>[a-zA-Z\._0-9]+)'),
+        re.compile(r'/api/camera_proxy_stream/(?P<entity_id>[a-zA-Z\._0-9]+)'),
         _proxy_camera_mjpeg_stream)
 
     return True
 
 
 class Camera(Entity):
-    """ The base class for camera components. """
+    """The base class for camera entities."""
 
     def __init__(self):
+        """Initialize a camera."""
         self.is_streaming = False
 
     @property
-    # pylint: disable=no-self-use
-    def is_recording(self):
-        """ Returns true if the device is recording. """
+    def should_poll(self):
+        """No need to poll cameras."""
+        return False
+
+    @property
+    def entity_picture(self):
+        """Return a link to the camera feed as entity picture."""
+        return ENTITY_IMAGE_URL.format(self.entity_id)
+
+    @property
+    def is_recording(self):
+        """Return true if the device is recording."""
         return False
 
     @property
-    # pylint: disable=no-self-use
     def brand(self):
-        """ Should return a string of the camera brand. """
+        """Camera brand."""
         return None
 
     @property
-    # pylint: disable=no-self-use
     def model(self):
-        """ Returns string of camera model. """
+        """Camera model."""
         return None
 
     def camera_image(self):
-        """ Return bytes of camera image. """
+        """Return bytes of camera image."""
         raise NotImplementedError()
 
+    def mjpeg_stream(self, handler):
+        """Generate an HTTP MJPEG stream from camera images."""
+        def write_string(text):
+            """Helper method to write a string to the stream."""
+            handler.request.sendall(bytes(text + '\r\n', 'utf-8'))
+
+        write_string('HTTP/1.1 200 OK')
+        write_string('Content-type: multipart/x-mixed-replace; '
+                     'boundary={}'.format(MULTIPART_BOUNDARY))
+        write_string('')
+        write_string(MULTIPART_BOUNDARY)
+
+        while True:
+            img_bytes = self.camera_image()
+
+            if img_bytes is None:
+                continue
+
+            write_string('Content-length: {}'.format(len(img_bytes)))
+            write_string('Content-type: image/jpeg')
+            write_string('')
+            handler.request.sendall(img_bytes)
+            write_string('')
+            write_string(MULTIPART_BOUNDARY)
+
+            time.sleep(0.5)
+
     @property
     def state(self):
-        """ Returns the state of the entity. """
+        """Camera state."""
         if self.is_recording:
             return STATE_RECORDING
         elif self.is_streaming:
@@ -202,11 +174,8 @@ class Camera(Entity):
 
     @property
     def state_attributes(self):
-        """ Returns optional state attributes. """
-        attr = {
-            ATTR_ENTITY_PICTURE: ENTITY_IMAGE_URL.format(
-                self.entity_id, time.time()),
-        }
+        """Camera state attributes."""
+        attr = {}
 
         if self.model:
             attr['model_name'] = self.model

homeassistant/components/camera/bloomsky.py

@@ -0,0 +1,61 @@
+"""
+Support for a camera of a BloomSky weather station.
+
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/camera.bloomsky/
+"""
+import logging
+
+import requests
+
+from homeassistant.components.camera import Camera
+from homeassistant.loader import get_component
+
+DEPENDENCIES = ["bloomsky"]
+
+
+# pylint: disable=unused-argument
+def setup_platform(hass, config, add_devices_callback, discovery_info=None):
+    """Setup access to BloomSky cameras."""
+    bloomsky = get_component('bloomsky')
+    for device in bloomsky.BLOOMSKY.devices.values():
+        add_devices_callback([BloomSkyCamera(bloomsky.BLOOMSKY, device)])
+
+
+class BloomSkyCamera(Camera):
+    """Representation of the images published from the BloomSky's camera."""
+
+    def __init__(self, bs, device):
+        """Setup for access to the BloomSky camera images."""
+        super(BloomSkyCamera, self).__init__()
+        self._name = device["DeviceName"]
+        self._id = device["DeviceID"]
+        self._bloomsky = bs
+        self._url = ""
+        self._last_url = ""
+        # _last_image will store images as they are downloaded so that the
+        # frequent updates in home-assistant don't keep poking the server
+        # to download the same image over and over.
+        self._last_image = ""
+        self._logger = logging.getLogger(__name__)
+
+    def camera_image(self):
+        """Update the camera's image if it has changed."""
+        try:
+            self._url = self._bloomsky.devices[self._id]["Data"]["ImageURL"]
+            self._bloomsky.refresh_devices()
+            # If the URL hasn't changed then the image hasn't changed.
+            if self._url != self._last_url:
+                response = requests.get(self._url, timeout=10)
+                self._last_url = self._url
+                self._last_image = response.content
+        except requests.exceptions.RequestException as error:
+            self._logger.error("Error getting bloomsky image: %s", error)
+            return None
+
+        return self._last_image
+
+    @property
+    def name(self):
+        """Return the name of this BloomSky device."""
+        return self._name

homeassistant/components/camera/demo.py

@@ -1,29 +1,32 @@
 """
-homeassistant.components.camera.demo
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Demo platform that has a fake camera.
+Demo camera platform that has a fake camera.
+
+For more details about this platform, please refer to the documentation
+https://home-assistant.io/components/demo/
 """
 import os
-from homeassistant.components.camera import Camera
+
 import homeassistant.util.dt as dt_util
+from homeassistant.components.camera import Camera
 
 
 def setup_platform(hass, config, add_devices, discovery_info=None):
-    """ Sets up the Demo camera. """
+    """Setup the Demo camera platform."""
     add_devices([
         DemoCamera('Demo camera')
     ])
 
 
 class DemoCamera(Camera):
-    """ A Demo camera. """
+    """A Demo camera."""
 
     def __init__(self, name):
+        """Initialize demo camera component."""
         super().__init__()
         self._name = name
 
     def camera_image(self):
-        """ Return a faked still image response. """
+        """Return a faked still image response."""
         now = dt_util.utcnow()
 
         image_path = os.path.join(os.path.dirname(__file__),
@@ -33,5 +36,5 @@ class DemoCamera(Camera):
 
     @property
     def name(self):
-        """ Return the name of this device. """
+        """Return the name of this camera."""
         return self._name

homeassistant/components/camera/foscam.py

@@ -1,6 +1,4 @@
 """
-homeassistant.components.camera.foscam
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 This component provides basic support for Foscam IP cameras.
 
 For more details about this platform, please refer to the documentation at
@@ -10,15 +8,15 @@ import logging
 
 import requests
 
-from homeassistant.helpers import validate_config
 from homeassistant.components.camera import DOMAIN, Camera
+from homeassistant.helpers import validate_config
 
 _LOGGER = logging.getLogger(__name__)
 
 
 # pylint: disable=unused-argument
 def setup_platform(hass, config, add_devices_callback, discovery_info=None):
-    """ Adds a Foscam IP Camera. """
+    """Setup a Foscam IP Camera."""
     if not validate_config({DOMAIN: config},
                            {DOMAIN: ['username', 'password', 'ip']}, _LOGGER):
         return None
@@ -28,9 +26,10 @@ def setup_platform(hass, config, add_devices_callback, discovery_info=None):
 
 # pylint: disable=too-many-instance-attributes
 class FoscamCamera(Camera):
-    """ An implementation of a Foscam IP camera. """
+    """An implementation of a Foscam IP camera."""
 
     def __init__(self, device_info):
+        """Initialize a Foscam camera."""
         super(FoscamCamera, self).__init__()
 
         ip_address = device_info.get('ip')
@@ -48,8 +47,7 @@ class FoscamCamera(Camera):
                      self._name, self._snap_picture_url)
 
     def camera_image(self):
-        """ Return a still image reponse from the camera. """
-
+        """Return a still image reponse from the camera."""
         # Send the request to snap a picture and return raw jpg data
         response = requests.get(self._snap_picture_url)
 
@@ -57,5 +55,5 @@ class FoscamCamera(Camera):
 
     @property
     def name(self):
-        """ Return the name of this device. """
+        """Return the name of this camera."""
         return self._name

homeassistant/components/camera/generic.py

@@ -1,6 +1,4 @@
 """
-homeassistant.components.camera.generic
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Support for IP Cameras.
 
 For more details about this platform, please refer to the documentation at
@@ -11,15 +9,15 @@ import logging
 import requests
 from requests.auth import HTTPBasicAuth
 
-from homeassistant.helpers import validate_config
 from homeassistant.components.camera import DOMAIN, Camera
+from homeassistant.helpers import validate_config
 
 _LOGGER = logging.getLogger(__name__)
 
 
 # pylint: disable=unused-argument
 def setup_platform(hass, config, add_devices_callback, discovery_info=None):
-    """ Adds a generic IP Camera. """
+    """Setup a generic IP Camera."""
     if not validate_config({DOMAIN: config}, {DOMAIN: ['still_image_url']},
                            _LOGGER):
         return None
@@ -29,11 +27,10 @@ def setup_platform(hass, config, add_devices_callback, discovery_info=None):
 
 # pylint: disable=too-many-instance-attributes
 class GenericCamera(Camera):
-    """
-    A generic implementation of an IP camera that is reachable over a URL.
-    """
+    """A generic implementation of an IP camera."""
 
     def __init__(self, device_info):
+        """Initialize a generic camera."""
         super().__init__()
         self._name = device_info.get('name', 'Generic Camera')
         self._username = device_info.get('username')
@@ -41,7 +38,7 @@ class GenericCamera(Camera):
         self._still_image_url = device_info['still_image_url']
 
     def camera_image(self):
-        """ Return a still image response from the camera. """
+        """Return a still image response from the camera."""
         if self._username and self._password:
             try:
                 response = requests.get(
@@ -61,5 +58,5 @@ class GenericCamera(Camera):
 
     @property
     def name(self):
-        """ Return the name of this device. """
+        """Return the name of this device."""
         return self._name

homeassistant/components/camera/mjpeg.py

@@ -1,26 +1,27 @@
 """
-homeassistant.components.camera.mjpeg
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Support for IP Cameras.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/camera.mjpeg/
 """
-from contextlib import closing
 import logging
+from contextlib import closing
 
 import requests
 from requests.auth import HTTPBasicAuth
 
-from homeassistant.helpers import validate_config
 from homeassistant.components.camera import DOMAIN, Camera
+from homeassistant.const import HTTP_OK
+from homeassistant.helpers import validate_config
+
+CONTENT_TYPE_HEADER = 'Content-Type'
 
 _LOGGER = logging.getLogger(__name__)
 
 
 # pylint: disable=unused-argument
 def setup_platform(hass, config, add_devices_callback, discovery_info=None):
-    """ Adds a mjpeg IP Camera. """
+    """Setup a MJPEG IP Camera."""
     if not validate_config({DOMAIN: config}, {DOMAIN: ['mjpeg_url']},
                            _LOGGER):
         return None
@@ -30,22 +31,31 @@ def setup_platform(hass, config, add_devices_callback, discovery_info=None):
 
 # pylint: disable=too-many-instance-attributes
 class MjpegCamera(Camera):
-    """
-    A generic implementation of an IP camera that is reachable over a URL.
-    """
+    """An implementation of an IP camera that is reachable over a URL."""
 
     def __init__(self, device_info):
+        """Initialize a MJPEG camera."""
         super().__init__()
         self._name = device_info.get('name', 'Mjpeg Camera')
         self._username = device_info.get('username')
         self._password = device_info.get('password')
         self._mjpeg_url = device_info['mjpeg_url']
 
-    def camera_image(self):
-        """ Return a still image response from the camera. """
+    def camera_stream(self):
+        """Return a MJPEG stream image response directly from the camera."""
+        if self._username and self._password:
+            return requests.get(self._mjpeg_url,
+                                auth=HTTPBasicAuth(self._username,
+                                                   self._password),
+                                stream=True)
+        else:
+            return requests.get(self._mjpeg_url,
+                                stream=True)
 
+    def camera_image(self):
+        """Return a still image response from the camera."""
         def process_response(response):
-            """ Take in a response object, return the jpg from it. """
+            """Take in a response object, return the jpg from it."""
             data = b''
             for chunk in response.iter_content(1024):
                 data += chunk
@@ -55,18 +65,24 @@ class MjpegCamera(Camera):
                     jpg = data[jpg_start:jpg_end + 2]
                     return jpg
 
-        if self._username and self._password:
-            with closing(requests.get(self._mjpeg_url,
-                                      auth=HTTPBasicAuth(self._username,
-                                                         self._password),
-                                      stream=True)) as response:
-                return process_response(response)
-        else:
-            with closing(requests.get(self._mjpeg_url,
-                                      stream=True)) as response:
-                return process_response(response)
+        with closing(self.camera_stream()) as response:
+            return process_response(response)
+
+    def mjpeg_stream(self, handler):
+        """Generate an HTTP MJPEG stream from the camera."""
+        response = self.camera_stream()
+        content_type = response.headers[CONTENT_TYPE_HEADER]
+
+        handler.send_response(HTTP_OK)
+        handler.send_header(CONTENT_TYPE_HEADER, content_type)
+        handler.end_headers()
+
+        for chunk in response.iter_content(chunk_size=1024):
+            if not chunk:
+                break
+            handler.wfile.write(chunk)
 
     @property
     def name(self):
-        """ Return the name of this device. """
+        """Return the name of this camera."""
         return self._name

homeassistant/components/camera/rpi_camera.py

@@ -0,0 +1,86 @@
+"""Camera platform that has a Raspberry Pi camera."""
+
+import os
+import subprocess
+import logging
+import shutil
+
+from homeassistant.components.camera import Camera
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Setup the Raspberry Camera."""
+    if shutil.which("raspistill") is None:
+        _LOGGER.error("Error: raspistill not found")
+        return False
+
+    setup_config = (
+        {
+            "name": config.get("name", "Raspberry Pi Camera"),
+            "image_width": int(config.get("image_width", "640")),
+            "image_height": int(config.get("image_height", "480")),
+            "image_quality": int(config.get("image_quality", "7")),
+            "image_rotation": int(config.get("image_rotation", "0")),
+            "timelapse": int(config.get("timelapse", "2000")),
+            "horizontal_flip": int(config.get("horizontal_flip", "0")),
+            "vertical_flip": int(config.get("vertical_flip", "0")),
+            "file_path": config.get("file_path",
+                                    os.path.join(os.path.dirname(__file__),
+                                                 'image.jpg'))
+        }
+    )
+
+    # check filepath given is writable
+    if not os.access(setup_config["file_path"], os.W_OK):
+        _LOGGER.error("Error: file path is not writable")
+        return False
+
+    add_devices([
+        RaspberryCamera(setup_config)
+    ])
+
+
+class RaspberryCamera(Camera):
+    """Raspberry Pi camera."""
+
+    def __init__(self, device_info):
+        """Initialize Raspberry Pi camera component."""
+        super().__init__()
+
+        self._name = device_info["name"]
+        self._config = device_info
+
+        # kill if there's raspistill instance
+        subprocess.Popen(['killall', 'raspistill'],
+                         stdout=subprocess.DEVNULL,
+                         stderr=subprocess.STDOUT)
+
+        cmd_args = [
+            'raspistill', '--nopreview', '-o', str(device_info["file_path"]),
+            '-t', '0', '-w', str(device_info["image_width"]),
+            '-h', str(device_info["image_height"]),
+            '-tl', str(device_info["timelapse"]),
+            '-q', str(device_info["image_quality"]),
+            '-rot', str(device_info["image_rotation"])
+        ]
+        if device_info["horizontal_flip"]:
+            cmd_args.append("-hf")
+
+        if device_info["vertical_flip"]:
+            cmd_args.append("-vf")
+
+        subprocess.Popen(cmd_args,
+                         stdout=subprocess.DEVNULL,
+                         stderr=subprocess.STDOUT)
+
+    def camera_image(self):
+        """Return raspstill image response."""
+        with open(self._config["file_path"], 'rb') as file:
+            return file.read()
+
+    @property
+    def name(self):
+        """Return the name of this camera."""
+        return self._name

homeassistant/components/camera/uvc.py

@@ -0,0 +1,158 @@
+"""
+Support for Ubiquiti's UVC cameras.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/camera.uvc/
+"""
+import logging
+import socket
+
+import requests
+
+from homeassistant.components.camera import DOMAIN, Camera
+from homeassistant.helpers import validate_config
+
+REQUIREMENTS = ['uvcclient==0.8']
+
+_LOGGER = logging.getLogger(__name__)
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Discover cameras on a Unifi NVR."""
+    if not validate_config({DOMAIN: config}, {DOMAIN: ['nvr', 'key']},
+                           _LOGGER):
+        return None
+
+    addr = config.get('nvr')
+    key = config.get('key')
+    try:
+        port = int(config.get('port', 7080))
+    except ValueError:
+        _LOGGER.error('Invalid port number provided')
+        return False
+
+    from uvcclient import nvr
+    nvrconn = nvr.UVCRemote(addr, port, key)
+    try:
+        cameras = nvrconn.index()
+    except nvr.NotAuthorized:
+        _LOGGER.error('Authorization failure while connecting to NVR')
+        return False
+    except nvr.NvrError:
+        _LOGGER.error('NVR refuses to talk to me')
+        return False
+    except requests.exceptions.ConnectionError as ex:
+        _LOGGER.error('Unable to connect to NVR: %s', str(ex))
+        return False
+
+    # Filter out airCam models, which are not supported in the latest
+    # version of UnifiVideo and which are EOL by Ubiquiti
+    cameras = [camera for camera in cameras
+               if 'airCam' not in nvrconn.get_camera(camera['uuid'])['model']]
+
+    add_devices([UnifiVideoCamera(nvrconn,
+                                  camera['uuid'],
+                                  camera['name'])
+                 for camera in cameras])
+    return True
+
+
+class UnifiVideoCamera(Camera):
+    """A Ubiquiti Unifi Video Camera."""
+
+    def __init__(self, nvr, uuid, name):
+        """Initialize an Unifi camera."""
+        super(UnifiVideoCamera, self).__init__()
+        self._nvr = nvr
+        self._uuid = uuid
+        self._name = name
+        self.is_streaming = False
+        self._connect_addr = None
+        self._camera = None
+
+    @property
+    def name(self):
+        """Return the name of this camera."""
+        return self._name
+
+    @property
+    def is_recording(self):
+        """Return true if the camera is recording."""
+        caminfo = self._nvr.get_camera(self._uuid)
+        return caminfo['recordingSettings']['fullTimeRecordEnabled']
+
+    @property
+    def brand(self):
+        """Return the brand of this camera."""
+        return 'Ubiquiti'
+
+    @property
+    def model(self):
+        """Return the model of this camera."""
+        caminfo = self._nvr.get_camera(self._uuid)
+        return caminfo['model']
+
+    def _login(self):
+        """Login to the camera."""
+        from uvcclient import camera as uvc_camera
+        from uvcclient import store as uvc_store
+
+        caminfo = self._nvr.get_camera(self._uuid)
+        if self._connect_addr:
+            addrs = [self._connect_addr]
+        else:
+            addrs = [caminfo['host'], caminfo['internalHost']]
+
+        store = uvc_store.get_info_store()
+        password = store.get_camera_password(self._uuid)
+        if password is None:
+            _LOGGER.debug('Logging into camera %(name)s with default password',
+                          dict(name=self._name))
+            password = 'ubnt'
+
+        camera = None
+        for addr in addrs:
+            try:
+                camera = uvc_camera.UVCCameraClient(addr,
+                                                    caminfo['username'],
+                                                    password)
+                camera.login()
+                _LOGGER.debug('Logged into UVC camera %(name)s via %(addr)s',
+                              dict(name=self._name, addr=addr))
+                self._connect_addr = addr
+                break
+            except socket.error:
+                pass
+            except uvc_camera.CameraConnectError:
+                pass
+            except uvc_camera.CameraAuthError:
+                pass
+        if not self._connect_addr:
+            _LOGGER.error('Unable to login to camera')
+            return None
+
+        self._camera = camera
+        return True
+
+    def camera_image(self):
+        """Return the image of this camera."""
+        from uvcclient import camera as uvc_camera
+        if not self._camera:
+            if not self._login():
+                return
+
+        def _get_image(retry=True):
+            try:
+                return self._camera.get_snapshot()
+            except uvc_camera.CameraConnectError:
+                _LOGGER.error('Unable to contact camera')
+            except uvc_camera.CameraAuthError:
+                if retry:
+                    self._login()
+                    return _get_image(retry=False)
+                else:
+                    _LOGGER.error('Unable to log into camera, unable '
+                                  'to get snapshot')
+                    raise
+
+        return _get_image()

homeassistant/components/configurator.py

@@ -1,8 +1,5 @@
 """
-homeassistant.components.configurator
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-A component to allow pieces of code to request configuration from the user.
+Support to allow pieces of code to request configuration from the user.
 
 Initiate a request by calling the `request_config` method with a callback.
 This will return a request id that has to be used for future calls.
@@ -11,8 +8,8 @@ the user has submitted configuration information.
 """
 import logging
 
-from homeassistant.helpers import generate_entity_id
 from homeassistant.const import EVENT_TIME_CHANGED
+from homeassistant.helpers.entity import generate_entity_id
 
 DOMAIN = "configurator"
 ENTITY_ID_FORMAT = DOMAIN + ".{}"
@@ -38,9 +35,10 @@ _LOGGER = logging.getLogger(__name__)
 def request_config(
         hass, name, callback, description=None, description_image=None,
         submit_caption=None, fields=None):
-    """ Create a new request for config.
-    Will return an ID to be used for sequent calls. """
+    """Create a new request for configuration.
 
+    Will return an ID to be used for sequent calls.
+    """
     instance = _get_instance(hass)
 
     request_id = instance.request_config(
@@ -53,7 +51,7 @@ def request_config(
 
 
 def notify_errors(request_id, error):
-    """ Add errors to a config request. """
+    """Add errors to a config request."""
     try:
         _REQUESTS[request_id].notify_errors(request_id, error)
     except KeyError:
@@ -62,7 +60,7 @@ def notify_errors(request_id, error):
 
 
 def request_done(request_id):
-    """ Mark a config request as done. """
+    """Mark a configuration request as done."""
     try:
         _REQUESTS.pop(request_id).request_done(request_id)
     except KeyError:
@@ -71,12 +69,12 @@ def request_done(request_id):
 
 
 def setup(hass, config):
-    """ Set up Configurator. """
+    """Setup the configurator component."""
     return True
 
 
 def _get_instance(hass):
-    """ Get an instance per hass object. """
+    """Get an instance per hass object."""
     try:
         return _INSTANCES[hass]
     except KeyError:
@@ -89,11 +87,10 @@ def _get_instance(hass):
 
 
 class Configurator(object):
-    """
-    Class to keep track of current configuration requests.
-    """
+    """The class to keep track of current configuration requests."""
 
     def __init__(self, hass):
+        """Initialize the configurator."""
         self.hass = hass
         self._cur_id = 0
         self._requests = {}
@@ -104,8 +101,7 @@ class Configurator(object):
     def request_config(
             self, name, callback,
             description, description_image, submit_caption, fields):
-        """ Setup a request for configuration. """
-
+        """Setup a request for configuration."""
         entity_id = generate_entity_id(ENTITY_ID_FORMAT, name, hass=self.hass)
 
         if fields is None:
@@ -133,7 +129,7 @@ class Configurator(object):
         return request_id
 
     def notify_errors(self, request_id, error):
-        """ Update the state with errors. """
+        """Update the state with errors."""
         if not self._validate_request_id(request_id):
             return
 
@@ -141,13 +137,13 @@ class Configurator(object):
 
         state = self.hass.states.get(entity_id)
 
-        new_data = state.attributes
+        new_data = dict(state.attributes)
         new_data[ATTR_ERRORS] = error
 
         self.hass.states.set(entity_id, STATE_CONFIGURE, new_data)
 
     def request_done(self, request_id):
-        """ Remove the config request. """
+        """Remove the configuration request."""
         if not self._validate_request_id(request_id):
             return
 
@@ -160,13 +156,13 @@ class Configurator(object):
         self.hass.states.set(entity_id, STATE_CONFIGURED)
 
         def deferred_remove(event):
-            """ Remove the request state. """
+            """Remove the request state."""
             self.hass.states.remove(entity_id)
 
         self.hass.bus.listen_once(EVENT_TIME_CHANGED, deferred_remove)
 
     def handle_service_call(self, call):
-        """ Handle a configure service call. """
+        """Handle a configure service call."""
         request_id = call.data.get(ATTR_CONFIGURE_ID)
 
         if not self._validate_request_id(request_id):
@@ -180,10 +176,10 @@ class Configurator(object):
         callback(call.data.get(ATTR_FIELDS, {}))
 
     def _generate_unique_id(self):
-        """ Generates a unique configurator id. """
+        """Generate a unique configurator ID."""
         self._cur_id += 1
         return "{}-{}".format(id(self), self._cur_id)
 
     def _validate_request_id(self, request_id):
-        """ Validate that the request belongs to this instance. """
+        """Validate that the request belongs to this instance."""
         return request_id in self._requests

homeassistant/components/conversation.py

@@ -1,18 +1,16 @@
 """
-homeassistant.components.conversation
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Provides functionality to have conversations with Home Assistant.
+Support for functionality to have conversations with Home Assistant.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/conversation/
 """
 import logging
 import re
-
+import warnings
 
 from homeassistant import core
 from homeassistant.const import (
-    ATTR_ENTITY_ID, SERVICE_TURN_ON, SERVICE_TURN_OFF)
+    ATTR_ENTITY_ID, SERVICE_TURN_OFF, SERVICE_TURN_ON)
 
 DOMAIN = "conversation"
 
@@ -26,19 +24,19 @@ REQUIREMENTS = ['fuzzywuzzy==0.8.0']
 
 
 def setup(hass, config):
-    """ Registers the process service. """
+    """Register the process service."""
+    warnings.filterwarnings('ignore', module='fuzzywuzzy')
     from fuzzywuzzy import process as fuzzyExtract
 
     logger = logging.getLogger(__name__)
 
     def process(service):
-        """ Parses text into commands for Home Assistant. """
+        """Parse text into commands."""
         if ATTR_TEXT not in service.data:
             logger.error("Received process service call without a text")
             return
 
         text = service.data[ATTR_TEXT].lower()
-
         match = REGEX_TURN_COMMAND.match(text)
 
         if not match:
@@ -46,11 +44,8 @@ def setup(hass, config):
             return
 
         name, command = match.groups()
-
         entities = {state.entity_id: state.name for state in hass.states.all()}
-
-        entity_ids = fuzzyExtract.extractOne(name,
-                                             entities,
+        entity_ids = fuzzyExtract.extractOne(name, entities,
                                              score_cutoff=65)[2]
 
         if not entity_ids:

homeassistant/components/demo.py

@@ -1,16 +1,15 @@
 """
-homeassistant.components.demo
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
 Sets up a demo environment that mimics interaction with devices.
+
+For more details about this component, please refer to the documentation
+https://home-assistant.io/components/demo/
 """
 import time
 
-import homeassistant.core as ha
 import homeassistant.bootstrap as bootstrap
+import homeassistant.core as ha
 import homeassistant.loader as loader
-from homeassistant.const import (
-    CONF_PLATFORM, ATTR_ENTITY_ID)
+from homeassistant.const import ATTR_ENTITY_ID, CONF_PLATFORM
 
 DOMAIN = "demo"
 
@@ -21,6 +20,7 @@ COMPONENTS_WITH_DEMO_PLATFORM = [
     'binary_sensor',
     'camera',
     'device_tracker',
+    'garage_door',
     'light',
     'lock',
     'media_player',
@@ -33,7 +33,7 @@ COMPONENTS_WITH_DEMO_PLATFORM = [
 
 
 def setup(hass, config):
-    """ Setup a demo environment. """
+    """Setup a demo environment."""
     group = loader.get_component('group')
     configurator = loader.get_component('configurator')
 
@@ -62,10 +62,31 @@ def setup(hass, config):
     lights = sorted(hass.states.entity_ids('light'))
     switches = sorted(hass.states.entity_ids('switch'))
     media_players = sorted(hass.states.entity_ids('media_player'))
-    group.setup_group(hass, 'living room', [lights[2], lights[1], switches[0],
-                                            media_players[1]])
-    group.setup_group(hass, 'bedroom', [lights[0], switches[1],
-                                        media_players[0]])
+    group.Group(hass, 'living room', [
+        lights[1], switches[0], 'input_select.living_room_preset',
+        'rollershutter.living_room_window', media_players[1],
+        'scene.romantic_lights'])
+    group.Group(hass, 'bedroom', [lights[0], switches[1], media_players[0]])
+    group.Group(hass, 'kitchen', [
+        lights[2], 'rollershutter.kitchen_window', 'lock.kitchen_door'])
+    group.Group(hass, 'doors', [
+        'lock.front_door', 'lock.kitchen_door',
+        'garage_door.right_garage_door', 'garage_door.left_garage_door'])
+    group.Group(hass, 'automations', [
+        'input_select.who_cooks', 'input_boolean.notify', ])
+    group.Group(hass, 'people', [
+        'device_tracker.demo_anne_therese', 'device_tracker.demo_home_boy',
+        'device_tracker.demo_paulus'])
+    group.Group(hass, 'thermostats', [
+        'thermostat.nest', 'thermostat.thermostat'])
+    group.Group(hass, 'downstairs', [
+        'group.living_room', 'group.kitchen',
+        'scene.romantic_lights', 'rollershutter.kitchen_window',
+        'rollershutter.living_room_window', 'group.doors', 'thermostat.nest',
+    ], view=True)
+    group.Group(hass, 'Upstairs', [
+        'thermostat.thermostat', 'group.bedroom',
+    ], view=True)
 
     # Setup scripts
     bootstrap.setup_component(
@@ -74,18 +95,18 @@ def setup(hass, config):
             'demo': {
                 'alias': 'Toggle {}'.format(lights[0].split('.')[1]),
                 'sequence': [{
-                    'execute_service': 'light.turn_off',
-                    'service_data': {ATTR_ENTITY_ID: lights[0]}
+                    'service': 'light.turn_off',
+                    'data': {ATTR_ENTITY_ID: lights[0]}
                 }, {
                     'delay': {'seconds': 5}
                 }, {
-                    'execute_service': 'light.turn_on',
-                    'service_data': {ATTR_ENTITY_ID: lights[0]}
+                    'service': 'light.turn_on',
+                    'data': {ATTR_ENTITY_ID: lights[0]}
                 }, {
                     'delay': {'seconds': 5}
                 }, {
-                    'execute_service': 'light.turn_off',
-                    'service_data': {ATTR_ENTITY_ID: lights[0]}
+                    'service': 'light.turn_off',
+                    'data': {ATTR_ENTITY_ID: lights[0]}
                 }]
             }}})
 
@@ -106,11 +127,33 @@ def setup(hass, config):
              }},
             ]})
 
+    # Set up input select
+    bootstrap.setup_component(
+        hass, 'input_select',
+        {'input_select':
+         {'living_room_preset': {'options': ['Visitors',
+                                             'Visitors with kids',
+                                             'Home Alone']},
+          'who_cooks': {'icon': 'mdi:panda',
+                        'initial': 'Anne Therese',
+                        'name': 'Cook today',
+                        'options': ['Paulus', 'Anne Therese']}}})
+    # Set up input boolean
+    bootstrap.setup_component(
+        hass, 'input_boolean',
+        {'input_boolean': {'notify': {'icon': 'mdi:car',
+                                      'initial': False,
+                                      'name': 'Notify Anne Therese is home'}}})
+    # Set up weblink
+    bootstrap.setup_component(
+        hass, 'weblink',
+        {'weblink': {'entities': [{'name': 'Router',
+                                   'url': 'http://192.168.1.1'}]}})
     # Setup configurator
     configurator_ids = []
 
     def hue_configuration_callback(data):
-        """ Fake callback, mark config as done. """
+        """Fake callback, mark config as done."""
         time.sleep(2)
 
         # First time it is called, pretend it failed.

homeassistant/components/device_sun_light_trigger.py

@@ -1,8 +1,5 @@
 """
-homeassistant.components.device_sun_light_trigger
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Provides functionality to turn on lights based on the state of the sun and
-devices.
+Provides functionality to turn on lights based on the states.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/device_sun_light_trigger/
@@ -10,10 +7,11 @@ https://home-assistant.io/components/device_sun_light_trigger/
 import logging
 from datetime import timedelta
 
-from homeassistant.helpers.event import track_point_in_time, track_state_change
 import homeassistant.util.dt as dt_util
 from homeassistant.const import STATE_HOME, STATE_NOT_HOME
-from . import light, sun, device_tracker, group
+from homeassistant.helpers.event import track_point_in_time
+from homeassistant.helpers.event_decorators import track_state_change
+from homeassistant.loader import get_component
 
 DOMAIN = "device_sun_light_trigger"
 DEPENDENCIES = ['light', 'device_tracker', 'group', 'sun']
@@ -28,28 +26,26 @@ CONF_LIGHT_GROUP = 'light_group'
 CONF_DEVICE_GROUP = 'device_group'
 
 
-# pylint: disable=too-many-branches
+# pylint: disable=too-many-locals
 def setup(hass, config):
-    """ Triggers to turn lights on or off based on device precense. """
+    """The triggers to turn lights on or off based on device presence."""
+    logger = logging.getLogger(__name__)
+    device_tracker = get_component('device_tracker')
+    group = get_component('group')
+    light = get_component('light')
+    sun = get_component('sun')
 
     disable_turn_off = 'disable_turn_off' in config[DOMAIN]
-
     light_group = config[DOMAIN].get(CONF_LIGHT_GROUP,
                                      light.ENTITY_ID_ALL_LIGHTS)
-
     light_profile = config[DOMAIN].get(CONF_LIGHT_PROFILE, LIGHT_PROFILE)
-
     device_group = config[DOMAIN].get(CONF_DEVICE_GROUP,
                                       device_tracker.ENTITY_ID_ALL_DEVICES)
-
-    logger = logging.getLogger(__name__)
-
     device_entity_ids = group.get_entity_ids(hass, device_group,
                                              device_tracker.DOMAIN)
 
     if not device_entity_ids:
         logger.error("No devices found to track")
-
         return False
 
     # Get the light IDs from the specified group
@@ -57,116 +53,105 @@ def setup(hass, config):
 
     if not light_ids:
         logger.error("No lights found to turn on ")
-
         return False
 
     def calc_time_for_light_when_sunset():
-        """ Calculates the time when to start fading lights in when sun sets.
-        Returns None if no next_setting data available. """
+        """Calculate the time when to start fading lights in when sun sets.
+
+        Returns None if no next_setting data available.
+        """
         next_setting = sun.next_setting(hass)
-
-        if next_setting:
-            return next_setting - LIGHT_TRANSITION_TIME * len(light_ids)
-        else:
+        if not next_setting:
             return None
+        return next_setting - LIGHT_TRANSITION_TIME * len(light_ids)
 
-    def schedule_light_on_sun_rise(entity, old_state, new_state):
-        """The moment sun sets we want to have all the lights on.
-           We will schedule to have each light start after one another
-           and slowly transition in."""
+    def turn_light_on_before_sunset(light_id):
+        """Helper function to turn on lights.
 
-        def turn_light_on_before_sunset(light_id):
-            """ Helper function to turn on lights slowly if there
-                are devices home and the light is not on yet. """
-            if device_tracker.is_on(hass) and not light.is_on(hass, light_id):
-
-                light.turn_on(hass, light_id,
-                              transition=LIGHT_TRANSITION_TIME.seconds,
-                              profile=light_profile)
-
-        def turn_on(light_id):
-            """ Lambda can keep track of function parameters but not local
-            parameters. If we put the lambda directly in the below statement
-            only the last light will be turned on.. """
-            return lambda now: turn_light_on_before_sunset(light_id)
-
-        start_point = calc_time_for_light_when_sunset()
-
-        if start_point:
-            for index, light_id in enumerate(light_ids):
-                track_point_in_time(
-                    hass, turn_on(light_id),
-                    (start_point + index * LIGHT_TRANSITION_TIME))
+        Speed is slow if there are devices home and the light is not on yet.
+        """
+        if not device_tracker.is_on(hass) or light.is_on(hass, light_id):
+            return
+        light.turn_on(hass, light_id,
+                      transition=LIGHT_TRANSITION_TIME.seconds,
+                      profile=light_profile)
 
     # Track every time sun rises so we can schedule a time-based
     # pre-sun set event
-    track_state_change(hass, sun.ENTITY_ID, schedule_light_on_sun_rise,
-                       sun.STATE_BELOW_HORIZON, sun.STATE_ABOVE_HORIZON)
+    @track_state_change(sun.ENTITY_ID, sun.STATE_BELOW_HORIZON,
+                        sun.STATE_ABOVE_HORIZON)
+    def schedule_lights_at_sun_set(hass, entity, old_state, new_state):
+        """The moment sun sets we want to have all the lights on.
 
-    # If the sun is already above horizon
-    # schedule the time-based pre-sun set event
+        We will schedule to have each light start after one another
+        and slowly transition in.
+        """
+        start_point = calc_time_for_light_when_sunset()
+        if not start_point:
+            return
+
+        def turn_on(light_id):
+            """Lambda can keep track of function parameters.
+
+            No local parameters. If we put the lambda directly in the below
+            statement only the last light will be turned on.
+            """
+            return lambda now: turn_light_on_before_sunset(light_id)
+
+        for index, light_id in enumerate(light_ids):
+            track_point_in_time(hass, turn_on(light_id),
+                                start_point + index * LIGHT_TRANSITION_TIME)
+
+    # If the sun is already above horizon schedule the time-based pre-sun set
+    # event.
     if sun.is_on(hass):
-        schedule_light_on_sun_rise(None, None, None)
+        schedule_lights_at_sun_set(hass, None, None, None)
 
-    def check_light_on_dev_state_change(entity, old_state, new_state):
-        """ Function to handle tracked device state changes. """
+    @track_state_change(device_entity_ids, STATE_NOT_HOME, STATE_HOME)
+    def check_light_on_dev_state_change(hass, entity, old_state, new_state):
+        """Handle tracked device state changes."""
+        # pylint: disable=unused-variable
         lights_are_on = group.is_on(hass, light_group)
 
         light_needed = not (lights_are_on or sun.is_on(hass))
 
-        # Specific device came home ?
-        if entity != device_tracker.ENTITY_ID_ALL_DEVICES and \
-           new_state.state == STATE_HOME:
+        # These variables are needed for the elif check
+        now = dt_util.now()
+        start_point = calc_time_for_light_when_sunset()
 
-            # These variables are needed for the elif check
-            now = dt_util.now()
-            start_point = calc_time_for_light_when_sunset()
+        # Do we need lights?
+        if light_needed:
+            logger.info("Home coming event for %s. Turning lights on", entity)
+            light.turn_on(hass, light_ids, profile=light_profile)
 
-            # Do we need lights?
-            if light_needed:
+        # Are we in the time span were we would turn on the lights
+        # if someone would be home?
+        # Check this by seeing if current time is later then the point
+        # in time when we would start putting the lights on.
+        elif (start_point and
+              start_point < now < sun.next_setting(hass)):
 
-                logger.info(
-                    "Home coming event for %s. Turning lights on", entity)
+            # Check for every light if it would be on if someone was home
+            # when the fading in started and turn it on if so
+            for index, light_id in enumerate(light_ids):
+                if now > start_point + index * LIGHT_TRANSITION_TIME:
+                    light.turn_on(hass, light_id)
 
-                light.turn_on(hass, light_ids, profile=light_profile)
+                else:
+                    # If this light didn't happen to be turned on yet so
+                    # will all the following then, break.
+                    break
 
-            # Are we in the time span were we would turn on the lights
-            # if someone would be home?
-            # Check this by seeing if current time is later then the point
-            # in time when we would start putting the lights on.
-            elif (start_point and
-                  start_point < now < sun.next_setting(hass)):
-
-                # Check for every light if it would be on if someone was home
-                # when the fading in started and turn it on if so
-                for index, light_id in enumerate(light_ids):
-
-                    if now > start_point + index * LIGHT_TRANSITION_TIME:
-                        light.turn_on(hass, light_id)
-
-                    else:
-                        # If this light didn't happen to be turned on yet so
-                        # will all the following then, break.
-                        break
-
-        # Did all devices leave the house?
-        elif (entity == device_group and
-              new_state.state == STATE_NOT_HOME and lights_are_on and
-              not disable_turn_off):
+    if not disable_turn_off:
+        @track_state_change(device_group, STATE_HOME, STATE_NOT_HOME)
+        def turn_off_lights_when_all_leave(hass, entity, old_state, new_state):
+            """Handle device group state change."""
+            # pylint: disable=unused-variable
+            if not group.is_on(hass, light_group):
+                return
 
             logger.info(
                 "Everyone has left but there are lights on. Turning them off")
-
             light.turn_off(hass, light_ids)
 
-    # Track home coming of each device
-    track_state_change(
-        hass, device_entity_ids, check_light_on_dev_state_change,
-        STATE_NOT_HOME, STATE_HOME)
-
-    # Track when all devices are gone to shut down lights
-    track_state_change(
-        hass, device_group, check_light_on_dev_state_change,
-        STATE_HOME, STATE_NOT_HOME)
-
     return True

homeassistant/components/device_tracker/__init__.py

@@ -1,14 +1,11 @@
 """
-homeassistant.components.device_tracker
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Provides functionality to keep track of devices.
+Provide functionality to keep track of devices.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/device_tracker/
 """
 # pylint: disable=too-many-instance-attributes, too-many-arguments
 # pylint: disable=too-many-locals
-import csv
 from datetime import timedelta
 import logging
 import os
@@ -20,12 +17,13 @@ from homeassistant.config import load_yaml_config_file
 from homeassistant.exceptions import HomeAssistantError
 from homeassistant.helpers import config_per_platform
 from homeassistant.helpers.entity import Entity
+from homeassistant.helpers.config_validation import PLATFORM_SCHEMA  # noqa
 import homeassistant.util as util
 import homeassistant.util.dt as dt_util
 
 from homeassistant.helpers.event import track_utc_time_change
 from homeassistant.const import (
-    ATTR_ENTITY_PICTURE, ATTR_GPS_ACCURACY, ATTR_LATITUDE, ATTR_LONGITUDE,
+    ATTR_GPS_ACCURACY, ATTR_LATITUDE, ATTR_LONGITUDE,
     DEVICE_DEFAULT_NAME, STATE_HOME, STATE_NOT_HOME)
 
 DOMAIN = "device_tracker"
@@ -36,7 +34,6 @@ ENTITY_ID_ALL_DEVICES = group.ENTITY_ID_FORMAT.format('all_devices')
 
 ENTITY_ID_FORMAT = DOMAIN + '.{}'
 
-CSV_DEVICES = "known_devices.csv"
 YAML_DEVICES = 'known_devices.yaml'
 
 CONF_TRACK_NEW = "track_new_devices"
@@ -72,7 +69,7 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def is_on(hass, entity_id=None):
-    """ Returns if any or specified device is home. """
+    """Return the state if any or a specified device is home."""
     entity = entity_id or ENTITY_ID_ALL_DEVICES
 
     return hass.states.is_state(entity, STATE_HOME)
@@ -80,23 +77,21 @@ def is_on(hass, entity_id=None):
 
 def see(hass, mac=None, dev_id=None, host_name=None, location_name=None,
         gps=None, gps_accuracy=None, battery=None):
-    """ Call service to notify you see device. """
+    """Call service to notify you see device."""
     data = {key: value for key, value in
             ((ATTR_MAC, mac),
              (ATTR_DEV_ID, dev_id),
              (ATTR_HOST_NAME, host_name),
              (ATTR_LOCATION_NAME, location_name),
-             (ATTR_GPS, gps)) if value is not None}
+             (ATTR_GPS, gps),
+             (ATTR_GPS_ACCURACY, gps_accuracy),
+             (ATTR_BATTERY, battery)) if value is not None}
     hass.services.call(DOMAIN, SERVICE_SEE, data)
 
 
 def setup(hass, config):
-    """ Setup device tracker """
+    """Setup device tracker."""
     yaml_path = hass.config.path(YAML_DEVICES)
-    csv_path = hass.config.path(CSV_DEVICES)
-    if os.path.isfile(csv_path) and not os.path.isfile(yaml_path) and \
-       convert_csv_config(csv_path, yaml_path):
-        os.remove(csv_path)
 
     conf = config.get(DOMAIN, {})
     if isinstance(conf, list):
@@ -114,7 +109,7 @@ def setup(hass, config):
                             devices)
 
     def setup_platform(p_type, p_config, disc_info=None):
-        """ Setup a device tracker platform. """
+        """Setup a device tracker platform."""
         platform = prepare_setup_platform(hass, config, DOMAIN, p_type)
         if platform is None:
             return
@@ -135,26 +130,25 @@ def setup(hass, config):
         except Exception:  # pylint: disable=broad-except
             _LOGGER.exception('Error setting up platform %s', p_type)
 
-    for p_type, p_config in \
-            config_per_platform(config, DOMAIN, _LOGGER):
+    for p_type, p_config in config_per_platform(config, DOMAIN):
         setup_platform(p_type, p_config)
 
     def device_tracker_discovered(service, info):
-        """ Called when a device tracker platform is discovered. """
+        """Called when a device tracker platform is discovered."""
         setup_platform(DISCOVERY_PLATFORMS[service], {}, info)
 
     discovery.listen(hass, DISCOVERY_PLATFORMS.keys(),
                      device_tracker_discovered)
 
     def update_stale(now):
-        """ Clean up stale devices. """
+        """Clean up stale devices."""
         tracker.update_stale(now)
     track_utc_time_change(hass, update_stale, second=range(0, 60, 5))
 
     tracker.setup_group()
 
     def see_service(call):
-        """ Service to see a device. """
+        """Service to see a device."""
         args = {key: value for key, value in call.data.items() if key in
                 (ATTR_MAC, ATTR_DEV_ID, ATTR_HOST_NAME, ATTR_LOCATION_NAME,
                  ATTR_GPS, ATTR_GPS_ACCURACY, ATTR_BATTERY)}
@@ -169,8 +163,10 @@ def setup(hass, config):
 
 
 class DeviceTracker(object):
-    """ Track devices """
+    """Representation of a device tracker."""
+
     def __init__(self, hass, consider_home, track_new, home_range, devices):
+        """Initialize a device tracker."""
         self.hass = hass
         self.devices = {dev.dev_id: dev for dev in devices}
         self.mac_to_dev = {dev.mac: dev for dev in devices if dev.mac}
@@ -187,7 +183,7 @@ class DeviceTracker(object):
 
     def see(self, mac=None, dev_id=None, host_name=None, location_name=None,
             gps=None, gps_accuracy=None, battery=None):
-        """ Notify device tracker that you see a device. """
+        """Notify the device tracker that you see a device."""
         with self.lock:
             if mac is None and dev_id is None:
                 raise HomeAssistantError('Neither mac or device id passed in')
@@ -208,6 +204,7 @@ class DeviceTracker(object):
                 return
 
             # If no device can be found, create it
+            dev_id = util.ensure_unique_string(dev_id, self.devices.keys())
             device = Device(
                 self.hass, self.consider_home, self.home_range, self.track_new,
                 dev_id, mac, (host_name or dev_id).replace('_', ' '))
@@ -226,14 +223,14 @@ class DeviceTracker(object):
             update_config(self.hass.config.path(YAML_DEVICES), dev_id, device)
 
     def setup_group(self):
-        """ Initializes group for all tracked devices. """
+        """Initialize group for all tracked devices."""
         entity_ids = (dev.entity_id for dev in self.devices.values()
                       if dev.track)
-        self.group = group.setup_group(
+        self.group = group.Group(
             self.hass, GROUP_NAME_ALL_DEVICES, entity_ids, False)
 
     def update_stale(self, now):
-        """ Update stale devices. """
+        """Update stale devices."""
         with self.lock:
             for device in self.devices.values():
                 if (device.track and device.last_update_home and
@@ -242,7 +239,7 @@ class DeviceTracker(object):
 
 
 class Device(Entity):
-    """ Tracked device. """
+    """Represent a tracked device."""
 
     host_name = None
     location_name = None
@@ -251,12 +248,13 @@ class Device(Entity):
     last_seen = None
     battery = None
 
-    # Track if the last update of this device was HOME
+    # Track if the last update of this device was HOME.
     last_update_home = False
     _state = STATE_NOT_HOME
 
     def __init__(self, hass, consider_home, home_range, track, dev_id, mac,
                  name=None, picture=None, away_hide=False):
+        """Initialize a device."""
         self.hass = hass
         self.entity_id = ENTITY_ID_FORMAT.format(dev_id)
 
@@ -282,28 +280,30 @@ class Device(Entity):
 
     @property
     def gps_home(self):
-        """ Return if device is within range of home. """
+        """Return if device is within range of home."""
         distance = max(
             0, self.hass.config.distance(*self.gps) - self.gps_accuracy)
         return self.gps is not None and distance <= self.home_range
 
     @property
     def name(self):
-        """ Returns the name of the entity. """
+        """Return the name of the entity."""
         return self.config_name or self.host_name or DEVICE_DEFAULT_NAME
 
     @property
     def state(self):
-        """ State of the device. """
+        """Return the state of the device."""
         return self._state
 
     @property
-    def state_attributes(self):
-        """ Device state attributes. """
-        attr = {}
+    def entity_picture(self):
+        """Return the picture of the device."""
+        return self.config_picture
 
-        if self.config_picture:
-            attr[ATTR_ENTITY_PICTURE] = self.config_picture
+    @property
+    def state_attributes(self):
+        """Return the device state attributes."""
+        attr = {}
 
         if self.gps:
             attr[ATTR_LATITUDE] = self.gps[0]
@@ -317,12 +317,12 @@ class Device(Entity):
 
     @property
     def hidden(self):
-        """ If device should be hidden. """
+        """If device should be hidden."""
         return self.away_hide and self.state != STATE_HOME
 
     def seen(self, host_name=None, location_name=None, gps=None,
              gps_accuracy=0, battery=None):
-        """ Mark the device as seen. """
+        """Mark the device as seen."""
         self.last_seen = dt_util.utcnow()
         self.host_name = host_name
         self.location_name = location_name
@@ -340,12 +340,12 @@ class Device(Entity):
         self.update()
 
     def stale(self, now=None):
-        """ Return if device state is stale. """
+        """Return if device state is stale."""
         return self.last_seen and \
             (now or dt_util.utcnow()) - self.last_seen > self.consider_home
 
     def update(self):
-        """ Update state of entity. """
+        """Update state of entity."""
         if not self.last_seen:
             return
         elif self.location_name:
@@ -368,23 +368,8 @@ class Device(Entity):
             self.last_update_home = True
 
 
-def convert_csv_config(csv_path, yaml_path):
-    """ Convert CSV config file format to YAML. """
-    used_ids = set()
-    with open(csv_path) as inp:
-        for row in csv.DictReader(inp):
-            dev_id = util.ensure_unique_string(
-                (util.slugify(row['name']) or DEVICE_DEFAULT_NAME).lower(),
-                used_ids)
-            used_ids.add(dev_id)
-            device = Device(None, None, None, row['track'] == '1', dev_id,
-                            row['device'], row['name'], row['picture'])
-            update_config(yaml_path, dev_id, device)
-    return True
-
-
 def load_config(path, hass, consider_home, home_range):
-    """ Load devices from YAML config file. """
+    """Load devices from YAML configuration file."""
     if not os.path.isfile(path):
         return []
     return [
@@ -396,7 +381,7 @@ def load_config(path, hass, consider_home, home_range):
 
 
 def setup_scanner_platform(hass, config, scanner, see_device):
-    """ Helper method to connect scanner-based platform to device tracker. """
+    """Helper method to connect scanner-based platform to device tracker."""
     interval = util.convert(config.get(CONF_SCAN_INTERVAL), int,
                             DEFAULT_SCAN_INTERVAL)
 
@@ -404,7 +389,7 @@ def setup_scanner_platform(hass, config, scanner, see_device):
     seen = set()
 
     def device_tracker_scan(now):
-        """ Called when interval matches. """
+        """Called when interval matches."""
         for mac in scanner.scan_devices():
             if mac in seen:
                 host_name = None
@@ -420,7 +405,7 @@ def setup_scanner_platform(hass, config, scanner, see_device):
 
 
 def update_config(path, dev_id, device):
-    """ Add device to YAML config file. """
+    """Add device to YAML configuration file."""
     with open(path, 'a') as out:
         out.write('\n')
         out.write('{}:\n'.format(device.dev_id))

homeassistant/components/device_tracker/actiontec.py

@@ -1,26 +1,23 @@
 """
-homeassistant.components.device_tracker.actiontec
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning an Actiontec MI424WR
-(Verizon FIOS) router for device presence.
+Support for Actiontec MI424WR (Verizon FIOS) routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.actiontec/
 """
 import logging
-from datetime import timedelta
-from collections import namedtuple
 import re
-import threading
 import telnetlib
+import threading
+from collections import namedtuple
+from datetime import timedelta
 
 import homeassistant.util.dt as dt_util
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
 
 _LOGGER = logging.getLogger(__name__)
@@ -34,7 +31,7 @@ _LEASES_REGEX = re.compile(
 
 # pylint: disable=unused-argument
 def get_scanner(hass, config):
-    """ Validates config and returns an Actiontec scanner. """
+    """Validate the configuration and return an Actiontec scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
                            _LOGGER):
@@ -46,12 +43,10 @@ Device = namedtuple("Device", ["mac", "ip", "last_update"])
 
 
 class ActiontecDeviceScanner(object):
-    """
-    This class queries a an actiontec router for connected devices.
-    Adapted from DD-WRT scanner.
-    """
+    """This class queries a an actiontec router for connected devices."""
 
     def __init__(self, config):
+        """Initialize the scanner."""
         self.host = config[CONF_HOST]
         self.username = config[CONF_USERNAME]
         self.password = config[CONF_PASSWORD]
@@ -62,15 +57,12 @@ class ActiontecDeviceScanner(object):
         _LOGGER.info("actiontec scanner initialized")
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device ids.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
         return [client.mac for client in self.last_results]
 
     def get_device_name(self, device):
-        """ Returns the name of the given device or None if we don't know. """
+        """Return the name of the given device or None if we don't know."""
         if not self.last_results:
             return None
         for client in self.last_results:
@@ -80,9 +72,9 @@ class ActiontecDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the Actiontec MI424WR router is up
-        to date. Returns boolean if scanning successful.
+        """Ensure the information from the router is up to date.
+
+        Return boolean if scanning successful.
         """
         _LOGGER.info("Scanning")
         if not self.success_init:
@@ -100,7 +92,7 @@ class ActiontecDeviceScanner(object):
             return True
 
     def get_actiontec_data(self):
-        """ Retrieve data from Actiontec MI424WR and return parsed result. """
+        """Retrieve data from Actiontec MI424WR and return parsed result."""
         try:
             telnet = telnetlib.Telnet(self.host)
             telnet.read_until(b'Username: ')

homeassistant/components/device_tracker/aruba.py

@@ -1,26 +1,23 @@
 """
-homeassistant.components.device_tracker.aruba
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a Aruba Access Point for device
-presence.
+Support for Aruba Access Points.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.aruba/
 """
 import logging
-from datetime import timedelta
 import re
 import threading
-import telnetlib
+from datetime import timedelta
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
 # Return cached results if last scan was less then this time ago
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
 
+REQUIREMENTS = ['pexpect==4.0.1']
 _LOGGER = logging.getLogger(__name__)
 
 _DEVICES_REGEX = re.compile(
@@ -31,7 +28,7 @@ _DEVICES_REGEX = re.compile(
 
 # pylint: disable=unused-argument
 def get_scanner(hass, config):
-    """ Validates config and returns a Aruba scanner. """
+    """Validate the configuration and return a Aruba scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
                            _LOGGER):
@@ -43,8 +40,10 @@ def get_scanner(hass, config):
 
 
 class ArubaDeviceScanner(object):
-    """ This class queries a Aruba Acces Point for connected devices. """
+    """This class queries a Aruba Access Point for connected devices."""
+
     def __init__(self, config):
+        """Initialize the scanner."""
         self.host = config[CONF_HOST]
         self.username = config[CONF_USERNAME]
         self.password = config[CONF_PASSWORD]
@@ -53,20 +52,17 @@ class ArubaDeviceScanner(object):
 
         self.last_results = {}
 
-        # Test the router is accessible
+        # Test the router is accessible.
         data = self.get_aruba_data()
         self.success_init = data is not None
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device IDs.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
         return [client['mac'] for client in self.last_results]
 
     def get_device_name(self, device):
-        """ Returns the name of the given device or None if we don't know. """
+        """Return the name of the given device or None if we don't know."""
         if not self.last_results:
             return None
         for client in self.last_results:
@@ -76,9 +72,9 @@ class ArubaDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the Aruba Access Point is up to date.
-        Returns boolean if scanning successful.
+        """Ensure the information from the Aruba Access Point is up to date.
+
+        Return boolean if scanning successful.
         """
         if not self.success_init:
             return False
@@ -92,24 +88,39 @@ class ArubaDeviceScanner(object):
             return True
 
     def get_aruba_data(self):
-        """ Retrieve data from Aruba Access Point and return parsed result. """
-        try:
-            telnet = telnetlib.Telnet(self.host)
-            telnet.read_until(b'User: ')
-            telnet.write((self.username + '\r\n').encode('ascii'))
-            telnet.read_until(b'Password: ')
-            telnet.write((self.password + '\r\n').encode('ascii'))
-            telnet.read_until(b'#')
-            telnet.write(('show clients\r\n').encode('ascii'))
-            devices_result = telnet.read_until(b'#').split(b'\r\n')
-            telnet.write('exit\r\n'.encode('ascii'))
-        except EOFError:
-            _LOGGER.exception("Unexpected response from router")
+        """Retrieve data from Aruba Access Point and return parsed result."""
+        import pexpect
+        connect = "ssh {}@{}"
+        ssh = pexpect.spawn(connect.format(self.username, self.host))
+        query = ssh.expect(['password:', pexpect.TIMEOUT, pexpect.EOF,
+                            'continue connecting (yes/no)?',
+                            'Host key verification failed.',
+                            'Connection refused',
+                            'Connection timed out'], timeout=120)
+        if query == 1:
+            _LOGGER.error("Timeout")
             return
-        except ConnectionRefusedError:
-            _LOGGER.exception("Connection refused by router," +
-                              " is telnet enabled?")
+        elif query == 2:
+            _LOGGER.error("Unexpected response from router")
             return
+        elif query == 3:
+            ssh.sendline('yes')
+            ssh.expect('password:')
+        elif query == 4:
+            _LOGGER.error("Host key Changed")
+            return
+        elif query == 5:
+            _LOGGER.error("Connection refused by server")
+            return
+        elif query == 6:
+            _LOGGER.error("Connection timed out")
+            return
+        ssh.sendline(self.password)
+        ssh.expect('#')
+        ssh.sendline('show clients')
+        ssh.expect('#')
+        devices_result = ssh.before.split(b'\r\n')
+        ssh.sendline('exit')
 
         devices = {}
         for device in devices_result:
@@ -119,5 +130,5 @@ class ArubaDeviceScanner(object):
                     'ip': match.group('ip'),
                     'mac': match.group('mac').upper(),
                     'name': match.group('name')
-                    }
+                }
         return devices

homeassistant/components/device_tracker/asuswrt.py

@@ -1,24 +1,21 @@
 """
-homeassistant.components.device_tracker.asuswrt
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a ASUSWRT router for device
-presence.
+Support for ASUSWRT routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.asuswrt/
 """
 import logging
-from datetime import timedelta
 import re
-import threading
 import telnetlib
+import threading
+from datetime import timedelta
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
 
 _LOGGER = logging.getLogger(__name__)
@@ -39,7 +36,7 @@ _IP_NEIGH_REGEX = re.compile(
 
 # pylint: disable=unused-argument
 def get_scanner(hass, config):
-    """ Validates config and returns an ASUS-WRT scanner. """
+    """Validate the configuration and return an ASUS-WRT scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
                            _LOGGER):
@@ -51,12 +48,10 @@ def get_scanner(hass, config):
 
 
 class AsusWrtDeviceScanner(object):
-    """
-    This class queries a router running ASUSWRT firmware
-    for connected devices. Adapted from DD-WRT scanner.
-    """
+    """This class queries a router running ASUSWRT firmware."""
 
     def __init__(self, config):
+        """Initialize the scanner."""
         self.host = config[CONF_HOST]
         self.username = str(config[CONF_USERNAME])
         self.password = str(config[CONF_PASSWORD])
@@ -65,20 +60,17 @@ class AsusWrtDeviceScanner(object):
 
         self.last_results = {}
 
-        # Test the router is accessible
+        # Test the router is accessible.
         data = self.get_asuswrt_data()
         self.success_init = data is not None
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device IDs.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
         return [client['mac'] for client in self.last_results]
 
     def get_device_name(self, device):
-        """ Returns the name of the given device or None if we don't know. """
+        """Return the name of the given device or None if we don't know."""
         if not self.last_results:
             return None
         for client in self.last_results:
@@ -88,9 +80,9 @@ class AsusWrtDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the ASUSWRT router is up to date.
-        Returns boolean if scanning successful.
+        """Ensure the information from the ASUSWRT router is up to date.
+
+        Return boolean if scanning successful.
         """
         if not self.success_init:
             return False
@@ -109,7 +101,7 @@ class AsusWrtDeviceScanner(object):
             return True
 
     def get_asuswrt_data(self):
-        """ Retrieve data from ASUSWRT and return parsed result. """
+        """Retrieve data from ASUSWRT and return parsed result."""
         try:
             telnet = telnetlib.Telnet(self.host)
             telnet.read_until(b'login: ')
@@ -138,9 +130,8 @@ class AsusWrtDeviceScanner(object):
                 _LOGGER.warning("Could not parse lease row: %s", lease)
                 continue
 
-            # For leases where the client doesn't set a hostname, ensure
-            # it is blank and not '*', which breaks the entity_id down
-            # the line
+            # For leases where the client doesn't set a hostname, ensure it is
+            # blank and not '*', which breaks the entity_id down the line.
             host = match.group('host')
             if host == '*':
                 host = ''

homeassistant/components/device_tracker/ddwrt.py

@@ -1,24 +1,22 @@
 """
-homeassistant.components.device_tracker.ddwrt
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a DD-WRT router for device
-presence.
+Support for DD-WRT routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.ddwrt/
 """
 import logging
-from datetime import timedelta
 import re
 import threading
+from datetime import timedelta
+
 import requests
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
 
 _LOGGER = logging.getLogger(__name__)
@@ -29,7 +27,7 @@ _MAC_REGEX = re.compile(r'(([0-9A-Fa-f]{1,2}\:){5}[0-9A-Fa-f]{1,2})')
 
 # pylint: disable=unused-argument
 def get_scanner(hass, config):
-    """ Validates config and returns a DD-WRT scanner. """
+    """Validate the configuration and return a DD-WRT scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
                            _LOGGER):
@@ -42,12 +40,10 @@ def get_scanner(hass, config):
 
 # pylint: disable=too-many-instance-attributes
 class DdWrtDeviceScanner(object):
-    """
-    This class queries a wireless router running DD-WRT firmware
-    for connected devices. Adapted from Tomato scanner.
-    """
+    """This class queries a wireless router running DD-WRT firmware."""
 
     def __init__(self, config):
+        """Initialize the scanner."""
         self.host = config[CONF_HOST]
         self.username = config[CONF_USERNAME]
         self.password = config[CONF_PASSWORD]
@@ -64,19 +60,15 @@ class DdWrtDeviceScanner(object):
         self.success_init = data is not None
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device ids.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
 
         return self.last_results
 
     def get_device_name(self, device):
-        """ Returns the name of the given device or None if we don't know. """
-
+        """Return the name of the given device or None if we don't know."""
         with self.lock:
-            # if not initialised and not already scanned and not found
+            # If not initialised and not already scanned and not found.
             if device not in self.mac2name:
                 url = 'http://{}/Status_Lan.live.asp'.format(self.host)
                 data = self.get_ddwrt_data(url)
@@ -89,15 +81,15 @@ class DdWrtDeviceScanner(object):
                 if not dhcp_leases:
                     return None
 
-                # remove leading and trailing single quotes
+                # Remove leading and trailing single quotes.
                 cleaned_str = dhcp_leases.strip().strip('"')
                 elements = cleaned_str.split('","')
                 num_clients = int(len(elements)/5)
                 self.mac2name = {}
                 for idx in range(0, num_clients):
-                    # this is stupid but the data is a single array
+                    # This is stupid but the data is a single array
                     # every 5 elements represents one hosts, the MAC
-                    # is the third element and the name is the first
+                    # is the third element and the name is the first.
                     mac_index = (idx * 5) + 2
                     if mac_index < len(elements):
                         mac = elements[mac_index]
@@ -107,9 +99,9 @@ class DdWrtDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the DD-WRT router is up to date.
-        Returns boolean if scanning successful.
+        """Ensure the information from the DD-WRT router is up to date.
+
+        Return boolean if scanning successful.
         """
         if not self.success_init:
             return False
@@ -134,7 +126,7 @@ class DdWrtDeviceScanner(object):
             # regex's out values so I guess I have to do the same,
             # LAME!!!
 
-            # remove leading and trailing single quotes
+            # Remove leading and trailing single quotes.
             clean_str = active_clients.strip().strip("'")
             elements = clean_str.split("','")
 
@@ -144,7 +136,7 @@ class DdWrtDeviceScanner(object):
             return True
 
     def get_ddwrt_data(self, url):
-        """ Retrieve data from DD-WRT and return parsed result. """
+        """Retrieve data from DD-WRT and return parsed result."""
         try:
             response = requests.get(
                 url,
@@ -166,7 +158,7 @@ class DdWrtDeviceScanner(object):
 
 
 def _parse_ddwrt_response(data_str):
-    """ Parse the DD-WRT data format. """
+    """Parse the DD-WRT data format."""
     return {
         key: val for key, val in _DDWRT_DATA_REGEX
         .findall(data_str)}

homeassistant/components/device_tracker/demo.py

@@ -1,25 +1,17 @@
-"""
-homeassistant.components.device_tracker.demo
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Demo platform for the device tracker.
-
-device_tracker:
-  platform: demo
-"""
+"""Demo platform for the device tracker."""
 import random
 
 from homeassistant.components.device_tracker import DOMAIN
 
 
 def setup_scanner(hass, config, see):
-    """ Set up a demo tracker. """
-
+    """Setup the demo tracker."""
     def offset():
-        """ Return random offset. """
+        """Return random offset."""
         return (random.randrange(500, 2000)) / 2e5 * random.choice((-1, 1))
 
     def random_see(dev_id, name):
-        """ Randomize a sighting. """
+        """Randomize a sighting."""
         see(
             dev_id=dev_id,
             host_name=name,
@@ -30,7 +22,7 @@ def setup_scanner(hass, config, see):
         )
 
     def observe(call=None):
-        """ Observe three entities. """
+        """Observe three entities."""
         random_see('demo_paulus', 'Paulus')
         random_see('demo_anne_therese', 'Anne Therese')
 

homeassistant/components/device_tracker/fritz.py

@@ -1,8 +1,5 @@
 """
-homeassistant.components.device_tracker.fritz
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a FRITZ!Box router for device
-presence.
+Support for FRITZ!Box routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.fritz/
@@ -10,20 +7,21 @@ https://home-assistant.io/components/device_tracker.fritz/
 import logging
 from datetime import timedelta
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
-# Return cached results if last scan was less then this time ago
+REQUIREMENTS = ['fritzconnection==0.4.6']
+
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
 
 _LOGGER = logging.getLogger(__name__)
 
 
-# noinspection PyUnusedLocal
 def get_scanner(hass, config):
-    """ Validates config and returns FritzBoxScanner. """
+    """Validate the configuration and return FritzBoxScanner."""
     if not validate_config(config,
                            {DOMAIN: []},
                            _LOGGER):
@@ -35,36 +33,18 @@ def get_scanner(hass, config):
 
 # pylint: disable=too-many-instance-attributes
 class FritzBoxScanner(object):
-    """
-    This class queries a FRITZ!Box router. It is using the
-    fritzconnection library for communication with the router.
+    """This class queries a FRITZ!Box router."""
 
-    The API description can be found under:
-    https://pypi.python.org/pypi/fritzconnection/0.4.6
-
-    This scanner retrieves the list of known hosts and checks their
-    corresponding states (on, or off).
-
-    Due to a bug of the fritzbox api (router side) it is not possible
-    to track more than 16 hosts.
-    """
     def __init__(self, config):
+        """Initialize the scanner."""
         self.last_results = []
-        self.host = '169.254.1.1'  # This IP is valid for all fritzboxes
+        self.host = '169.254.1.1'  # This IP is valid for all FRITZ!Box router.
         self.username = 'admin'
         self.password = ''
         self.success_init = True
 
-        # Try to import the fritzconnection library
-        try:
-            # noinspection PyPackageRequirements,PyUnresolvedReferences
-            import fritzconnection as fc
-        except ImportError:
-            _LOGGER.exception("""Failed to import Python library
-                                fritzconnection. Please run
-                                <home-assistant>/setup to install it.""")
-            self.success_init = False
-            return
+        # pylint: disable=import-error
+        import fritzconnection as fc
 
         # Check for user specific configuration
         if CONF_HOST in config.keys():
@@ -74,7 +54,7 @@ class FritzBoxScanner(object):
         if CONF_PASSWORD in config.keys():
             self.password = config[CONF_PASSWORD]
 
-        # Establish a connection to the FRITZ!Box
+        # Establish a connection to the FRITZ!Box.
         try:
             self.fritz_box = fc.FritzHosts(address=self.host,
                                            user=self.username,
@@ -83,7 +63,7 @@ class FritzBoxScanner(object):
             self.fritz_box = None
 
         # At this point it is difficult to tell if a connection is established.
-        # So just check for null objects ...
+        # So just check for null objects.
         if self.fritz_box is None or not self.fritz_box.modelname:
             self.success_init = False
 
@@ -96,7 +76,7 @@ class FritzBoxScanner(object):
                           "with IP: %s", self.host)
 
     def scan_devices(self):
-        """ Scan for new devices and return a list of found device ids. """
+        """Scan for new devices and return a list of found device ids."""
         self._update_info()
         active_hosts = []
         for known_host in self.last_results:
@@ -105,7 +85,7 @@ class FritzBoxScanner(object):
         return active_hosts
 
     def get_device_name(self, mac):
-        """ Returns the name of the given device or None if is not known. """
+        """Return the name of the given device or None if is not known."""
         ret = self.fritz_box.get_specific_host_entry(mac)["NewHostName"]
         if ret == {}:
             return None
@@ -113,7 +93,7 @@ class FritzBoxScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """ Retrieves latest information from the FRITZ!Box. """
+        """Retrieve latest information from the FRITZ!Box."""
         if not self.success_init:
             return False
 

homeassistant/components/device_tracker/icloud.py

@@ -1,15 +1,13 @@
 """
-homeassistant.components.device_tracker.icloud
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning iCloud devices.
+Support for iCloud connected devices.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.icloud/
 """
 import logging
-
 import re
-from homeassistant.const import CONF_USERNAME, CONF_PASSWORD
+
+from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers.event import track_utc_time_change
 
 _LOGGER = logging.getLogger(__name__)
@@ -21,12 +19,12 @@ DEFAULT_INTERVAL = 8
 
 
 def setup_scanner(hass, config, see):
-    """ Set up the iCloud Scanner. """
+    """Setup the iCloud Scanner."""
     from pyicloud import PyiCloudService
     from pyicloud.exceptions import PyiCloudFailedLoginException
     from pyicloud.exceptions import PyiCloudNoDevicesException
 
-    # Get the username and password from the configuration
+    # Get the username and password from the configuration.
     username = config.get(CONF_USERNAME)
     password = config.get(CONF_PASSWORD)
 
@@ -45,14 +43,14 @@ def setup_scanner(hass, config, see):
         return False
 
     def keep_alive(now):
-        """ Keeps authenticating iCloud connection. """
+        """Keep authenticating iCloud connection."""
         api.authenticate()
         _LOGGER.info("Authenticate against iCloud")
 
     track_utc_time_change(hass, keep_alive, second=0)
 
     def update_icloud(now):
-        """ Authenticate against iCloud and scan for devices. """
+        """Authenticate against iCloud and scan for devices."""
         try:
             # The session timeouts if we are not using it so we
             # have to re-authenticate. This will send an email.

homeassistant/components/device_tracker/locative.py

@@ -1,7 +1,5 @@
 """
-homeassistant.components.device_tracker.locative
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Locative platform for the device tracker.
+Support for the Locative platform.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.locative/
@@ -9,9 +7,8 @@ https://home-assistant.io/components/device_tracker.locative/
 import logging
 from functools import partial
 
-from homeassistant.const import (
-    HTTP_UNPROCESSABLE_ENTITY, STATE_NOT_HOME)
 from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import HTTP_UNPROCESSABLE_ENTITY, STATE_NOT_HOME
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -21,12 +18,10 @@ URL_API_LOCATIVE_ENDPOINT = "/api/locative"
 
 
 def setup_scanner(hass, config, see):
-    """ Set up an endpoint for the Locative app. """
-
+    """Setup an endpoint for the Locative application."""
     # POST would be semantically better, but that currently does not work
     # since Locative sends the data as key1=value1&key2=value2
     # in the request body, while Home Assistant expects json there.
-
     hass.http.register_path(
         'GET', URL_API_LOCATIVE_ENDPOINT,
         partial(_handle_get_api_locative, hass, see))
@@ -35,8 +30,7 @@ def setup_scanner(hass, config, see):
 
 
 def _handle_get_api_locative(hass, see, handler, path_match, data):
-    """ Locative message received. """
-
+    """Locative message received."""
     if not _check_data(handler, data):
         return
 
@@ -77,6 +71,7 @@ def _handle_get_api_locative(hass, see, handler, path_match, data):
 
 
 def _check_data(handler, data):
+    """Check the data."""
     if 'latitude' not in data or 'longitude' not in data:
         handler.write_text("Latitude and longitude not specified.",
                            HTTP_UNPROCESSABLE_ENTITY)

homeassistant/components/device_tracker/luci.py

@@ -1,32 +1,30 @@
 """
-homeassistant.components.device_tracker.luci
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a OpenWRT router for device
-presence.
+Support for OpenWRT (luci) routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.luci/
 """
-import logging
 import json
-from datetime import timedelta
+import logging
 import re
 import threading
+from datetime import timedelta
+
 import requests
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
 
 _LOGGER = logging.getLogger(__name__)
 
 
 def get_scanner(hass, config):
-    """ Validates config and returns a Luci scanner. """
+    """Validate the configuration and return a Luci scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
                            _LOGGER):
@@ -39,20 +37,13 @@ def get_scanner(hass, config):
 
 # pylint: disable=too-many-instance-attributes
 class LuciDeviceScanner(object):
-    """
-    This class queries a wireless router running OpenWrt firmware
-    for connected devices. Adapted from Tomato scanner.
+    """This class queries a wireless router running OpenWrt firmware.
 
-    # opkg install luci-mod-rpc
-    for this to work on the router.
-
-    The API is described here:
-    http://luci.subsignal.org/trac/wiki/Documentation/JsonRpcHowTo
-
-    (Currently, we do only wifi iwscan, and no DHCP lease access.)
+    Adapted from Tomato scanner.
     """
 
     def __init__(self, config):
+        """Initialize the scanner."""
         host = config[CONF_HOST]
         username, password = config[CONF_USERNAME], config[CONF_PASSWORD]
 
@@ -69,17 +60,12 @@ class LuciDeviceScanner(object):
         self.success_init = self.token is not None
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device ids.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
-
         return self.last_results
 
     def get_device_name(self, device):
-        """ Returns the name of the given device or None if we don't know. """
-
+        """Return the name of the given device or None if we don't know."""
         with self.lock:
             if self.mac2name is None:
                 url = 'http://{}/cgi-bin/luci/rpc/uci'.format(self.host)
@@ -99,8 +85,8 @@ class LuciDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the Luci router is up to date.
+        """Ensure the information from the Luci router is up to date.
+
         Returns boolean if scanning successful.
         """
         if not self.success_init:
@@ -126,7 +112,7 @@ class LuciDeviceScanner(object):
 
 
 def _req_json_rpc(url, method, *args, **kwargs):
-    """ Perform one JSON RPC operation. """
+    """Perform one JSON RPC operation."""
     data = json.dumps({'method': method, 'params': args})
     try:
         res = requests.post(url, data=data, timeout=5, **kwargs)
@@ -156,6 +142,6 @@ def _req_json_rpc(url, method, *args, **kwargs):
 
 
 def _get_token(host, username, password):
-    """ Get authentication token for the given host+username+password. """
+    """Get authentication token for the given host+username+password."""
     url = 'http://{}/cgi-bin/luci/rpc/auth'.format(host)
     return _req_json_rpc(url, 'login', username, password)

homeassistant/components/device_tracker/mqtt.py

@@ -1,39 +1,37 @@
 """
-homeassistant.components.device_tracker.mqtt
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-MQTT platform for the device tracker.
+Support for tracking MQTT enabled devices.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.mqtt/
 """
 import logging
-from homeassistant import util
+
+import voluptuous as vol
+
 import homeassistant.components.mqtt as mqtt
+from homeassistant.components.mqtt import CONF_QOS
+import homeassistant.helpers.config_validation as cv
 
 DEPENDENCIES = ['mqtt']
 
-CONF_QOS = 'qos'
 CONF_DEVICES = 'devices'
 
-DEFAULT_QOS = 0
-
 _LOGGER = logging.getLogger(__name__)
 
+PLATFORM_SCHEMA = mqtt.MQTT_BASE_PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_DEVICES): {cv.string: mqtt.valid_subscribe_topic},
+})
+
 
 def setup_scanner(hass, config, see):
-    """ Set up a MQTT tracker. """
-    devices = config.get(CONF_DEVICES)
-    qos = util.convert(config.get(CONF_QOS), int, DEFAULT_QOS)
-
-    if not isinstance(devices, dict):
-        _LOGGER.error('Expected %s to be a dict, found %s', CONF_DEVICES,
-                      devices)
-        return False
+    """Setup the MQTT tracker."""
+    devices = config[CONF_DEVICES]
+    qos = config[CONF_QOS]
 
     dev_id_lookup = {}
 
     def device_tracker_message_received(topic, payload, qos):
-        """ MQTT message received. """
+        """MQTT message received."""
         see(dev_id=dev_id_lookup[topic], location_name=payload)
 
     for dev_id, topic in devices.items():

homeassistant/components/device_tracker/netgear.py

@@ -1,29 +1,26 @@
 """
-homeassistant.components.device_tracker.netgear
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a Netgear router for device
-presence.
+Support for Netgear routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.netgear/
 """
 import logging
-from datetime import timedelta
 import threading
+from datetime import timedelta
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
-from homeassistant.util import Throttle
 from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
+from homeassistant.util import Throttle
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
 
 _LOGGER = logging.getLogger(__name__)
-REQUIREMENTS = ['pynetgear==0.3.1']
+REQUIREMENTS = ['pynetgear==0.3.2']
 
 
 def get_scanner(hass, config):
-    """ Validates config and returns a Netgear scanner. """
+    """Validate the configuration and returns a Netgear scanner."""
     info = config[DOMAIN]
     host = info.get(CONF_HOST)
     username = info.get(CONF_USERNAME)
@@ -39,9 +36,10 @@ def get_scanner(hass, config):
 
 
 class NetgearDeviceScanner(object):
-    """ This class queries a Netgear wireless router using the SOAP-API. """
+    """Queries a Netgear wireless router using the SOAP-API."""
 
     def __init__(self, host, username, password):
+        """Initialize the scanner."""
         import pynetgear
 
         self.last_results = []
@@ -66,15 +64,13 @@ class NetgearDeviceScanner(object):
             _LOGGER.error("Failed to Login")
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device ids.
-        """
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
 
         return (device.mac for device in self.last_results)
 
     def get_device_name(self, mac):
-        """ Returns the name of the given device or None if we don't know. """
+        """Return the name of the given device or None if we don't know."""
         try:
             return next(device.name for device in self.last_results
                         if device.mac == mac)
@@ -83,8 +79,8 @@ class NetgearDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Retrieves latest information from the Netgear router.
+        """Retrieve latest information from the Netgear router.
+
         Returns boolean if scanning successful.
         """
         if not self.success_init:
@@ -93,4 +89,9 @@ class NetgearDeviceScanner(object):
         with self.lock:
             _LOGGER.info("Scanning")
 
-            self.last_results = self._api.get_attached_devices() or []
+            results = self._api.get_attached_devices()
+
+            if results is None:
+                _LOGGER.warning('Error scanning devices')
+
+            self.last_results = results or []

homeassistant/components/device_tracker/nmap_tracker.py

@@ -1,22 +1,20 @@
 """
-homeassistant.components.device_tracker.nmap
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a network with nmap.
+Support for scanning a network with nmap.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.nmap_scanner/
 """
 import logging
-from datetime import timedelta
-from collections import namedtuple
-import subprocess
 import re
+import subprocess
+from collections import namedtuple
+from datetime import timedelta
 
 import homeassistant.util.dt as dt_util
+from homeassistant.components.device_tracker import DOMAIN
 from homeassistant.const import CONF_HOSTS
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle, convert
-from homeassistant.components.device_tracker import DOMAIN
 
 # Return cached results if last scan was less then this time ago
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
@@ -26,11 +24,11 @@ _LOGGER = logging.getLogger(__name__)
 # interval in minutes to exclude devices from a scan while they are home
 CONF_HOME_INTERVAL = "home_interval"
 
-REQUIREMENTS = ['python-nmap==0.4.3']
+REQUIREMENTS = ['python-nmap==0.6.0']
 
 
 def get_scanner(hass, config):
-    """ Validates config and returns a Nmap scanner. """
+    """Validate the configuration and return a Nmap scanner."""
     if not validate_config(config, {DOMAIN: [CONF_HOSTS]},
                            _LOGGER):
         return None
@@ -43,7 +41,7 @@ Device = namedtuple("Device", ["mac", "name", "ip", "last_update"])
 
 
 def _arp(ip_address):
-    """ Get the MAC address for a given IP. """
+    """Get the MAC address for a given IP."""
     cmd = ['arp', '-n', ip_address]
     arp = subprocess.Popen(cmd, stdout=subprocess.PIPE)
     out, _ = arp.communicate()
@@ -55,9 +53,10 @@ def _arp(ip_address):
 
 
 class NmapDeviceScanner(object):
-    """ This class scans for devices using nmap. """
+    """This class scans for devices using nmap."""
 
     def __init__(self, config):
+        """Initialize the scanner."""
         self.last_results = []
 
         self.hosts = config[CONF_HOSTS]
@@ -68,17 +67,13 @@ class NmapDeviceScanner(object):
         _LOGGER.info("nmap scanner initialized")
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device ids.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
 
         return [device.mac for device in self.last_results]
 
     def get_device_name(self, mac):
-        """ Returns the name of the given device or None if we don't know. """
-
+        """Return the name of the given device or None if we don't know."""
         filter_named = [device.name for device in self.last_results
                         if device.mac == mac]
 
@@ -89,8 +84,8 @@ class NmapDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Scans the network for devices.
+        """Scan the network for devices.
+
         Returns boolean if scanning successful.
         """
         _LOGGER.info("Scanning")

homeassistant/components/device_tracker/owntracks.py

@@ -1,106 +1,196 @@
 """
-homeassistant.components.device_tracker.owntracks
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-OwnTracks platform for the device tracker.
+Support the OwnTracks platform.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.owntracks/
 """
 import json
 import logging
+import threading
+from collections import defaultdict
 
 import homeassistant.components.mqtt as mqtt
-from homeassistant.const import (STATE_HOME, STATE_NOT_HOME)
+from homeassistant.const import STATE_HOME
+from homeassistant.util import convert
 
 DEPENDENCIES = ['mqtt']
 
-CONF_TRANSITION_EVENTS = 'use_events'
+REGIONS_ENTERED = defaultdict(list)
+MOBILE_BEACONS_ACTIVE = defaultdict(list)
+
+BEACON_DEV_ID = 'beacon'
+
 LOCATION_TOPIC = 'owntracks/+/+'
 EVENT_TOPIC = 'owntracks/+/+/event'
 
+_LOGGER = logging.getLogger(__name__)
+
+LOCK = threading.Lock()
+
+CONF_MAX_GPS_ACCURACY = 'max_gps_accuracy'
+
 
 def setup_scanner(hass, config, see):
-    """ Set up an OwnTracks tracker. """
+    """Setup an OwnTracks tracker."""
+    max_gps_accuracy = config.get(CONF_MAX_GPS_ACCURACY)
 
     def owntracks_location_update(topic, payload, qos):
-        """ MQTT message received. """
-
+        """MQTT message received."""
         # Docs on available data:
         # http://owntracks.org/booklet/tech/json/#_typelocation
         try:
             data = json.loads(payload)
         except ValueError:
             # If invalid JSON
-            logging.getLogger(__name__).error(
+            _LOGGER.error(
                 'Unable to parse payload as JSON: %s', payload)
             return
 
-        if not isinstance(data, dict) or data.get('_type') != 'location':
+        if (not isinstance(data, dict) or data.get('_type') != 'location') or (
+                max_gps_accuracy is not None and
+                convert(data.get('acc'), float, 0.0) > max_gps_accuracy):
             return
 
-        parts = topic.split('/')
-        kwargs = {
-            'dev_id': '{}_{}'.format(parts[1], parts[2]),
-            'host_name': parts[1],
-            'gps': (data['lat'], data['lon']),
-        }
-        if 'acc' in data:
-            kwargs['gps_accuracy'] = data['acc']
-        if 'batt' in data:
-            kwargs['battery'] = data['batt']
+        dev_id, kwargs = _parse_see_args(topic, data)
 
-        see(**kwargs)
+        # Block updates if we're in a region
+        with LOCK:
+            if REGIONS_ENTERED[dev_id]:
+                _LOGGER.debug(
+                    "location update ignored - inside region %s",
+                    REGIONS_ENTERED[-1])
+                return
+
+            see(**kwargs)
+            see_beacons(dev_id, kwargs)
 
     def owntracks_event_update(topic, payload, qos):
-        """ MQTT event (geofences) received. """
-
+        # pylint: disable=too-many-branches, too-many-statements
+        """MQTT event (geofences) received."""
         # Docs on available data:
         # http://owntracks.org/booklet/tech/json/#_typetransition
         try:
             data = json.loads(payload)
         except ValueError:
             # If invalid JSON
-            logging.getLogger(__name__).error(
+            _LOGGER.error(
                 'Unable to parse payload as JSON: %s', payload)
             return
 
         if not isinstance(data, dict) or data.get('_type') != 'transition':
             return
 
-        # check if in "home" fence or other zone
-        location = ''
-        if data['event'] == 'enter':
+        if data.get('desc') is None:
+            _LOGGER.error(
+                "Location missing from `enter/exit` message - "
+                "please turn `Share` on in OwnTracks app")
+            return
+        # OwnTracks uses - at the start of a beacon zone
+        # to switch on 'hold mode' - ignore this
+        location = data['desc'].lstrip("-")
+        if location.lower() == 'home':
+            location = STATE_HOME
 
-            if data['desc'].lower() == 'home':
-                location = STATE_HOME
-            else:
-                location = data['desc']
+        dev_id, kwargs = _parse_see_args(topic, data)
+
+        if data['event'] == 'enter':
+            zone = hass.states.get("zone.{}".format(location))
+            with LOCK:
+                if zone is None:
+                    if data['t'] == 'b':
+                        # Not a HA zone, and a beacon so assume mobile
+                        beacons = MOBILE_BEACONS_ACTIVE[dev_id]
+                        if location not in beacons:
+                            beacons.append(location)
+                        _LOGGER.info("Added beacon %s", location)
+                else:
+                    # Normal region
+                    regions = REGIONS_ENTERED[dev_id]
+                    if location not in regions:
+                        regions.append(location)
+                    _LOGGER.info("Enter region %s", location)
+                    _set_gps_from_zone(kwargs, location, zone)
+
+                see(**kwargs)
+                see_beacons(dev_id, kwargs)
 
         elif data['event'] == 'leave':
-            location = STATE_NOT_HOME
+            with LOCK:
+                regions = REGIONS_ENTERED[dev_id]
+                if location in regions:
+                    regions.remove(location)
+                new_region = regions[-1] if regions else None
+
+                if new_region:
+                    # Exit to previous region
+                    zone = hass.states.get("zone.{}".format(new_region))
+                    _set_gps_from_zone(kwargs, new_region, zone)
+                    _LOGGER.info("Exit to %s", new_region)
+                    see(**kwargs)
+                    see_beacons(dev_id, kwargs)
+
+                else:
+                    _LOGGER.info("Exit to GPS")
+                    # Check for GPS accuracy
+                    if not ('acc' in data and
+                            max_gps_accuracy is not None and
+                            data['acc'] > max_gps_accuracy):
+
+                        see(**kwargs)
+                        see_beacons(dev_id, kwargs)
+                    else:
+                        _LOGGER.info("Inaccurate GPS reported")
+
+                beacons = MOBILE_BEACONS_ACTIVE[dev_id]
+                if location in beacons:
+                    beacons.remove(location)
+                    _LOGGER.info("Remove beacon %s", location)
+
         else:
-            logging.getLogger(__name__).error(
+            _LOGGER.error(
                 'Misformatted mqtt msgs, _type=transition, event=%s',
                 data['event'])
             return
 
-        parts = topic.split('/')
-        kwargs = {
-            'dev_id': '{}_{}'.format(parts[1], parts[2]),
-            'host_name': parts[1],
-            'gps': (data['lat'], data['lon']),
-            'location_name': location,
-        }
-        if 'acc' in data:
-            kwargs['gps_accuracy'] = data['acc']
+    def see_beacons(dev_id, kwargs_param):
+        """Set active beacons to the current location."""
+        kwargs = kwargs_param.copy()
+        # the battery state applies to the tracking device, not the beacon
+        kwargs.pop('battery', None)
+        for beacon in MOBILE_BEACONS_ACTIVE[dev_id]:
+            kwargs['dev_id'] = "{}_{}".format(BEACON_DEV_ID, beacon)
+            kwargs['host_name'] = beacon
+            see(**kwargs)
 
-        see(**kwargs)
-
-    use_events = config.get(CONF_TRANSITION_EVENTS)
-
-    if use_events:
-        mqtt.subscribe(hass, EVENT_TOPIC, owntracks_event_update, 1)
-    else:
-        mqtt.subscribe(hass, LOCATION_TOPIC, owntracks_location_update, 1)
+    mqtt.subscribe(hass, LOCATION_TOPIC, owntracks_location_update, 1)
+    mqtt.subscribe(hass, EVENT_TOPIC, owntracks_event_update, 1)
 
     return True
+
+
+def _parse_see_args(topic, data):
+    """Parse the OwnTracks location parameters, into the format see expects."""
+    parts = topic.split('/')
+    dev_id = '{}_{}'.format(parts[1], parts[2])
+    host_name = parts[1]
+    kwargs = {
+        'dev_id': dev_id,
+        'host_name': host_name,
+        'gps': (data['lat'], data['lon'])
+    }
+    if 'acc' in data:
+        kwargs['gps_accuracy'] = data['acc']
+    if 'batt' in data:
+        kwargs['battery'] = data['batt']
+    return dev_id, kwargs
+
+
+def _set_gps_from_zone(kwargs, location, zone):
+    """Set the see parameters from the zone parameters."""
+    if zone is not None:
+        kwargs['gps'] = (
+            zone.attributes['latitude'],
+            zone.attributes['longitude'])
+        kwargs['gps_accuracy'] = zone.attributes['radius']
+        kwargs['location_name'] = location
+    return kwargs

homeassistant/components/device_tracker/snmp.py

@@ -1,23 +1,20 @@
 """
-homeassistant.components.device_tracker.snmp
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports fetching WiFi associations
-through SNMP.
+Support for fetching WiFi associations through SNMP.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.snmp/
 """
-import logging
-from datetime import timedelta
-import threading
 import binascii
+import logging
+import threading
+from datetime import timedelta
 
+from homeassistant.components.device_tracker import DOMAIN
 from homeassistant.const import CONF_HOST
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
 
 _LOGGER = logging.getLogger(__name__)
@@ -29,7 +26,7 @@ CONF_BASEOID = "baseoid"
 
 # pylint: disable=unused-argument
 def get_scanner(hass, config):
-    """ Validates config and returns an snmp scanner """
+    """Validate the configuration and return an snmp scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_COMMUNITY, CONF_BASEOID]},
                            _LOGGER):
@@ -41,10 +38,10 @@ def get_scanner(hass, config):
 
 
 class SnmpScanner(object):
-    """
-    This class queries any SNMP capable Acces Point for connected devices.
-    """
+    """Queries any SNMP capable Access Point for connected devices."""
+
     def __init__(self, config):
+        """Initialize the scanner."""
         from pysnmp.entity.rfc3413.oneliner import cmdgen
         self.snmp = cmdgen.CommandGenerator()
 
@@ -61,25 +58,23 @@ class SnmpScanner(object):
         self.success_init = data is not None
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device IDs.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
-        return [client['mac'] for client in self.last_results]
+        return [client['mac'] for client in self.last_results
+                if client.get('mac')]
 
     # Supressing no-self-use warning
     # pylint: disable=R0201
     def get_device_name(self, device):
-        """ Returns the name of the given device or None if we don't know. """
+        """Return the name of the given device or None if we don't know."""
         # We have no names
         return None
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the WAP is up to date.
-        Returns boolean if scanning successful.
+        """Ensure the information from the WAP is up to date.
+
+        Return boolean if scanning successful.
         """
         if not self.success_init:
             return False
@@ -93,8 +88,7 @@ class SnmpScanner(object):
             return True
 
     def get_snmp_data(self):
-        """ Fetch mac addresses from WAP via SNMP. """
-
+        """Fetch MAC addresses from WAP via SNMP."""
         devices = []
 
         errindication, errstatus, errindex, restable = self.snmp.nextCmd(
@@ -111,6 +105,7 @@ class SnmpScanner(object):
         for resrow in restable:
             for _, val in resrow:
                 mac = binascii.hexlify(val.asOctets()).decode('utf-8')
+                _LOGGER.debug('Found mac %s', mac)
                 mac = ':'.join([mac[i:i+2] for i in range(0, len(mac), 2)])
                 devices.append({'mac': mac})
         return devices

homeassistant/components/device_tracker/thomson.py

@@ -1,24 +1,21 @@
 """
-homeassistant.components.device_tracker.thomson
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a THOMSON router for device
-presence.
+Support for THOMSON routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.thomson/
 """
 import logging
-from datetime import timedelta
 import re
-import threading
 import telnetlib
+import threading
+from datetime import timedelta
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
 
 _LOGGER = logging.getLogger(__name__)
@@ -35,7 +32,7 @@ _DEVICES_REGEX = re.compile(
 
 # pylint: disable=unused-argument
 def get_scanner(hass, config):
-    """ Validates config and returns a THOMSON scanner. """
+    """Validate the configuration and return a THOMSON scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
                            _LOGGER):
@@ -47,12 +44,10 @@ def get_scanner(hass, config):
 
 
 class ThomsonDeviceScanner(object):
-    """
-    This class queries a router running THOMSON firmware
-    for connected devices. Adapted from ASUSWRT scanner.
-    """
+    """This class queries a router running THOMSON firmware."""
 
     def __init__(self, config):
+        """Initialize the scanner."""
         self.host = config[CONF_HOST]
         self.username = config[CONF_USERNAME]
         self.password = config[CONF_PASSWORD]
@@ -61,20 +56,17 @@ class ThomsonDeviceScanner(object):
 
         self.last_results = {}
 
-        # Test the router is accessible
+        # Test the router is accessible.
         data = self.get_thomson_data()
         self.success_init = data is not None
 
     def scan_devices(self):
-        """ Scans for new devices and return a
-            list containing found device ids. """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
         return [client['mac'] for client in self.last_results]
 
     def get_device_name(self, device):
-        """ Returns the name of the given device
-            or None if we don't know. """
+        """Return the name of the given device or None if we don't know."""
         if not self.last_results:
             return None
         for client in self.last_results:
@@ -84,9 +76,9 @@ class ThomsonDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the THOMSON router is up to date.
-        Returns boolean if scanning successful.
+        """Ensure the information from the THOMSON router is up to date.
+
+        Return boolean if scanning successful.
         """
         if not self.success_init:
             return False
@@ -97,14 +89,14 @@ class ThomsonDeviceScanner(object):
             if not data:
                 return False
 
-            # flag C stands for CONNECTED
+            # Flag C stands for CONNECTED
             active_clients = [client for client in data.values() if
                               client['status'].find('C') != -1]
             self.last_results = active_clients
             return True
 
     def get_thomson_data(self):
-        """ Retrieve data from THOMSON and return parsed result. """
+        """Retrieve data from THOMSON and return parsed result."""
         try:
             telnet = telnetlib.Telnet(self.host)
             telnet.read_until(b'Username : ')

homeassistant/components/device_tracker/tomato.py

@@ -1,26 +1,23 @@
 """
-homeassistant.components.device_tracker.tomato
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a Tomato router for device
-presence.
+Support for Tomato routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.tomato/
 """
-import logging
 import json
-from datetime import timedelta
+import logging
 import re
 import threading
+from datetime import timedelta
 
 import requests
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
 
 CONF_HTTP_ID = "http_id"
@@ -29,7 +26,7 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def get_scanner(hass, config):
-    """ Validates config and returns a Tomato scanner. """
+    """Validate the configuration and returns a Tomato scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_USERNAME,
                                      CONF_PASSWORD, CONF_HTTP_ID]},
@@ -40,14 +37,10 @@ def get_scanner(hass, config):
 
 
 class TomatoDeviceScanner(object):
-    """ This class queries a wireless router running Tomato firmware
-    for connected devices.
-
-    A description of the Tomato API can be found on
-    http://paulusschoutsen.nl/blog/2013/10/tomato-api-documentation/
-    """
+    """This class queries a wireless router running Tomato firmware."""
 
     def __init__(self, config):
+        """Initialize the scanner."""
         host, http_id = config[CONF_HOST], config[CONF_HTTP_ID]
         username, password = config[CONF_USERNAME], config[CONF_PASSWORD]
 
@@ -68,16 +61,13 @@ class TomatoDeviceScanner(object):
         self.success_init = self._update_tomato_info()
 
     def scan_devices(self):
-        """ Scans for new devices and return a
-            list containing found device ids. """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_tomato_info()
 
         return [item[1] for item in self.last_results['wldev']]
 
     def get_device_name(self, device):
-        """ Returns the name of the given device or None if we don't know. """
-
+        """Return the name of the given device or None if we don't know."""
         filter_named = [item[0] for item in self.last_results['dhcpd_lease']
                         if item[2] == device]
 
@@ -88,19 +78,17 @@ class TomatoDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_tomato_info(self):
-        """ Ensures the information from the Tomato router is up to date.
-            Returns boolean if scanning successful. """
+        """Ensure the information from the Tomato router is up to date.
 
+        Return boolean if scanning successful.
+        """
         with self.lock:
             self.logger.info("Scanning")
 
             try:
                 response = requests.Session().send(self.req, timeout=3)
-
                 # Calling and parsing the Tomato api here. We only need the
-                # wldev and dhcpd_lease values. For API description see:
-                # http://paulusschoutsen.nl/
-                #   blog/2013/10/tomato-api-documentation/
+                # wldev and dhcpd_lease values.
                 if response.status_code == 200:
 
                     for param, value in \
@@ -109,7 +97,6 @@ class TomatoDeviceScanner(object):
                         if param == 'wldev' or param == 'dhcpd_lease':
                             self.last_results[param] = \
                                 json.loads(value.replace("'", '"'))
-
                     return True
 
                 elif response.status_code == 401:
@@ -117,29 +104,25 @@ class TomatoDeviceScanner(object):
                     self.logger.exception((
                         "Failed to authenticate, "
                         "please check your username and password"))
-
                     return False
 
             except requests.exceptions.ConnectionError:
                 # We get this if we could not connect to the router or
-                # an invalid http_id was supplied
+                # an invalid http_id was supplied.
                 self.logger.exception((
                     "Failed to connect to the router"
                     " or invalid http_id supplied"))
-
                 return False
 
             except requests.exceptions.Timeout:
                 # We get this if we could not connect to the router or
-                # an invalid http_id was supplied
+                # an invalid http_id was supplied.
                 self.logger.exception(
                     "Connection to the router timed out")
-
                 return False
 
             except ValueError:
-                # If json decoder could not parse the response
+                # If JSON decoder could not parse the response.
                 self.logger.exception(
                     "Failed to parse response from router")
-
                 return False

homeassistant/components/device_tracker/tplink.py

@@ -1,23 +1,22 @@
 """
-homeassistant.components.device_tracker.tplink
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a TP-Link router for device
-presence.
+Support for TP-Link routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.tplink/
 """
 import base64
+import hashlib
 import logging
-from datetime import timedelta
 import re
 import threading
+from datetime import timedelta
+
 import requests
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
 # Return cached results if last scan was less then this time ago
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
@@ -26,30 +25,31 @@ _LOGGER = logging.getLogger(__name__)
 
 
 def get_scanner(hass, config):
-    """ Validates config and returns a TP-Link scanner. """
+    """Validate the configuration and return a TP-Link scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
                            _LOGGER):
         return None
 
-    scanner = Tplink3DeviceScanner(config[DOMAIN])
+    scanner = Tplink4DeviceScanner(config[DOMAIN])
+
+    if not scanner.success_init:
+        scanner = Tplink3DeviceScanner(config[DOMAIN])
 
     if not scanner.success_init:
         scanner = Tplink2DeviceScanner(config[DOMAIN])
 
-        if not scanner.success_init:
-            scanner = TplinkDeviceScanner(config[DOMAIN])
+    if not scanner.success_init:
+        scanner = TplinkDeviceScanner(config[DOMAIN])
 
     return scanner if scanner.success_init else None
 
 
 class TplinkDeviceScanner(object):
-    """
-    This class queries a wireless router running TP-Link firmware
-    for connected devices.
-    """
+    """This class queries a wireless router running TP-Link firmware."""
 
     def __init__(self, config):
+        """Initialize the scanner."""
         host = config[CONF_HOST]
         username, password = config[CONF_USERNAME], config[CONF_PASSWORD]
 
@@ -65,29 +65,21 @@ class TplinkDeviceScanner(object):
         self.success_init = self._update_info()
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device ids.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
-
         return self.last_results
 
     # pylint: disable=no-self-use
     def get_device_name(self, device):
-        """
-        The TP-Link firmware doesn't save the name of the wireless device.
-        """
-
+        """The firmware doesn't save the name of the wireless device."""
         return None
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the TP-Link router is up to date.
-        Returns boolean if scanning successful.
-        """
+        """Ensure the information from the TP-Link router is up to date.
 
+        Return boolean if scanning successful.
+        """
         with self.lock:
             _LOGGER.info("Loading wireless clients...")
 
@@ -106,34 +98,24 @@ class TplinkDeviceScanner(object):
 
 
 class Tplink2DeviceScanner(TplinkDeviceScanner):
-    """
-    This class queries a wireless router running newer version of TP-Link
-    firmware for connected devices.
-    """
+    """This class queries a router with newer version of TP-Link firmware."""
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device ids.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
         return self.last_results.keys()
 
     # pylint: disable=no-self-use
     def get_device_name(self, device):
-        """
-        The TP-Link firmware doesn't save the name of the wireless device.
-        """
-
+        """The firmware doesn't save the name of the wireless device."""
         return self.last_results.get(device)
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the TP-Link router is up to date.
-        Returns boolean if scanning successful.
-        """
+        """Ensure the information from the TP-Link router is up to date.
 
+        Return boolean if scanning successful.
+        """
         with self.lock:
             _LOGGER.info("Loading wireless clients...")
 
@@ -171,46 +153,36 @@ class Tplink2DeviceScanner(TplinkDeviceScanner):
 
 
 class Tplink3DeviceScanner(TplinkDeviceScanner):
-    """
-    This class queries the Archer C9 router running version 150811 or higher
-    of TP-Link firmware for connected devices.
-    """
+    """This class queries the Archer C9 router with version 150811 or high."""
 
     def __init__(self, config):
+        """Initialize the scanner."""
         self.stok = ''
         self.sysauth = ''
         super(Tplink3DeviceScanner, self).__init__(config)
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device ids.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
         return self.last_results.keys()
 
     # pylint: disable=no-self-use
     def get_device_name(self, device):
-        """
-        The TP-Link firmware doesn't save the name of the wireless device.
+        """The firmware doesn't save the name of the wireless device.
+
         We are forced to use the MAC address as name here.
         """
-
         return self.last_results.get(device)
 
     def _get_auth_tokens(self):
-        """
-        Retrieves auth tokens from the router.
-        """
-
+        """Retrieve auth tokens from the router."""
         _LOGGER.info("Retrieving auth tokens...")
 
         url = 'http://{}/cgi-bin/luci/;stok=/login?form=login' \
             .format(self.host)
         referer = 'http://{}/webpages/login.html'.format(self.host)
 
-        # if possible implement rsa encryption of password here
-
+        # If possible implement rsa encryption of password here.
         response = requests.post(url,
                                  params={'operation': 'login',
                                          'username': self.username,
@@ -231,11 +203,10 @@ class Tplink3DeviceScanner(TplinkDeviceScanner):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the TP-Link router is up to date.
-        Returns boolean if scanning successful.
-        """
+        """Ensure the information from the TP-Link router is up to date.
 
+        Return boolean if scanning successful.
+        """
         with self.lock:
             if (self.stok == '') or (self.sysauth == ''):
                 self._get_auth_tokens()
@@ -280,3 +251,81 @@ class Tplink3DeviceScanner(TplinkDeviceScanner):
                 return True
 
             return False
+
+
+class Tplink4DeviceScanner(TplinkDeviceScanner):
+    """This class queries an Archer C7 router with TP-Link firmware 150427."""
+
+    def __init__(self, config):
+        """Initialize the scanner."""
+        self.credentials = ''
+        self.token = ''
+        super(Tplink4DeviceScanner, self).__init__(config)
+
+    def scan_devices(self):
+        """Scan for new devices and return a list with found device IDs."""
+        self._update_info()
+        return self.last_results
+
+    # pylint: disable=no-self-use
+    def get_device_name(self, device):
+        """The firmware doesn't save the name of the wireless device."""
+        return None
+
+    def _get_auth_tokens(self):
+        """Retrieve auth tokens from the router."""
+        _LOGGER.info("Retrieving auth tokens...")
+        url = 'http://{}/userRpm/LoginRpm.htm?Save=Save'.format(self.host)
+
+        # Generate md5 hash of password
+        password = hashlib.md5(self.password.encode('utf')).hexdigest()
+        credentials = '{}:{}'.format(self.username, password).encode('utf')
+
+        # Encode the credentials to be sent as a cookie.
+        self.credentials = base64.b64encode(credentials).decode('utf')
+
+        # Create the authorization cookie.
+        cookie = 'Authorization=Basic {}'.format(self.credentials)
+
+        response = requests.get(url, headers={'cookie': cookie})
+
+        try:
+            result = re.search(r'window.parent.location.href = '
+                               r'"https?:\/\/.*\/(.*)\/userRpm\/Index.htm";',
+                               response.text)
+            if not result:
+                return False
+            self.token = result.group(1)
+            return True
+        except ValueError:
+            _LOGGER.error("Couldn't fetch auth tokens!")
+            return False
+
+    @Throttle(MIN_TIME_BETWEEN_SCANS)
+    def _update_info(self):
+        """Ensure the information from the TP-Link router is up to date.
+
+        Return boolean if scanning successful.
+        """
+        with self.lock:
+            if (self.credentials == '') or (self.token == ''):
+                self._get_auth_tokens()
+
+            _LOGGER.info("Loading wireless clients...")
+
+            url = 'http://{}/{}/userRpm/WlanStationRpm.htm' \
+                .format(self.host, self.token)
+            referer = 'http://{}'.format(self.host)
+            cookie = 'Authorization=Basic {}'.format(self.credentials)
+
+            page = requests.get(url, headers={
+                'cookie': cookie,
+                'referer': referer
+            })
+            result = self.parse_macs.findall(page.text)
+
+            if not result:
+                return False
+
+            self.last_results = [mac.replace("-", ":") for mac in result]
+            return True

homeassistant/components/device_tracker/ubus.py

@@ -1,32 +1,30 @@
 """
-homeassistant.components.device_tracker.ubus
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Device tracker platform that supports scanning a OpenWRT router for device
-presence.
+Support for OpenWRT (ubus) routers.
 
 For more details about this platform, please refer to the documentation at
 https://home-assistant.io/components/device_tracker.ubus/
 """
-import logging
 import json
-from datetime import timedelta
+import logging
 import re
 import threading
+from datetime import timedelta
+
 import requests
 
-from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_USERNAME
 from homeassistant.helpers import validate_config
 from homeassistant.util import Throttle
-from homeassistant.components.device_tracker import DOMAIN
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_SCANS = timedelta(seconds=5)
 
 _LOGGER = logging.getLogger(__name__)
 
 
 def get_scanner(hass, config):
-    """ Validates config and returns a Luci scanner. """
+    """Validate the configuration and return an ubus scanner."""
     if not validate_config(config,
                            {DOMAIN: [CONF_HOST, CONF_USERNAME, CONF_PASSWORD]},
                            _LOGGER):
@@ -40,23 +38,13 @@ def get_scanner(hass, config):
 # pylint: disable=too-many-instance-attributes
 class UbusDeviceScanner(object):
     """
-    This class queries a wireless router running OpenWrt firmware
-    for connected devices. Adapted from Tomato scanner.
-
-    Configure your routers' ubus ACL based on following instructions:
-
-    http://wiki.openwrt.org/doc/techref/ubus
-
-    Read only access will be fine.
-
-    To use this class you have to install rpcd-mod-file package
-    in your OpenWrt router:
-
-    opkg install rpcd-mod-file
+    This class queries a wireless router running OpenWrt firmware.
 
+    Adapted from Tomato scanner.
     """
 
     def __init__(self, config):
+        """Initialize the scanner."""
         host = config[CONF_HOST]
         username, password = config[CONF_USERNAME], config[CONF_PASSWORD]
 
@@ -72,17 +60,12 @@ class UbusDeviceScanner(object):
         self.success_init = self.session_id is not None
 
     def scan_devices(self):
-        """
-        Scans for new devices and return a list containing found device ids.
-        """
-
+        """Scan for new devices and return a list with found device IDs."""
         self._update_info()
-
         return self.last_results
 
     def get_device_name(self, device):
-        """ Returns the name of the given device or None if we don't know. """
-
+        """Return the name of the given device or None if we don't know."""
         with self.lock:
             if self.leasefile is None:
                 result = _req_json_rpc(self.url, self.session_id,
@@ -111,8 +94,8 @@ class UbusDeviceScanner(object):
 
     @Throttle(MIN_TIME_BETWEEN_SCANS)
     def _update_info(self):
-        """
-        Ensures the information from the Luci router is up to date.
+        """Ensure the information from the Luci router is up to date.
+
         Returns boolean if scanning successful.
         """
         if not self.success_init:
@@ -140,8 +123,7 @@ class UbusDeviceScanner(object):
 
 
 def _req_json_rpc(url, session_id, rpcmethod, subsystem, method, **params):
-    """ Perform one JSON RPC operation. """
-
+    """Perform one JSON RPC operation."""
     data = json.dumps({"jsonrpc": "2.0",
                        "id": 1,
                        "method": rpcmethod,
@@ -166,7 +148,7 @@ def _req_json_rpc(url, session_id, rpcmethod, subsystem, method, **params):
 
 
 def _get_session_id(url, username, password):
-    """ Get authentication token for the given host+username+password. """
+    """Get the authentication token for the given host+username+password."""
     res = _req_json_rpc(url, "00000000000000000000000000000000", 'call',
                         'session', 'login', username=username,
                         password=password)

homeassistant/components/device_tracker/unifi.py

@@ -0,0 +1,82 @@
+"""
+Support for Unifi WAP controllers.
+
+For more details about this platform, please refer to the documentation at
+https://home-assistant.io/components/device_tracker.unifi/
+"""
+import logging
+import urllib
+
+from homeassistant.components.device_tracker import DOMAIN
+from homeassistant.const import CONF_HOST, CONF_USERNAME, CONF_PASSWORD
+from homeassistant.helpers import validate_config
+
+# Unifi package doesn't list urllib3 as a requirement
+REQUIREMENTS = ['urllib3', 'unifi==1.2.4']
+_LOGGER = logging.getLogger(__name__)
+CONF_PORT = 'port'
+
+
+def get_scanner(hass, config):
+    """Setup Unifi device_tracker."""
+    from unifi.controller import Controller
+
+    if not validate_config(config, {DOMAIN: [CONF_USERNAME,
+                                             CONF_PASSWORD]},
+                           _LOGGER):
+        _LOGGER.error('Invalid configuration')
+        return False
+
+    this_config = config[DOMAIN]
+    host = this_config.get(CONF_HOST, 'localhost')
+    username = this_config.get(CONF_USERNAME)
+    password = this_config.get(CONF_PASSWORD)
+
+    try:
+        port = int(this_config.get(CONF_PORT, 8443))
+    except ValueError:
+        _LOGGER.error('Invalid port (must be numeric like 8443)')
+        return False
+
+    try:
+        ctrl = Controller(host, username, password, port, 'v4')
+    except urllib.error.HTTPError as ex:
+        _LOGGER.error('Failed to connect to unifi: %s', ex)
+        return False
+
+    return UnifiScanner(ctrl)
+
+
+class UnifiScanner(object):
+    """Provide device_tracker support from Unifi WAP client data."""
+
+    def __init__(self, controller):
+        """Initialize the scanner."""
+        self._controller = controller
+        self._update()
+
+    def _update(self):
+        """Get the clients from the device."""
+        try:
+            clients = self._controller.get_clients()
+        except urllib.error.HTTPError as ex:
+            _LOGGER.error('Failed to scan clients: %s', ex)
+            clients = []
+
+        self._clients = {client['mac']: client for client in clients}
+
+    def scan_devices(self):
+        """Scan for devices."""
+        self._update()
+        return self._clients.keys()
+
+    def get_device_name(self, mac):
+        """Return the name (if known) of the device.
+
+        If a name has been set in Unifi, then return that, else
+        return the hostname if it has been detected.
+        """
+        client = self._clients.get(mac, {})
+        name = client.get('name') or client.get('hostname')
+        _LOGGER.debug('Device %s name %s', mac, name)
+        return name

homeassistant/components/discovery.py

@@ -1,6 +1,4 @@
 """
-homeassistant.components.discovery
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Starts a service to scan in intervals for new devices.
 
 Will emit EVENT_PLATFORM_DISCOVERED whenever a new service has been discovered.
@@ -13,11 +11,11 @@ import threading
 
 from homeassistant import bootstrap
 from homeassistant.const import (
-    EVENT_HOMEASSISTANT_START, EVENT_PLATFORM_DISCOVERED,
-    ATTR_SERVICE, ATTR_DISCOVERED)
+    ATTR_DISCOVERED, ATTR_SERVICE, EVENT_HOMEASSISTANT_START,
+    EVENT_PLATFORM_DISCOVERED)
 
 DOMAIN = "discovery"
-REQUIREMENTS = ['netdisco==0.5.2']
+REQUIREMENTS = ['netdisco==0.6.1']
 
 SCAN_INTERVAL = 300  # seconds
 
@@ -27,38 +25,56 @@ SERVICE_CAST = 'google_cast'
 SERVICE_NETGEAR = 'netgear_router'
 SERVICE_SONOS = 'sonos'
 SERVICE_PLEX = 'plex_mediaserver'
+SERVICE_SQUEEZEBOX = 'logitech_mediaserver'
+SERVICE_PANASONIC_VIERA = 'panasonic_viera'
 
 SERVICE_HANDLERS = {
-    SERVICE_WEMO: "switch",
+    SERVICE_WEMO: "wemo",
     SERVICE_CAST: "media_player",
     SERVICE_HUE: "light",
     SERVICE_NETGEAR: 'device_tracker',
     SERVICE_SONOS: 'media_player',
     SERVICE_PLEX: 'media_player',
+    SERVICE_SQUEEZEBOX: 'media_player',
+    SERVICE_PANASONIC_VIERA: 'media_player',
 }
 
 
 def listen(hass, service, callback):
-    """
-    Setup listener for discovery of specific service.
+    """Setup listener for discovery of specific service.
+
     Service can be a string or a list/tuple.
     """
-
     if isinstance(service, str):
         service = (service,)
     else:
         service = tuple(service)
 
     def discovery_event_listener(event):
-        """ Listens for discovery events. """
+        """Listen for discovery events."""
         if event.data[ATTR_SERVICE] in service:
-            callback(event.data[ATTR_SERVICE], event.data[ATTR_DISCOVERED])
+            callback(event.data[ATTR_SERVICE], event.data.get(ATTR_DISCOVERED))
 
     hass.bus.listen(EVENT_PLATFORM_DISCOVERED, discovery_event_listener)
 
 
+def discover(hass, service, discovered=None, component=None, hass_config=None):
+    """Fire discovery event. Can ensure a component is loaded."""
+    if component is not None:
+        bootstrap.setup_component(hass, component, hass_config)
+
+    data = {
+        ATTR_SERVICE: service
+    }
+
+    if discovered is not None:
+        data[ATTR_DISCOVERED] = discovered
+
+    hass.bus.fire(EVENT_PLATFORM_DISCOVERED, data)
+
+
 def setup(hass, config):
-    """ Starts a discovery service. """
+    """Start a discovery service."""
     logger = logging.getLogger(__name__)
 
     from netdisco.service import DiscoveryService
@@ -69,13 +85,13 @@ def setup(hass, config):
     lock = threading.Lock()
 
     def new_service_listener(service, info):
-        """ Called when a new service is found. """
+        """Called when a new service is found."""
         with lock:
             logger.info("Found new service: %s %s", service, info)
 
             component = SERVICE_HANDLERS.get(service)
 
-            # We do not know how to handle this service
+            # We do not know how to handle this service.
             if not component:
                 return
 
@@ -90,7 +106,7 @@ def setup(hass, config):
 
     # pylint: disable=unused-argument
     def start_discovery(event):
-        """ Start discovering. """
+        """Start discovering."""
         netdisco = DiscoveryService(SCAN_INTERVAL)
         netdisco.add_listener(new_service_listener)
         netdisco.start()

homeassistant/components/downloader.py

@@ -1,16 +1,16 @@
 """
-homeassistant.components.downloader
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-Provides functionality to download files.
+Support for functionality to download files.
 
 For more details about this component, please refer to the documentation at
 https://home-assistant.io/components/downloader/
 """
-import os
 import logging
+import os
 import re
 import threading
 
+import requests
+
 from homeassistant.helpers import validate_config
 from homeassistant.util import sanitize_filename
 
@@ -26,18 +26,9 @@ CONF_DOWNLOAD_DIR = 'download_dir'
 
 # pylint: disable=too-many-branches
 def setup(hass, config):
-    """ Listens for download events to download files. """
-
+    """Listen for download events to download files."""
     logger = logging.getLogger(__name__)
 
-    try:
-        import requests
-    except ImportError:
-        logger.exception(("Failed to import requests. "
-                          "Did you maybe not execute 'pip install requests'?"))
-
-        return False
-
     if not validate_config(config, {DOMAIN: [CONF_DOWNLOAD_DIR]}, logger):
         return False
 
@@ -56,14 +47,13 @@ def setup(hass, config):
         return False
 
     def download_file(service):
-        """ Starts thread to download file specified in the url. """
-
+        """Start thread to download file specified in the URL."""
         if ATTR_URL not in service.data:
             logger.error("Service called but 'url' parameter not specified.")
             return
 
         def do_download():
-            """ Downloads the file. """
+            """Download the file."""
             try:
                 url = service.data[ATTR_URL]
 

homeassistant/components/ecobee.py

@@ -1,40 +1,18 @@
 """
-homeassistant.components.ecobee
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Ecobee Component
-
-This component adds support for Ecobee3 Wireless Thermostats.
-You will need to setup developer access to your thermostat,
-and create and API key on the ecobee website.
-
-The first time you run this component you will see a configuration
-component card in Home Assistant.  This card will contain a PIN code
-that you will need to use to authorize access to your thermostat.  You
-can do this at https://www.ecobee.com/consumerportal/index.html
-Click My Apps, Add application, Enter Pin and click Authorize.
-
-After authorizing the application click the button in the configuration
-card.  Now your thermostat and sensors should shown in home-assistant.
-
-You can use the optional hold_temp parameter to set whether or not holds
-are set indefintely or until the next scheduled event.
-
-ecobee:
-  api_key: asdfasdfasdfasdfasdfaasdfasdfasdfasdf
-  hold_temp: True
+Support for Ecobee.
 
+For more details about this component, please refer to the documentation at
+https://home-assistant.io/components/ecobee/
 """
-
-from datetime import timedelta
 import logging
 import os
+from datetime import timedelta
 
-from homeassistant.loader import get_component
 from homeassistant import bootstrap
-from homeassistant.util import Throttle
 from homeassistant.const import (
-    EVENT_PLATFORM_DISCOVERED, ATTR_SERVICE, ATTR_DISCOVERED, CONF_API_KEY)
+    ATTR_DISCOVERED, ATTR_SERVICE, CONF_API_KEY, EVENT_PLATFORM_DISCOVERED)
+from homeassistant.loader import get_component
+from homeassistant.util import Throttle
 
 DOMAIN = "ecobee"
 DISCOVER_THERMOSTAT = "ecobee.thermostat"
@@ -51,12 +29,12 @@ _LOGGER = logging.getLogger(__name__)
 ECOBEE_CONFIG_FILE = 'ecobee.conf'
 _CONFIGURING = {}
 
-# Return cached results if last scan was less then this time ago
+# Return cached results if last scan was less then this time ago.
 MIN_TIME_BETWEEN_UPDATES = timedelta(seconds=180)
 
 
 def request_configuration(network, hass, config):
-    """ Request configuration steps from the user. """
+    """Request configuration steps from the user."""
     configurator = get_component('configurator')
     if 'ecobee' in _CONFIGURING:
         configurator.notify_errors(
@@ -66,7 +44,7 @@ def request_configuration(network, hass, config):
 
     # pylint: disable=unused-argument
     def ecobee_configuration_callback(callback_data):
-        """ Actions to do when our configuration callback is called. """
+        """The actions to do when our configuration callback is called."""
         network.request_tokens()
         network.update()
         setup_ecobee(hass, network, config)
@@ -82,7 +60,7 @@ def request_configuration(network, hass, config):
 
 
 def setup_ecobee(hass, network, config):
-    """ Setup ecobee thermostat """
+    """Setup Ecobee thermostat."""
     # If ecobee has a PIN then it needs to be configured.
     if network.pin is not None:
         request_configuration(network, hass, config)
@@ -113,22 +91,23 @@ def setup_ecobee(hass, network, config):
 
 # pylint: disable=too-few-public-methods
 class EcobeeData(object):
-    """ Gets the latest data and update the states. """
+    """Get the latest data and update the states."""
 
     def __init__(self, config_file):
+        """Initialize the Ecobee data object."""
         from pyecobee import Ecobee
         self.ecobee = Ecobee(config_file)
 
     @Throttle(MIN_TIME_BETWEEN_UPDATES)
     def update(self):
-        """ Get the latest data from pyecobee. """
+        """Get the latest data from pyecobee."""
         self.ecobee.update()
         _LOGGER.info("ecobee data updated successfully.")
 
 
 def setup(hass, config):
-    """
-    Setup Ecobee.
+    """Setup Ecobee.
+
     Will automatically load thermostat and sensor components to support
     devices discovered on the network.
     """

homeassistant/components/frontend/__init__.py

@@ -1,9 +1,4 @@
-"""
-homeassistant.components.frontend
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Provides a frontend for Home Assistant.
-"""
+"""Handle the frontend for Home Assistant."""
 import re
 import os
 import logging
@@ -11,6 +6,7 @@ import logging
 from . import version, mdi_version
 import homeassistant.util as util
 from homeassistant.const import URL_ROOT, HTTP_OK
+from homeassistant.components import api
 
 DOMAIN = 'frontend'
 DEPENDENCIES = ['api']
@@ -21,23 +17,27 @@ _LOGGER = logging.getLogger(__name__)
 
 FRONTEND_URLS = [
     URL_ROOT, '/logbook', '/history', '/map', '/devService', '/devState',
-    '/devEvent', '/devInfo', '/devTemplate', '/states']
+    '/devEvent', '/devInfo', '/devTemplate',
+    re.compile(r'/states(/([a-zA-Z\._\-0-9/]+)|)'),
+]
+
+URL_API_BOOTSTRAP = "/api/bootstrap"
 
 _FINGERPRINT = re.compile(r'^(\w+)-[a-z0-9]{32}\.(\w+)$', re.IGNORECASE)
 
 
 def setup(hass, config):
-    """ Setup serving the frontend. """
-    if 'http' not in hass.config.components:
-        _LOGGER.error('Dependency http is not loaded')
-        return False
-
+    """Setup serving the frontend."""
     for url in FRONTEND_URLS:
         hass.http.register_path('GET', url, _handle_get_root, False)
 
     hass.http.register_path('GET', '/service_worker.js',
                             _handle_get_service_worker, False)
 
+    # Bootstrap API
+    hass.http.register_path(
+        'GET', URL_API_BOOTSTRAP, _handle_get_api_bootstrap)
+
     # Static files
     hass.http.register_path(
         'GET', re.compile(r'/static/(?P<file>[a-zA-Z\._\-0-9/]+)'),
@@ -52,12 +52,20 @@ def setup(hass, config):
     return True
 
 
-def _handle_get_root(handler, path_match, data):
-    """ Renders the frontend. """
-    handler.send_response(HTTP_OK)
-    handler.send_header('Content-type', 'text/html; charset=utf-8')
-    handler.end_headers()
+def _handle_get_api_bootstrap(handler, path_match, data):
+    """Return all data needed to bootstrap Home Assistant."""
+    hass = handler.server.hass
 
+    handler.write_json({
+        'config': hass.config.as_dict(),
+        'states': hass.states.all(),
+        'events': api.events_json(hass),
+        'services': api.services_json(hass),
+    })
+
+
+def _handle_get_root(handler, path_match, data):
+    """Render the frontend."""
     if handler.server.development:
         app_url = "home-assistant-polymer/src/home-assistant.html"
     else:
@@ -74,11 +82,13 @@ def _handle_get_root(handler, path_match, data):
     template_html = template_html.replace('{{ auth }}', auth)
     template_html = template_html.replace('{{ icons }}', mdi_version.VERSION)
 
-    handler.wfile.write(template_html.encode("UTF-8"))
+    handler.send_response(HTTP_OK)
+    handler.write_content(template_html.encode("UTF-8"),
+                          'text/html; charset=utf-8')
 
 
 def _handle_get_service_worker(handler, path_match, data):
-    """ Returns service worker for the frontend. """
+    """Return service worker for the frontend."""
     if handler.server.development:
         sw_path = "home-assistant-polymer/build/service_worker.js"
     else:
@@ -89,7 +99,7 @@ def _handle_get_service_worker(handler, path_match, data):
 
 
 def _handle_get_static(handler, path_match, data):
-    """ Returns a static file for the frontend. """
+    """Return a static file for the frontend."""
     req_file = util.sanitize_path(path_match.group('file'))
 
     # Strip md5 hash out
@@ -103,9 +113,7 @@ def _handle_get_static(handler, path_match, data):
 
 
 def _handle_get_local(handler, path_match, data):
-    """
-    Returns a static file from the hass.config.path/www for the frontend.
-    """
+    """Return a static file from the hass.config.path/www for the frontend."""
     req_file = util.sanitize_path(path_match.group('file'))
 
     path = handler.server.hass.config.path('www', req_file)

homeassistant/components/frontend/mdi_version.py

@@ -1,2 +1,2 @@
-""" DO NOT MODIFY. Auto-generated by update_mdi script """
-VERSION = "7d76081c37634d36af21f5cc1ca79408"
+"""DO NOT MODIFY. Auto-generated by update_mdi script."""
+VERSION = "df49e6b7c930eb39b42ff1909712e95e"

homeassistant/components/frontend/version.py

@@ -1,2 +1,2 @@
-""" DO NOT MODIFY. Auto-generated by build_frontend script """
-VERSION = "1003c31441ec44b3db84b49980f736a7"
+"""DO NOT MODIFY. Auto-generated by build_frontend script."""
+VERSION = "c2932592a6946e955ddc46f31409b81f"

homeassistant/components/frontend/www_static/fonts/roboto/COPYRIGHT.txt

@@ -0,0 +1 @@
+Copyright 2011 Google Inc. All Rights Reserved.

homeassistant/components/frontend/www_static/fonts/roboto/DESCRIPTION.en_us.html

@@ -0,0 +1,17 @@
+<p>Roboto has a dual nature. It has a mechanical skeleton and the forms are
+largely geometric. At the same time, the font features friendly and open
+curves. While some grotesks distort their letterforms to force a rigid rhythm,
+Roboto doesn’t compromise, allowing letters to be settled into their natural
+width. This makes for a more natural reading rhythm more commonly found in
+humanist and serif types.</p>
+
+<p>This is the normal family, which can be used alongside the
+<a href="http://www.google.com/fonts/specimen/Roboto+Condensed">Roboto Condensed</a> family and the 
+<a href="http://www.google.com/fonts/specimen/Roboto+Slab">Roboto Slab</a> family.</p>
+
+<p>
+<b>Updated January 14 2015:</b>
+Christian Robertson and the Material Design team unveiled the latest version of Roboto at Google I/O last year, and it is now available from Google Fonts. 
+Existing websites using Roboto via Google Fonts will start using the latest version automatically. 
+If you have installed the fonts on your computer, please download them again and re-install.
+</p>

homeassistant/components/frontend/www_static/fonts/roboto/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

homeassistant/components/frontend/www_static/fonts/roboto/METADATA.json

@@ -0,0 +1,129 @@
+{
+  "name": "Roboto",
+  "designer": "Christian Robertson",
+  "license": "Apache2",
+  "visibility": "External",
+  "category": "Sans Serif",
+  "size": 86523,
+  "fonts": [
+    {
+      "name": "Roboto",
+      "style": "normal",
+      "weight": 100,
+      "filename": "Roboto-Thin.ttf",
+      "postScriptName": "Roboto-Thin",
+      "fullName": "Roboto Thin",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "italic",
+      "weight": 100,
+      "filename": "Roboto-ThinItalic.ttf",
+      "postScriptName": "Roboto-ThinItalic",
+      "fullName": "Roboto Thin Italic",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "normal",
+      "weight": 300,
+      "filename": "Roboto-Light.ttf",
+      "postScriptName": "Roboto-Light",
+      "fullName": "Roboto Light",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "italic",
+      "weight": 300,
+      "filename": "Roboto-LightItalic.ttf",
+      "postScriptName": "Roboto-LightItalic",
+      "fullName": "Roboto Light Italic",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "normal",
+      "weight": 400,
+      "filename": "Roboto-Regular.ttf",
+      "postScriptName": "Roboto-Regular",
+      "fullName": "Roboto",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "italic",
+      "weight": 400,
+      "filename": "Roboto-Italic.ttf",
+      "postScriptName": "Roboto-Italic",
+      "fullName": "Roboto Italic",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "normal",
+      "weight": 500,
+      "filename": "Roboto-Medium.ttf",
+      "postScriptName": "Roboto-Medium",
+      "fullName": "Roboto Medium",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "italic",
+      "weight": 500,
+      "filename": "Roboto-MediumItalic.ttf",
+      "postScriptName": "Roboto-MediumItalic",
+      "fullName": "Roboto Medium Italic",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "normal",
+      "weight": 700,
+      "filename": "Roboto-Bold.ttf",
+      "postScriptName": "Roboto-Bold",
+      "fullName": "Roboto Bold",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "italic",
+      "weight": 700,
+      "filename": "Roboto-BoldItalic.ttf",
+      "postScriptName": "Roboto-BoldItalic",
+      "fullName": "Roboto Bold Italic",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "normal",
+      "weight": 900,
+      "filename": "Roboto-Black.ttf",
+      "postScriptName": "Roboto-Black",
+      "fullName": "Roboto Black",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    },
+    {
+      "name": "Roboto",
+      "style": "italic",
+      "weight": 900,
+      "filename": "Roboto-BlackItalic.ttf",
+      "postScriptName": "Roboto-BlackItalic",
+      "fullName": "Roboto Black Italic",
+      "copyright": "Copyright 2011 Google Inc. All Rights Reserved."
+    }
+  ],
+  "subsets": [
+    "cyrillic",
+    "cyrillic-ext",
+    "greek",
+    "greek-ext",
+    "latin",
+    "latin-ext",
+    "menu",
+    "vietnamese"
+  ],
+  "dateAdded": "2013-01-09"
+}