update header

This commit is contained in:
Fabian Affolter 2015-08-08 19:09:37 +02:00
parent ac14698ab9
commit 6268a9f5b2

View file

@ -1,9 +1,11 @@
""" """
homeassistant.components.switch.vera
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Support for Vera switches. Support for Vera switches.
Configuration: Configuration:
To use the Vera lights you will need to add something like the following to To use the Vera lights you will need to add something like the following to
your config/configuration.yaml your config/configuration.yaml.
switch: switch:
platform: vera platform: vera
@ -15,38 +17,32 @@ switch:
13: 13:
name: Another Switch name: Another Switch
VARIABLES: Variables:
vera_controller_url vera_controller_url
*Required *Required
This is the base URL of your vera controller including the port number if not This is the base URL of your vera controller including the port number if not
running on 80 running on 80. Example: http://192.168.1.21:3480/
Example: http://192.168.1.21:3480/
device_data device_data
*Optional *Optional
This contains an array additional device info for your Vera devices. It is not This contains an array additional device info for your Vera devices. It is not
required and if not specified all lights configured in your Vera controller required and if not specified all lights configured in your Vera controller
will be added with default values. You should use the id of your vera device will be added with default values. You should use the id of your vera device
as the key for the device within device_data as the key for the device within device_data.
These are the variables for the device_data array: These are the variables for the device_data array:
name name
*Optional *Optional
This parameter allows you to override the name of your Vera device in the HA This parameter allows you to override the name of your Vera device in the HA
interface, if not specified the value configured for the device in your Vera interface, if not specified the value configured for the device in your Vera
will be used will be used.
exclude exclude
*Optional *Optional
This parameter allows you to exclude the specified device from homeassistant, This parameter allows you to exclude the specified device from homeassistant,
it should be set to "true" if you want this device excluded it should be set to "true" if you want this device excluded.
""" """
import logging import logging
import time import time
@ -82,7 +78,7 @@ def get_devices(hass, config):
devices = vera_controller.get_devices([ devices = vera_controller.get_devices([
'Switch', 'Armable Sensor', 'On/Off Switch']) 'Switch', 'Armable Sensor', 'On/Off Switch'])
except RequestException: except RequestException:
# There was a network related error connecting to the vera controller # There was a network related error connecting to the vera controller.
_LOGGER.exception("Error communicating with Vera API") _LOGGER.exception("Error communicating with Vera API")
return False return False
@ -103,7 +99,7 @@ def setup_platform(hass, config, add_devices, discovery_info=None):
class VeraSwitch(ToggleEntity): class VeraSwitch(ToggleEntity):
""" Represents a Vera Switch """ """ Represents a Vera Switch. """
def __init__(self, vera_device, extra_data=None): def __init__(self, vera_device, extra_data=None):
self.vera_device = vera_device self.vera_device = vera_device