Wiren Board Software: различия между версиями

Материал из Wiren Board
(не показаны 62 промежуточные версии 8 участников)
Строка 1: Строка 1:
{{DISPLAYTITLE: Программное обеспечение контроллеров Wiren Board}}
<languages/>
== Как устроено ПО Wiren Board ==
<translate>
[[File:DebianLinux.png | thumb | 600px | Структура ПО контроллера. В центре очередь сообщений MQTT, которая используется для обмена информацией между разными частями ПО]]
<!--T:1-->
Wiren Board имеет готовый веб-интерфейс для пользователей, но также предоставляет возможность разработки и использования собственного ПО. Исходные коды всего ПО открыты.


Wiren Board работает под управлением Debian Linux. Для архитектуры используемого процессора есть [https://www.debian.org/ports/arm/ официальный порт], поэтому любое стандартное Linux-приложение можно установить из репозитория одной командой <code>apt install имя_пакета</code>.
== Веб-интерфейс == <!--T:2-->
[[Файл:Веб-интерфейс - главная.png|thumb|500 px|Главная страница веб-интерфейса]]
[[Wiren Board]] имеет собственный, находящийся локально на устройстве веб-интерфейс. В нём можно:
*следить за состоянием контроллера и подключённых устройств и управлять ими
*подключать устройства к контроллеру
*настраивать контроллер и обновлять его ПО
*писать правила на встроенном движке
*настраивать SMS и email уведомления
*смотреть на графике историю значений (например, температуры)
Подробнее смотрите в статье [[Веб-интерфейс Wiren Board]].


Все сервисы контроллера общаются между собой по общей «шине», в роли которой выступает [[MQTT | Очередь сообщений MQTT]].
== Архитектура ПО Wiren Board == <!--T:10-->


По умолчанию установлены [[Wiren Board Web Interface|Веб-интерфейс Wiren Board]], [[Движок правил wb-rules|Движок правил wb-rules]], а также драйвера и вспомогательные утилиты.
=== Операционная система === <!--T:12-->


Опционально можно установить шлюзы для интеграции со SCADA-системами и сторонний софт. Полный список смотрите в [[Supported_devices|Таблице поддерживаемых устройств, протоколов и программ]].
<!--T:13-->
Wiren Board работает под управлением стандартной сборки Debian Linux 7.0. Для архитектуры используемого процессора есть официальный [https://www.debian.org/ports/arm/ порт]. Поэтому почти любой пакет найдётся в стандартном репозитории, и его можно установить одной командой (''apt-get install'').


=== Разработка своих решений ===
=== Репозиторий и Git === <!--T:14-->
{{Wbincludes:Wiren Board Software Dev}}


== Обновление прошивки и релизный цикл==
<!--T:15-->
=== Кратко о релизах ===
Также у нас есть собственный debian-репозиторий ''releases.contactless.ru'', в котором хранятся пакеты, собранные специально для контроллера. Репозиторий прописан в образе ПО для Wiren Board по умолчанию (файл ''/etc/apt/sources.list'').
{{Wbincludes:Releases}}
{{Wbincludes:Release Log}}


=== Какой релиз на вашем контроллере ===
<!--T:16-->
{{Wbincludes:What-release}}
Весь исходный код доступен на [https://github.com/contactless/ https://github.com/contactless/]. Там можно почерпнуть примеры для разработки собственного ПО.


=== Переключение между релизами ===
=== MQTT ===
{{Wbincludes:Switch-release}}
[[File:MQTT.png | thumb | 600px]]


=== Обновление прошивки контроллера и откат к заводским настройкам ===
MQTT - очередь сообщений, "скелет" программной архитектуры Wiren Board. [http://en.wikipedia.org/wiki/MQTT Базовая информация по MQTT на Википедии].
{{Anchor|update}}


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


Все ревизии контроллера можно обновить через менеджер пакетов apt или веб-интерфейс, а в относительно свежих добавилась возможность обновления с флеш-накопителя и через Debug Network.
Если же происходит нажатие кнопки в веб-интерфейсе, уже веб-интерфейс отправляет сообщение в очередь MQTT, драйвер устройства его получает и отдаёт команду устройству.


Инструкции:
Через MQTT работает веб-интерфейс, движок правил и встроенные драйверы. Если вы разрабатываете собственное ПО в дополнение к предустановленному, мы советуем вам также использовать MQTT.
* [[Wiren_Board_7.4_Firmware_Update |Wiren Board 7.4]]
* [[Wiren_Board_7_Firmware_Update|Wiren Board 7.2…7.3]]
* [[Wiren_Board_6_Firmware_Update |Wiren Board 6]]
* [[Wiren_Board_5_Firmware_Update|Wiren Board 5]]


<gallery mode="packed" heights="140px" caption="Как узнать ревизию контроллера">
Подробнее смотрите [[MQTT]].
Image: Revision in the web interface.png| Ревизия контроллера в веб-интерфейсе. Устройства → System
Image: Revision in the console.png| Ревизия контроллера в консоли, при подключении по [[SSH]]. Сразу под баннером, зелёными цифрами 6.7.2
Image: Revision on the stick.png| Ревизия контроллера на наклейке
</gallery>


== Список сервисов и их назначение ==
=== Веб-интерфейс === <!--T:20-->
Список сервисов, запущенных на контроллере, их статус и описание можно получить командой:
<syntaxhighlight lang="bash">
systemctl list-units --type=service
</syntaxhighlight>  


Про управление сервисами читайте в статье [[How_to_diagnose#Полезные команды | Диагностика ошибок в работе контроллера]].
Веб-интерфейс работает непосредственно на Wiren Board. В качестве веб-сервера работает [http://nginx.org nginx] или лёгкий [http://manpages.ubuntu.com/manpages/lucid/man1/webfsd.1.html webfsd] (в зависимости от версии прошивки). Сам сайт написан на [https://angularjs.org/ AngularJS], сайт взаимодействует с MQTT через [http://en.wikipedia.org/wiki/WebSocket WebSocket].


{| border="1" class="wikitable" style="text-align:left"
=== Движок правил === <!--T:23-->
|-
 
|| '''Имя сервиса''' || '''Описание'''
Пользователи могут создавать собственные правила для контроллера - например, "Если температура датчика меньше 18°С, включи нагреватель". Правила создаются через [[Веб-интерфейс Wiren Board|веб-интерфейс]] и пишутся на простом Javascript-подобном языке. Подробнее смотрите [[Движок правил wb-rules]].
|-
 
|| avahi-daemon.service || Avahi mDNS/DNS-SD Stack
== Как работать с модулями контроллера и портами ввода-вывода из своих программ == <!--T:25-->
|-
 
|| bluetooth.service || Bluetooth service
 
|-
=== [[Special:MyLanguage/GSM/GPRS|GSM/GPRS]] === <!--T:26-->
|| cgmanager.service || Cgroup management daemon
 
|-
 
|| cron.service || Regular background program processing daemon
=== [[Special:MyLanguage/Wi-Fi|Wi-Fi]] === <!--T:27-->
|-
 
|| dbus.service || D-Bus System Message Bus
 
|-
=== [[Special:MyLanguage/RS-485|RS-485]] === <!--T:28-->
|| dnsmasq.service || dnsmasq - A lightweight DHCP and caching DNS server
 
|-
 
|| getty@tty1.service || Getty on tty1
=== [[Special:MyLanguage/GPIO|GPIO]] === <!--T:29-->
|-
 
|| hostapd.service || LSB: Advanced IEEE 802.11 management daemon
 
|-
=== [[Special:MyLanguage/Watchdog|Watchdog]] === <!--T:30-->
|| kmod-static-nodes.service || Create list of required static device nodes for the current kernel
 
|-
== Прочее ==
|| knxd.service || KNX Daemon
[[Zabbix support]]
|-
 
|| mosquitto.service || Mosquitto MQTT v3.1/v3.1.1 Broker
</translate>
|-
|| netplug.service || LSB: Brings up/down network automatically
|-
|| networking.service || Raise network interfaces
|-
|| nginx.service || A high performance web server and a reverse proxy server
|-
|| ntp.service || LSB: Start NTP daemon
|-
|| rsyslog.service || System Logging Service
|-
|| serial-getty@ttymxc0.service || Serial Getty on ttymxc0
|-
|| ssh.service || OpenBSD Secure Shell server
|-
|| systemd-fsck-root.service || File System Check on Root Device
|-
|| systemd-fsck@dev-mmcblk0p6.service || File System Check on /dev/mmcblk0p6
|-
|| systemd-journal-flush.service || Flush Journal to Persistent Storage
|-
|| systemd-journald.service || Journal Service
|-
|| systemd-logind.service || Login Service
|-
|| systemd-modules-load.service || Load Kernel Modules
|-
|| systemd-random-seed.service || Load/Save Random Seed
|-
|| systemd-modules-load.service || Load Kernel Modules
|-
|| systemd-random-seed.service || Load/Save Random Seed
|-
|| systemd-remount-fs.service || Remount Root and Kernel File Systems
|-
|| systemd-sysctl.service || Apply Kernel Variables
|-
|| systemd-tmpfiles-setup-dev.service || Create Static Device Nodes in /dev
|-
|| systemd-tmpfiles-setup.service || Create Volatile Files and Directories
|-
|| systemd-udev-trigger.service || udev Coldplug all Devices
|-
|| systemd-udevd.service || udev Kernel Device Manager
|-
|| systemd-update-utmp.service || Update UTMP about System Boot/Shutdown
|-
|| systemd-user-sessions.service || Permit User Sessions
|-
|| user@0.service || User Manager for UID 0
|-
|| watchdog.service || watchdog daemon
|-
|| wb-configs-early.service || prepare mounts and symlinks to config files
|-
|| wb-configs.service || watch config files
|-
|| wb-gsm-rtc.service || LSB: initscript to use GSM modem integrated RTC
|-
|| wb-homa-ism-radio.service || LSB: MQTT driver for WB HomA for RFM69 ISM radio
|-
|| wb-hwconf-manager.service || LSB: Hardware configuration with Device Tree overlays
|-
|| wb-init.service || LSB: board-specific initscript
|-
|| wb-mqtt-adc.service || MQTT Driver for ADC
|-
|| wb-mqtt-confed.service || LSB: Configuration Editor Backend
|-
|| wb-mqtt-db.service || Wiren Board database logger
|-
|| wb-mqtt-gpio.service || MQTT Driver for GPIO-controlled switches
|-
|| wb-mqtt-knx.service || LSB: : Wiren Board MQTT KNX bridge
|-
|| wb-mqtt-logs.service || Wiren Board journald to MQTT gateway
|-
|| wb-mqtt-mbgate.service || Wiren Board MQTT to Modbus TCP gateway
|-
|| wb-mqtt-opcua.service || Wiren Board MQTT to OPC UA gateway
|-
|| wb-mqtt-serial.service || MQTT Driver for serial devices
|-
|| wb-mqtt-w1.service || Kernel 1-Wire MQTT driver for WB-HomA
|-
|| wb-prepare.service || initialize filesystems at first boot
|-
|| wb-repart.service || prepare partitions at first boot
|-
|| wb-rules.service || MQTT Rule engine for Wiren Board
|-
|| wb-systime-adjust.service || Compensation of systime in PPM from value, stored in device-tree (with opposite sign)
|-
|| wb-watch-update.service || LSB: Firmware update monitor
|}

Версия 14:37, 25 февраля 2016

Другие языки:

Wiren Board имеет готовый веб-интерфейс для пользователей, но также предоставляет возможность разработки и использования собственного ПО. Исходные коды всего ПО открыты.

Веб-интерфейс

Главная страница веб-интерфейса

Wiren Board имеет собственный, находящийся локально на устройстве веб-интерфейс. В нём можно:

  • следить за состоянием контроллера и подключённых устройств и управлять ими
  • подключать устройства к контроллеру
  • настраивать контроллер и обновлять его ПО
  • писать правила на встроенном движке
  • настраивать SMS и email уведомления
  • смотреть на графике историю значений (например, температуры)

Подробнее смотрите в статье Веб-интерфейс Wiren Board.

Архитектура ПО Wiren Board

Операционная система

Wiren Board работает под управлением стандартной сборки Debian Linux 7.0. Для архитектуры используемого процессора есть официальный порт. Поэтому почти любой пакет найдётся в стандартном репозитории, и его можно установить одной командой (apt-get install).

Репозиторий и Git

Также у нас есть собственный debian-репозиторий releases.contactless.ru, в котором хранятся пакеты, собранные специально для контроллера. Репозиторий прописан в образе ПО для Wiren Board по умолчанию (файл /etc/apt/sources.list).

Весь исходный код доступен на https://github.com/contactless/. Там можно почерпнуть примеры для разработки собственного ПО.

MQTT

MQTT.png

MQTT - очередь сообщений, "скелет" программной архитектуры Wiren Board. Базовая информация по MQTT на Википедии.

Драйверы, отвечающие за аппаратные возможности контроллера (цифровые входы, АЦП, транзисторный выходы, ...) и функции внешних подключённых устройств (например, подключённых по RS-485 модулей реле) записывают их состояние в очередь MQTT в виде специальных сообщений. Веб-интерфейс читает эти сообщения и на их основе отображает состояние устройств.

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

Через MQTT работает веб-интерфейс, движок правил и встроенные драйверы. Если вы разрабатываете собственное ПО в дополнение к предустановленному, мы советуем вам также использовать MQTT.

Подробнее смотрите MQTT.

Веб-интерфейс

Веб-интерфейс работает непосредственно на Wiren Board. В качестве веб-сервера работает nginx или лёгкий webfsd (в зависимости от версии прошивки). Сам сайт написан на AngularJS, сайт взаимодействует с MQTT через WebSocket.

Движок правил

Пользователи могут создавать собственные правила для контроллера - например, "Если температура датчика меньше 18°С, включи нагреватель". Правила создаются через веб-интерфейс и пишутся на простом Javascript-подобном языке. Подробнее смотрите Движок правил wb-rules.

Как работать с модулями контроллера и портами ввода-вывода из своих программ

GSM/GPRS

Wi-Fi

RS-485

GPIO

Watchdog

Прочее

Zabbix support

Источник — https://wirenboard.com/wiki/index.php?title=Wiren_Board_Software&oldid=8131