jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-19 19:27:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use dict[key] for required config keys and keys with default values. (#22833)

Browse Source
This commit is contained in:
Erik Montnemery 2019-04-07 16:08:47 +02:00 committed by Fabian Affolter
parent 439197ea3e
commit a4e7708450
1 changed files with 34 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
homeassistant/components/mqtt/fan.py
View File

@ -50,29 +50,29 @@ OSCILLATE_OFF_PAYLOAD = 'oscillate_off'
OSCILLATION = 'oscillation' OSCILLATION = 'oscillation'
PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({ PLATFORM_SCHEMA = mqtt.MQTT_RW_PLATFORM_SCHEMA.extend({
vol.Optional(CONF_DEVICE): mqtt.MQTT_ENTITY_DEVICE_INFO_SCHEMA,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string, vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Optional(CONF_STATE_VALUE_TEMPLATE): cv.template, vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
vol.Optional(CONF_SPEED_STATE_TOPIC): mqtt.valid_subscribe_topic,
vol.Optional(CONF_SPEED_COMMAND_TOPIC): mqtt.valid_publish_topic,
vol.Optional(CONF_SPEED_VALUE_TEMPLATE): cv.template,
vol.Optional(CONF_OSCILLATION_STATE_TOPIC): mqtt.valid_subscribe_topic,
vol.Optional(CONF_OSCILLATION_COMMAND_TOPIC): mqtt.valid_publish_topic, vol.Optional(CONF_OSCILLATION_COMMAND_TOPIC): mqtt.valid_publish_topic,
vol.Optional(CONF_OSCILLATION_STATE_TOPIC): mqtt.valid_subscribe_topic,
vol.Optional(CONF_OSCILLATION_VALUE_TEMPLATE): cv.template, vol.Optional(CONF_OSCILLATION_VALUE_TEMPLATE): cv.template,
vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string, vol.Optional(CONF_PAYLOAD_HIGH_SPEED, default=SPEED_HIGH): cv.string,
vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
vol.Optional(CONF_PAYLOAD_OSCILLATION_ON,
default=DEFAULT_PAYLOAD_ON): cv.string,
vol.Optional(CONF_PAYLOAD_OSCILLATION_OFF,
default=DEFAULT_PAYLOAD_OFF): cv.string,
vol.Optional(CONF_PAYLOAD_LOW_SPEED, default=SPEED_LOW): cv.string, vol.Optional(CONF_PAYLOAD_LOW_SPEED, default=SPEED_LOW): cv.string,
vol.Optional(CONF_PAYLOAD_MEDIUM_SPEED, default=SPEED_MEDIUM): cv.string, vol.Optional(CONF_PAYLOAD_MEDIUM_SPEED, default=SPEED_MEDIUM): cv.string,
vol.Optional(CONF_PAYLOAD_HIGH_SPEED, default=SPEED_HIGH): cv.string, vol.Optional(CONF_PAYLOAD_OFF, default=DEFAULT_PAYLOAD_OFF): cv.string,
vol.Optional(CONF_PAYLOAD_ON, default=DEFAULT_PAYLOAD_ON): cv.string,
vol.Optional(CONF_PAYLOAD_OSCILLATION_OFF,
default=DEFAULT_PAYLOAD_OFF): cv.string,
vol.Optional(CONF_PAYLOAD_OSCILLATION_ON,
default=DEFAULT_PAYLOAD_ON): cv.string,
vol.Optional(CONF_SPEED_COMMAND_TOPIC): mqtt.valid_publish_topic,
vol.Optional(CONF_SPEED_LIST, vol.Optional(CONF_SPEED_LIST,
default=[SPEED_OFF, SPEED_LOW, default=[SPEED_OFF, SPEED_LOW,
SPEED_MEDIUM, SPEED_HIGH]): cv.ensure_list, SPEED_MEDIUM, SPEED_HIGH]): cv.ensure_list,
vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean, vol.Optional(CONF_SPEED_STATE_TOPIC): mqtt.valid_subscribe_topic,
vol.Optional(CONF_SPEED_VALUE_TEMPLATE): cv.template,
vol.Optional(CONF_STATE_VALUE_TEMPLATE): cv.template,
vol.Optional(CONF_UNIQUE_ID): cv.string, vol.Optional(CONF_UNIQUE_ID): cv.string,
vol.Optional(CONF_DEVICE): mqtt.MQTT_ENTITY_DEVICE_INFO_SCHEMA,
}).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema).extend( }).extend(mqtt.MQTT_AVAILABILITY_SCHEMA.schema).extend(
mqtt.MQTT_JSON_ATTRS_SCHEMA.schema) mqtt.MQTT_JSON_ATTRS_SCHEMA.schema)
@ -174,15 +174,15 @@ class MqttFan(MqttAttributes, MqttAvailability, MqttDiscoveryUpdate,
OSCILLATION: config.get(CONF_OSCILLATION_VALUE_TEMPLATE) OSCILLATION: config.get(CONF_OSCILLATION_VALUE_TEMPLATE)
} }
self._payload = { self._payload = {
STATE_ON: config.get(CONF_PAYLOAD_ON), STATE_ON: config[CONF_PAYLOAD_ON],
STATE_OFF: config.get(CONF_PAYLOAD_OFF), STATE_OFF: config[CONF_PAYLOAD_OFF],
OSCILLATE_ON_PAYLOAD: config.get(CONF_PAYLOAD_OSCILLATION_ON), OSCILLATE_ON_PAYLOAD: config[CONF_PAYLOAD_OSCILLATION_ON],
OSCILLATE_OFF_PAYLOAD: config.get(CONF_PAYLOAD_OSCILLATION_OFF), OSCILLATE_OFF_PAYLOAD: config[CONF_PAYLOAD_OSCILLATION_OFF],
SPEED_LOW: config.get(CONF_PAYLOAD_LOW_SPEED), SPEED_LOW: config[CONF_PAYLOAD_LOW_SPEED],
SPEED_MEDIUM: config.get(CONF_PAYLOAD_MEDIUM_SPEED), SPEED_MEDIUM: config[CONF_PAYLOAD_MEDIUM_SPEED],
SPEED_HIGH: config.get(CONF_PAYLOAD_HIGH_SPEED), SPEED_HIGH: config[CONF_PAYLOAD_HIGH_SPEED],
} }
optimistic = config.get(CONF_OPTIMISTIC) optimistic = config[CONF_OPTIMISTIC]
self._optimistic = optimistic or self._topic[CONF_STATE_TOPIC] is None self._optimistic = optimistic or self._topic[CONF_STATE_TOPIC] is None
self._optimistic_oscillation = ( self._optimistic_oscillation = (
optimistic or self._topic[CONF_OSCILLATION_STATE_TOPIC] is None) optimistic or self._topic[CONF_OSCILLATION_STATE_TOPIC] is None)
@ -220,7 +220,7 @@ class MqttFan(MqttAttributes, MqttAvailability, MqttDiscoveryUpdate,
topics[CONF_STATE_TOPIC] = { topics[CONF_STATE_TOPIC] = {
'topic': self._topic[CONF_STATE_TOPIC], 'topic': self._topic[CONF_STATE_TOPIC],
'msg_callback': state_received, 'msg_callback': state_received,
'qos': self._config.get(CONF_QOS)} 'qos': self._config[CONF_QOS]}
@callback @callback
def speed_received(msg): def speed_received(msg):
@ -238,7 +238,7 @@ class MqttFan(MqttAttributes, MqttAvailability, MqttDiscoveryUpdate,
topics[CONF_SPEED_STATE_TOPIC] = { topics[CONF_SPEED_STATE_TOPIC] = {
'topic': self._topic[CONF_SPEED_STATE_TOPIC], 'topic': self._topic[CONF_SPEED_STATE_TOPIC],
'msg_callback': speed_received, 'msg_callback': speed_received,
'qos': self._config.get(CONF_QOS)} 'qos': self._config[CONF_QOS]}
self._speed = SPEED_OFF self._speed = SPEED_OFF
@callback @callback
@ -255,7 +255,7 @@ class MqttFan(MqttAttributes, MqttAvailability, MqttDiscoveryUpdate,
topics[CONF_OSCILLATION_STATE_TOPIC] = { topics[CONF_OSCILLATION_STATE_TOPIC] = {
'topic': self._topic[CONF_OSCILLATION_STATE_TOPIC], 'topic': self._topic[CONF_OSCILLATION_STATE_TOPIC],
'msg_callback': oscillation_received, 'msg_callback': oscillation_received,
'qos': self._config.get(CONF_QOS)} 'qos': self._config[CONF_QOS]}
self._oscillation = False self._oscillation = False
self._sub_state = await subscription.async_subscribe_topics( self._sub_state = await subscription.async_subscribe_topics(
@ -287,12 +287,12 @@ class MqttFan(MqttAttributes, MqttAvailability, MqttDiscoveryUpdate,
@property @property
def name(self) -> str: def name(self) -> str:
"""Get entity name.""" """Get entity name."""
return self._config.get(CONF_NAME) return self._config[CONF_NAME]
@property @property
def speed_list(self) -> list: def speed_list(self) -> list:
"""Get the list of available speeds.""" """Get the list of available speeds."""
return self._config.get(CONF_SPEED_LIST) return self._config[CONF_SPEED_LIST]
@property @property
def supported_features(self) -> int: def supported_features(self) -> int:
@ -316,8 +316,8 @@ class MqttFan(MqttAttributes, MqttAvailability, MqttDiscoveryUpdate,
""" """
mqtt.async_publish( mqtt.async_publish(
self.hass, self._topic[CONF_COMMAND_TOPIC], self.hass, self._topic[CONF_COMMAND_TOPIC],
self._payload[STATE_ON], self._config.get(CONF_QOS), self._payload[STATE_ON], self._config[CONF_QOS],
self._config.get(CONF_RETAIN)) self._config[CONF_RETAIN])
if speed: if speed:
await self.async_set_speed(speed) await self.async_set_speed(speed)
@ -328,8 +328,8 @@ class MqttFan(MqttAttributes, MqttAvailability, MqttDiscoveryUpdate,
""" """
mqtt.async_publish( mqtt.async_publish(
self.hass, self._topic[CONF_COMMAND_TOPIC], self.hass, self._topic[CONF_COMMAND_TOPIC],
self._payload[STATE_OFF], self._config.get(CONF_QOS), self._payload[STATE_OFF], self._config[CONF_QOS],
self._config.get(CONF_RETAIN)) self._config[CONF_RETAIN])
async def async_set_speed(self, speed: str) -> None: async def async_set_speed(self, speed: str) -> None:
"""Set the speed of the fan. """Set the speed of the fan.
@ -350,8 +350,8 @@ class MqttFan(MqttAttributes, MqttAvailability, MqttDiscoveryUpdate,
mqtt.async_publish( mqtt.async_publish(
self.hass, self._topic[CONF_SPEED_COMMAND_TOPIC], self.hass, self._topic[CONF_SPEED_COMMAND_TOPIC],
mqtt_payload, self._config.get(CONF_QOS), mqtt_payload, self._config[CONF_QOS],
self._config.get(CONF_RETAIN)) self._config[CONF_RETAIN])
if self._optimistic_speed: if self._optimistic_speed:
self._speed = speed self._speed = speed
@ -372,7 +372,7 @@ class MqttFan(MqttAttributes, MqttAvailability, MqttDiscoveryUpdate,
mqtt.async_publish( mqtt.async_publish(
self.hass, self._topic[CONF_OSCILLATION_COMMAND_TOPIC], self.hass, self._topic[CONF_OSCILLATION_COMMAND_TOPIC],
payload, self._config.get(CONF_QOS), self._config.get(CONF_RETAIN)) payload, self._config[CONF_QOS], self._config[CONF_RETAIN])
if self._optimistic_oscillation: if self._optimistic_oscillation:
self._oscillation = oscillating self._oscillation = oscillating