SAYMON: различия между версиями

Материал из Wiren Board
(Новая страница: «<languages/> <translate> <!--T:1--> '''MQTT''' - очередь сообщений, использующаяся в Программное обеспечени…»)
 
м
Метка: visualeditor-switched
 
(не показана 1 промежуточная версия этого же участника)
Строка 1: Строка 1:
<languages/>
[https://saymon.info '''SAYMON'''] - отечественная платформа для сбора данных с устройств, мониторинга их состояния и управления.
<translate>
<!--T:1-->
'''MQTT''' - очередь сообщений, использующаяся в [[Программное обеспечение Wiren Board|программном обеспечении Wiren Board]]. [http://en.wikipedia.org/wiki/MQTT Базовая информация по MQTT на Википедии].


<!--T:134-->
В данной статье описаны инструкции по установке SAYMON Agent и конфигурации MQTT-брокера на примере контроллера Wiren Board 6.
Драйверы, отвечающие за аппаратные возможности контроллера (цифровые входы, АЦП, транзисторный выходы, ...) и функции внешних подключённых устройств (например, подключённых по RS-485 модулей реле) записывают их состояние в очередь MQTT в виде специальных сообщений. Веб-интерфейс читает эти сообщения и на их основе отображает состояние устройств.


<!--T:135-->
Если же происходит нажатие кнопки в веб-интерфейсе, уже веб-интерфейс отправляет сообщение в очередь MQTT, драйвер устройства его получает и отдаёт команду устройству.


== Примеры работы через очередь MQTT == <!--T:3-->
== Установка SAYMON Agent ==
===Получение значения от датчика температуры и вывод его в веб-интерфейс===
=== Введение ===
[[File:Web-devices-1-wire.png|400px|thumb|Показания датчика и его уникальный идентификатор на странице ''Devices'' веб-интерфейса]]
Установка SAYMON Agent на контроллер [[Wiren Board]] может потребоваться для сбора основных параметров о работе устройства, например, количестве свободного места, памяти, или для выполнения каких-либо пользовательских скриптов.
Предположим, что к [[Wiren Board]] подключён датчик температуры по шине [[1-Wire]]. Проследим, как данные с него через очередь сообщений попадают в веб-интерфейс:
#Драйвер, отвечающий за данную аппаратную функцию ([https://github.com/contactless/wb-homa-drivers/tree/master/wb-homa-w1 wb-homa-w1]) опрашивает подключённые к контролеру датчики 1-Wire.
#При получении значения драйвер размещает в очереди сообщение следующего вида: <pre>/devices/wb-w1/controls/28-0115a48fcfff 23.25</pre>Оно значит, что на устройстве 1-Wire с идентификатором ''28-0115a48fcfff'' получено значение 23.25°C.
#Веб-интерфейс, который получает все сообщения из очереди (он ''подписан'' на все сообщения), получает это сообщение и выводит значение датчика на страницу.
===Нажатие кнопки в веб-интерфейсе и переключение реле на внешнем модуле===
[[File:Web-devices-serial.png|400px|thumb|Веб-интерфейс после нажатия кнопки включения Реле 1 на подключённом по RS-485 релейном модуле [[WB-MRM2]]]]
Предположим, что к контроллеру по шине [[RS-485]] подключён релейный модуль [[WB-MRM2]]. Пользователь в веб-интерфейсе нажимает кнопку включения реле. Проследим, как команда из веб-интерфейса попадает на внешний модуль:
#После нажатия кнопки веб-интерфейс размещает в очереди сообщение следующего вида: <pre>/devices/wb-mrm2_130/controls/Relay 1/on 1</pre>Оно значит, что устройство WB-MRM2 с адресом ''130'' должно перевести Реле 1 в состояние логической единицы - "включено".
#[[Драйвер wb-mqtt-serial]], отвечающий за данную аппаратную функцию, получает это сообщение (он ''подписан'' на все сообщения, относящиеся к подключённым по RS-485 устройствам) и посылает по шине RS-485 релейному модулю команду на включение первого реле.
#Релейный модуль WB-MRM2 получает команду от контроллера, переключает реле и посылает обратно уведомление ("Реле 1 включено").
#Драйвер wb-mqtt-serial получает это уведомление по RS-485 и публикует в очереди сообщение:<pre>/devices/wb-mrm2_130/controls/Relay 1 1</pre>Оно значит, что первое реле на устройстве WB-MRM2 с адресом ''130'' находится (уже переведено) в состоянии логической единицы ("включено").


== Принцип работы очереди сообщений == <!--T:136-->
=== Установка ===
[[File:MQTT.png | thumb | 600px | Через очередь сообщений MQTT работают драйверы внутренних функций, внешних устройств, веб-интерфейс, система правил]]
Скачиваем архив с агентом по [http://www.saymon.info/downloads/saymon-agent-rl-linux-generic.tar.gz ссылке] и распаковываем его в папку <pre>/opt/saymon-agent/</pre>
Система сообщений MQTT построена по следующему принципу:
*есть иерархическая система "топиков" (как на обычных форумах в интернете)
*в эти топики клиенты (в случае Wiren Board это драйверы устройств и веб-интерфейс) могут писать сообщения и читать оттуда
*чтобы следить за изменениями нужного топика (например, температуры на датчике), клиент может на него "подписаться" - тогда он получит все сообщения в данном топике.
Полное описание системы топиков и подписок [http://mosquitto.org/man/mqtt-7.html http://mosquitto.org/man/mqtt-7.html].


=== Отображение устройств в структуре сообщений === <!--T:24-->
Скачиваем архив с JDK по [https://download.oracle.com/otn/java/jdk/8u231-b11/5b13a193868b4bf28bcb45c792fce896/jdk-8u231-linux-arm32-vfp-hflt.tar.gz ссылке] (попросит регистрации на сайте), распаковываем архив в папку temp и из неё полностью копируем директорию jre в папку <pre>/opt/saymon-agent/</pre>


<!--T:25-->
Затем выполняем следующие команды:
Логика организации топиков, соответствующих разным устройствам и их параметрам, в Wiren Board следует определённым правилам - так называемым соглашениям ([https://github.com/contactless/homeui/blob/master/conventions.md Wiren Board MQTT Conventions]).


<!--T:137-->
Полный список MQTT-топиков можно увидеть на странице ''Settings'' веб-интерфейса в разделе ''MQTT Channels'' (появилось в последних версиях [[Обновление прошивки|прошивки]]).
=== Клиенты очереди сообщений === <!--T:138-->
*драйверы внутренних аппаратных функций
*драйверы внешних подключённых устройств
*веб-интерфейс
*движок правил
*(если есть) собственные программы пользователя
=== Структура сообщения о состоянии устройства === <!--T:139-->
Вот пример сообщения от драйвера температурного датчика 1-Wire из примера выше:
<pre>
/devices/wb-w1/controls/28-0115a48fcfff 23.25
</pre>
Часть до пробела - название топика, после - само сообщение.
<!--T:140-->
Название топика состоит из вложенных друг в друга "подтопиков":
* ''/devices'' - коренной топик для всех "устройств" - как встроенных функций Wiren Board (цифровые, АЦП, ...), так и подключённых внешних (например, модулей реле)
* ''/wb-w1'' - подтопик, который наполняется драйвером 1-Wire
* ''/controls'' - подтопик, который есть у всех устройств - именно в него записываются все их параметры, которые меняются ("включено-выключено", значение датчика, ...)
* ''/28-0115a48fcfff'' - непосредственно сам "канал" ("контрол)" - топик, куда записывается значение с датчика. Его название совпадает с адресом 1-Wire датчика на шине.
Содержание сообщения:
* ''23.25'' - значение температуры
<!--T:141-->
Если вы хотите самостоятельно написать драйвер устройства, и хотите, что оно отображалось на вкладке Devices и его можно было использовать в правилах, вам необходимо придерживаться такой же структуры топиков.
=== Пример подписки === <!--T:113-->
<!--T:122-->
Клиенты, которые хотят следить за значением температуры, "подписываются" на этот топик, и им приходят все новые сообщения - меняющиеся значения температуры. Один из таких клиентов - веб-интерфейс.
<!--T:133-->
Подписаться на сообщения можно и из консоли Linux при помощи утилиты '''mosquitto_sub''' (полное описание работы с очередью из командной строки смотрите ниже):
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
root@wirenboard:~# mosquitto_sub -t '/devices/wb-w1/controls/28-0115a48fcfff' -v //получить сообщения из топика устройства 1-Wire с идентификатором 28-0115a48fcfff
useradd -M -r -s /bin/false -K MAIL_DIR=/dev/null saymon
/devices/wb-w1/controls/28-0115a48fcfff 22.75 //в этой строке и ниже - вывод утилиты, полученные сообщения
chown -R saymon:saymon /opt/saymon-agent
/devices/wb-w1/controls/28-0115a48fcfff 22.75
cp /opt/saymon-agent/systemd/* /etc/systemd/system
/devices/wb-w1/controls/28-0115a48fcfff 22.75
systemctl enable saymon-agent
service saymon-agent start
</syntaxhighlight>
</syntaxhighlight>


=== Структура сообщения - команды на изменение состояния === <!--T:16-->
=== Конфигурация агента ===
При необходимости отредактируйте [https://wiki.saymon.info/pages/viewpage.action?pageId=37388671 файл настроек агента]: <pre>/opt/saymon-agent/conf/agent.properties</pre>


<!--T:17-->
=== Лог-файлы ===
Подпишемся на сообщения о состоянии первого реле подключённого по RS-485 релейного модуля WB-MRM2:
Логи агента пишутся в директорию <pre>/var/log/saymon</pre>
<syntaxhighlight lang="bash">
root@wirenboard:~# mosquitto_sub -t "/devices/wb-mrm2_130/controls/Relay 1/#" -v
/devices/wb-mrm2_130/controls/Relay 1/meta/type switch
/devices/wb-mrm2_130/controls/Relay 1/meta/order 1
/devices/wb-mrm2_130/controls/Relay 1 0
</syntaxhighlight>
Тут стоит отметить, что MQTT сохраняет часть сообщений (а именно те, которые при отправке были помечены флагом ''retained'') вечно, поэтому после подписки вы получите даже те сообщения, которые были отправлены раньше, чем вы подписались.


<!--T:18-->
При необходимости логирование отключается в файле <pre>/opt/saymon-agent/conf/logback-upstart.xml</pre>
Релейный модуль управляется драйвером [[Драйвер wb-mqtt-serial]]. У него есть соответствующий топик-"канал"("контрол") ''Relay 1''. У него самого есть значение - ''0'' (реле выключено), и есть два подтопика. Один из них - служебный: в ''/meta/type'' записан тип "контрола". Здесь он ''switch'' - выключатель. Второй подтопик ''/on'' - интереснее: в него клиенты пишут то состояние, в которое они хотят установить реле. Заметим, что оно может не совпадать некоторое время (затрачиваемое на процесс переключения) с тем состоянием, в котором реле находится. Драйвер при этом ведёт себя следующим образом: при получении сообщения в топик ''/devices/wb-mrm2_130/controls/Relay 1/on'' он физически включает реле на релейном модуле, а лишь затем записывает новое состояние реле в топик ''/devices/wb-mrm2_130/controls/Relay''.


<!--T:19-->
Для этого достаточно поменять содержимое секции
Например, если мы сейчас нажмём на кнопку реле в веб-интерфейсе (переключим его состояние), то получим новые сообщения:
<pre>
/devices/wb-mrm2_130/controls/Relay 1/on 1
/devices/wb-mrm2_130/controls/Relay 1 1
</pre>
- веб-интерфейс сначала "даёт указание" включить реле, потом драйвер его включает и записывает актуальное состояние в "канал"("контрол").
 
==Работа с очередью сообщений== <!--T:142-->
Программа (демон), отвечающая за рассылку сообщений от одних клиентов другим, называется брокером сообщений. В Wiren Board используется брокер сообщений [http://mosquitto.org/ Mosquitto]. Фактически, все драйверы и веб-интерфейс передают свои сообщения именно демону-брокеру Mosquitto.
===Работа из командной строки===
 
==== Управление устройствами из командной строки ==== <!--T:20-->
 
<!--T:143-->
Для управления устройством (изменения значения канала), необходимо отправить сообщение в топик "/devices/<device-id>/controls/<control-id>/on" (обратите внимание на /on в конце).
Это делается с помощью консольной команды '''mosquitto_pub'''. Пример:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
root@wirenboard:~# mosquitto_pub -t "/devices/wb-mrm2_130/controls/Relay 1/on" -m "1"
<root level="INFO">
<appender-ref ref="FILE-INFO"/>
<!--<appender-ref ref="FILE-DEBUG"/>-->
<!--<appender-ref ref="SYSLOG"/>-->
</root>
</syntaxhighlight>
</syntaxhighlight>
команда отправляет сообщение "1" (логическую единицу, "включить") в топик, соответствующий подключённому по RS-485 релейном модуле WM-MRM2 с адресом 130.
на
 
==== Слежение за состоянием устройства / подписка на топик ==== <!--T:11-->
 
<!--T:12-->
Клиенты, которые хотят следить за значением температуры, "подписываются" на этот топик, и им приходят все новые сообщения - меняющиеся значения температуры. Один из таких клиентов - веб-интерфейс.
 
Подписаться на сообщения можно и из консоли Linux при помощи утилиты '''mosquitto_sub''' (полное описание утилиты смотрите на [http://mosquitto.org/man/mosquitto_sub-1.html http://mosquitto.org/man/mosquitto_sub-1.html]):
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
root@wirenboard:~# mosquitto_sub -t '/devices/wb-w1/controls/28-0115a48fcfff' -v //получить сообщения из топика устройства 1-Wire с идентификатором 28-0115a48fcfff
<root level="INFO">
/devices/wb-w1/controls/28-0115a48fcfff 22.75 //в этой строке и ниже - вывод утилиты, полученные сообщения
<!--<appender-ref ref="FILE-INFO"/>-->
/devices/wb-w1/controls/28-0115a48fcfff 22.75
<!--<appender-ref ref="FILE-DEBUG"/>-->
/devices/wb-w1/controls/28-0115a48fcfff 22.75
<!--<appender-ref ref="SYSLOG"/>-->
</root>
</syntaxhighlight>
</syntaxhighlight>
===Метасимволы=== <!--T:13-->


<!--T:144-->
=== Работа сервиса ===
Подписаться можно не только на один топик, но и на группу топиков по метасиволу. В MQTT применяется два метасимвола: '''#''' и '''+'''. Метасимвол ''#''  означает любое количество уровней вложенных топиков. Выполним команду
Узнать состояние, запустить, перезапустить и остановить сервис агента можно следующими командами:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
root@wirenboard:~# mosquitto_sub -t '/devices/wb-w1/#' -v
service saymon-agent status
/devices/wb-w1/meta/name 1-wire Thermometers
service saymon-agent start
/devices/wb-w1/controls/28-0115a48fcfff 22.812
service saymon-agent restart
/devices/wb-w1/controls/28-0115a48fcfff/meta/type temperature
service saymon-agent stop
/devices/wb-w1/controls/28-0115a48fcfff 22.75
</syntaxhighlight>
</syntaxhighlight>
В результате мы получили не только значения с "контрола" устройства, но и топики с метаданными - название драйвера устройства и тип "контрола" - ''temperature''.
Существует так же метасимвол ''+'', который обозначает один уровень, а не произвольное количество,как ''#'':
<syntaxhighlight lang="bash">
mosquitto_sub -v -t "/config/widgets/+/name"
</syntaxhighlight>
В этом случае мы получим имена всех виджетов.


<!--T:145-->
== Настройка MQTT-моста (MQTT-bridge) ==
Полное описание системы топиков и подписок [http://mosquitto.org/man/mqtt-7.html http://mosquitto.org/man/mqtt-7.html].
Подробности о работе MQTT на контроллерах [[Wiren Board]] можно узнать в соответствующей статье - [[MQTT]]. Здесь же мы приведем пример конфигурации моста для отправки данных на сервер SAYMON и управления устройствами со стороны сервера.


==== Очистка очереди сообщений ==== <!--T:26-->
На контроллере в конец файла <pre>/etc/mosquitto/mosquitto.conf</pre> необходимо добавить следующие строки:
 
<!--T:27-->
Ненужные retained-сообщения могут остаться в системе MQTT после удаления неиспользуемых драйверов или отключения каких-либо устройств.
Это приводит к тому, что несуществующие больше устройства могут отображаться в разделе ''Devices'' веб-интерфейса.
 
<!--T:28-->
Для удаления топиков можно воспользоваться командой ''mqtt-delete-retained''. Пример использования:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
root@wirenboard:~# mqtt-delete-retained '/devices/noolite_tx_1234/#'
connection saymon
address your.saymonserver.com:1883
remote_username login
remote_password password
clientid your_name
try_private false
start_type automatic
topic # both ABCDEFG
</syntaxhighlight>
</syntaxhighlight>
- удалит все топики, начинающиеся на '/devices/noolite_tx_1234/'
где:
* saymon - имя подключения
* your.saymonserver.com:1883 - адрес вашего сервера SAYMON и порт MQTT-брокера
* login - логин пользователя в MQTT-брокере
* password - пароль пользователя в MQTT-брокере
* your_name - ваше имя
* # both ABCDEFG
** # - все топики
** both - отправляются на сервер и принимаются от сервера
** ABCDEFG - с префиксом ABCDEFG (серийным номером контроллера)


<!--T:146-->
С подробным описанием всех доступных опций конфигурирования можно ознакомиться в документации [https://mosquitto.org/man/mosquitto-conf-5.html MQTT-брокера Mosquitto]
Для удаления топиков "по маске", можно циклично вызывать runShellCommand из правил. Таким образом, задача сводится к задаче работы со строками в js.
 
После изменения конфигурационного файла необходимо перезапустить сервис mosquitto на контроллере следующей командой:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
var deviceName = ['name1',.., 'nameN'];
service mosquitto restart
var controlName = 'Temperature';
 
<!--T:147-->
for (var i = 0; i<deviceName.length; i++) {
  runShellCommand ('mqtt-delete-retained /devices/'+ deviceName[i]  + '/controls/controlName/#');
}
</syntaxhighlight>
</syntaxhighlight>


=== Работа с очередью из внешних программ === <!--T:34-->
== Вопросы и поддержка ==
 
После прочтения данной статьи у вас могли остаться какие-то вопросы, получить ответы на которые вы можете, обратившись в службу технической поддержки команды SAYMON - care@saymon.info.
<!--T:35-->
Если вы разрабатываете собственное ПО для Wiren Board, взаимодействовать с его аппаратными ресурсами лучше всего через очередь сообщений - ваша программа передаёт сообщение в очередь, драйвер управляет устройством, и вашей программе не нужно напрямую взаимодействовать с устройством на низком уровне.
 
<!--T:148-->
Для того, чтобы отправлять сообщения MQTT, для многих языков программирования есть библиотеки. Примеры:
* Python - [https://github.com/contactless/mqtt-tools]
* C - [http://mosquitto.org/man/libmosquitto-3.html]
 
 
=== Просмотр MQTT-каналов в web-интерфейсе === <!--T:149-->
MQTT-названия устройств, их элементов управления и последние значения можно найти в разделе Settings web-интерфейса:
[[Файл:Wb_settings.png|900px|thumb|center|Информация об MQTT-названиях устройств]]
 
=== Настройка MQTT моста (bridge) === <!--T:150-->
[[File:CloudMQTT.png | thumb | 400px | Настройки брокера Cloud MQTT]]
MQTT мост (bridge) - это функция MQTT-брокера, позволяющая пересылать все или часть сообщений на другой MQTT-брокер, и получать сообщения с другого брокера обратно. На контроллере эта функция настраивается в конфигурационных файлах ''mosquitto''. Самый простой вариант конфигурации приведён ниже.
 
<!--T:151-->
'''Задача:''' настроить пересылку всех сообщений MQTT на популярный бесплатный облачный MQTT брокер http://cloudmqtt.com/ и обратно.
 
<!--T:152-->
'''Решение:'''
# Зарегистрируйтесь на http://cloudmqtt.com/
# Зайдите в свой аккаунт на http://cloudmqtt.com/ и посмотрите настройки: сервер, порт, логин, пароль.
# Зайдите на контроллер и добавьте в конец файла ''/etc/mosquitto/mosquitto.conf'' следующие строки:
#: <syntaxhighlight lang="bash">
connection cloudmqtt
address m21.cloudmqtt.com:10858
remote_username fs_user_kp
remote_password 5dn_pass_pm
clientid pavel_test
try_private false
start_type automatic
topic # both
</syntaxhighlight>
#: (последняя строка говорит, что нужно пересылать все сообщения (метасимвол '''#''', смотрите описание выше) в обе ('''both''') стороны (с брокера контроллера на облачный брокер и обратно)
#: Более подробное описание всех опций смотрите на https://mosquitto.org/man/mosquitto-conf-5.html.
# Перезапустите mosquitto, выполнив в консоли
#: <syntaxhighlight lang="bash">
service mosquitto restart
</syntaxhighlight>
</translate>

Текущая версия на 12:34, 15 января 2020

SAYMON - отечественная платформа для сбора данных с устройств, мониторинга их состояния и управления.

В данной статье описаны инструкции по установке SAYMON Agent и конфигурации MQTT-брокера на примере контроллера Wiren Board 6.


Установка SAYMON Agent

Введение

Установка SAYMON Agent на контроллер Wiren Board может потребоваться для сбора основных параметров о работе устройства, например, количестве свободного места, памяти, или для выполнения каких-либо пользовательских скриптов.

Установка

Скачиваем архив с агентом по ссылке и распаковываем его в папку

/opt/saymon-agent/

Скачиваем архив с JDK по ссылке (попросит регистрации на сайте), распаковываем архив в папку temp и из неё полностью копируем директорию jre в папку

/opt/saymon-agent/

Затем выполняем следующие команды:

useradd -M -r -s /bin/false -K MAIL_DIR=/dev/null saymon
chown -R saymon:saymon /opt/saymon-agent
cp /opt/saymon-agent/systemd/* /etc/systemd/system
systemctl enable saymon-agent
service saymon-agent start

Конфигурация агента

При необходимости отредактируйте файл настроек агента:

/opt/saymon-agent/conf/agent.properties

Лог-файлы

Логи агента пишутся в директорию

/var/log/saymon

При необходимости логирование отключается в файле

/opt/saymon-agent/conf/logback-upstart.xml

Для этого достаточно поменять содержимое секции

<root level="INFO">
<appender-ref ref="FILE-INFO"/>
<!--<appender-ref ref="FILE-DEBUG"/>-->
<!--<appender-ref ref="SYSLOG"/>-->
</root>

на

<root level="INFO">
<!--<appender-ref ref="FILE-INFO"/>-->
<!--<appender-ref ref="FILE-DEBUG"/>-->
<!--<appender-ref ref="SYSLOG"/>-->
</root>

Работа сервиса

Узнать состояние, запустить, перезапустить и остановить сервис агента можно следующими командами:

service saymon-agent status
service saymon-agent start
service saymon-agent restart
service saymon-agent stop

Настройка MQTT-моста (MQTT-bridge)

Подробности о работе MQTT на контроллерах Wiren Board можно узнать в соответствующей статье - MQTT. Здесь же мы приведем пример конфигурации моста для отправки данных на сервер SAYMON и управления устройствами со стороны сервера.

На контроллере в конец файла

/etc/mosquitto/mosquitto.conf

необходимо добавить следующие строки:

connection saymon
address your.saymonserver.com:1883
remote_username login
remote_password password
clientid your_name
try_private false
start_type automatic
topic # both ABCDEFG

где:

  • saymon - имя подключения
  • your.saymonserver.com:1883 - адрес вашего сервера SAYMON и порт MQTT-брокера
  • login - логин пользователя в MQTT-брокере
  • password - пароль пользователя в MQTT-брокере
  • your_name - ваше имя
  • # both ABCDEFG
    • # - все топики
    • both - отправляются на сервер и принимаются от сервера
    • ABCDEFG - с префиксом ABCDEFG (серийным номером контроллера)

С подробным описанием всех доступных опций конфигурирования можно ознакомиться в документации MQTT-брокера Mosquitto

После изменения конфигурационного файла необходимо перезапустить сервис mosquitto на контроллере следующей командой:

service mosquitto restart

Вопросы и поддержка

После прочтения данной статьи у вас могли остаться какие-то вопросы, получить ответы на которые вы можете, обратившись в службу технической поддержки команды SAYMON - care@saymon.info.