Skip to content

Commit

Permalink
Change "dev" description (#88)
Browse files Browse the repository at this point in the history
Понятнее сформулировал описание объекта dev.
  • Loading branch information
matveevrj authored Nov 28, 2023
1 parent fc4ec8f commit 38b155d
Showing 1 changed file with 16 additions and 7 deletions.
23 changes: 16 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,16 +159,25 @@ defineRule("crontest_hourly", {

### Объект `dev`

`dev` задаёт доступные параметры и устройства. `dev["abc/def"]` задаёт
параметр `def` устройства `abc`, доступный по MQTT-топику
`/devices/.../controls/...`. Альтернативная нотация -
`dev["abc"]["def"]` (или, что в данном случае то же самое,
dev.abc.def).
Объект 'dev' определяет MQTT-топик в правилах wb-rules.

Синтаксис:

`dev["device/control"]`

где, device — имя устройства в MQTT-топике,
control — название контрола.

Параметры **device** и **control** содерджатся в полном адресе топика, который имеет вид `/devices/device/controls/control`.

Альтернативный синтаксис:

`dev["device"]["control"]` или, что то же самое, `dev.abc.def`.

Значение параметра зависит от его типа: `switch`, `alarm`
булевский тип, "text"строковой, остальные известные типы параметров,
булевский тип, `text`строковый, остальные известные типы параметров,
кроме уставок диммеров (тип rgb), считаются числовыми, уставки диммеров (тип rgb)
и неизвестные типы параметров - строковыми. Смотрите полный список в [Wiren Board MQTT Conventions](https://github.com/wirenboard/conventions/blob/main/README.md).
и неизвестные типы параметров строковыми. Полный список типов параметров в [Wiren Board MQTT Conventions](https://github.com/wirenboard/conventions/blob/main/README.md).

Не следует использовать объект `dev` вне кода правил. Не следует
присваивать значения параметрам через `dev` вне `then`-функций правил
Expand Down

2 comments on commit 38b155d

@Sidddha
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

В 178 строке заменили dev["abc"]["def"] на dev["device"]["control"], а dev.abc.def поменять забыли, что может ввести в заблуждение

@sikmir
Copy link
Contributor

@sikmir sikmir commented on 38b155d Feb 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Спасибо, поправил #101

Please sign in to comment.