Imported-Repos/yandex2mqtt
1
0
Fork 0
mirror of https://github.com/lasthead0/yandex2mqtt.git synced 2025-08-07 08:40:29 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add logging and some code improvement

Browse Source
This commit is contained in:
Evgenii Abramov
2021-05-17 00:22:39 +03:00
parent 6c07dd726d
commit f375a0b755
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -4,7 +4,7 @@
Форк [Проекта](https://github.com/munrexio/yandex2mqtt) и [Статья на Хабре](https://habr.com/ru/post/465537/) к оригиналу.
## Важно
Те, кто пользуется оригинальным проектом (или его форками), обратите внимание на то, что немного изменились настройки устройств (блок **devices** в файле конфигурации).
Те, кто пользуется оригинальным проектом (или его форками), обратите внимание на то, что немного изменились настройки устройств (блок `devices` в файле конфигурации).
На данный момент проверено получение температуры и влажности с датчиков (датчики дверей и движения пока в бета-тесте), и включение/выключение света (вкл./выкл. других устройств по аналогии тоже должно работать).
@@ -23,7 +23,7 @@
###### Release
Проведён рефакторинг кода и, местами, внесены значительные правки.
Добавлена поддержка датчиков (устройств **devices.types.sensor**)
Добавлена поддержка датчиков (устройств `devices.types.sensor`)
## Требования
- **"Белый" IP адрес и домен**. Если нет своего домена и белого IP адреса можно воспользоваться Dynamic DNS сервисами (например, noip.com).
@@ -305,7 +305,7 @@ notification: [
Если к yandex2mqtt "подключено" несколько навыков УД, то в массиве необходимо указать настройки для каждого навыка УД, который должен получать уведомления.
skill_id (идентификатор вызываемого навыка, присвоенный при создании) и oauth_token (авторизационный токен владельца навыка) можно узнать из документации на [Уведомление об изменении состояний устройств](https://yandex.ru/dev/dialogs/smart-home/doc/reference-alerts/post-skill_id-callback-state.html), а user_id - id пользователя в файле конфигурации yandex2mqtt.
`skill_id` (идентификатор вызываемого навыка, присвоенный при создании) и `oauth_token` (авторизационный токен владельца навыка) можно узнать из документации на [Уведомление об изменении состояний устройств](https://yandex.ru/dev/dialogs/smart-home/doc/reference-alerts/post-skill_id-callback-state.html), а `user_id` - id пользователя в файле конфигурации yandex2mqtt.
*Важно. Уведомления будут отправляться при изменнии mqtt топика хранящего состояние устройства. Соответственно, если для устройства не задан топик state, то уведомление для устройтва отправляться не будет.*
@@ -313,10 +313,10 @@ skill_id (идентификатор вызываемого навыка, при
#### Разрешенные пользователи для устройств (allowedUsers)
В блоке конфигурации можно указать пользователей (id пользователей), для которых будет доступно устройство.
В опции allowedUsers указыватся массив (строковых значений) id. Если данная опция не указана, то для неё будет назначено значение ['1'];
В опции `allowedUsers` указыватся массив (строковых значений) id. Если данная опция не указана, то для неё будет назначено значение ['1'];
#### Mapping значений
Блок valueMapping позволяет настроить конвертацию значений между yandex api и MQTT. Это может быть актуально для умений типа **devices.capabilities.on_off** и **devices.capabilities.toggle**.
Блок valueMapping позволяет настроить конвертацию значений между yandex api и MQTT. Это может быть актуально для умений типа `devices.capabilities.on_off` и `devices.capabilities.toggle`.
*Например, если в УД состояние влючено/выключено соответствует значениям 1/0, то Вам понадобиться их конвертировать, т.к. в навыках Yandex значения true/false.*
```
@@ -335,10 +335,10 @@ valueMapping: [
- [Типы встроенных датчиков](https://yandex.ru/dev/dialogs/alice/doc/smart-home/concepts/properties-types.html)
## Логирование
Добавлено две "стратегии" логирования: логироване сообщений об ощибках в файл `log/errors.log` (аргумент запуска `--log-errors`) и логирование всех сообщений в консоль (`--log-info`).
## Создание службы
В папке /etc/systemd/system/ создать файл yandex2mqtt.service со следующим содержанем:
В папке `/etc/systemd/system/` создать файл `yandex2mqtt.service` со следующим содержанем:
```
[Unit]
Description=yandex2mqtt