mirror of
https://github.com/lasthead0/yandex2mqtt.git
synced 2025-08-08 09:01:00 +03:00
Update documentation
This commit is contained in:
34
README.md
34
README.md
@@ -11,6 +11,9 @@
|
||||
Прочий функционал (изменение громкости, каналов, отключение звука), поидее, так же должны работать.
|
||||
|
||||
## ChangeLog
|
||||
###### 13.05.2021
|
||||
Добавлена поддержка API уведомлений об изменении состояний устройств.
|
||||
|
||||
###### 31.03.2021
|
||||
Добавлена поддрежка разделения доступа пользователей к устройствам.
|
||||
|
||||
@@ -64,6 +67,12 @@ mv config.orig.js config.js
|
||||
#### Файл конфигурации
|
||||
```
|
||||
module.exports = {
|
||||
notification: [
|
||||
{
|
||||
...
|
||||
},
|
||||
...
|
||||
]
|
||||
mqtt: {
|
||||
...
|
||||
},
|
||||
@@ -76,18 +85,21 @@ module.exports = {
|
||||
{
|
||||
...
|
||||
},
|
||||
...
|
||||
],
|
||||
|
||||
users: [
|
||||
{
|
||||
...
|
||||
},
|
||||
...
|
||||
],
|
||||
|
||||
devices: [
|
||||
{
|
||||
...
|
||||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
```
|
||||
@@ -273,6 +285,28 @@ devices: [
|
||||
|
||||
*В случае отсутсвия id в конфиге, он будет назначен автоматически по индексу в массиве.*
|
||||
|
||||
#### Уведомление об изменении состояний устройств
|
||||
Платформа УД Яндекс предоставляет сервис уведомлений об изменении состояний устройств. При изменении состояния устройства (например, изменение влажности) yandex2mqtt будет отправлять запрос с новым состоянием.
|
||||
|
||||
В настройках предусмотрен блок **notification**.
|
||||
|
||||
```
|
||||
notification: [
|
||||
{
|
||||
skill_id: '6fca0a54-a505-4420-b774-f01da95e5c31',
|
||||
oauth_token: 'AQA11AAPv-V2BAT7o_ps6gEtrtNNjlE2ENYt96w',
|
||||
user_id: '2'
|
||||
},
|
||||
]
|
||||
```
|
||||
|
||||
Если к 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, то уведомление для устройтва отправляться не будет.*
|
||||
|
||||
|
||||
#### Разрешенные пользователи для устройств (allowedUsers)
|
||||
В блоке конфигурации можно указать пользователей (id пользователей), для которых будет доступно устройство.
|
||||
|
||||
|
Reference in New Issue
Block a user