-
Notifications
You must be signed in to change notification settings - Fork 3
/
unipi_control.py
264 lines (221 loc) · 9.25 KB
/
unipi_control.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
251
252
253
254
255
256
257
258
259
260
261
262
263
264
"""Unipi Control entry point for read configuration, initialize modbus and connect to mqtt."""
import argparse
import asyncio
import sys
import uuid
from aiomqtt import Client
from aiomqtt import MqttError
from asyncio import Task
from contextlib import AsyncExitStack
from pathlib import Path
from pymodbus.client.serial import AsyncModbusSerialClient
from pymodbus.client.tcp import AsyncModbusTcpClient
from typing import Awaitable
from typing import Callable
from typing import List
from typing import NoReturn
from typing import Optional
from typing import Set
from unipi_control.config import Config
from unipi_control.config import DEFAULT_CONFIG_DIR
from unipi_control.config import LogPrefix
from unipi_control.config import MqttConfig
from unipi_control.config import UNIPI_LOGGER
from unipi_control.helpers.argparse import init_argparse
from unipi_control.helpers.exception import ConfigError
from unipi_control.helpers.exception import UnexpectedError
from unipi_control.helpers.text import slugify
from unipi_control.helpers.typing import ModbusClient
from unipi_control.integrations.covers import CoverMap
from unipi_control.mqtt.discovery.binary_sensors import HassBinarySensorsMqttPlugin
from unipi_control.mqtt.discovery.covers import HassCoversMqttPlugin
from unipi_control.mqtt.discovery.sensors import HassSensorsMqttPlugin
from unipi_control.mqtt.discovery.switches import HassSwitchesMqttPlugin
from unipi_control.mqtt.features import MeterFeaturesMqttPlugin
from unipi_control.mqtt.features import NeuronFeaturesMqttPlugin
from unipi_control.mqtt.integrations.covers import CoversMqttPlugin
from unipi_control.neuron import Neuron
from unipi_control.version import __version__
class UnipiControl:
"""Control Unipi I/O directly with MQTT commands.
Unipi Control use Modbus for fast access to the I/O and provide MQTT
topics for reading and writing the circuits. Optionally you can enable
the Home Assistant MQTT discovery for binary sensors, sensors, switches and covers.
"""
def __init__(self, config: Config, modbus_client: ModbusClient) -> None:
self.config: Config = config
self.modbus_client: ModbusClient = modbus_client
self.neuron: Neuron = Neuron(config=config, modbus_client=modbus_client)
async def _init_tasks(self, stack: AsyncExitStack, mqtt_client: Client) -> None:
tasks: Set[Task] = set()
stack.push_async_callback(self._cancel_tasks, tasks)
await NeuronFeaturesMqttPlugin(self.neuron, mqtt_client).init_tasks(stack, tasks)
await MeterFeaturesMqttPlugin(self.neuron, mqtt_client).init_tasks(tasks)
covers = CoverMap(self.config, self.neuron.features)
covers.init()
covers_plugin = CoversMqttPlugin(mqtt_client, covers)
await covers_plugin.init_tasks(stack, tasks)
if self.config.homeassistant.enabled:
await HassCoversMqttPlugin(self.neuron, mqtt_client, covers).init_tasks(tasks)
await HassBinarySensorsMqttPlugin(self.neuron, mqtt_client).init_tasks(tasks)
await HassSensorsMqttPlugin(self.neuron, mqtt_client).init_tasks(tasks)
await HassSwitchesMqttPlugin(self.neuron, mqtt_client).init_tasks(tasks)
await asyncio.gather(*tasks)
@staticmethod
async def _cancel_tasks(tasks: Set[Task]) -> None:
try:
for task in tasks:
if task.done():
continue
task.cancel()
await task
except asyncio.CancelledError:
...
async def _modbus_connect(self) -> None:
await self.modbus_client.tcp.connect()
if self.modbus_client.tcp.connected:
UNIPI_LOGGER.info(
"%s TCP client connected to %s:%s",
LogPrefix.MODBUS,
"localhost",
502,
)
else:
exception_message_tcp: str = (
f"{LogPrefix.MODBUS} TCP client can't connect to "
f"{self.config.modbus_tcp.host}:{self.config.modbus_tcp.port}"
)
raise UnexpectedError(exception_message_tcp)
await self.modbus_client.serial.connect()
if self.modbus_client.serial.connected:
UNIPI_LOGGER.info(
"%s Serial client connected to %s",
LogPrefix.MODBUS,
self.config.modbus_serial.port,
)
else:
exception_message_serial: str = (
f"{LogPrefix.MODBUS} Serial client can't connect to {self.config.modbus_serial.port}"
)
raise UnexpectedError(exception_message_serial)
@staticmethod
async def mqtt_connect(
mqtt_config: MqttConfig,
mqtt_client_id: str,
callback: Callable[[AsyncExitStack, Client], Awaitable[None]],
) -> NoReturn:
"""Connect to MQTT broker and automatically retry on disconnect.
Parameters
----------
mqtt_config: MqttConfig
MQTT config class with hostname, port, keepalive, retry limit and reconnect interval.
mqtt_client_id: str
A unique MQTT client ID.
callback: Callback
A callback function that executed after successful MQTT connect.
"""
UNIPI_LOGGER.info("%s Client ID: %s", LogPrefix.MQTT, mqtt_client_id)
reconnect_interval: int = mqtt_config.reconnect_interval
retry_limit: Optional[int] = mqtt_config.retry_limit
retry_reconnect: int = 0
while True:
try:
UNIPI_LOGGER.info("%s Connecting to broker ...", LogPrefix.MQTT)
async with AsyncExitStack() as stack:
mqtt_client: Client = Client(
mqtt_config.host,
mqtt_config.port,
client_id=mqtt_client_id,
keepalive=mqtt_config.keepalive,
)
await stack.enter_async_context(mqtt_client)
retry_reconnect = 0
UNIPI_LOGGER.info(
"%s Connected to broker at '%s:%s'", LogPrefix.MQTT, mqtt_config.host, mqtt_config.port
)
await callback(stack, mqtt_client)
except MqttError as error:
UNIPI_LOGGER.error(
"%s Error '%s'. Connecting attempt #%s. Reconnecting in %s seconds.",
LogPrefix.MQTT,
error,
retry_reconnect + 1,
reconnect_interval,
)
finally:
if retry_limit and retry_reconnect > retry_limit:
sys.exit(1)
retry_reconnect += 1
await asyncio.sleep(reconnect_interval)
async def run(self) -> NoReturn:
"""Connect to Modbus and initialize Unipi Neuron hardware."""
await self._modbus_connect()
await self.neuron.init()
await self.mqtt_connect(
mqtt_config=self.config.mqtt,
mqtt_client_id=f"{slugify(self.config.device_info.name)}-{uuid.uuid4()}",
callback=self._init_tasks,
)
def parse_args(args: List[str]) -> argparse.Namespace:
"""Initialize argument parser options.
Parameters
----------
args: list
Arguments as list.
Returns
-------
Argparse namespace
"""
parser: argparse.ArgumentParser = init_argparse(description="Control Unipi I/O with MQTT commands")
parser.add_argument(
"-c",
"--config",
action="store",
default=DEFAULT_CONFIG_DIR,
help=f"path to the configuration (default: {DEFAULT_CONFIG_DIR})",
)
parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
return parser.parse_args(args)
def main(argv: Optional[List[str]] = None) -> None:
"""Entrypoint for Unipi Control."""
if argv is None:
argv = sys.argv[1:]
unipi_control: Optional[UnipiControl] = None
try:
args: argparse.Namespace = parse_args(argv)
config: Config = Config(config_base_dir=Path(args.config))
config.logging.init(log=args.log, verbose=args.verbose)
unipi_control = UnipiControl(
config=config,
modbus_client=ModbusClient(
tcp=AsyncModbusTcpClient(
host=config.modbus_tcp.host,
port=config.modbus_tcp.port,
timeout=0.5,
retries=3,
retry_on_empty=True,
),
serial=AsyncModbusSerialClient(
port=config.modbus_serial.port,
baudrate=config.modbus_serial.baud_rate,
parity=config.modbus_serial.parity,
timeout=1,
retries=3,
retry_on_empty=True,
),
),
)
asyncio.run(unipi_control.run())
except ConfigError as error:
UNIPI_LOGGER.critical("%s %s", LogPrefix.CONFIG, error)
sys.exit(1)
except UnexpectedError as error:
UNIPI_LOGGER.critical(error)
sys.exit(1)
except KeyboardInterrupt:
...
except asyncio.CancelledError:
...
finally:
if unipi_control:
UNIPI_LOGGER.info("Successfully shutdown the Unipi Control service.")