mirror of
https://github.com/andvikt/mega_hacs.git
synced 2025-12-12 01:24:29 +05:00
Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9fab4fce62 | ||
|
|
3c28cf4598 | ||
|
|
af2360b0a0 | ||
|
|
8f7604c9f6 | ||
|
|
f70d72bf39 | ||
|
|
896e02a457 | ||
|
|
bb95c9d312 |
8
.github/ISSUE_TEMPLATE/bug-report.md
vendored
8
.github/ISSUE_TEMPLATE/bug-report.md
vendored
@@ -24,10 +24,4 @@ megad firmware version:
|
|||||||
If applicable, add screenshots to help explain your problem.
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
**LOG**
|
**LOG**
|
||||||
Просьба прикладывать детальный лог, который можно включить в конфиге так:
|
Просьба прикладывать детальный лог, подробная инструкция как включать отладку по [ссылке](https://github.com/andvikt/mega_hacs/wiki/Отладка)
|
||||||
```yaml
|
|
||||||
logger:
|
|
||||||
default: info
|
|
||||||
logs:
|
|
||||||
custom_components.mega: debug
|
|
||||||
```
|
|
||||||
|
|||||||
@@ -57,7 +57,7 @@ async def validate_input(hass: core.HomeAssistant, data):
|
|||||||
class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
|
class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
|
||||||
"""Handle a config flow for mega."""
|
"""Handle a config flow for mega."""
|
||||||
|
|
||||||
VERSION = 5
|
VERSION = 6
|
||||||
CONNECTION_CLASS = config_entries.CONN_CLASS_ASSUMED
|
CONNECTION_CLASS = config_entries.CONN_CLASS_ASSUMED
|
||||||
|
|
||||||
async def async_step_user(self, user_input=None):
|
async def async_step_user(self, user_input=None):
|
||||||
|
|||||||
@@ -218,9 +218,9 @@ class MegaOutPort(MegaPushEntity):
|
|||||||
self._is_on = None
|
self._is_on = None
|
||||||
self.dimmer = dimmer
|
self.dimmer = dimmer
|
||||||
|
|
||||||
@property
|
# @property
|
||||||
def assumed_state(self) -> bool:
|
# def assumed_state(self) -> bool:
|
||||||
return True if self.index is not None or self.mega.mqtt is None else False
|
# return True if self.index is not None or self.mega.mqtt is None else False
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def invert(self):
|
def invert(self):
|
||||||
@@ -290,12 +290,12 @@ class MegaOutPort(MegaPushEntity):
|
|||||||
await self.mega.request(**cmd)
|
await self.mega.request(**cmd)
|
||||||
if self.index is not None:
|
if self.index is not None:
|
||||||
# обновление текущего стейта для ds2413
|
# обновление текущего стейта для ds2413
|
||||||
self.hass.async_create_task(self.mega.get_port(
|
await self.mega.get_port(
|
||||||
port=self.port,
|
port=self.port,
|
||||||
force_http=True,
|
force_http=True,
|
||||||
conv=False,
|
conv=False,
|
||||||
http_cmd='list',
|
http_cmd='list',
|
||||||
))
|
)
|
||||||
else:
|
else:
|
||||||
self.mega.values[self.port] = {'value': cmd}
|
self.mega.values[self.port] = {'value': cmd}
|
||||||
await self.get_state()
|
await self.get_state()
|
||||||
@@ -309,12 +309,12 @@ class MegaOutPort(MegaPushEntity):
|
|||||||
await self.mega.request(**cmd)
|
await self.mega.request(**cmd)
|
||||||
if self.index is not None:
|
if self.index is not None:
|
||||||
# обновление текущего стейта для ds2413
|
# обновление текущего стейта для ds2413
|
||||||
self.hass.async_create_task(self.mega.get_port(
|
await self.mega.get_port(
|
||||||
port=self.port,
|
port=self.port,
|
||||||
force_http=True,
|
force_http=True,
|
||||||
conv=False,
|
conv=False,
|
||||||
http_cmd='list',
|
http_cmd='list',
|
||||||
))
|
)
|
||||||
else:
|
else:
|
||||||
self.mega.values[self.port] = {'value': cmd}
|
self.mega.values[self.port] = {'value': cmd}
|
||||||
await self.get_state()
|
await self.get_state()
|
||||||
|
|||||||
@@ -196,15 +196,20 @@ class MegaD:
|
|||||||
Polling ports
|
Polling ports
|
||||||
"""
|
"""
|
||||||
self.lg.debug('poll')
|
self.lg.debug('poll')
|
||||||
|
ds2413_polled = []
|
||||||
for x in self.entities:
|
for x in self.entities:
|
||||||
# обновление ds2413 устройств
|
# обновление ds2413 устройств
|
||||||
if x.http_cmd == 'ds2413':
|
if x.http_cmd == 'ds2413':
|
||||||
|
self.lg.debug(f'poll ds2413 for {x.entity_id}')
|
||||||
|
if x.port in ds2413_polled:
|
||||||
|
continue
|
||||||
await self.get_port(
|
await self.get_port(
|
||||||
port=x.port,
|
port=x.port,
|
||||||
force_http=True,
|
force_http=True,
|
||||||
http_cmd='list',
|
http_cmd='list',
|
||||||
conv=False
|
conv=False
|
||||||
)
|
)
|
||||||
|
ds2413_polled.append(x.port)
|
||||||
if self.mqtt is None:
|
if self.mqtt is None:
|
||||||
await self.get_all_ports()
|
await self.get_all_ports()
|
||||||
await self.get_sensors(only_list=True)
|
await self.get_sensors(only_list=True)
|
||||||
@@ -253,7 +258,7 @@ class MegaD:
|
|||||||
if 'busy' in ret:
|
if 'busy' in ret:
|
||||||
return None
|
return None
|
||||||
if ':' in ret:
|
if ':' in ret:
|
||||||
ret = PATT_SPLIT.split(ret)
|
ret = ret.split(';')
|
||||||
ret = {'value': dict([
|
ret = {'value': dict([
|
||||||
x.split(':') for x in ret if x.count(':') == 1
|
x.split(':') for x in ret if x.count(':') == 1
|
||||||
])}
|
])}
|
||||||
@@ -455,7 +460,7 @@ class MegaD:
|
|||||||
self.lg.warning(f'can not add ds2413 on port {port}, it has wrong data: {_data}')
|
self.lg.warning(f'can not add ds2413 on port {port}, it has wrong data: {_data}')
|
||||||
continue
|
continue
|
||||||
for addr, state in data.items():
|
for addr, state in data.items():
|
||||||
ret['light'][port].append([
|
ret['light'][port].extend([
|
||||||
{"index": 0, "addr": addr, "id_suffix": f'{addr}_a', "http_cmd": 'ds2413'},
|
{"index": 0, "addr": addr, "id_suffix": f'{addr}_a', "http_cmd": 'ds2413'},
|
||||||
{"index": 1, "addr": addr, "id_suffix": f'{addr}_b', "http_cmd": 'ds2413'},
|
{"index": 1, "addr": addr, "id_suffix": f'{addr}_b', "http_cmd": 'ds2413'},
|
||||||
])
|
])
|
||||||
|
|||||||
@@ -15,5 +15,5 @@
|
|||||||
"@andvikt"
|
"@andvikt"
|
||||||
],
|
],
|
||||||
"issue_tracker": "https://github.com/andvikt/mega_hacs/issues",
|
"issue_tracker": "https://github.com/andvikt/mega_hacs/issues",
|
||||||
"version": "v0.4.1b"
|
"version": "v0.4.1b3"
|
||||||
}
|
}
|
||||||
232
readme.md
232
readme.md
@@ -10,6 +10,8 @@
|
|||||||
интеграция очень понравилась - еще приятнее, если вы воспользуетесь кнопкой доната )
|
интеграция очень понравилась - еще приятнее, если вы воспользуетесь кнопкой доната )
|
||||||
|
|
||||||
Обновление прошивки MegaD можно делать прямо из HA с помощью [аддона](https://github.com/andvikt/mega_addon.git)
|
Обновление прошивки MegaD можно делать прямо из HA с помощью [аддона](https://github.com/andvikt/mega_addon.git)
|
||||||
|
|
||||||
|
Подробная документация по [ссылке](https://github.com/andvikt/mega_hacs/wiki)
|
||||||
## Основные особенности:
|
## Основные особенности:
|
||||||
- Настройка в веб-интерфейсе + yaml
|
- Настройка в веб-интерфейсе + yaml
|
||||||
- Все порты автоматически добавляются как устройства (для обычных релейных выходов создается
|
- Все порты автоматически добавляются как устройства (для обычных релейных выходов создается
|
||||||
@@ -28,6 +30,13 @@
|
|||||||
|
|
||||||
HACS - Integrations - Explore, в поиске ищем MegaD.
|
HACS - Integrations - Explore, в поиске ищем MegaD.
|
||||||
|
|
||||||
|
Чтобы включить возможность использования бета-версий, зайдите в HACS, найдите интеграцию MegaD, нажмите три точки,
|
||||||
|
там кнопка "переустановить" или reinstall, дальше нужно нажать галку "показывать бета-версии"
|
||||||
|
|
||||||
|
Обновления выполняются так же в меню HACS.
|
||||||
|
Информация об обновлениях приходит с некоторым интервалом, чтобы вручную проверить наличие обновлений
|
||||||
|
нажмите три точки возле интеграции в меню HACS и нажмите `обновить информацию`
|
||||||
|
|
||||||
Альтернативный способ установки:
|
Альтернативный способ установки:
|
||||||
```shell
|
```shell
|
||||||
# из папки с конфигом
|
# из папки с конфигом
|
||||||
@@ -40,226 +49,7 @@ wget -q -O - https://raw.githubusercontent.com/andvikt/mega_hacs/master/install.
|
|||||||
|
|
||||||
Все имеющиеся у вас порты будут настроены автоматически. Вы можете менять названия, иконки и entity_id так же из интерфейса.
|
Все имеющиеся у вас порты будут настроены автоматически. Вы можете менять названия, иконки и entity_id так же из интерфейса.
|
||||||
|
|
||||||
#### Кастомизация устройств с помощью yaml:
|
|
||||||
```yaml
|
|
||||||
# configuration.yaml
|
|
||||||
|
|
||||||
mega:
|
|
||||||
hello: # ID меги, как в UI
|
|
||||||
7: # номер порта
|
|
||||||
domain: switch # тип устройства (switch или light, по умолчанию для цифровых выходов используется light)
|
|
||||||
invert: true # инвертировать или нет (по умолчанию false)
|
|
||||||
name: Насос # имя устройства
|
|
||||||
8:
|
|
||||||
# исключить из сканирования
|
|
||||||
skip: true
|
|
||||||
10:
|
|
||||||
skip: false # если нужен skip, то он работает только целиком для всего порта
|
|
||||||
# в случае если порт настроен как ds2413
|
|
||||||
address_a: #address - это адрес ds2413
|
|
||||||
# здесь внутри работают все стандартные поля конфигурирования порта
|
|
||||||
invert: true
|
|
||||||
domain: switch
|
|
||||||
c6c439000000_b:
|
|
||||||
name: какое-то имя
|
|
||||||
33:
|
|
||||||
# для датчиков можно кастомизировать только имя и unit_of_measurement
|
|
||||||
# для температуры и влажность unit определяется автоматически, для остальных юнита нет
|
|
||||||
name:
|
|
||||||
hum: "влажность"
|
|
||||||
temp: "температура"
|
|
||||||
unit_of_measurement:
|
|
||||||
hum: "%" # если датчиков несколько, то можно указывать юниты по их ключам
|
|
||||||
temp: "°C"
|
|
||||||
# можно так же указать шаблон для конвертации значения, может быть полезно для ацп-входа
|
|
||||||
# текущее значение порта передается в шаблон в переменной "value"
|
|
||||||
conv_template: "{{(value|float)/100}}"
|
|
||||||
14:
|
|
||||||
name: какой-то датчик
|
|
||||||
unit_of_measurement: "°C" # если датчик один, то просто строчкой
|
|
||||||
```
|
|
||||||
|
|
||||||
## Зависимости
|
## Зависимости
|
||||||
Для совместимости c mqtt необходимо настроить интеграцию [mqtt](https://www.home-assistant.io/integrations/mqtt/)
|
Для совместимости c mqtt необходимо настроить интеграцию [mqtt](https://www.home-assistant.io/integrations/mqtt/)
|
||||||
в HomeAssistant, а так же обновить ваш контроллер до последней версии, тк были важные обновления в части mqtt
|
в HomeAssistant, а так же обновить ваш контроллер до последней версии, обновление прошивки MegaD можно делать прямо
|
||||||
|
из HA с помощью [аддона](https://github.com/andvikt/mega_addon.git)
|
||||||
## HTTP in
|
|
||||||
Начиная с версии `0.3.1` интеграция стала поддерживать обратную связь без mqtt, используя http-сервер. Для этого в настройках
|
|
||||||
интеграции необходимо снять галку с `использовать mqtt`
|
|
||||||
|
|
||||||
**Внимание!** Не используйте srv loop на контроллере, это может приводить к ложным срабатываниям входов. Вместо srv loop
|
|
||||||
интеграция будет сама обновлять все состояния портов с заданным интервалом
|
|
||||||
|
|
||||||
В самой меге необходимо прописать настройки:
|
|
||||||
```yaml
|
|
||||||
srv: "192.168.1.4:8123" # ip:port вашего HA
|
|
||||||
script: "mega" # это api интеграции, к которому будет обращаться контроллер
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Ответ на входящие события от контроллера
|
|
||||||
Контроллер ожидает ответ от сервера, который может быть сценарием (по умолчанию интеграция отвечает `d`, что означает
|
|
||||||
запустить то что прописано в поле act в настройках порта).
|
|
||||||
|
|
||||||
Поддерживаются шаблоны HA. Это может быть использовано, например, для запоминания яркости (тк сам контроллер этого не
|
|
||||||
умеет). В шаблоне можно использовать параметры, которые передает контроллер (m, click, pt, mdid, mega_id)
|
|
||||||
|
|
||||||
Примеры:
|
|
||||||
```yaml
|
|
||||||
mega:
|
|
||||||
mega1: # id меги, который вы сами придумываете в конфиге в UI
|
|
||||||
4: # номер порта, с которого ожидаются события
|
|
||||||
response_template: "5:2" # простейший пример без шаблона. Каждый раз когда будет приходить сообщение на этот порт,
|
|
||||||
# будем менять состояние на противоположное
|
|
||||||
5:
|
|
||||||
# пример с использованием шаблона, порт 1 будет выключен если он сейчас включен и включен с последней сохраненной
|
|
||||||
# яркостью если он сейчас выключен
|
|
||||||
response_template: >-
|
|
||||||
{% if is_state('light.some_port_1', 'on') %}
|
|
||||||
1:0
|
|
||||||
{% else %}
|
|
||||||
1:{{state_attr('light.some_port_1', 'brightness')}}
|
|
||||||
{% endif %}
|
|
||||||
6:
|
|
||||||
# в шаблон так же передаются все параметры, которые передает контроллер (pt, cnt, m, click)
|
|
||||||
# эти параметры можно использовать в условиях или непосредственно в шаблоне в виде {{pt}}
|
|
||||||
response_template: >-
|
|
||||||
{% if m==2 %}1:0{% else %}d{% endif %}
|
|
||||||
```
|
|
||||||
|
|
||||||
Начиная с версии v0.3.17 ответ можно слать так же и в режиме MQTT. Аналогично, темплейт должен возвращать готовую команду
|
|
||||||
такую же как требует команда cmd, так же можно использовать d, но d не отправляется по умолчанию, это сделано чтобы не
|
|
||||||
сломать текущую логику у пользователей предыдущих версий. Чтобы включить для всех входов в режиме mqtt отправку команды
|
|
||||||
d необходимо в конфиге прописать следующее:
|
|
||||||
```yaml
|
|
||||||
mega:
|
|
||||||
mega1:
|
|
||||||
force_d: true
|
|
||||||
```
|
|
||||||
**Внимание!** Нельзя использовать чекбокс напротив поля act если планируется использовать ответ сервера - у вас и
|
|
||||||
сработает act и команда от сервера, а вслучае ответа d сработает act два раза.
|
|
||||||
|
|
||||||
Так же следует понимать, что это не "ответ" в нормальном понимании - это вызов следом за полученным mqtt-сообщением
|
|
||||||
http команды такого вида `http://megaurl/?pt=port&cmd=rendered_template`, где `port` - это номер порта сработавшего входа,
|
|
||||||
а `cmd` - текст команды, который получен из темплейта. Те это имитация ответа. У этого подхода есть минус - задержка в
|
|
||||||
исполнении будет значительно выше чем при ответе в режиме http, но тем не менее эта задержка скорее всего не будет
|
|
||||||
сильно заметна.
|
|
||||||
|
|
||||||
## binary_sensor и события
|
|
||||||
|
|
||||||
Входы будут доступны как binary_sensor, а так же в виде событий `mega.sensor` и `mega.binary`.
|
|
||||||
Для корректной работы binary_sensor имеет смысл использовать режим P&R, для остальных режимов - лучше пользоваться
|
|
||||||
событиями.
|
|
||||||
|
|
||||||
События можно использовать в автоматизациях, например так:
|
|
||||||
```yaml
|
|
||||||
# Пример события с полями как есть прямо из меги
|
|
||||||
- alias: some double click
|
|
||||||
trigger:
|
|
||||||
- platform: event
|
|
||||||
event_type: mega.sensor
|
|
||||||
event_data:
|
|
||||||
pt: 1
|
|
||||||
click: 2
|
|
||||||
action:
|
|
||||||
- service: light.toggle
|
|
||||||
entity_id: light.some_light
|
|
||||||
```
|
|
||||||
События могут содержать следующие поля:
|
|
||||||
- `mega_id`: id как в конфиге HA
|
|
||||||
- `pt`: номер порта
|
|
||||||
- `cnt`: счетчик срабатываний
|
|
||||||
- `mdid`: if как в конфиге контроллера
|
|
||||||
- `click`: клик (подробнее в документации меги)
|
|
||||||
- `value`: текущее значение (только для mqtt)
|
|
||||||
- `port`: номер порта
|
|
||||||
|
|
||||||
Начиная с версии 0.3.7 появилось так же событие типа `mega.binary`:
|
|
||||||
```yaml
|
|
||||||
# Пример события с полями как есть прямо из меги
|
|
||||||
- alias: some long click
|
|
||||||
trigger:
|
|
||||||
- platform: event
|
|
||||||
event_type: mega.binary
|
|
||||||
event_data:
|
|
||||||
entity_id: binary_sensor.some_id
|
|
||||||
type: long
|
|
||||||
action:
|
|
||||||
- service: light.toggle
|
|
||||||
entity_id: light.some_light
|
|
||||||
```
|
|
||||||
Возможные варианты поля `type`:
|
|
||||||
- `long`: долгое нажатие
|
|
||||||
- `release`: размыкание (с гарантией** что не было долгого нажатия)
|
|
||||||
- `long_release`: размыкание после долгого нажатия
|
|
||||||
- `press`: замыкание
|
|
||||||
- `single`: одинарный клик (в режиме кликов)
|
|
||||||
- `double`: двойной клик
|
|
||||||
|
|
||||||
**гарантия есть только при использовании http-метода синхронизации, mqtt не гарантирует порядок доставки сообщений, хотя
|
|
||||||
маловероятно, что порядок будет нарушен, но все же сам протокол не дает таких гарантий.
|
|
||||||
|
|
||||||
Чтобы понять, какие события происходят, лучше всего воспользоваться панелью разработчика и подписаться
|
|
||||||
на вкладке события на событие `mega.sensor`, понажимать кнопки.
|
|
||||||
|
|
||||||
## Сервисы
|
|
||||||
Все сервисы доступны в меню разработчика с описанием и примерами использования
|
|
||||||
```yaml
|
|
||||||
mega.save:
|
|
||||||
description: Сохраняет текущее состояние портов (?cmd=s)
|
|
||||||
fields:
|
|
||||||
mega_id:
|
|
||||||
description: ID меги, можно оставить пустым, тогда будут сохранены все зарегистрированные меги
|
|
||||||
example: "mega"
|
|
||||||
|
|
||||||
mega.get_port:
|
|
||||||
description: Запросить текущий статус порта (или всех)
|
|
||||||
fields:
|
|
||||||
mega_id:
|
|
||||||
description: ID меги, можно оставить пустым, тогда будут порты всех зарегистрированных мег
|
|
||||||
example: "mega"
|
|
||||||
port:
|
|
||||||
description: Номер порта (если не заполнять, будут запрошены все порты сразу)
|
|
||||||
example: 1
|
|
||||||
|
|
||||||
mega.run_cmd:
|
|
||||||
description: Выполнить любую произвольную команду
|
|
||||||
fields:
|
|
||||||
mega_id:
|
|
||||||
description: ID меги
|
|
||||||
example: "mega"
|
|
||||||
port:
|
|
||||||
description: Номер порта (это не порт, которым мы управляем, а порт с которого шлем команду)
|
|
||||||
example: 1
|
|
||||||
cmd:
|
|
||||||
description: Любая поддерживаемая мегой команда
|
|
||||||
example: "1:0"
|
|
||||||
```
|
|
||||||
|
|
||||||
## Отладка
|
|
||||||
Интеграция находится в активной разработке, при возникновении проблем [заводите issue](https://github.com/andvikt/mega_hacs/issues/new/choose)
|
|
||||||
|
|
||||||
Просьба прикладывать детальный лог, который можно включить в конфиге так:
|
|
||||||
```yaml
|
|
||||||
logger:
|
|
||||||
default: info
|
|
||||||
logs:
|
|
||||||
custom_components.mega: debug
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Отладка ответов http-сервера
|
|
||||||
Для отладки ответов сервера можно самим имитировать запросы контроллера, если у вас есть доступ к консоли
|
|
||||||
HA:
|
|
||||||
```shell
|
|
||||||
curl -v -X GET 'http://localhost:8123/mega?pt=5&m=1'
|
|
||||||
```
|
|
||||||
Если доступа нет, нужно в файл конфигурации добавить ip, с которого вы хотите делать запросы, например:
|
|
||||||
```yaml
|
|
||||||
mega:
|
|
||||||
allow_hosts:
|
|
||||||
- 192.168.1.1
|
|
||||||
```
|
|
||||||
И тогда можно с локальной машины делать запросы на ваш сервер HA:
|
|
||||||
```shell
|
|
||||||
curl -v -X GET 'http://192.168.88.1.4:8123/mega?pt=5&m=1'
|
|
||||||
```
|
|
||||||
В ответ будет приходить либо `d`, либо скрипт, который вы настроили
|
|
||||||
|
|||||||
Reference in New Issue
Block a user