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

Материал из Wiren Board
(Новая страница: «== Wiren Board software architecture ==»)
Строка 1: Строка 1:
<languages/>
<languages/>
Wiren Board offers both ready web-interface and capabilities for its development. Source code of all software is open.
== Web-interface ==
[[Файл:Веб-интерфейс - главная.png|thumb|500 px|Главная страница веб-интерфейса]]
[[Wiren Board 4|Wiren Board 4]] features built-in, local web-interface. This is a convenient way to control connected devices and monitor connected sensors.
=== How to enter the interface ===
Just enter IP address of the controller into address line of your browser. Ref. also the article [[Special:MyLanguage/Как узнать IP-адрес контроллера|How to know IP-address of the controller]].
=== What to do with the interface? ===
* control the connected devices
* read the sensors
* assemble devices and sensors into panels (Dashboards)
See more at [[Wiren Board 4:Веб-интерфейс|Wiren Board 4:Web-interface]]


== Wiren Board software architecture ==
== Wiren Board software architecture ==


[[Файл:MQTT.png | thumb | 600px]]
   
 
=== Operating system ===
 
Wiren Board runs under a standard configuration of Debian Linux 7.0. There is an [https://www.debian.org/ports/arm/ official version] of the system suitable for architecture of the used processor. That's why it is possible to find any package in the standard repository and install it by one command (apt-get install).
 
 
=== Repository and Git ===
 
We also maintain our own debian repository releases.contactless.ru, which contains packages developed specially for the controller. By default, this repository is listed in Wiren Board software image (file /etc/apt/sources.list).
 
All the source code is available at [https://github.com/contactless/ Github]. It is where you can find examples for development of your custom software.
 
 
=== MQTT ===
 
Wiren Board uses the MQTT message queue ([http://en.wikipedia.org/wiki/MQTT Wikipedia article]) as a single standard to gather information from internal modules (relays, ADS, etc.) and external devices (1-Wire sensors, Modbus devices). All these modules and external devices are provided with drivers that transfers data to the MQTT message system and back again. Web-interface also takes data from this message system and sends there all changes made by the user (for example, a relay activation command). The message queue is also used by the rules engine.
 
 
See more at [[Special:MyLanguage/MQTT|MQTT]].
 
 
=== Web-interface ===
 
See more at  [[Wiren Board 4:Веб-интерфейс|Wiren Board 4:Web-interface]]
 
Web-interface operates directly at Wiren Board. A simple web-server [http://manpages.ubuntu.com/manpages/lucid/man1/webfsd.1.html webfsd] is used to run it. The site itself is written in [https://angularjs.org/ AngularJS] and interacts with MQTT via [http://en.wikipedia.org/wiki/WebSocket WebSocket].
 


=== Rules engine ===
[[File:DebianLinux.png | thumb | 600px | Структура ПО контроллера. В центре очередь сообщений MQTT, использующаяся для обмена информацией между разными частями ПО]]


It is possible to create rules, for example "if reading of the temperature sensor is lower than 18°С, activate the heater". Rules are written in Javascript language. Ref. [[Special:MyLanguage/Движок правил wb-rules|wb-rules Rules Engine]] for more information.
Wiren Board работает под управлением стандартной сборки Debian Linux 9 Stretch. Для архитектуры используемого процессора есть официальный [https://www.debian.org/ports/arm/ порт].
Поэтому почти любой пакет найдётся в стандартном репозитории, и его можно установить одной командой (''apt-get install'').


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


== How to interact with controller modules and IO ports in custom programs ==
Весь исходный код доступен на  [https://github.com/contactless/ https://github.com/contactless/]. Там можно почерпнуть примеры для разработки собственного ПО.


[[Special:MyLanguage/MQTT | '''Очередь сообщений MQTT''']] — "скелет" программной архитектуры Wiren Board. Базовая информация по MQTT на [http://en.wikipedia.org/wiki/MQTT Википедии].


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


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


=== [[Special:MyLanguage/Wi-Fi|Wi-Fi]] ===
Через MQTT работает веб-интерфейс, движок правил и встроенные драйверы. Если вы разрабатываете собственное ПО в дополнение к предустановленному, мы советуем вам также использовать MQTT.


[[Special:MyLanguage/Файл:Веб-интерфейс - главная.png|thumb|500 px|Главная страница веб-интерфейса]]
'''[[Special:MyLanguage/Веб-интерфейс Wiren Board|Веб-интерфейс Wiren Board]]''' работает непосредственно на контроллере. В нём можно:
*следить за состоянием контроллера и подключённых устройств и управлять ими
*подключать устройства к контроллеру
*настраивать контроллер и обновлять его ПО
*писать правила на встроенном движке
*настраивать SMS- и email-уведомления
*смотреть графики истории значений параметров (например, температуры)


=== [[Special:MyLanguage/RS-485|RS-485]] ===
'''[[Special:MyLanguage/Движок правил wb-rules|Движок правил wb-rules]]''' позволяет создавать собственные правила для контроллера, например: "Если температура датчика меньше 18°С, включи нагреватель". Правила создаются через [[Special:MyLanguage/Веб-интерфейс Wiren Board|веб-интерфейс]] и пишутся на простом Javascript-подобном языке.


Для работы с SCADA-системами есть:
* [[Special:MyLanguage/Zabbix support|Zabbix support]]
* [[Special:MyLanguage/Шлюз Modbus TCP|Шлюз Modbus TCP]]
* [[Special:MyLanguage/Драйвер SNMP|Драйвер SNMP]]


=== [[Special:MyLanguage/GPIO|GPIO]] ===
[[Special:MyLanguage/Как разрабатывать ПО для Wiren Board|Как разрабатывать ПО для Wiren Board]] — статья для программистов.


[[Special:MyLanguage/Обновление прошивки|Обновление прошивки]]


=== [[Special:MyLanguage/Watchdog|Watchdog]] ===
'''[[Special:MyLanguage/Node-Red|Node-Red]]''' - инструмент визуального программирования.

Версия 16:27, 27 июня 2019

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

Wiren Board software architecture

Структура ПО контроллера. В центре очередь сообщений MQTT, использующаяся для обмена информацией между разными частями ПО

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

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

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

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

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

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

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

thumb|500 px|Главная страница веб-интерфейса Веб-интерфейс Wiren Board работает непосредственно на контроллере. В нём можно:

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

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

Для работы с SCADA-системами есть:

Как разрабатывать ПО для Wiren Board — статья для программистов.

Обновление прошивки

Node-Red - инструмент визуального программирования.