Различия

Показаны различия между двумя версиями страницы.

--- настройка_modbus [2022/05/18 10:33]
Sanch-KK [Раздел "items" конфигурации]
+++ настройка_modbus [2025/04/06 10:48] (текущий)
Admin [Mapping значений и команд контроллера в регистры Modbus]
@@ Строка 1: / Строка 1: @@
-** Данная статья формируется в процессе написания кода **
-Далее описана функциональность драйвера Modbus v2
+====== Функциональность драйвера Modbus v2 ======
 LightHub можно настроить на работу в качестве шлюза с фактически любым устройством, поддерживающим Modbus RTU и работающем в режиме Slave
@@ Строка 24: / Строка 24: @@
 В примере выше:
-* "t_heat" - имя параметра устройства.
+  *  "t_heat" - имя параметра устройства.
-* "reg" - регистр (или стартовый HOLDING REGISTER) параметра
+  *  "reg" - регистр (или стартовый HOLDING REGISTER) параметра
-* "ir: - INPUT REGISTER
+  *  "ir: - INPUT REGISTER или "reg"- HOLDING REGISTER или "coil": COIL или "din" - DISCRETE INPUT
-* "map" - правила преобразования  (TBD)
+  * "map" - правила преобразования  (TBD)
-* "type":"i16" -  указывает, что значение - 16-ти битное число со знаком
+  * "type":"i16" -  указывает, что значение - 16-ти битное число со знаком
 Возможные варианты типов:
-* i16 - знаковый 16-ти битный регистр (по умолчанию)
+  * i16 - знаковый 16-ти битный регистр (по умолчанию)
-* i32 - знаковый 32-ти битный регистр (первый регистр - младшие биты, следующий - старшие)
+  * i32 - знаковый 32-ти битный регистр (первый регистр - младшие биты, следующий - старшие)
-* u16 - беззнаковый 16-ти битный регистр
+  * u16 - беззнаковый 16-ти битный регистр
-* u32 - беззнаковый 32-ти битный регистр (первый регистр - младшие биты, следующий - старшие)
+  * u32 - беззнаковый 32-ти битный регистр (первый регистр - младшие биты, следующий - старшие)
-* i8h - старшие 8 бит регистра (при записи значения, другие 8 бит будут заполнены значением 0xFF)
+  * i8h - старшие 8 бит регистра (при записи значения, другие 8 бит будут заполнены значением 0xFF)
-* i8l - старшие 8 бит регистра (при записи значения, другие 8 бит будут заполнены значением 0xFF)
+  * i8l - старшие 8 бит регистра (при записи значения, другие 8 бит будут заполнены значением 0xFF)
-* x10 - дробное число с точностью до 0.1 полученное путем деления значения 16 битного регистра со знаком на 10 (часто используется в разных устройствах для кодирования температуры, например, значение 124 в регистре соответствует 12,4)
+  * x10 - дробное число с точностью до 0.1 полученное путем деления значения 16 битного регистра со знаком на 10 (часто используется в разных устройствах для кодирования температуры, например, значение 124 в регистре соответствует 12,4)
-* 100 - дробное число с точностью до 0.01 полученное путем деления значения 16 битного регистра со знаком на 100
+  * 100 - дробное число с точностью до 0.01 полученное путем деления значения 16 битного регистра со знаком на 100
@@ Строка 54: / Строка 54: @@
 Обозначает, что с интервалом 10 сек будут произведены следующие три опроса:
-* Команда чтения группы из 15-ти регистров с 40000 по 40014
+  * Команда чтения группы из 15-ти регистров с 40000 по 40014
-* Команда чтения группы из 3-x регистров с 30000 по 30002
+  * Команда чтения группы из 3-x регистров с 30000 по 30002
-* Команда чтения одиночного регистра 40099
+  * Команда чтения одиночного регистра 40099
 Для каждого из успешно прочитанных регистров, проводится поиск соответствия в разделе par и ir
@@ Строка 62: / Строка 62: @@
 Отправка происходит, если с момента последнего опроса значение регистра изменилось
+кроме regs допустимы irs и coils
+Или вот пример для сенсора Sensair S8
+Опрашиваем INPUT REGISTERS 0-3,21,25-30 и HOLDING REGISTERS 0,1,31
+<code>
+   "sensair":{"baud":9600,
+             "poll":{"irs":[[0,3],21,[25,30]],"regs":[0,1,31],"delay":1000},
+             "par":{
+                            "co2":{"ir":3},
+                            "meterStat":{"ir":0},
+                            "alarmStat":{"ir":1},
+                            "outStat":{"ir":0},
+                            "pwm":{"ir":21},
+                            "typeid":{"ir":25,"type":"u32"},
+                            "mapver":{"ir":27},
+                            "fwver":{"ir":28},
+                            "sensorid":{"ir":29,"type":"u32"},
+                            "ack":{"reg":0},
+                            "command":{"reg":1},
+                            "abc":{"reg":31}
+             }
+</code>
+А вот пример подключения Modbus адаптера кондиционера Haier
+<code>
+"modbus":
+  {
+    "haier":{"baud":9600,
+             "poll":{"regs":[[0,3]],"irs":[[0,1]],"coils":[0],"delay":5000},
+             "par":{
+                            "pwr":{"coil":0,"map":{"cmd":[1,["OFF",0]],"val":null, "def":"acmode"},"id":1},
+                            "acmode":{"reg":1,"map":{"cmd":[["FAN_ONLY",4],["HEAT",2],["COOL",1],["DRY",3],["AUTO",5]],"val":null},"id":1},
+                            "$temp":{"ir":0},
+                            "$fault":{"ir":1},
+                            "set":{"reg":0,"id":2},
+                            "fan":{"reg":2,"id":7,"map":{"cmd":[["OFF",0],["LOW",1],["HIGH",3],["MEDIUM",2],["AUTO",4]]}},
+                            "lock":{"reg":3,"map":{"cmd":[["OFF",1],["ON",4]]}}
+                    }
+       }
+  },
+"items": {
+  "ac_2":[14,[128,
+                  "haier",
+                  {
+                  "pwr":{"emit":"home/s_out/ac_2/cmd","@V":null},
+                  "$temp":{"emit":"home/s_out/ac_2/$temp","@S":null},
+                  "$fault":{"emit":"home/s_out/ac_2/$fault"},
+                  "set":{"emit":"home/s_out/ac_2/set"},
+                  "acmode":{"emit":"home/s_out/ac_2/$mode","@V":null},
+                  "fan":{"emit":"home/s_out/ac_2/fan","@V":null},
+                  "lock":{"emit":"home/s_out/ac_2/lock","@V":null}
+                  }
+                  ]
+              ]
+          }
+}
+</code>
 ==== Разделы baud и serial ====
@@ Строка 232: / Строка 295: @@
 <code>
+"modbus":
+  {
+    "panel":{
+            "serial":"8E1",
+            "poll":{"regs":[[40000,40014],[30000,30002]],"delay":10000},
+             "par":{
+                            "fan"  :{"reg":40000,"map":[1,[0,7,0,100]],"id":11},
+                            "mode" :{"reg":40001,"mapcmd":[2,[[1,"FAN_ONLY"],[2,"HEAT"],[4,"COOL"],[8,"AUTO"]]]},
+                            "settemp"  :{"reg":40002,"id":12},
+                            "pwr"  :{"reg":40003,"mapcmd":[2,[[0,2],[1,1]]]},
+                            "alm01":{"reg":40004},
+                            "alm17":{"reg":40005},
+                            "alm33":{"reg":40006},
+                            "sethum" :{"reg":40007,"id":13},
+                            "setvoc" :{"reg":40008,"id":14},
+                            "roomtemp" :{"reg":30000,"type":"x10"},
+                            "hum"  :{"reg":30001},
+                            "voc"  :{"reg":30002},
+                            "ch_temp"  :{"reg":40009,"type":"x10","id":15},
+                            "ext_temp" :{"reg":40010,"type":"x10","id":16},
+                            "out_temp" :{"reg":40011,"type":"x10","id":17},
+                            "water_temp" :{"reg":40012,"type":"x10","id":18},
+                            "ch_hum"  :{"reg":40013},
+                            "heat_pwr":{"reg":40014}
+             }
+    }
+  },
+ items:{
     "p_zal3":[14,[2,"panel",
               {
@@ Строка 251: / Строка 345: @@
                 "out_temp":{},
                 "water_temp":{},
-                "heat_pwr":{},
+                "heat_pwr":{}
-                "cmd":{"sa":2,"reg":"mode","on":1,"off":0}
               }
               ]]
+}
 </code>
+Также, по-умолчанию, контроллер выполняет какие-то действия, только если регистр Модбас устройства поменялся не в результате записи в него со стороны контроллера(такая логика сделана, чтобы избежать зацикливания нотификаций)
+Например, если в регистре число 3 а мы записали в него 5 - никаких действий при опросе не произойдет. А вот если значение в регистре изменилось в результате каких-то внутренних процессов устройства (например, пользователь изменил значение температуры на панеле) - это значение будет обработано.
+Данную фильтрацию можно отменить, если в настройке параметра добавить переменную @V типа, отличного от целого.
+Например так:
+<code>
+"fan" :{"emit":"edem/air/vents/zal3/fan","@V":null},
+</code>
+В этом случае, после того, как мы что-то записали в регистр, при следующем же опросе устройства, это будет обнаружено (если значение изменилось) и будут предприняты настроенные действия (например, значение будет отправлено по MQTT и отобразится в мобильном приложении Home Assistant)
+<del>И еще один фильтр: при попытке записать в регистр значение, не отличающееся от последнего полученного при опросе, такая попытка будет проигнорирована. Такое поведение отключить нельзя.</del>
+===== Запись в Modbus устройство =====
+Параметры Модбас устройства можно записывать аналогично, со всеми остальными items контроллера - с использованием MQTT, прямым обращением из других items контроллера, через http API
+Рассмотрим на примере вентустановки:
+Скорость можно поменять, обращаясь к "суб-топику" fanspeed
+//vent/fanspeed/set// (для прямого обращения по api или как к item-у)
+Для обращения через MQTT топик будет выглядеть как myhome/devicename/vent/fanspeed/set
+Внимание, для названий субтопиков следует избегать стандартных имен суффиксов (cmd,set,hsv,rgb,fan,mode,hue,sat,temp,val,del,raw)
+Параметры fanmin и fanmax доступны только на запись (контроллер не будет отслеживать изменение их значений)
+также, есть возможность "прикрепить" параметры к стандартным суффиксам item-а (set,cmd,fan и пр), указав числовой параметр id, соответствующий данному стандартному суффиксу в описании этого параметра.
+Перечень суффиксов:
+<code>
+CMD  1
+SET  2
+HSV  5
+RGB  6
+FAN  7
+MODE 8
+HUE  9
+SAT  10
+TEMP 11
+VAL  12
+DELAYED 13
+RAW 14
+</code>
+в примере ниже, это значит, что альтернативный описанному метод поменять скорость:
+//vent/fan//
+А при записи в vent/cmd это значение установится как в регистр 41 (параметр on) так и в регистр 43 (параметр pmode) так как у них указан одинаковый id=1, соответствующий суффиксу /cmd
+<code>
+"modbus":
+  {
+    "airset":{
+              "baud":9600,
+              "serial":"8E1",
+              "poll":{"regs":[[0,60],1008],"delay":2000},
+              "par":{
+                            "rtemp":{"reg":5,"type":"100", "mode":"r"},
+                            "fanmin":{"reg":50,"type":"u8l"},
+                            "fanmax":{"reg":51,"type":"u8l"},
+                            "on":{"reg":41,"type":"u8l","id":1},
+                            "fanspeed":{"reg":42,"type":"u8l","id":7},
+                            "pmode":{"reg":43,"type":"u8l","id":1,"map":{}},
+                            "tset":{"reg":44,"type":"u8l","id":2},
+                            "numspeed":{"reg":60,"type":"u8l"},
+                            "fault":{"reg":1008}
+              }
+              }
+  },
+  "items": {
+  "vent":[14,[247,"airset",
+    {
+      "tset":{"emit":"edem/s_out/vent/tset/set","@V":null},
+      "pmode":{"emit":"edem/s_out/vent/pmode/set","@V":null},
+      "fanspeed":{"emit":"edem/s_out/vent/fanspeed/set","@V":null},
+      "on":{"emit":"edem/s_out/vent/on/set","@V":null},
+      "rtemp":{"emit":"edem/s_out/vent/rtemp"},
+      "fanmin":{},
+      "fanmax":{}
+    }
+    ]],
+  }
+</code>
+===== Mapping значений и команд контроллера в регистры Modbus =====
+Более подробно настройка преобразований описана в отдельном разделе [[использование_преобразований_map]]
+Далее, разобраны примеры применения
+Рассмотрим на примере вентустановки
+Допустим, регистр 41 отвечает за включение установки. Соответственно, в него надо записать "1" для всех рабочих режимов:
+  * AUTO
+  * ON
+  * HEAT
+  * FAN_ONLY
+Для команды OFF записываем 0
+Это реализуется строкой
+<code>
+"on":{"reg":41,"type":"u8l","id":1,"map":{"cmd":[["OFF",0],["ON",1],["AUTO",1],["HEAT",1],["FAN_ONLY",1]]}}
+</code>
+наличие "id"=1 позволяет не только напрямую управлять данным регистром при помощи именованного параметра "on" (топика air/on/set) но и привязать его к командному суффиксу канала
+Соответственно, доступно управление по командному топику air/cmd
+В нашей вентустановке за переключение режима работы (нагрев-вентиляция-авто) отвечает отдельный регистр 43
+настроим отображение режима работы на требуемые значения данного регистра и, также, привяжем это отображение к командному топику ("id":1)
+<code>
+"pmode":{"reg":43,"type":"u8l","id":1,"map":{"cmd":[["AUTO",3],["HEAT",2],["FAN_ONLY",1]]}},
+</code>
+теперь при переключении режимов в регистр 43 будет записываться 3 для Авторежима, 2 - для режима нагрева, 1 - для режима вентиляции
+Еще лайфхак:
+<code>
+"humpwr":{"reg":39998,"map":{"cmd":[null,["ON",1],["OFF",0]],"val":null}},
+</code>
+В примере выше, в значения регистра будет маппироваться только команда, поступающая на humpwr. Команда ON в 1, команда OFF в 0
+первый null перед массивом соответствия команда -> значение по умолчанию, которое будет использоваться если не удастся подобрать команду. (null тут можно не указывать)
+Если не подобрали - пытаемся преобразовать по значению
+Если не использовать "val":null - то значения, отправляемые в humpwr/set будут передаваться в регистр без преобразований. Использование null обеспечивает игнорирование значений (не команд)
+(описание не завершено)
+<code>
+"modbus":
+  {
+    "airset":{
+              "baud":9600,
+              "serial":"8E1",
+              "poll":{"regs":[[0,60],1008],"delay":2000},
+              "par":{
+                            "on":{"reg":41,"type":"u8l","id":1,"map":{"cmd":[["OFF",0],["ON",1],["AUTO",1],["HEAT",1],["FAN_ONLY",1]]}},
+                            "fanspeed":{"reg":42,"type":"u8l","id":7,"map":{"cmd":"fan"}},
+                            "offbyfan":{"reg":41,"type":"u8l","id":7,"map":{"cmd":[1,["OFF",0]]}},
+                            "pmode":{"reg":43,"type":"u8l","id":1,"map":{"cmd":[["AUTO",3],["HEAT",2],["FAN_ONLY",1]]}},
+                            "tset":{"reg":44,"type":"u8l","id":2},
+                            "di":{"reg":47,"type":"u8l"},
+                            "dp":{"reg":48,"type":"u8l"},
+                            "dt":{"reg":49,"type":"u8l"},
+                            "fault":{"reg":1008}
+              }
+              }
+  }
+},
+"items":
+{
+  "vent":[14,[247,"airset",
+    {
+      "tset":{"emit":"edem/s_out/vent/set","@V":null},
+      "pmode":{"emit":"edem/s_out/vent/cmd","@V":null},
+      "fanspeed":{"emit":"edem/s_out/vent/fan","@V":null},
+      "on":{"emit":"edem/s_out/vent/oncmd","@V":null},
+      "ruheat":{"emit":"edem/s_out/vent/ruheat"},
+      "ruslow":{"emit":"edem/s_out/vent/rupump"},
+      "ramode":{"emit":"edem/s_out/vent/ramode"},
+      "rfanspd":{"emit":"edem/s_out/vent/rfanspd"},
+      "rfanlvl":{"emit":"edem/s_out/vent/rfanlvl"},
+      "rpumpon":{"emit":"edem/s_out/vent/rpumpon"},
+      "rtemp":{"emit":"edem/s_out/vent/rtemp"},
+      "rtempset":{"emit":"edem/s_out/vent/rtempset"},
+      "fault":{"emit":"edem/s_out/vent/fault"},
+      "tautoheat":{},
+      "tautocool":{},
+      "di":{},
+      "dp":{},
+      "dt":{},
+      "fanmin":{},
+      "fanmax":{},
+      "tmreheat":{},
+      "tairfreeze":{},
+      "twaterstart":{},
+      "twatershut":{},
+      "twateridle":{},
+      "fanauto":{"emit":"edem/s_out/vent/fanauto/set","@V":null},
+      "numspeed":{},
+      "offbyfan":{}
+    }
+    ]]
+}
+</code>

LightHub

Инструменты пользователя

Инструменты сайта

Различия

Инструменты страницы