Documentation improvement

This commit is contained in:
Evgenii Abramov
2021-03-29 21:37:35 +03:00
parent 439f55df00
commit 7ae570ee8d

View File

@@ -11,12 +11,10 @@
Прочий функционал (изменение громкости, каналов, отключение звука), поидее, так же должны работать.
## ChangeLog
**01.04.2021**
###### 01.04.2021
Добавлена поддержка [уведомлений навыка об изменении состояния устройств](https://yandex.ru/dev/dialogs/alice/doc/smart-home/reference-alerts/post-skill_id-callback-state.html).
**Release**
###### Release
Проведён рефакторинг кода и, местами, внесены значительные правки.
Добавлена поддержка датчиков (устройств **devices.types.sensor**)
@@ -63,7 +61,7 @@ npm start
mv config.orig.js config.js
```
**Файл конфигурации**
#### Файл конфигурации
```
module.exports = {
yandex: {
@@ -97,8 +95,7 @@ module.exports = {
]
}
```
**Блок настройки навыка Yandex (необязательный блок, необходим для уведомлений)**
###### Блок настройки навыка Yandex (необязательный блок, необходим для уведомлений)
Указать id навыка (навык должен быть опубликован) и токен пользователя ([информация по получению токена](https://yandex.ru/dev/dialogs/alice/doc/smart-home/reference-alerts/resources-alerts.html#resources-alerts__oauth)).
```
yandex: {
@@ -107,8 +104,7 @@ yandex: {
},
```
**Блок настройки mqtt клиента**
###### Блок настройки mqtt клиента
Указать данные Вашего MQTT сервера
```
mqtt: {
@@ -119,8 +115,7 @@ mqtt: {
},
```
**Блок настройки https сервера**
###### Блок настройки https сервера
Указать порт, на котором будет работать мост, а так же пути к сертификату ssl.
```
https: {
@@ -130,8 +125,7 @@ https: {
},
```
**Блок настройки клиентов**
###### Блок настройки клиентов
Здесь используются произвольные данные, далее они понадобятся для подключения к УД Yandex.
```
clients: [
@@ -145,7 +139,7 @@ clients: [
],
```
**Блок настройки пользователей**
###### Блок настройки пользователей
```
users: [
{
@@ -163,7 +157,7 @@ users: [
],
```
**Блок настройки устройств**
###### Блок настройки устройств
```
devices: [
{
@@ -253,7 +247,7 @@ valueMapping: [
```
В mapping указывается миссив массивов. Первый массив - значения в yandex, второй - в MQTT.
###### Уведомление об изменении состояний устройств
#### Уведомление об изменении состояний устройств
Для работы уведомлений необходимо у устройства задать mqtt топик state. При изменении этого топика y2m будет отправлять навыку уведомление об изменении состояния устройтсва.
@@ -331,7 +325,7 @@ service yandex2mqtt restart
## Известные "особенности поведения" ioBroker (iob)
###### Не изменяются и не читаются топики MQTT
#### Не изменяются и не читаются топики MQTT
Если случается такое, что Алиса получает голосовую команду и не сообщает об ошибке, но при этом топик не меняет своего значения или, при изменении стейта (объекта iob) MQTT топик не публикуется (Алиса не получает нового значения, а сообщает старое) **необходимо перезапустить адаптер mqtt**.