Update docstrings (#7374)

* Update docstrings

* Update docstrings

* Update docstrings

* Update docstrings

* Update docstrings

* Update docstrings

* Update docstring

* Update docstrings

* Update docstrings

* Fix lint issues

* Update docstrings

* Revert changes in dict
This commit is contained in:
Fabian Affolter 2017-05-02 18:18:47 +02:00 committed by Paulus Schoutsen
parent 0e08925259
commit a4f1f6e724
340 changed files with 1533 additions and 1708 deletions

View file

@ -4,19 +4,18 @@ Sensors of a KNX Device.
For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/knx/
"""
from homeassistant.const import (TEMP_CELSIUS, TEMPERATURE, CONF_TYPE,
ILLUMINANCE, SPEED_MS, CONF_MINIMUM,
CONF_MAXIMUM)
from homeassistant.const import (
TEMP_CELSIUS, TEMPERATURE, CONF_TYPE, ILLUMINANCE, SPEED_MS, CONF_MINIMUM,
CONF_MAXIMUM)
from homeassistant.components.knx import (KNXConfig, KNXGroupAddress)
DEPENDENCIES = ["knx"]
DEPENDENCIES = ['knx']
# Speed units
SPEED_METERPERSECOND = "m/s" # type: str
SPEED_METERPERSECOND = 'm/s' # type: str
# Illuminance units
ILLUMINANCE_LUX = "lx" # type: str
ILLUMINANCE_LUX = 'lx' # type: str
# Predefined Minimum, Maximum Values for Sensors
# Temperature as defined in KNX Standard 3.10 - 9.001 DPT_Value_Temp
@ -33,25 +32,25 @@ KNX_SPEED_MS_MAX = 670760
def setup_platform(hass, config, add_entities, discovery_info=None):
"""Setup the KNX Sensor platform."""
"""Set up the KNX Sensor platform."""
# Add KNX Temperature Sensors
# KNX Datapoint 9.001 DPT_Value_Temp
if config[CONF_TYPE] == TEMPERATURE:
minimum_value, maximum_value = \
update_and_define_min_max(config, KNX_TEMP_MIN,
KNX_TEMP_MAX)
update_and_define_min_max(config, KNX_TEMP_MIN, KNX_TEMP_MAX)
add_entities([
KNXSensorFloatClass(hass, KNXConfig(config), TEMP_CELSIUS,
minimum_value, maximum_value)
KNXSensorFloatClass(
hass, KNXConfig(config), TEMP_CELSIUS, minimum_value,
maximum_value)
])
# Add KNX Speed Sensors(Like Wind Speed)
# KNX Datapoint 9.005 DPT_Value_Wsp
elif config[CONF_TYPE] == SPEED_MS:
minimum_value, maximum_value = \
update_and_define_min_max(config, KNX_SPEED_MS_MIN,
KNX_SPEED_MS_MAX)
update_and_define_min_max(
config, KNX_SPEED_MS_MIN, KNX_SPEED_MS_MAX)
add_entities([
KNXSensorFloatClass(hass, KNXConfig(config), SPEED_METERPERSECOND,
@ -70,9 +69,8 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
])
def update_and_define_min_max(config, minimum_default,
maximum_default):
"""Function help determinate a min/max value defined in config."""
def update_and_define_min_max(config, minimum_default, maximum_default):
"""Determinate a min/max value defined in the configuration."""
minimum_value = minimum_default
maximum_value = maximum_default
if config.get(CONF_MINIMUM):