Материал из Module developer
Перейти к: навигация, поиск

Блок оформления:

head

body

head

body

head

body


Функция/событие API (переводимый шаблон). Ставь после имени шаблона код языка: /ru или /en:


описание функции

Синтаксис

синтаксис

Название Пример Описание

входные параметры (таблица JS Table)

На выходе

выходные параметры (таблица JS Table)


Пример

пример (скрипт, см. основную вики)

примечания


таблица для входных и выходных параметров API:

имя пример type: тип данных
описание
имя пример type: тип данных
описание
имя пример type: тип данных
описание

<translate>

Object Condition Name "MyCondition" type: string
имя условия
EventType "Simple" type: string
тип события, принимает одно из следующих значений:
  • "Simple" - простой Condition, ожидает фиксированное значение;
  • "Advanced" - расширенный Condition, ожидает значение указанное пользователем при добавлении.
OperationType "Token" type: string
тип источника значения (токен или канал), если принимает значение "Token", то в "ChannelName" указывается путь к токену и сравниваемое значение берётся из токена. Если это поле отсутствует, то значение берётся из канала.
Compare "eq" type: string
логическая операция сравнения с "Param". "eq" - равно, "gt" - больше, "lt" - меньше, "ge" - больше либо равно, "le" - меньше либо равно
Param 1 type: Number
значение, которое сравниваем. Только для EventType "Simple"
ChannelName "Dimmer:channel1" type: string
имя канала. Не используется в "script_call" Condition
Object Field (Advanced only) ControlType "Number" type: string
тип окна ввода параметров Advanced Condition, принимает одно из следующих значений:
  • "Number" - числовой ввод параметра;
  • "Text" - текстовый ввод параметра;
  • "Select" - выбор параметра из готовых значений (выпадающий список).
Min 0 type: Number
минимальное значение, которое может ожидать Condition. Только для ControlType "Number"
Max 100 type: Number
максимальное значение, которое может ожидать Condition. Только для ControlType "Number"
Step 5 type: Number
шаг изменения значения, которое может ожидать Condition. Только для ControlType "Number"
Default "Значение по-умолчанию" type: String
введённое значение по-умолчанию. Только для ControlType "Text"
Validate function type: Function
функция проверки введённого значения. Принимает как параметр введённое в поле значение, в случае успеха должна возвращать число 0. Только для ControlType "Text"
List [{Caption: "turn on", Value: 100}] type: Array
массив значений либо объектов. В случае объектов Condition ожидает значение поля "Value". Только для ControlType "Select"

</translate>