16 244
правки
Wb-mqtt-serial templates: различия между версиями
м
→Секция инициализации (setup-секция): Добавил описание parameters-секции
м (→Каналы устройства (channels): Уточнил типы регистров) |
м (→Секция инициализации (setup-секция): Добавил описание parameters-секции) |
||
| Строка 180: | Строка 180: | ||
=== Секция инициализации (setup-секция) === | === Секция инициализации (setup-секция) === | ||
Секция содержит перечень параметров, которые передаются устройству при перезапуске дайвера <code>wb-mqtt-serial</code> или при восстановлении связи с устройством. С ее помощью удобно конфигурировать устройства: для работы в каком-то определенном режиме; задавать изначальные значения яркости, положения сервоприводов, состояния реле или режима работы с входами релейных модулей и т. п. | |||
Секция | |||
'''Важно!''' Изменение параметров, описанных в setup-секции с помощью веб-интерфейса не предусмотрено. Если вы хотите изменять параметры инициализации в веб-интерфейсе, используйте ''parameters-секцию''. | |||
В секции доступны элементы: | В секции доступны элементы: | ||
* title — наименование параметра, будет отображен в веб-интерфейсе. | * title — наименование параметра, будет отображен в веб-интерфейсе. | ||
* address — адрес регистра, в который нужно записать параметр. | * address — адрес регистра, в который нужно записать параметр. | ||
* value — фиксированное значение. Если у регистра указать фиксированное значение, то пользователь не сможет его изменить через веб-интерфейс. | * value — фиксированное значение. Если у регистра указать фиксированное значение, то пользователь не сможет его изменить через веб-интерфейс. | ||
Значения ''address'' | Значения ''address'' и ''value'' можно указывать в десятичной или шестнадцатеричной системе счисления. | ||
Пример setup-секции: | Пример setup-секции: | ||
| Строка 204: | Строка 198: | ||
"address": 20000, | "address": 20000, | ||
"value": "0xfff2" | "value": "0xfff2" | ||
}, | }, | ||
{ | { | ||
"title": "s45", | |||
"address": 24010, | |||
"value": "0x0003" | |||
} | |||
] | |||
</syntaxhighlight> | |||
=== Секция параметров (parameters-секция) === | |||
[[Image: Webui2. WB-MR14 Device Options.png|300px|thumb|right| Представление parameters-секции в веб-интерфейсе — Device options]] | |||
Секция содержит перечень параметров, которые передаются устройству при перезапуске дайвера <code>wb-mqtt-serial</code> или при восстановлении связи с устройством. С ее помощью удобно конфигурировать устройства: для работы в каком-то определенном режиме; задавать изначальные значения яркости, положения сервоприводов, состояния реле или режима работы с входами релейных модулей и т. п. | |||
В шаблоне можно перечислить параметры и задать их значения по умолчанию. | |||
В отличие от ''setup-секции'', пользователь сможет изменить значения параметров в веб-интерфейсе, а сама секция имеет структуру: | |||
<syntaxhighlight lang="javascript"> | |||
"parameters": [ | |||
"Param1Name": { // имя параметра | |||
"элемент_параметра": "значение", | |||
... | |||
"элемент_параметра": "значение" | |||
}, | |||
"Param2Name": { | |||
... | |||
} | |||
] | |||
</syntaxhighlight> | |||
'''Важно!''' Чтение параметров из устройства не предусмотрено. | |||
В секции доступны элементы: | |||
* title — наименование параметра, будет отображен в веб-интерфейсе. | |||
* address — адрес регистра, в который нужно записать параметр. | |||
* enum — массив числовых значений, которые можно записать в регистр. | |||
* enum_titles — массив текстовых описаний значений, указанных в ''enum''. | |||
* default — значение по умолчанию. Записывается в регистр, если пользователь не выбрал свое. | |||
* value — фиксированное значение. Если у регистра указать фиксированное значение, то пользователь не сможет его изменить через веб-интерфейс. | |||
Значения ''address'', ''enum'', ''value'' и ''default'' можно указывать в десятичной или шестнадцатеричной системе счисления. | |||
Пример parameters-секции: | |||
<syntaxhighlight lang="javascript"> | |||
"parameters": [ | |||
"SoundValue": { | |||
"title": "Sound value", | "title": "Sound value", | ||
"address": 0x00, | "address": 0x00, | ||
"min": 0, | "min": 0, | ||
"max": 100 | "max": 100, | ||
"default": 0x0a | |||
}, | }, | ||
{ | "FanMode": { | ||
"title": "Fan mode", | "title": "Fan mode", | ||
"address": 3, | "address": 3, | ||