Skip to content

Small refactoring of MQTT fan #18851

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Danielhiversen merged 1 commit into from
Dec 2, 2018
Merged

Small refactoring of MQTT fan #18851

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 16 additions & 19 deletions homeassistant/components/fan/mqtt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,33 +117,30 @@ class MqttFan(MqttAvailability, MqttDiscoveryUpdate, MqttEntityDeviceInfo,

def __init__(self, config, discovery_hash):
"""Initialize the MQTT fan."""
self._unique_id = config.get(CONF_UNIQUE_ID)
self._state = False
self._speed = None
self._oscillation = None
self._supported_features = 0
self._sub_state = None

self._name = None
self._topic = None
self._qos = None
self._retain = None
self._payload = None
self._templates = None
self._speed_list = None
self._optimistic = None
self._optimistic_oscillation = None
self._optimistic_speed = None
self._unique_id = None

# Load config
self._setup_from_config(config)

availability_topic = config.get(CONF_AVAILABILITY_TOPIC)
payload_available = config.get(CONF_PAYLOAD_AVAILABLE)
payload_not_available = config.get(CONF_PAYLOAD_NOT_AVAILABLE)
qos = config.get(CONF_QOS)
device_config = config.get(CONF_DEVICE)

MqttAvailability.__init__(self, availability_topic, self._qos,
MqttAvailability.__init__(self, availability_topic, qos,
payload_available, payload_not_available)
MqttDiscoveryUpdate.__init__(self, discovery_hash,
self.discovery_update)
Expand All @@ -164,7 +161,7 @@ async def discovery_update(self, discovery_payload):

def _setup_from_config(self, config):
"""(Re)Setup the entity."""
self._name = config.get(CONF_NAME)
self._config = config
self._topic = {
key: config.get(key) for key in (
CONF_STATE_TOPIC,
Expand All @@ -180,8 +177,6 @@ def _setup_from_config(self, config):
ATTR_SPEED: config.get(CONF_SPEED_VALUE_TEMPLATE),
OSCILLATION: config.get(CONF_OSCILLATION_VALUE_TEMPLATE)
}
self._qos = config.get(CONF_QOS)
self._retain = config.get(CONF_RETAIN)
self._payload = {
STATE_ON: config.get(CONF_PAYLOAD_ON),
STATE_OFF: config.get(CONF_PAYLOAD_OFF),
Expand All @@ -191,7 +186,6 @@ def _setup_from_config(self, config):
SPEED_MEDIUM: config.get(CONF_PAYLOAD_MEDIUM_SPEED),
SPEED_HIGH: config.get(CONF_PAYLOAD_HIGH_SPEED),
}
self._speed_list = config.get(CONF_SPEED_LIST)
optimistic = config.get(CONF_OPTIMISTIC)
self._optimistic = optimistic or self._topic[CONF_STATE_TOPIC] is None
self._optimistic_oscillation = (
Expand Down Expand Up @@ -232,7 +226,7 @@ def state_received(topic, payload, qos):
topics[CONF_STATE_TOPIC] = {
'topic': self._topic[CONF_STATE_TOPIC],
'msg_callback': state_received,
'qos': self._qos}
'qos': self._config.get(CONF_QOS)}

@callback
def speed_received(topic, payload, qos):
Expand All @@ -250,7 +244,7 @@ def speed_received(topic, payload, qos):
topics[CONF_SPEED_STATE_TOPIC] = {
'topic': self._topic[CONF_SPEED_STATE_TOPIC],
'msg_callback': speed_received,
'qos': self._qos}
'qos': self._config.get(CONF_QOS)}
self._speed = SPEED_OFF

@callback
Expand All @@ -267,7 +261,7 @@ def oscillation_received(topic, payload, qos):
topics[CONF_OSCILLATION_STATE_TOPIC] = {
'topic': self._topic[CONF_OSCILLATION_STATE_TOPIC],
'msg_callback': oscillation_received,
'qos': self._qos}
'qos': self._config.get(CONF_QOS)}
self._oscillation = False

self._sub_state = await subscription.async_subscribe_topics(
Expand Down Expand Up @@ -297,12 +291,12 @@ def is_on(self):
@property
def name(self) -> str:
"""Get entity name."""
return self._name
return self._config.get(CONF_NAME)

@property
def speed_list(self) -> list:
"""Get the list of available speeds."""
return self._speed_list
return self._config.get(CONF_SPEED_LIST)

@property
def supported_features(self) -> int:
Expand All @@ -326,7 +320,8 @@ async def async_turn_on(self, speed: str = None, **kwargs) -> None:
"""
mqtt.async_publish(
self.hass, self._topic[CONF_COMMAND_TOPIC],
self._payload[STATE_ON], self._qos, self._retain)
self._payload[STATE_ON], self._config.get(CONF_QOS),
self._config.get(CONF_RETAIN))
if speed:
await self.async_set_speed(speed)

Expand All @@ -337,7 +332,8 @@ async def async_turn_off(self, **kwargs) -> None:
"""
mqtt.async_publish(
self.hass, self._topic[CONF_COMMAND_TOPIC],
self._payload[STATE_OFF], self._qos, self._retain)
self._payload[STATE_OFF], self._config.get(CONF_QOS),
self._config.get(CONF_RETAIN))

async def async_set_speed(self, speed: str) -> None:
"""Set the speed of the fan.
Expand All @@ -358,7 +354,8 @@ async def async_set_speed(self, speed: str) -> None:

mqtt.async_publish(
self.hass, self._topic[CONF_SPEED_COMMAND_TOPIC],
mqtt_payload, self._qos, self._retain)
mqtt_payload, self._config.get(CONF_QOS),
self._config.get(CONF_RETAIN))

if self._optimistic_speed:
self._speed = speed
Expand All @@ -379,7 +376,7 @@ async def async_oscillate(self, oscillating: bool) -> None:

mqtt.async_publish(
self.hass, self._topic[CONF_OSCILLATION_COMMAND_TOPIC],
payload, self._qos, self._retain)
payload, self._config.get(CONF_QOS), self._config.get(CONF_RETAIN))

if self._optimistic_oscillation:
self._oscillation = oscillating
Expand Down