Добавляем описание сценарных функций из модулей

This commit is contained in:
2022-09-17 20:45:06 +03:00
parent fd219e3191
commit cd72802542
11 changed files with 159 additions and 7 deletions

View File

@@ -46,7 +46,54 @@
"size": "Размерность матрицы экрана.", "size": "Размерность матрицы экрана.",
"coord": "Координата позиции для вывода данных элемента конфигурации.", "coord": "Координата позиции для вывода данных элемента конфигурации.",
"id2show": "id элемента конфигурации." "id2show": "id элемента конфигурации."
},
"funcInfo": [
{
"name": "noBacklight",
"descr": "Выключить подсветку",
"params": []
},
{
"name": "backlight",
"descr": "Включить подсветку",
"params": []
},
{
"name": "noDisplay",
"descr": "Спрятать все данные",
"params": []
},
{
"name": "display",
"descr": "Показать данные на экране",
"params": []
},
{
"name": "toggle",
"descr": "Переключает видимость значений на экране",
"params": []
},
{
"name": "x",
"descr": "Устанавливает первую координату",
"params": ["Номер строки первого символа"]
},
{
"name": "y",
"descr": "Устанавливает вторую координату",
"params": ["Номер столбца первого символа"]
},
{
"name": "descr",
"descr": "Задает приставку слева от значения",
"params": ["Строка"]
},
{
"name": "id2show",
"descr": "Задает ИД элемента, значение которого хотим отображать на экране",
"params": ["Имя элемента конфигурации"]
} }
]
}, },
"defActive": true, "defActive": true,

View File

@@ -26,6 +26,7 @@
"moduleVersion": "1.0", "moduleVersion": "1.0",
"title": "Кнопка подключенная к пину", "title": "Кнопка подключенная к пину",
"moduleDesc": "Позволяет интерпретировать сигналы на цифровом пине как кнопку, т.е. создает в системе объект для чтения булевых значений с внешнего физического источника. Может вести себя как кнопка или как переключатель.", "moduleDesc": "Позволяет интерпретировать сигналы на цифровом пине как кнопку, т.е. создает в системе объект для чтения булевых значений с внешнего физического источника. Может вести себя как кнопка или как переключатель.",
"retInfo": "Элемент данного модуля может иметь два значения 0 - низкий уровень, 1 - высокий уровень на входе. Значение меняется при выполнении условий по параметрам.",
"propInfo": { "propInfo": {
"pin": "Укажите GPIO номер пина для чтения состояний подключенной кнопки", "pin": "Укажите GPIO номер пина для чтения состояний подключенной кнопки",
"execLevel": "Высокий 1 или низкий 0 уровень переключения состояния в режиме fixState = 1", "execLevel": "Высокий 1 или низкий 0 уровень переключения состояния в режиме fixState = 1",

View File

@@ -26,7 +26,15 @@
"propInfo": { "propInfo": {
"pin": "Укажите GPIO номер пина для управления выходом", "pin": "Укажите GPIO номер пина для управления выходом",
"inv": "Инвертировать выходные сигналы" "inv": "Инвертировать выходные сигналы"
},
"retInfo": "Элемент данного модуля может иметь два значения 0 - низкий уровень, 1 - высокий уровень на выходе",
"funcInfo": [
{
"name": "change",
"descr": "Инвертирует значение переключателя",
"params": []
} }
]
}, },
"defActive": true, "defActive": true,
"devices": { "devices": {

View File

@@ -30,7 +30,14 @@
"useLed": "использовать диод подсветки при съемке.", "useLed": "использовать диод подсветки при съемке.",
"ticker": "Генерировать(1) или нет(0) событие с интервалом int", "ticker": "Генерировать(1) или нет(0) событие с интервалом int",
"webTicker": "Генерировать(1) или нет(0) событие при обращении через веб-страницу с текущим фото в памяти." "webTicker": "Генерировать(1) или нет(0) событие при обращении через веб-страницу с текущим фото в памяти."
},
"funcInfo": [
{
"name": "shot",
"descr": "Сделать снимок",
"params": []
} }
]
}, },
"defActive": false, "defActive": false,

View File

@@ -30,7 +30,15 @@
"pin": "Пин, к которому подключен сервопривод", "pin": "Пин, к которому подключен сервопривод",
"apin": "Номер GPIO аналогового пина. Если -1, то функция отключена.", "apin": "Номер GPIO аналогового пина. Если -1, то функция отключена.",
"amap": "Настройки преобразования значений аналога в нужный диапазон сервы, имеет смысл, если аналог включен." "amap": "Настройки преобразования значений аналога в нужный диапазон сервы, имеет смысл, если аналог включен."
},
"retInfo": "Содержит текущее значение поворота",
"funcInfo": [
{
"name": "rotate",
"descr": "Повернуть привод на значение",
"params": ["Числовое значение"]
} }
]
}, },
"defActive": true, "defActive": true,

View File

@@ -28,7 +28,55 @@
"int": "Периодичность в секундах опроса состояния плеера.", "int": "Периодичность в секундах опроса состояния плеера.",
"pins": "Список GPIO через запятую, к которым подключен плеер.", "pins": "Список GPIO через запятую, к которым подключен плеер.",
"volume": "Уровень громкости при инициализации." "volume": "Уровень громкости при инициализации."
},
"retInfo": "Содержит описание текущего статуса модуля, например, Time Out! - не может подключиться",
"funcInfo": [
{
"name": "enableLoop",
"descr": "Включить бесконечное повторение",
"params": []
},
{
"name": "disableLoop",
"descr": "Выключить бесконечное повторение",
"params": []
},
{
"name": "randomAll",
"descr": "Запустить случайны трек",
"params": []
},
{
"name": "stop",
"descr": "Остановить проигрывание трека",
"params": []
},
{
"name": "volume",
"descr": "Установить громкость",
"params": ["Значение громкости"]
},
{
"name": "playFolder",
"descr": "Проиграть файл из папки",
"params": ["Номер папки", "Номер файла"]
},
{
"name": "play",
"descr": "Запустить проигрывание первого файла",
"params": []
},
{
"name": "next",
"descr": "Запустить проигрывание следующего файла",
"params": []
},
{
"name": "previous",
"descr": "Запустить проигрывание предыдущего файла",
"params": []
} }
]
}, },
"defActive": true, "defActive": true,

View File

@@ -27,6 +27,7 @@
"moduleVersion": "1.0", "moduleVersion": "1.0",
"title": "PWM ESP32", "title": "PWM ESP32",
"moduleDesc": "Позволяет управлять Широтно-Импульсной Модуляцией на конкретном пине платы.", "moduleDesc": "Позволяет управлять Широтно-Импульсной Модуляцией на конкретном пине платы.",
"retInfo": "Содержит текущее значение ШИМ",
"propInfo": { "propInfo": {
"int": "Количество миллисекунд между опросами аналога. 0 - выключено.", "int": "Количество миллисекунд между опросами аналога. 0 - выключено.",
"pin": "Управляемый пин", "pin": "Управляемый пин",

View File

@@ -25,6 +25,7 @@
"moduleVersion": "1.0", "moduleVersion": "1.0",
"title": "PWM ESP8266", "title": "PWM ESP8266",
"moduleDesc": "Позволяет управлять Широтно-Импульсной Модуляцией на конкретном пине платы.", "moduleDesc": "Позволяет управлять Широтно-Импульсной Модуляцией на конкретном пине платы.",
"retInfo": "Содержит текущее значение ШИМ",
"propInfo": { "propInfo": {
"int": "Количество миллисекунд между опросами аналога. 0 - выключено.", "int": "Количество миллисекунд между опросами аналога. 0 - выключено.",
"pin": "Управляемый пин", "pin": "Управляемый пин",

View File

@@ -31,7 +31,19 @@
"autos": "Автоматически(1) или нет(0) запоминать ChatID по входящим сообщениям. Т.е. бот будет информировать тех, кто последний прислал сообщение.", "autos": "Автоматически(1) или нет(0) запоминать ChatID по входящим сообщениям. Т.е. бот будет информировать тех, кто последний прислал сообщение.",
"receiveMsg": "Обрабатывать(1) или нет(0) входящие сообщения.", "receiveMsg": "Обрабатывать(1) или нет(0) входящие сообщения.",
"chatID": "ИД диалога с контактом. Необходим для отправки сообщений именно вам." "chatID": "ИД диалога с контактом. Необходим для отправки сообщений именно вам."
},
"funcInfo": [
{
"name": "sendMsg",
"descr": "Отправить сообщение без повторений.",
"params": ["Сообщение, может быть строкой, числом или ИД другого элемента для получения значения"]
},
{
"name": "sendOftenMsg",
"descr": "Отправить сообщение в любом случае, даж если отправляли такое ранее.",
"params": ["Сообщение, может быть строкой, числом или ИД другого элемента для получения значения"]
} }
]
}, },
"defActive": false, "defActive": false,

View File

@@ -25,7 +25,25 @@
"pinRx": "GPIO номер, к которому подключен радио приемник 433 MHz. Если < 0, то приемник выключен", "pinRx": "GPIO номер, к которому подключен радио приемник 433 MHz. Если < 0, то приемник выключен",
"pinTx": "GPIO номер, к которому подключен радио передатчик 433 MHz. Если < 0, то передатчик выключен", "pinTx": "GPIO номер, к которому подключен радио передатчик 433 MHz. Если < 0, то передатчик выключен",
"int": "Количество миллисекунд между опросами датчика. 0 - выключено. (устранение повторений при нажатой кнопке)" "int": "Количество миллисекунд между опросами датчика. 0 - выключено. (устранение повторений при нажатой кнопке)"
},
"retInfo": "Содержит принятое значение",
"funcInfo": [
{
"name": "sendBitStr",
"descr": "Отправляем строку вида 000000000001010100010001",
"params": ["Строка 000000000001010100010001"]
},
{
"name": "sendTriState",
"descr": "отправляем строку вида 00000FFF0F0F",
"params": ["Строка 00000FFF0F0F"]
},
{
"name": "sendDecimal",
"descr": "отправляем строку вида 5393",
"params": ["Код в виде числа", "Количество бит чтоб заполнить нулями"]
} }
]
}, },
"defActive": true, "defActive": true,

View File

@@ -33,6 +33,7 @@
"repeat": "Сбрасывать(1) или нет(0) таймер в начальное состояние при достижении нуля.", "repeat": "Сбрасывать(1) или нет(0) таймер в начальное состояние при достижении нуля.",
"needSave": "Требуется сохранять(1) или нет(0) состояние в энерго независимую память. Функция находится в разработке." "needSave": "Требуется сохранять(1) или нет(0) состояние в энерго независимую память. Функция находится в разработке."
}, },
"retInfo": "Содержит текущее счетчика обратного отсчета",
"funcInfo": [ "funcInfo": [
{ {
"name": "stop", "name": "stop",