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