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

Documentation improvement

Browse Source
This commit is contained in:
Evgenii Abramov
2021-03-29 21:30:40 +03:00
parent 028790aacc
commit 439f55df00
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -12,9 +12,11 @@
## ChangeLog ## ChangeLog
**01.04.2021** **01.04.2021**
Добавлена поддержка [уведомлений навыка об изменении состояния устройств](https://yandex.ru/dev/dialogs/alice/doc/smart-home/reference-alerts/post-skill_id-callback-state.html). Добавлена поддержка [уведомлений навыка об изменении состояния устройств](https://yandex.ru/dev/dialogs/alice/doc/smart-home/reference-alerts/post-skill_id-callback-state.html).
**Release** **Release**
Проведён рефакторинг кода и, местами, внесены значительные правки. Проведён рефакторинг кода и, местами, внесены значительные правки.
Добавлена поддержка датчиков (устройств **devices.types.sensor**) Добавлена поддержка датчиков (устройств **devices.types.sensor**)
@@ -96,6 +98,7 @@ module.exports = {
} }
``` ```
**Блок настройки навыка Yandex (необязательный блок, необходим для уведомлений)** **Блок настройки навыка Yandex (необязательный блок, необходим для уведомлений)**
Указать id навыка (навык должен быть опубликован) и токен пользователя ([информация по получению токена](https://yandex.ru/dev/dialogs/alice/doc/smart-home/reference-alerts/resources-alerts.html#resources-alerts__oauth)). Указать id навыка (навык должен быть опубликован) и токен пользователя ([информация по получению токена](https://yandex.ru/dev/dialogs/alice/doc/smart-home/reference-alerts/resources-alerts.html#resources-alerts__oauth)).
``` ```
yandex: { yandex: {
@@ -105,6 +108,7 @@ yandex: {
``` ```
**Блок настройки mqtt клиента** **Блок настройки mqtt клиента**
Указать данные Вашего MQTT сервера Указать данные Вашего MQTT сервера
``` ```
mqtt: { mqtt: {
@@ -116,6 +120,7 @@ mqtt: {
``` ```
**Блок настройки https сервера** **Блок настройки https сервера**
Указать порт, на котором будет работать мост, а так же пути к сертификату ssl. Указать порт, на котором будет работать мост, а так же пути к сертификату ssl.
``` ```
https: { https: {
@@ -126,6 +131,7 @@ https: {
``` ```
**Блок настройки клиентов** **Блок настройки клиентов**
Здесь используются произвольные данные, далее они понадобятся для подключения к УД Yandex. Здесь используются произвольные данные, далее они понадобятся для подключения к УД Yandex.
``` ```
clients: [ clients: [
@@ -233,7 +239,7 @@ devices: [
*В случае отсутсвия id в конфиге, он будет назначен автоматически по индексу в массиве.* *В случае отсутсвия id в конфиге, он будет назначен автоматически по индексу в массиве.*
###### Mapping значений #### 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.* *Например, если в УД состояние влючено/выключено соответствует значениям 1/0, то Вам понадобиться их конвертировать, т.к. в навыках Yandex значения true/false.*
@@ -248,6 +254,7 @@ valueMapping: [
В mapping указывается миссив массивов. Первый массив - значения в yandex, второй - в MQTT. В mapping указывается миссив массивов. Первый массив - значения в yandex, второй - в MQTT.
###### Уведомление об изменении состояний устройств ###### Уведомление об изменении состояний устройств
Для работы уведомлений необходимо у устройства задать mqtt топик state. При изменении этого топика y2m будет отправлять навыку уведомление об изменении состояния устройтсва. Для работы уведомлений необходимо у устройства задать mqtt топик state. При изменении этого топика y2m будет отправлять навыку уведомление об изменении состояния устройтсва.
Рекомендую для set и state использовать разные топики, а "синхронизацию" этих топиков организовать средствами "умного дома". Рекомендую для set и state использовать разные топики, а "синхронизацию" этих топиков организовать средствами "умного дома".