Documentation style improvement

This commit is contained in:
Evgenii Abramov
2021-03-30 18:50:54 +03:00
parent dec96a9a4e
commit 1d68d695a0

View File

@@ -11,8 +11,6 @@
Прочий функционал (изменение громкости, каналов, отключение звука), поидее, так же должны работать.
## ChangeLog
###### 01.04.2021
Добавлена поддержка [уведомлений навыка об изменении состояния устройств](https://yandex.ru/dev/dialogs/alice/doc/smart-home/reference-alerts/post-skill_id-callback-state.html).
###### Release
Проведён рефакторинг кода и, местами, внесены значительные правки.
@@ -64,10 +62,6 @@ mv config.orig.js config.js
#### Файл конфигурации
```
module.exports = {
yandex: {
...
},
mqtt: {
...
},
@@ -95,14 +89,6 @@ module.exports = {
]
}
```
###### Блок настройки навыка Yandex (необязательный блок, необходим для уведомлений)
Указать id навыка (навык должен быть опубликован) и токен пользователя ([информация по получению токена](https://yandex.ru/dev/dialogs/alice/doc/smart-home/reference-alerts/resources-alerts.html#resources-alerts__oauth)).
```
yandex: {
skillId: '4cc31a75-a20d-422a-b2f6-f10ca93e5b32',
token: 'AQABCDAPv-V233T7o_ps7gESgkNNjlE3EfZt96w'
},
```
###### Блок настройки mqtt клиента
Указать данные Вашего MQTT сервера
@@ -247,12 +233,6 @@ valueMapping: [
```
В mapping указывается миссив массивов. Первый массив - значения в yandex, второй - в MQTT.
#### Уведомление об изменении состояний устройств
Для работы уведомлений необходимо у устройства задать mqtt топик state. При изменении этого топика y2m будет отправлять навыку уведомление об изменении состояния устройтсва.
Рекомендую для set и state использовать разные топики, а "синхронизацию" этих топиков организовать средствами "умного дома".
## Документация Яндекс
- [Типы устройств](https://yandex.ru/dev/dialogs/alice/doc/smart-home/concepts/device-types.html)
- [Типы умений устройства](https://yandex.ru/dev/dialogs/alice/doc/smart-home/concepts/capability-types.html)