edit readme

custom_components/mega/__init__.py

@@ -1,13 +1,11 @@
 """The mega integration."""
 import asyncio
 import logging
-import typing
 from functools import partial
 
 import voluptuous as vol
-from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_PLATFORM, CONF_SCAN_INTERVAL, CONF_ID
-from homeassistant.core import HomeAssistant
-from homeassistant.helpers.entity_component import EntityComponent
+from homeassistant.const import CONF_HOST, CONF_PASSWORD, CONF_SCAN_INTERVAL, CONF_ID
+from homeassistant.core import HomeAssistant, ServiceCall
 from homeassistant.helpers.service import bind_hass
 from homeassistant.components import mqtt
 from homeassistant.config_entries import ConfigEntry
@@ -52,18 +50,18 @@ async def async_setup(hass: HomeAssistant, config: dict):
     conf = config.get(DOMAIN)
     hass.data[DOMAIN] = {}
     hass.services.async_register(
-        DOMAIN, 'save', _save_service, schema=vol.Schema({
+        DOMAIN, 'save', partial(_save_service, hass), schema=vol.Schema({
             vol.Optional('mega_id'): str
         })
     )
     hass.services.async_register(
-        DOMAIN, 'get_port', _get_port, schema=vol.Schema({
+        DOMAIN, 'get_port', partial(_get_port, hass), schema=vol.Schema({
             vol.Optional('mega_id'): str,
             vol.Optional('port'): int,
         })
     )
     hass.services.async_register(
-        DOMAIN, 'run_cmd', _run_cmd, schema=vol.Schema({
+        DOMAIN, 'run_cmd', partial(_run_cmd, hass), schema=vol.Schema({
             vol.Required('port'): int,
             vol.Required('cmd'): str,
             vol.Optional('mega_id'): str,
@@ -74,9 +72,10 @@ async def async_setup(hass: HomeAssistant, config: dict):
     if CONF_HOST in conf:
         conf = {DEF_ID: conf}
     for id, data in conf.items():
+        _LOGGER.warning('YAML configuration is deprecated, please use web-interface')
         await _add_mega(hass, id, data)
 
-    for id, hub in hass.data[DOMAIN].__items__():
+    for id, hub in hass.data[DOMAIN].items():
         _POLL_TASKS[id] = asyncio.create_task(hub.poll())
     return True
 
@@ -131,10 +130,11 @@ async def async_remove_entry(hass, entry) -> None:
     _hubs.pop(entry.entry_id)
     unsub = _subs.pop(entry.entry_id)
     unsub()
+    hass.data[DOMAIN].pop(id)
 
 
-@bind_hass
-async def _save_service(hass: HomeAssistant, mega_id=None):
+async def _save_service(hass: HomeAssistant, call: ServiceCall):
+    mega_id = call.data.get('mega_id')
     if mega_id:
         hub: MegaD = hass.data[DOMAIN][mega_id]
         await hub.save()
@@ -144,7 +144,9 @@ async def _save_service(hass: HomeAssistant, mega_id=None):
 
 
 @bind_hass
-async def _get_port(hass: HomeAssistant, port=None, mega_id=None):
+async def _get_port(hass: HomeAssistant, call: ServiceCall):
+    port = call.data.get('port')
+    mega_id = call.data.get('mega_id')
     if mega_id:
         hub: MegaD = hass.data[DOMAIN][mega_id]
         if port is None:
@@ -158,8 +160,12 @@ async def _get_port(hass: HomeAssistant, port=None, mega_id=None):
             else:
                 await hub.get_port(port)
 
+
 @bind_hass
-async def _run_cmd(hass: HomeAssistant, port: int, cmd: str, mega_id=None):
+async def _run_cmd(hass: HomeAssistant, call: ServiceCall):
+    port = call.data.get('port')
+    mega_id = call.data.get('mega_id')
+    cmd = call.data.get('cmd')
     if mega_id:
         hub: MegaD = hass.data[DOMAIN][mega_id]
         await hub.send_command(port=port, cmd=cmd)

custom_components/mega/binary_sensor.py

@@ -1,7 +1,6 @@
 """Platform for light integration."""
-import asyncio
-import json
 import logging
+import asyncio
 
 import voluptuous as vol
 
@@ -18,7 +17,6 @@ from homeassistant.const import (
     CONF_ID
 )
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.restore_state import RestoreEntity
 from .entities import BaseMegaEntity
 
 from .hub import MegaD
@@ -63,12 +61,16 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, asyn
     mid = config_entry.data[CONF_ID]
     hub: MegaD = hass.data['mega'][mid]
     devices = []
-    async for port, pty, m in hub.scan_ports():
-        if pty == "0":
-            sensor = MegaBinarySensor(mega_id=mid, port=port)
-            devices.append(sensor)
 
-    async_add_devices(devices)
+    async def scan():
+        async for port, pty, m in hub.scan_ports():
+            if pty == "0":
+                sensor = MegaBinarySensor(mega_id=mid, port=port, config_entry=config_entry)
+                devices.append(sensor)
+
+        async_add_devices(devices)
+
+    asyncio.create_task(scan())
 
 
 class MegaBinarySensor(BinarySensorEntity, BaseMegaEntity):

custom_components/mega/config_flow.py

@@ -9,7 +9,7 @@ from homeassistant.components import mqtt
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_HOST, CONF_ID, CONF_PASSWORD, CONF_SCAN_INTERVAL
 from homeassistant.core import callback
-from .const import DOMAIN, CONF_PORT_TO_SCAN, CONF_RELOAD, CONF_INVERT  # pylint:disable=unused-import
+from .const import DOMAIN, CONF_PORT_TO_SCAN, CONF_RELOAD  # pylint:disable=unused-import
 from .hub import MegaD
 from . import exceptions
 
@@ -103,7 +103,7 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
             data_schema=vol.Schema({
                 vol.Optional(CONF_SCAN_INTERVAL, default=e[CONF_SCAN_INTERVAL]): int,
                 vol.Optional(CONF_PORT_TO_SCAN, default=e.get(CONF_PORT_TO_SCAN, 0)): int,
-                vol.Optional(CONF_RELOAD, default=False): bool,
+                # vol.Optional(CONF_RELOAD, default=False): bool,
                 # vol.Optional(CONF_INVERT, default=''): str,
             }),
         )

custom_components/mega/entities.py

@@ -3,6 +3,7 @@ import asyncio
 import json
 import logging
 
+from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import State
 from .hub import MegaD
 from homeassistant.helpers.restore_state import RestoreEntity
@@ -19,12 +20,14 @@ class BaseMegaEntity(RestoreEntity):
             self,
             mega_id: str,
             port: int,
+            config_entry: ConfigEntry = None,
             id_suffix=None,
             name=None,
-            unique_id=None
+            unique_id=None,
     ):
         self._state: State = None
         self.port = port
+        self.config_entry = config_entry
         self._mega_id = mega_id
         self._lg = None
         self._unique_id = unique_id or f"mega_{mega_id}_{port}" + \
@@ -32,6 +35,23 @@ class BaseMegaEntity(RestoreEntity):
         self._name = name or f"{mega_id}_{port}" + \
                             (f"_{id_suffix}" if id_suffix else "")
 
+    @property
+    def device_info(self):
+        return {
+            "identifiers": {
+                # Serial numbers are unique identifiers within a specific domain
+                (DOMAIN, f'{self._mega_id}', self.port),
+            },
+            "config_entries": [
+                self.config_entry,
+            ],
+            "name": f'port {self.port}',
+            "manufacturer": 'ab-log.ru',
+            # "model": self.light.productname,
+            # "sw_version": self.light.swversion,
+            "via_device": (DOMAIN, self._mega_id),
+        }
+
     @property
     def lg(self) -> logging.Logger:
         if self._lg is None:

custom_components/mega/hub.py

@@ -140,36 +140,47 @@ class MegaD:
     async def save(self):
         await self.send_command(cmd='s')
 
-    async def get_port(self, port, get_value=False):
-        if get_value:
-            ftr = asyncio.get_event_loop().create_future()
+    async def get_port(self, port):
+        """
+        Опрашивает порт с помощью mqtt. Ждет ответ, возвращает ответ.
 
-            def cb(msg):
-                try:
-                    ftr.set_result(json.loads(msg.payload).get('value'))
-                except Exception as exc:
-                    self.lg.warning(f'could not parse {msg.payload}: {exc}')
-                    ftr.set_result(None)
+        :param port:
+        :return:
+        """
+        ftr = asyncio.get_event_loop().create_future()
+
+        def cb(msg):
+
+            try:
+                if '"value":NA' in msg.payload.decode():
+                    if not ftr.done():
+                        ftr.set_result(None)
+                    return
+                ret = json.loads(msg.payload).get('value')
+                if not ftr.done():
+                    ftr.set_result(ret)
+            except Exception as exc:
+                ret = None
+                self.lg.exception(f'while parsing response from port {port}: {msg.payload}')
+                ftr.set_result(None)
+
+            self.lg.debug(
+                f'port: %s response: %s', port, ret
+            )
+
+        async with self.lck:
             unsub = await self.mqtt.async_subscribe(
                 topic=f'{self.mqtt_id}/{port}',
                 msg_callback=cb,
                 qos=1,
             )
-
-        self.lg.debug(
-            f'get port: %s', port
-        )
-        async with self.lck:
-            await self.mqtt.async_publish(
-                topic=f'{self.mqtt_id}/cmd',
-                payload=f'get:{port}',
-                qos=0,
-                retain=False,
-            )
-            await asyncio.sleep(0.1)
-
-        if get_value:
             try:
+                await self.mqtt.async_publish(
+                    topic=f'{self.mqtt_id}/cmd',
+                    payload=f'get:{port}',
+                    qos=1,
+                    retain=False,
+                )
                 return await asyncio.wait_for(ftr, timeout=2)
             except asyncio.TimeoutError:
                 self.lg.warning(f'timeout on port {port}')
@@ -227,36 +238,37 @@ class MegaD:
             return await req.text()
 
     async def scan_port(self, port):
-        if port in self._scanned:
-            return self._scanned[port]
-        url = f'http://{self.host}/{self.sec}/?pt={port}'
-        self.lg.debug(
-            f'scan port %s: %s', port, url
-        )
-        async with aiohttp.request('get', url) as req:
-            html = await req.text()
-        tree = BeautifulSoup(html, features="lxml")
-        pty = tree.find('select', attrs={'name': 'pty'})
-        if pty is None:
-            return
-        else:
-            pty = pty.find(selected=True)
-            if pty:
-                pty = pty['value']
-            else:
+        async with self.lck:
+            if port in self._scanned:
+                return self._scanned[port]
+            url = f'http://{self.host}/{self.sec}/?pt={port}'
+            self.lg.debug(
+                f'scan port %s: %s', port, url
+            )
+            async with aiohttp.request('get', url) as req:
+                html = await req.text()
+            tree = BeautifulSoup(html, features="lxml")
+            pty = tree.find('select', attrs={'name': 'pty'})
+            if pty is None:
                 return
-        if pty in ['0', '1']:
-            m = tree.find('select', attrs={'name': 'm'})
-            if m:
-                m = m.find(selected=True)['value']
-            self._scanned[port] = (pty, m)
-            return pty, m
-        elif pty == '3':
-            m = tree.find('select', attrs={'name': 'd'})
-            if m:
-                m = m.find(selected=True)['value']
-            self._scanned[port] = (pty, m)
-            return pty, m
+            else:
+                pty = pty.find(selected=True)
+                if pty:
+                    pty = pty['value']
+                else:
+                    return
+            if pty in ['0', '1']:
+                m = tree.find('select', attrs={'name': 'm'})
+                if m:
+                    m = m.find(selected=True)['value']
+                self._scanned[port] = (pty, m)
+                return pty, m
+            elif pty == '3':
+                m = tree.find('select', attrs={'name': 'd'})
+                if m:
+                    m = m.find(selected=True)['value']
+                self._scanned[port] = (pty, m)
+                return pty, m
 
     async def scan_ports(self,):
         for x in range(38):

custom_components/mega/light.py

@@ -1,8 +1,6 @@
 """Platform for light integration."""
-import asyncio
-import json
 import logging
-
+import asyncio
 import voluptuous as vol
 
 from homeassistant.components.light import (
@@ -19,7 +17,6 @@ from homeassistant.const import (
     CONF_ID
 )
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.restore_state import RestoreEntity
 from .entities import BaseMegaEntity
 
 from .hub import MegaD
@@ -80,11 +77,15 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, asyn
     mid = config_entry.data[CONF_ID]
     hub: MegaD = hass.data['mega'][mid]
     devices = []
-    async for port, pty, m in hub.scan_ports():
-        if pty == "1" and m in ['0', '1']:
-            light = MegaLight(mega_id=mid, port=port, dimmer=m == '1')
-            devices.append(light)
-    async_add_devices(devices)
+
+    async def scan_ports():
+        async for port, pty, m in hub.scan_ports():
+            if pty == "1" and m in ['0', '1']:
+                light = MegaLight(mega_id=mid, port=port, dimmer=m == '1', config_entry=config_entry)
+                devices.append(light)
+        async_add_devices(devices)
+
+    asyncio.create_task(scan_ports())
 
 
 class MegaLight(LightEntity, BaseMegaEntity):

custom_components/mega/sensor.py

@@ -1,7 +1,6 @@
 """Platform for light integration."""
+import asyncio
 import logging
-
-import typing
 import voluptuous as vol
 
 from homeassistant.components.sensor import (
@@ -70,7 +69,7 @@ async def async_setup_platform(hass, config, add_entities, discovery_info=None):
     return True
 
 
-def _make_entity(mid: str, port: int, conf: dict):
+def _make_entity(config_entry, mid: str, port: int, conf: dict):
     key = conf[CONF_KEY]
     return Mega1WSensor(
         key=key,
@@ -79,7 +78,8 @@ def _make_entity(mid: str, port: int, conf: dict):
         patt=PATTERNS.get(key),
         unit_of_measurement=UNITS.get(key, UNITS[TEMP]),  # TODO: make other units, make options in config flow
         device_class=CLASSES.get(key, CLASSES[TEMP]),
-        id_suffix=key
+        id_suffix=key,
+        config_entry=config_entry
     )
 
 
@@ -87,29 +87,35 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, asyn
     mid = config_entry.data[CONF_ID]
     hub: MegaD = hass.data['mega'][mid]
     devices = []
-    async for port, pty, m in hub.scan_ports():
-        if pty == "3":
-            values = await hub.get_port(port, get_value=True)
-            lg.debug(f'values: %s', values)
-            if values is None:
-                continue
-            if isinstance(values, str) and TEMP_PATT.search(values):
-                    values = {TEMP: values}
-            elif not isinstance(values, dict):
-                values = {None: values}
-            for key in values:
-                hub.lg.debug(f'add sensor {W1}:{key}')
-                sensor = _make_entity(
-                    mid=mid,
-                    port=port,
-                    conf={
-                        CONF_TYPE: W1,
-                        CONF_KEY: key,
-                    })
-                devices.append(sensor)
-                hub.sensors.append(sensor)
 
-    async_add_devices(devices)
+    async def scan():
+        async for port, pty, m in hub.scan_ports():
+            if pty == "3":
+                values = await hub.get_port(port)
+                lg.debug(f'values: %s', values)
+                if values is None:
+                    continue
+                if isinstance(values, str) and TEMP_PATT.search(values):
+                    values = {TEMP: values}
+                elif not isinstance(values, dict):
+                    values = {None: values}
+                for key in values:
+                    hub.lg.debug(f'add sensor {W1}:{key}')
+                    sensor = _make_entity(
+                        mid=mid,
+                        port=port,
+                        conf={
+                            CONF_TYPE: W1,
+                            CONF_KEY: key,
+                        },
+                        config_entry=config_entry,
+                    )
+                    devices.append(sensor)
+                    hub.sensors.append(sensor)
+
+        async_add_devices(devices)
+
+    asyncio.create_task(scan())
 
 
 class Mega1WSensor(BaseMegaEntity):

custom_components/mega/switch.py

@@ -1,5 +1,4 @@
 """Platform for light integration."""
-import json
 import logging
 
 import voluptuous as vol
@@ -13,11 +12,7 @@ from homeassistant.const import (
     CONF_PLATFORM,
     CONF_PORT,
 )
-from homeassistant.core import HomeAssistant
-from homeassistant.helpers.restore_state import RestoreEntity
 from .entities import BaseMegaEntity
-
-from .hub import MegaD
 from .const import CONF_DIMMER, CONF_SWITCH
 
 _LOGGER = logging.getLogger(__name__)

readme.md

@@ -1,111 +1,68 @@
-# MegaD HomeAssistant custom component
+# MegaD HomeAssistant integration
 
 Интеграция с [MegaD-2561](https://www.ab-log.ru/smart-house/ethernet/megad-2561)
 
 ## Основные особенности:
-- Настройка как из yaml так и из веб-интерфейса
-- При настройки из веба все порты автоматически добавляются как устройства (для обычных релейных выходов создается 
-  `light`, для шим - `light` с поддержкой яркости, для цифровых входов `binary_sensor`, для температурных датчиков
+- Настройка в веб-интерфейсе
+- Все порты автоматически добавляются как устройства (для обычных релейных выходов создается 
+  `light`, для шим - `light` с поддержкой яркости, для цифровых входов `binary_sensor`, для датчиков
   `sensor`)
 - Возможность работы с несколькими megad
 - Обратная связь по mqtt
-- Команды выполняются друг за другом без конкурентного доступа к ресурсам megad
-## Устройства
-Поддерживаются устройства: light, switch, binary_sensor, sensor. light может работать как диммер
+- Команды выполняются друг за другом без конкурентного доступа к ресурсам megad, это дает гарантии надежного исполнения
+  большого кол-ва команд (например в сценах). Каждая следующая команда отправляется только после получения ответа о
+  выполнении предыдущей.
+
+## Зависимости
+**Важно!!** Перед использованием необходимо настроить интеграцию mqtt в HomeAssistant
+
+Для максимальной совместимости необходимо обновить ваш контроллер до последней версии, тк были важные обновления в части
+mqtt
+
 ## Установка
-Рекомендованнй способ - через [HACS](https://hacs.xyz/docs/installation/installation).
-После установки HACS, нужно перейти в меню hacs -> integrations, далее в верхнем правом углу
-нажать три точки, где будет `Custom repositories`, открыть, нажать add и добавить `https://github.com/andvikt/mega_hacs.git`
+Рекомендованный способ с поддержкой обновлений - [HACS](https://hacs.xyz/docs/installation/installation):
+
+HACS - Integrations - Explore, в поиске ищем MegaD. 
 
 Альтернативный способ установки:
 ```shell
 # из папки с конфигом
 wget -q -O - https://raw.githubusercontent.com/andvikt/mega_hacs/master/install.sh | bash -
 ```
-Перезагрузить HA
+Не забываем перезагрузить HA
 
-Для обновления повторить
-## Зависимости
-Перед использованием необходимо настроить интеграцию mqtt в HomeAssistant
-
-## Настройка из веб-интерфейса
+## Настройка
 `Настройки` -> `Интеграции` -> `Добавить интеграцию` в поиске ищем mega
 
-## Пример настройки с помощью yaml:
-```yaml
-mega: 
-  mega1:
-    host: 192.168.0.14
-    name: hello
-    password: sec
-    mqtt_id: mega # это id в конфиге меги
+Все имеющиеся у вас порты будут настроены автоматически.
 
-light:
-  - platform: mega
-    mega1:
-      switch:
-        - 1 # можно просто перечислить порты
-        - 2
-        - 3
-      dimmer:
-        - port: 7
-          name: hello # можно использовать расширенный вариант с названиями
-        - 9
-        - 10
-
-binary_sensor:
-  - platform: mega
-    mega1:
-      - port: 16
-        name: sensor1
-      - port: 18
-        name: sensor2
-
-sensor:
-  - platform: mega
-    mega1:
-      - port: 10
-        name: some temp
-        type: w1
-        key: temp
-      - port: 10
-        name: some hum
-        type: w1
-        key: hum
-
-switch:
-  - platform: mega
-    mega1:
-      - 11
-
-```
+Вы можете менять названия, иконки и entity_id так же из интерфейса.
 
 ## Сервисы
+Все сервисы доступны в меню разработчика с описанием и примерами использования
 ```yaml
-save:
+mega.save:
   description: Сохраняет текущее состояние портов (?cmd=s)
   fields:
-
     mega_id:
       description: ID меги, можно оставить пустым, тогда будут сохранены все зарегистрированные меги
       example: "mega"
 
-get_port:
+mega.get_port:
   description: Запросить текущий статус порта (или всех)
   fields:
     mega_id:
-      description: ID меги, можно оставить пустым, тогда будут сохранены все зарегистрированные меги
+      description: ID меги, можно оставить пустым, тогда будут порты всех зарегистрированных мег
       example: "mega"
     port:
       description: Номер порта (если не заполнять, будут запрошены все порты сразу)
       example: 1
 
-run_cmd:
+mega.run_cmd:
   description: Выполнить любую произвольную команду
   fields:
-
     mega_id:
-      description: ID меги, можно оставить пустым, тогда будут сохранены все зарегистрированные меги
+      description: ID меги
       example: "mega"
     port:
       description: Номер порта (это не порт, которым мы управляем, а порт с которого шлем команду)
@@ -113,18 +70,15 @@ run_cmd:
     cmd:
       description: Любая поддерживаемая мегой команда
       example: "1:0"
-
 ```
 
-## Состояния
-Так же каждое устройство megad опрашивается на предмет работоспособности, текущий статус
-хранится в mega.<id>
-
 ## Отладка
-Если возникают проблемы, можно включить детальный лог, для этого в конфиг добавить:
+Интеграция находится в активной разработке, при возникновении проблем [заводите issue](https://github.com/andvikt/mega_hacs/issues/new/choose)
+
+Просьба прикладывать детальный лог, который можно включить в конфиге так:
 ```yaml
 logger:
   default: info
   logs:
     custom_components.mega: debug
-```
+```