Wb-mqtt-serial driver: различия между версиями

м
→‎Устройства, их каналы и параметры (devices, channels и setup): Добавил пример описания устройства с шаблоном
м (→‎Устройства, их каналы и параметры (devices, channels и setup): Добавил пример описания устройства с шаблоном)
Строка 170: Строка 170:


==== Устройства, их каналы и параметры (devices, channels и setup) ====
==== Устройства, их каналы и параметры (devices, channels и setup) ====
Раздел devices содержит описание устройств, подключенных к порту и имеет структуру:
Раздел '''devices''' содержит описание устройств, подключенных к порту и имеет структуру:
 
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
"devices" :  
"devices" :  
Строка 192: Строка 191:
</syntaxhighlight>
</syntaxhighlight>


Так как для описания устройств мы рекомендуем использовать шаблоны, то подробное описание разделов '''devices''', '''channels''' и '''setup''' вы найдете [[Wb-mqtt-serial templates | в статье о шаблонах]].
Описание устройства '''device''' может быть задано двумя способами: вручную прописать все параметры или задать только несколько параметров, а остальные вынести в шаблон:
<syntaxhighlight lang="javascript">
{
    // По DeviceType драйвер будет искать в папках с шаблонами описаний устройств
    "device_type" : "DeviceType",
 
    // отображаемое имя устройства. Публикуется как
    // .../meta/name в MQTT
    // По умолчанию name берется из шаблона и добавляется slave_id, т.е.
    // "name" + " " + "slave_id"
    "name" : "somename",
 
    // уникальный идентификатор устройства в MQTT.
    // каждый элемент в devices должен иметь уникальный id
    // topic'и, относящиеся в MQTT к данному устройству,
    // имеют общий префикс /devices/<идентификатор топика>/...
    // также по умолчанию берется из шаблона с добавлением slave_id:
    // "deviceID" + "_" + slave_id
    "id" : "deviceID",
 
    // идентификатор slave
    "slave_id" : slaveID,
 
    // включить/выключить устройство. В случае задания
    // "enabled": false опрос устройства и запись значений
    // его каналов не происходит. По умолчанию - true.
    "enabled" : true,
 
    // если используется шаблон устройства, определения
    // каналов совмещаются. Если имя (name) в определении
    // канала устройства совпадает с именем канала в шаблоне,
    // свойства каналов из шаблона и определения устройства
    // совмещаются, при этом значения свойств из определения
    // устройства (в файле конфигурации) имеют преимущество.
    // Это можно использовать, например, для задания индивидуальных
    // интервалов опроса каналов. Если канал с таким же
    // именем, как канал в определении устройства, отсутствует
    // в шаблоне, создаётся новый канал.
    "channels": [
        {
            // имя канала. topic'и, соответствующие каналу,
            "name" : "Temp 1",
            "poll_interval": 10000
        }
    ]
}
</syntaxhighlight>
 
Подробное описание разделов '''device''', '''channels''' и '''setup''' вы найдете [[Wb-mqtt-serial templates | в статье о шаблонах]].


=== Редактирование через веб-интерфейс ===
=== Редактирование через веб-интерфейс ===