From 42dc973ccc34b0610838fbb43720a6d897b27043 Mon Sep 17 00:00:00 2001 From: jamespcole Date: Mon, 9 Mar 2015 01:14:44 +1100 Subject: [PATCH] Fixed up linting errors --- homeassistant/components/light/vera.py | 61 +++++++++++--------- homeassistant/components/sensor/vera.py | 74 +++++++++++++------------ homeassistant/components/switch/vera.py | 60 ++++++++++---------- 3 files changed, 105 insertions(+), 90 deletions(-) diff --git a/homeassistant/components/light/vera.py b/homeassistant/components/light/vera.py index bb60c97624b..15033a7c495 100644 --- a/homeassistant/components/light/vera.py +++ b/homeassistant/components/light/vera.py @@ -1,36 +1,40 @@ -""" -Support for Vera lights. +""" +Support for Vera lights. Configuration: -This component is useful if you wish for switches connected to your Vera controller to appear as lights -in homeassistant. All switches will be added as a light unless you exclude them in the config. +This component is useful if you wish for switches connected to your Vera +controller to appear as lights in homeassistant. All switches will be added +as a light unless you exclude them in the config. -To use the Vera lights you will need to add something like the following to your config/configuration.yaml +To use the Vera lights you will need to add something like the following to +your config/configuration.yaml light: platform: vera vera_controller_url: http://YOUR_VERA_IP:3480/ - device_data: - - + device_data: + - vera_id: 12 name: My awesome switch exclude: true - vera_id: 13 - name: Another switch + name: Another switch -VARIABLES: +VARIABLES: vera_controller_url *Required -This is the base URL of your vera controller including the port number if not running on 80 +This is the base URL of your vera controller including the port number if not +running on 80 Example: http://192.168.1.21:3480/ device_data *Optional -This contains an array additional device info for your Vera devices. It is not required and if -not specified all sensors configured in your Vera controller will be added with default values. +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 +will be added with default values. These are the variables for the device_data array: @@ -42,35 +46,34 @@ The Vera device id you wish these configuration options to be applied to name *Optional -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 will be used +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 +will be used exclude *Optional -This parameter allows you to exclude the specified device from homeassistant, it should be set to "true" if -you want this device excluded - - +This parameter allows you to exclude the specified device from homeassistant, +it should be set to "true" if you want this device excluded """ import logging -import requests import time -import json from homeassistant.helpers import ToggleDevice +# pylint: disable=no-name-in-module, import-error import homeassistant.external.vera.vera as veraApi _LOGGER = logging.getLogger(__name__) - +# pylint: disable=unused-argument def setup_platform(hass, config, add_devices_callback, discovery_info=None): """ Find and return Vera lights. """ try: base_url = config.get('vera_controller_url') if not base_url: - _LOGGER.error("The required parameter 'vera_controller_url' was not found in config") + _LOGGER.error("The required parameter 'vera_controller_url'" + " was not found in config") return False device_data = config.get('device_data', None) @@ -85,16 +88,18 @@ def setup_platform(hass, config, add_devices_callback, discovery_info=None): if extra_data: exclude = extra_data.get('exclude', False) - if exclude is not True: + if exclude is not True: lights.append(VeraLight(device, extra_data)) add_devices_callback(lights) + # pylint: disable=broad-except except Exception as inst: _LOGGER.error("Could not find Vera lights: %s", inst) return False def get_extra_device_data(device_data, device_id): + """ Gets the additional configuration data by Vera device Id """ if not device_data: return None @@ -136,9 +141,11 @@ class VeraLight(ToggleDevice): attr['Armed'] = 'True' if armed == '1' else 'False' if self.vera_device.is_trippable: - lastTripped = self.vera_device.refresh_value('LastTrip') - tripTimeStr = time.strftime("%Y-%m-%d %H:%M", time.localtime(int(lastTripped))) - attr['Last Tripped'] = tripTimeStr + last_tripped = self.vera_device.refresh_value('LastTrip') + trip_time_str = time.strftime("%Y-%m-%d %H:%M", + time.localtime(int(last_tripped))) + + attr['Last Tripped'] = trip_time_str tripped = self.vera_device.refresh_value('Tripped') attr['Tripped'] = 'True' if tripped == '1' else 'False' @@ -164,7 +171,7 @@ class VeraLight(ToggleDevice): return self.is_on_status def update(self): - # We need to debounce the status call after turning light on or off + # We need to debounce the status call after turning light on or off # because the vera has some lag in updating the device status if (self.last_command_send + 5) < time.time(): self.is_on_status = self.vera_device.is_switched_on() diff --git a/homeassistant/components/sensor/vera.py b/homeassistant/components/sensor/vera.py index 0f901123864..885186fb9f9 100644 --- a/homeassistant/components/sensor/vera.py +++ b/homeassistant/components/sensor/vera.py @@ -1,33 +1,36 @@ -""" -Support for Vera sensors. +""" +Support for Vera sensors. Configuration: -To use the Vera sensors you will need to add something like the following to your config/configuration.yaml +To use the Vera sensors you will need to add something like the following to +your config/configuration.yaml sensor: platform: vera vera_controller_url: http://YOUR_VERA_IP:3480/ - device_data: - - + device_data: + - vera_id: 12 name: My awesome sensor exclude: true - vera_id: 13 - name: Another sensor + name: Another sensor -VARIABLES: +VARIABLES: vera_controller_url *Required -This is the base URL of your vera controller including the port number if not running on 80 +This is the base URL of your vera controller including the port number if not +running on 80 Example: http://192.168.1.21:3480/ device_data *Optional -This contains an array additional device info for your Vera devices. It is not required and if -not specified all sensors configured in your Vera controller will be added with default values. +This contains an array additional device info for your Vera devices. It is not +required and if not specified all sensors configured in your Vera controller +will be added with default values. These are the variables for the device_data array: @@ -39,44 +42,41 @@ The Vera device id you wish these configuration options to be applied to name *Optional -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 will be used +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 +will be used exclude *Optional -This parameter allows you to exclude the specified device from homeassistant, it should be set to "true" if -you want this device excluded - - +This parameter allows you to exclude the specified device from homeassistant, +it should be set to "true" if you want this device excluded """ import logging -import requests import time -import json from homeassistant.helpers import Device +# pylint: disable=no-name-in-module, import-error import homeassistant.external.vera.vera as veraApi -from homeassistant.const import (STATE_OPEN, STATE_CLOSED, ATTR_FRIENDLY_NAME) _LOGGER = logging.getLogger(__name__) -vera_controller = None -vera_sensors = [] - +# pylint: disable=unused-argument def get_devices(hass, config): """ Find and return Vera Sensors. """ try: base_url = config.get('vera_controller_url') if not base_url: - _LOGGER.error("The required parameter 'vera_controller_url' was not found in config") + _LOGGER.error("The required parameter 'vera_controller_url'" + " was not found in config") return False device_data = config.get('device_data', None) vera_controller = veraApi.VeraController(base_url) - devices = vera_controller.get_devices(['Temperature Sensor', 'Light Sensor', 'Sensor']) + categories = ['Temperature Sensor', 'Light Sensor', 'Sensor'] + devices = vera_controller.get_devices(categories) vera_sensors = [] for device in devices: @@ -85,18 +85,20 @@ def get_devices(hass, config): if extra_data: exclude = extra_data.get('exclude', False) - if exclude is not True: + if exclude is not True: vera_sensors.append(VeraSensor(device, extra_data)) - + # pylint: disable=broad-except except Exception as inst: _LOGGER.error("Could not find Vera sensors: %s", inst) return vera_sensors def setup_platform(hass, config, add_devices, discovery_info=None): + """ Performs setup for Vera controller devices """ add_devices(get_devices(hass, config)) def get_extra_device_data(device_data, device_id): + """ Gets the additional configuration data by Vera device Id """ if not device_data: return None @@ -113,18 +115,15 @@ class VeraSensor(Device): def __init__(self, vera_device, extra_data=None): self.vera_device = vera_device - self.extra_data = extra_data + self.extra_data = extra_data def __str__(self): - return "%s %s %s" % (self.name(), self.deviceId(), self.state()) + return "%s %s %s" % (self.name, self.vera_device.deviceId, self.state) @property def state(self): return self.current_value - def updateState(self): - return self.state() - @property def name(self): """ Get the mame of the sensor. """ @@ -144,9 +143,11 @@ class VeraSensor(Device): attr['Armed'] = 'True' if armed == '1' else 'False' if self.vera_device.is_trippable: - lastTripped = self.vera_device.refresh_value('LastTrip') - tripTimeStr = time.strftime("%Y-%m-%d %H:%M", time.localtime(int(lastTripped))) - attr['Last Tripped'] = tripTimeStr + last_tripped = self.vera_device.refresh_value('LastTrip') + trip_time_str = time.strftime("%Y-%m-%d %H:%M", + time.localtime(int(last_tripped))) + + attr['Last Tripped'] = trip_time_str tripped = self.vera_device.refresh_value('Tripped') attr['Tripped'] = 'True' if tripped == '1' else 'False' @@ -159,7 +160,10 @@ class VeraSensor(Device): def update(self): if self.vera_device.category == "Temperature Sensor": self.vera_device.refresh_value('CurrentTemperature') - self.current_value = self.vera_device.get_value('CurrentTemperature') + '°' + self.vera_device.veraController.temperature_units + current_temp = self.vera_device.get_value('CurrentTemperature') + vera_temp_units = self.vera_device.veraController.temperature_units + self.current_value = current_temp + '°' + vera_temp_units + elif self.vera_device.category == "Light Sensor": self.vera_device.refresh_value('CurrentLevel') self.current_value = self.vera_device.get_value('CurrentLevel') diff --git a/homeassistant/components/switch/vera.py b/homeassistant/components/switch/vera.py index 8efb0a85b03..f917b7f0477 100644 --- a/homeassistant/components/switch/vera.py +++ b/homeassistant/components/switch/vera.py @@ -1,33 +1,36 @@ -""" -Support for Vera switches. +""" +Support for Vera switches. Configuration: -To use the Vera switches you will need to add something like the following to your config/configuration.yaml +To use the Vera lights you will need to add something like the following to +your config/configuration.yaml switch: platform: vera vera_controller_url: http://YOUR_VERA_IP:3480/ - device_data: - - + device_data: + - vera_id: 12 name: My awesome switch exclude: true - vera_id: 13 - name: Another Switch + name: Another Switch -VARIABLES: +VARIABLES: vera_controller_url *Required -This is the base URL of your vera controller including the port number if not running on 80 +This is the base URL of your vera controller including the port number if not +running on 80 Example: http://192.168.1.21:3480/ device_data *Optional -This contains an array additional device info for your Vera devices. It is not required and if -not specified all switches configured in your Vera controller will be added with default values. +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 +will be added with default values. These are the variables for the device_data array: @@ -39,37 +42,34 @@ The Vera device id you wish these configuration options to be applied to name *Optional -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 will be used +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 +will be used exclude *Optional -This parameter allows you to exclude the specified device from homeassistant, it should be set to "true" if -you want this device excluded - - +This parameter allows you to exclude the specified device from homeassistant, +it should be set to "true" if you want this device excluded """ import logging -import requests import time -import json from homeassistant.helpers import ToggleDevice +# pylint: disable=no-name-in-module, import-error import homeassistant.external.vera.vera as veraApi _LOGGER = logging.getLogger(__name__) -vera_controller = None -vera_switches = [] - +# pylint: disable=unused-argument def get_devices(hass, config): """ Find and return Vera switches. """ try: base_url = config.get('vera_controller_url') if not base_url: - _LOGGER.error("The required parameter 'vera_controller_url' was not found in config") + _LOGGER.error("The required parameter 'vera_controller_url'" + " was not found in config") return False device_data = config.get('device_data', None) @@ -84,9 +84,10 @@ def get_devices(hass, config): if extra_data: exclude = extra_data.get('exclude', False) - if exclude is not True: + if exclude is not True: vera_switches.append(VeraSwitch(device, extra_data)) + # pylint: disable=broad-except except Exception as inst: _LOGGER.error("Could not find Vera switches: %s", inst) return False @@ -94,6 +95,7 @@ def get_devices(hass, config): return vera_switches def get_extra_device_data(device_data, device_id): + """ Gets the additional configuration data by Vera device Id """ if not device_data: return None @@ -104,6 +106,7 @@ def get_extra_device_data(device_data, device_id): def setup_platform(hass, config, add_devices, discovery_info=None): + """ Find and return Vera lights. """ add_devices(get_devices(hass, config)) class VeraSwitch(ToggleDevice): @@ -136,9 +139,11 @@ class VeraSwitch(ToggleDevice): attr['Armed'] = 'True' if armed == '1' else 'False' if self.vera_device.is_trippable: - lastTripped = self.vera_device.refresh_value('LastTrip') - tripTimeStr = time.strftime("%Y-%m-%d %H:%M", time.localtime(int(lastTripped))) - attr['Last Tripped'] = tripTimeStr + last_tripped = self.vera_device.refresh_value('LastTrip') + trip_time_str = time.strftime("%Y-%m-%d %H:%M", + time.localtime(int(last_tripped))) + + attr['Last Tripped'] = trip_time_str tripped = self.vera_device.refresh_value('Tripped') attr['Tripped'] = 'True' if tripped == '1' else 'False' @@ -156,7 +161,6 @@ class VeraSwitch(ToggleDevice): self.last_command_send = time.time() self.vera_device.switch_off() self.is_on_status = False - @property def is_on(self): @@ -165,7 +169,7 @@ class VeraSwitch(ToggleDevice): return self.is_on_status def update(self): - # We need to debounce the status call after turning switch on or off + # We need to debounce the status call after turning switch on or off # because the vera has some lag in updating the device status if (self.last_command_send + 5) < time.time(): self.is_on_status = self.vera_device.is_switched_on()