Refine wb-rules examples and align player/TTS API
This commit is contained in:
29
README.md
29
README.md
@@ -12,6 +12,7 @@
|
||||
- [Полная установка](#полная-установка)
|
||||
- [Токен](#токен)
|
||||
- [CLI](#cli)
|
||||
- [Примеры wb-rules](#примеры-wb-rules)
|
||||
- [Прямые Python-команды](#прямые-python-команды)
|
||||
- [Web UI](#web-ui)
|
||||
- [Systemd](#systemd)
|
||||
@@ -304,6 +305,32 @@ cd /opt/shd/plugins/alice
|
||||
./cli.sh web --host 0.0.0.0 --port 9140
|
||||
```
|
||||
|
||||
## Примеры wb-rules
|
||||
|
||||
Есть готовый файл:
|
||||
|
||||
```text
|
||||
configs/wb-rules/wb-rules-examples.js
|
||||
```
|
||||
|
||||
- `wb-rules-examples.js`:
|
||||
- примеры действий для одной колонки:
|
||||
- `player` (`play`, `stop`, `next`, `prev`);
|
||||
- `tts`;
|
||||
- `command`;
|
||||
- `audio + tts` (через параметры `tts_audio` + `text`).
|
||||
|
||||
Как привязать к конкретной колонке:
|
||||
|
||||
1. возьми `id` нужной станции из `data/stations.json`;
|
||||
2. подставь его в строку:
|
||||
|
||||
```js
|
||||
var STATION = "PUT_EXACT_STATION_ID_HERE";
|
||||
```
|
||||
|
||||
3. скопируй файл в `/etc/wb-rules/` и перезапусти `wb-rules`.
|
||||
|
||||
## Прямые Python-команды
|
||||
|
||||
Все публичные Python-команды задокументированы ниже. Их можно использовать напрямую, но штатный способ — `cli.sh`.
|
||||
@@ -434,6 +461,7 @@ cd /opt/shd/plugins/alice
|
||||
├── loxone/
|
||||
│ └── loxone_templates.zip
|
||||
└── wb-rules/
|
||||
├── wb-rules-examples.js
|
||||
└── wb_rules_templates.zip
|
||||
```
|
||||
|
||||
@@ -442,6 +470,7 @@ cd /opt/shd/plugins/alice
|
||||
- `token.txt` — OAuth-токен;
|
||||
- `data/config.json` — сохранённый IP контроллера и служебные настройки;
|
||||
- `data/stations.json` — найденные станции;
|
||||
- `configs/wb-rules/wb-rules-examples.js` — примеры `player/tts/command/audio+tts` для одной станции;
|
||||
- `configs/loxone/loxone_templates.zip` — ZIP для Loxone;
|
||||
- `configs/wb-rules/wb_rules_templates.zip` — ZIP для wb-rules.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user