mirror of
https://github.com/lasthead0/yandex2mqtt.git
synced 2025-08-08 09:01:00 +03:00
Documentation improvement
This commit is contained in:
24
README.md
24
README.md
@@ -11,6 +11,10 @@
|
||||
Прочий функционал (изменение громкости, каналов, отключение звука), поидее, так же должны работать.
|
||||
|
||||
## 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**)
|
||||
@@ -60,6 +64,10 @@ mv config.orig.js config.js
|
||||
**Файл конфигурации**
|
||||
```
|
||||
module.exports = {
|
||||
yandex: {
|
||||
...
|
||||
},
|
||||
|
||||
mqtt: {
|
||||
...
|
||||
},
|
||||
@@ -87,6 +95,14 @@ 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 сервера
|
||||
@@ -213,7 +229,7 @@ devices: [
|
||||
/* --- end */
|
||||
]
|
||||
```
|
||||
*Рекомендую указывать id в конфиге, чтобы исключить "наложение" новых устройств на "старые", которые уже добавлены в yandex.*
|
||||
*Рекомендую указывать id в конфиге, чтобы исключить "наложение" новых устройств на "старые", которые уже добавлены в навык.*
|
||||
|
||||
*В случае отсутсвия id в конфиге, он будет назначен автоматически по индексу в массиве.*
|
||||
|
||||
@@ -231,6 +247,11 @@ 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)
|
||||
@@ -314,4 +335,3 @@ service yandex2mqtt restart
|
||||
"topic": "/yandex/controls/light_BdR_002/state"
|
||||
}
|
||||
```
|
||||
**Перезапустить адаптер mqtt**
|
Reference in New Issue
Block a user