-
-
Notifications
You must be signed in to change notification settings - Fork 29k
/
lawn_mower.py
250 lines (217 loc) · 9.41 KB
/
lawn_mower.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
"""Support for MQTT lawn mowers."""
from __future__ import annotations
from collections.abc import Callable
import contextlib
import functools
import logging
import voluptuous as vol
from homeassistant.components import lawn_mower
from homeassistant.components.lawn_mower import (
LawnMowerActivity,
LawnMowerEntity,
LawnMowerEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_NAME, CONF_OPTIMISTIC
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.restore_state import RestoreEntity
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from . import subscription
from .config import MQTT_BASE_SCHEMA
from .const import (
CONF_ENCODING,
CONF_QOS,
CONF_RETAIN,
DEFAULT_OPTIMISTIC,
DEFAULT_RETAIN,
)
from .debug_info import log_messages
from .mixins import MQTT_ENTITY_COMMON_SCHEMA, MqttEntity, async_setup_entry_helper
from .models import (
MqttCommandTemplate,
MqttValueTemplate,
PublishPayloadType,
ReceiveMessage,
ReceivePayloadType,
)
from .util import get_mqtt_data, valid_publish_topic, valid_subscribe_topic
_LOGGER = logging.getLogger(__name__)
CONF_ACTIVITY_STATE_TOPIC = "activity_state_topic"
CONF_ACTIVITY_VALUE_TEMPLATE = "activity_value_template"
CONF_DOCK_COMMAND_TOPIC = "dock_command_topic"
CONF_DOCK_COMMAND_TEMPLATE = "dock_command_template"
CONF_PAUSE_COMMAND_TOPIC = "pause_command_topic"
CONF_PAUSE_COMMAND_TEMPLATE = "pause_command_template"
CONF_START_MOWING_COMMAND_TOPIC = "start_mowing_command_topic"
CONF_START_MOWING_COMMAND_TEMPLATE = "start_mowing_command_template"
DEFAULT_NAME = "MQTT Lawn Mower"
ENTITY_ID_FORMAT = lawn_mower.DOMAIN + ".{}"
MQTT_LAWN_MOWER_ATTRIBUTES_BLOCKED: frozenset[str] = frozenset()
FEATURE_DOCK = "dock"
FEATURE_PAUSE = "pause"
FEATURE_START_MOWING = "start_mowing"
PLATFORM_SCHEMA_MODERN = MQTT_BASE_SCHEMA.extend(
{
vol.Optional(CONF_ACTIVITY_VALUE_TEMPLATE): cv.template,
vol.Optional(CONF_ACTIVITY_STATE_TOPIC): valid_subscribe_topic,
vol.Optional(CONF_DOCK_COMMAND_TEMPLATE): cv.template,
vol.Optional(CONF_DOCK_COMMAND_TOPIC): valid_publish_topic,
vol.Optional(CONF_NAME): vol.Any(cv.string, None),
vol.Optional(CONF_OPTIMISTIC, default=DEFAULT_OPTIMISTIC): cv.boolean,
vol.Optional(CONF_PAUSE_COMMAND_TEMPLATE): cv.template,
vol.Optional(CONF_PAUSE_COMMAND_TOPIC): valid_publish_topic,
vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
vol.Optional(CONF_START_MOWING_COMMAND_TEMPLATE): cv.template,
vol.Optional(CONF_START_MOWING_COMMAND_TOPIC): valid_publish_topic,
},
).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)
DISCOVERY_SCHEMA = vol.All(PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA))
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up MQTT lawn mower through YAML and through MQTT discovery."""
setup = functools.partial(
_async_setup_entity, hass, async_add_entities, config_entry=config_entry
)
await async_setup_entry_helper(hass, lawn_mower.DOMAIN, setup, DISCOVERY_SCHEMA)
async def _async_setup_entity(
hass: HomeAssistant,
async_add_entities: AddEntitiesCallback,
config: ConfigType,
config_entry: ConfigEntry,
discovery_data: DiscoveryInfoType | None = None,
) -> None:
"""Set up the MQTT lawn mower."""
async_add_entities([MqttLawnMower(hass, config, config_entry, discovery_data)])
class MqttLawnMower(MqttEntity, LawnMowerEntity, RestoreEntity):
"""Representation of an MQTT lawn mower."""
_default_name = DEFAULT_NAME
_entity_id_format = ENTITY_ID_FORMAT
_attributes_extra_blocked = MQTT_LAWN_MOWER_ATTRIBUTES_BLOCKED
_command_templates: dict[str, Callable[[PublishPayloadType], PublishPayloadType]]
_command_topics: dict[str, str]
_value_template: Callable[[ReceivePayloadType], ReceivePayloadType]
def __init__(
self,
hass: HomeAssistant,
config: ConfigType,
config_entry: ConfigEntry,
discovery_data: DiscoveryInfoType | None,
) -> None:
"""Initialize the MQTT lawn mower."""
self._attr_current_option = None
LawnMowerEntity.__init__(self)
MqttEntity.__init__(self, hass, config, config_entry, discovery_data)
@staticmethod
def config_schema() -> vol.Schema:
"""Return the config schema."""
return DISCOVERY_SCHEMA
def _setup_from_config(self, config: ConfigType) -> None:
"""(Re)Setup the entity."""
self._attr_assumed_state = config[CONF_OPTIMISTIC]
self._value_template = MqttValueTemplate(
config.get(CONF_ACTIVITY_VALUE_TEMPLATE), entity=self
).async_render_with_possible_json_value
supported_features = LawnMowerEntityFeature(0)
self._command_topics = {}
if CONF_DOCK_COMMAND_TOPIC in config:
self._command_topics[FEATURE_DOCK] = config[CONF_DOCK_COMMAND_TOPIC]
supported_features |= LawnMowerEntityFeature.DOCK
if CONF_PAUSE_COMMAND_TOPIC in config:
self._command_topics[FEATURE_PAUSE] = config[CONF_PAUSE_COMMAND_TOPIC]
supported_features |= LawnMowerEntityFeature.PAUSE
if CONF_START_MOWING_COMMAND_TOPIC in config:
self._command_topics[FEATURE_START_MOWING] = config[
CONF_START_MOWING_COMMAND_TOPIC
]
supported_features |= LawnMowerEntityFeature.START_MOWING
self._attr_supported_features = supported_features
self._command_templates = {}
self._command_templates[FEATURE_DOCK] = MqttCommandTemplate(
config.get(CONF_DOCK_COMMAND_TEMPLATE), entity=self
).async_render
self._command_templates[FEATURE_PAUSE] = MqttCommandTemplate(
config.get(CONF_PAUSE_COMMAND_TEMPLATE), entity=self
).async_render
self._command_templates[FEATURE_START_MOWING] = MqttCommandTemplate(
config.get(CONF_START_MOWING_COMMAND_TEMPLATE), entity=self
).async_render
def _prepare_subscribe_topics(self) -> None:
"""(Re)Subscribe to topics."""
@callback
@log_messages(self.hass, self.entity_id)
def message_received(msg: ReceiveMessage) -> None:
"""Handle new MQTT messages."""
payload = str(self._value_template(msg.payload))
if not payload:
_LOGGER.debug(
"Invalid empty activity payload from topic %s, for entity %s",
msg.topic,
self.entity_id,
)
return
if payload.lower() == "none":
self._attr_activity = None
get_mqtt_data(self.hass).state_write_requests.write_state_request(self)
return
try:
self._attr_activity = LawnMowerActivity(payload)
except ValueError:
_LOGGER.error(
"Invalid activity for %s: '%s' (valid activies: %s)",
self.entity_id,
payload,
[option.value for option in LawnMowerActivity],
)
return
get_mqtt_data(self.hass).state_write_requests.write_state_request(self)
if self._config.get(CONF_ACTIVITY_STATE_TOPIC) is None:
# Force into optimistic mode.
self._attr_assumed_state = True
else:
self._sub_state = subscription.async_prepare_subscribe_topics(
self.hass,
self._sub_state,
{
CONF_ACTIVITY_STATE_TOPIC: {
"topic": self._config.get(CONF_ACTIVITY_STATE_TOPIC),
"msg_callback": message_received,
"qos": self._config[CONF_QOS],
"encoding": self._config[CONF_ENCODING] or None,
}
},
)
async def _subscribe_topics(self) -> None:
"""(Re)Subscribe to topics."""
await subscription.async_subscribe_topics(self.hass, self._sub_state)
if self._attr_assumed_state and (
last_state := await self.async_get_last_state()
):
with contextlib.suppress(ValueError):
self._attr_activity = LawnMowerActivity(last_state.state)
async def _async_operate(self, option: str, activity: LawnMowerActivity) -> None:
"""Execute operation."""
payload = self._command_templates[option](option)
if self._attr_assumed_state:
self._attr_activity = activity
self.async_write_ha_state()
await self.async_publish(
self._command_topics[option],
payload,
self._config[CONF_QOS],
self._config[CONF_RETAIN],
self._config[CONF_ENCODING],
)
async def async_start_mowing(self) -> None:
"""Start or resume mowing."""
await self._async_operate("start_mowing", LawnMowerActivity.MOWING)
async def async_dock(self) -> None:
"""Dock the mower."""
await self._async_operate("dock", LawnMowerActivity.DOCKED)
async def async_pause(self) -> None:
"""Pause the lawn mower."""
await self._async_operate("pause", LawnMowerActivity.PAUSED)