Imported-Repos/yandex2mqtt
1
0
Fork 0
mirror of https://github.com/lasthead0/yandex2mqtt.git synced 2025-08-08 09:01:00 +03:00
Code Issues Packages Projects Releases Wiki Activity

Documentation improvement

Browse Source
This commit is contained in:
Evgenii Abramov
2021-03-31 00:15:22 +03:00
parent 431b587420
commit 53646d6e04
1 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -11,6 +11,8 @@
Прочий функционал (изменение громкости, каналов, отключение звука), поидее, так же должны работать. Прочий функционал (изменение громкости, каналов, отключение звука), поидее, так же должны работать.
## ChangeLog ## ChangeLog
###### 31.03.2021
Добавлена поддрежка разделения доступа пользователей к устройствам.
###### Release ###### Release
Проведён рефакторинг кода и, местами, внесены значительные правки. Проведён рефакторинг кода и, местами, внесены значительные правки.
@@ -271,17 +273,22 @@ devices: [
*В случае отсутсвия id в конфиге, он будет назначен автоматически по индексу в массиве.* *В случае отсутсвия id в конфиге, он будет назначен автоматически по индексу в массиве.*
#### Разрешенные пользователи для устройств (allowedUsers)
В блоке конфигурации можно указать пользователей (id пользователей), для которых будет доступно устройство.
В опции allowedUsers указыватся массив (строковых значений) id. Если данная опция не указана, то для неё будет назначено значение ['1'];
#### Mapping значений #### Mapping значений
Блок valueMapping позволяет настроить конвертацию значений между yandex api и MQTT. Это может быть актуально для умений типа **devices.capabilities.on_off** и **devices.capabilities.toggle**. Блок valueMapping позволяет настроить конвертацию значений между yandex api и MQTT. Это может быть актуально для умений типа **devices.capabilities.on_off** и **devices.capabilities.toggle**.
*Например, если в УД состояние влючено/выключено соответствует значениям 1/0, то Вам понадобиться их конвертировать, т.к. в навыках Yandex значения true/false.* *Например, если в УД состояние влючено/выключено соответствует значениям 1/0, то Вам понадобиться их конвертировать, т.к. в навыках Yandex значения true/false.*
``` ```
valueMapping: [ valueMapping: [
{ {
type: "on_off", type: 'on_off',
mapping: [[false, true], [0, 1]] // [yandex, mqtt] mapping: [[false, true], [0, 1]], // [yandex, mqtt]
} },
] ],
``` ```
В mapping указывается миссив массивов. Первый массив - значения в yandex, второй - в MQTT. В mapping указывается миссив массивов. Первый массив - значения в yandex, второй - в MQTT.
@@ -326,7 +333,6 @@ service yandex2mqtt restart
``` ```
## Создание навыка (в Яндекс Диалоги) ## Создание навыка (в Яндекс Диалоги)
Заходим в [Яндекс Диалоги](https://dialogs.yandex.ru/developer) => Создать диалог => Умный дом Заходим в [Яндекс Диалоги](https://dialogs.yandex.ru/developer) => Создать диалог => Умный дом
#### Основные настройки #### Основные настройки