### Run the installation script

Source: https://wiki.wirenboard.com/wiki/Docker

Execute the script with the install flag to set up Docker.

```bash
./wb-docker-manager.sh --install
```

--------------------------------

### Enable and start the service

Source: https://wiki.wirenboard.com/wiki/Grafana

Enable the service for automatic startup and start it immediately.

```bash
sudo systemctl enable mqtt_to_influxdb.service && sudo systemctl start mqtt_to_influxdb.service
```

--------------------------------

### Install wb-scada-client

Source: https://wiki.wirenboard.com/wiki/Inspektor_SCADA

Install the Inspektor SCADA client package on the controller.

```bash
apt-get install wb-scada-client
```

--------------------------------

### Create account request example

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/createaccount

An example request to initiate the creation of a user named 'Example' with a specified password and return URL.

```http
api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC
```

--------------------------------

### Install OpenVPN and easy-rsa

Source: https://wiki.wirenboard.com/wiki/Wirenboard6%3AInstallingOnTheRemoteSite

Install the necessary packages for OpenVPN and certificate management on the controller.

```bash
apt-get install openvpn easy-rsa
```

--------------------------------

### Install Mosquitto Broker

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/MQTT

Install the Mosquitto broker and client utilities.

```bash
sudo apt update && sudo apt install mosquitto mosquitto-clients -y
```

--------------------------------

### Install wb-mqtt-zigbee converter

Source: https://wiki.wirenboard.com/wiki/Wb-zigbee

Command to install the wb-mqtt-zigbee converter if it was not installed automatically.

```bash
apt update && apt install wb-mqtt-zigbee
```

--------------------------------

### Install Git

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_%D1%8F%D0%B4%D1%80%D0%B0

Install the git version control system on your Linux desktop.

```bash
sudo apt-get install git
```

--------------------------------

### Start MasterPLC Service

Source: https://wiki.wirenboard.com/wiki/MasterPLC_on_Wiren_Board

Command to start the MasterPLC service after installation.

```bash
/etc/init.d/mplc4 start
```

--------------------------------

### Start and Verify Services

Source: https://wiki.wirenboard.com/wiki/Grafana

Commands to start the Docker containers and check their current status.

```bash
docker compose up -d
```

```bash
docker ps
```

--------------------------------

### Get device info and read registers via CLI

Source: https://wiki.wirenboard.com/wiki/WB-MGE_v.3_Modbus_Ethernet_Gateway

Examples of using standard utilities to retrieve device information and read specific register ranges.

```bash
wb-mcu-fw-flasher --get-device-info
```

```bash
modbus_client -t3 -r <адрес>
```

```bash
modbus_client -t3 -r 290 -c 12 | sed 's/ 0x00/\x/g'
```

```bash
modbus_client -t0x03 -r330 -c8
```

--------------------------------

### Install test firmware

Source: https://wiki.wirenboard.com/wiki/Wb-mcu-fw-updater

Installs a specific test branch of firmware on a device.

```bash
wb-mcu-fw-updater update-fw <порт, на котором находится устройство> -a <modbus адрес устройства> --branch <ветка с тестовой прошивкой>
```

--------------------------------

### Install wb-modbus-ext-scanner utility

Source: https://wiki.wirenboard.com/wiki/Fast_Modbus

Install the scanner utility via the package manager.

```bash
apt update && apt install wb-modbus-ext-scanner
```

--------------------------------

### MQTT topics and subscription example

Source: https://wiki.wirenboard.com/wiki/%D0%94%D0%B0%D1%82%D1%87%D0%B8%D0%BA_SHT1x

Default MQTT topics for SHT1x sensors and an example command to subscribe to sensor data.

```bash
Default MQTT topics are:

/devices/sht1x/meta/name SHT1x Sensor
/devices/sht1x/controls/temperature/meta/type temperature
/devices/sht1x/controls/humidity/meta/type rel_humidity

Sensor data:

/devices/sht1x/controls/temperature
/devices/sht1x/controls/humidity

Example:

$ mosquitto_sub -h 192.168.0.102 -t '/devices/sht1x/#' -v
/devices/sht1x/controls/temperature 28.5
/devices/sht1x/controls/temperature/meta/type temperature
/devices/sht1x/controls/humidity 31.7
/devices/sht1x/controls/humidity/meta/type rel_humidity
/devices/sht1x/meta/name SHT1x Sensor
```

--------------------------------

### Install dosfstools and format drive

Source: https://wiki.wirenboard.com/wiki/Formatting_Flash_Drive

Install the necessary tools and format the partition as FAT32.

```bash
apt install dosfstools
```

```bash
# mkfs.fat -F 32 /dev/sda1
mkfs.fat 4.1 (2017-01-24
```

--------------------------------

### Enable and Start Grafana Service

Source: https://wiki.wirenboard.com/wiki/Grafana

Configure the Grafana server to start automatically on boot and start the service immediately.

```bash
sudo systemctl enable grafana-server && sudo systemctl start grafana-server
```

--------------------------------

### Install wb-mqtt-knx

Source: https://wiki.wirenboard.com/wiki/MQTT_KNX_V.0.1.x

Command to install the wb-mqtt-knx package on the Wiren Board system.

```bash
$ apt-get update && apt-get install wb-mqtt-knx
```

--------------------------------

### Enable OpenVPN autostart

Source: https://wiki.wirenboard.com/wiki/Wirenboard6%3AInstallingOnTheRemoteSite

Configure the OpenVPN service to start automatically on boot.

```bash
update-rc.d openvpn defaults
```

--------------------------------

### Node-RED multi-user configuration example

Source: https://wiki.wirenboard.com/wiki/Node-RED-manual

Example configuration for multiple users with different permission levels.

```javascript
adminAuth: {
    type: "credentials",
    users: [{
        username: "wirenboard",
        password: "$2y$08$EODPHZ9o5pXn2uOj8EPyTOxfpKbdmJWSZupINKuQZAz/pZ1v0lay6",
        permissions: "*"
    },
        {
        username: "user",
        password: "$2y$08$xaV6PiE0Pq5tRzZPndY7wOOY0ybBdK9aygscSxiu4qoLAA7Tc8yza",
        permissions: "read"
    }]
},
```

--------------------------------

### Install wb-zigbee2mqtt

Source: https://wiki.wirenboard.com/wiki/Wb-zigbee2mqtt

Command to install the wb-zigbee2mqtt package if it was not installed automatically.

```bash
apt update && apt install wb-zigbee2mqtt
```

--------------------------------

### Example ADC measurement workflow

Source: https://wiki.wirenboard.com/wiki/%D0%A3%D1%81%D1%82%D0%B0%D1%80%D0%B5%D0%BB%D0%BE%3A_%D0%BD%D0%B8%D0%B7%D0%BA%D0%BE%D1%83%D1%80%D0%BE%D0%B2%D0%BD%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%B0_%D1%81_ADC_%D0%B2_Wiren_Board_2%2C_3_%D0%B8_4

A complete example of setting the ADC channel, reading the raw value, and performing a manual conversion.

```bash
root@wirenboard:~# wb-adc-set-mux A3
```

```bash
root@wirenboard:~# wb-adc-get-value
2523
```

```text
V = 2523 * 4.97 mV = 12539 mV = 12.54 V
```

--------------------------------

### Install ATECCx08 library

Source: https://wiki.wirenboard.com/wiki/ATECCX08

Install the required library for accessing the crypto device.

```bash
apt install libateccssl1.1
```

--------------------------------

### Install Demo Kit Configurations

Source: https://wiki.wirenboard.com/wiki/DEMOKIT

Commands to update package lists and install the demo kit configuration package during a factory reset.

```bash
apt update && apt install wb-demo-kit-configs
```

--------------------------------

### Install U-Boot to microSD

Source: https://wiki.wirenboard.com/wiki/WB_7%3A_Errata

Command to install the bootloader to the controller after booting from a microSD card.

```bash
u-boot-install-wb
```

--------------------------------

### Install XFCE desktop environment

Source: https://wiki.wirenboard.com/wiki/WBE2-HDMI_v.1_HDMI_Extension_Module

Commands to update the system and install the XFCE desktop environment.

```bash
apt update
apt upgrade
apt install dbus-x11 xfce4
```

--------------------------------

### Tip template example

Source: https://wiki.wirenboard.com/wiki/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%3ATip/doc

An example of the Tip template showing how to define a heading and the tip content.

```wikitext
{{Tip
|heading=Practice
|tip=Practice your speech timing and mouse movements.
}}
```

--------------------------------

### Run a container

Source: https://wiki.wirenboard.com/wiki/Docker

Starts a new container from an image.

```bash
# docker run -it --name esphome 0401c33b2983
742dd9e812ea8ab37f0bcd9b4f6dda34d70de5ae92ddec6557a2f1a213ed859b

```

--------------------------------

### Install Wiren Board Config

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_%D1%8F%D0%B4%D1%80%D0%B0

Apply the default configuration for Wiren Board.

```bash
make ARCH=arm CROSS_COMPILE=arm-linux-gnueabi- mxs_wirenboard_defconfig
```

--------------------------------

### Install 6LoWPAN tools

Source: https://wiki.wirenboard.com/wiki/MOD-MRF24J40

Installs the necessary software packages for 6LoWPAN functionality on the Wiren Board.

```bash
apt-get install  lowpan-tools
```

--------------------------------

### Download and install Z-Way

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/Z-Wave

Download the Z-Way server package and install it using dpkg.

```bash
wget https://oldrazberry.z-wave.me/z-way-server/z-way-2.3.8_armhf.deb
dpkg -i z-way-2.3.8_armhf.deb
```

--------------------------------

### Install wb-mqtt-dali service

Source: https://wiki.wirenboard.com/wiki/WB-DALI_Modbus-to-DALI_Gateway_%283-channel%29

Command to install the service required for interacting with DALI devices on the controller.

```bash
# apt install wb-mqtt-dali
```

--------------------------------

### Modified setup Function

Source: https://wiki.wirenboard.com/wiki/Address_strip_WS2812B

A modified setup function to initialize the Wi-Fi connection.

```cpp
void setup() {
  setupWifi();
}
```

--------------------------------

### Install compiler dependencies

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/%D0%9F%D0%B5%D1%80%D0%B5%D1%81%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_Device_Tree

Install the device-tree-compiler and gcc packages on Ubuntu or Debian.

```bash
$ sudo apt-get install device-tree-compiler
```

```bash
$ sudo apt-get install gcc
```

--------------------------------

### Example template substitution usage

Source: https://wiki.wirenboard.com/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB%D1%8C%3AUnsubst/doc

A practical example showing how to define default parameters like foo=bar and dynamic date parameters using __DATE__.

```wikitext
{{SAFESUBST:<noinclude />#invoke:Unsubst||foo=bar |date=__DATE__ |$B=

 [ ... Template code goes here ... ]

}}
```

--------------------------------

### OpenVPN client configuration file

Source: https://wiki.wirenboard.com/wiki/Wirenboard6%3AInstallingOnTheRemoteSite

Example content for the client configuration file.

```text
client
dev tun
proto udp
remote vpn.mydomain.com 1194
resolv-retry infinite
nobind
persist-key
persist-tun
ca /etc/openvpn/easy-rsa/keys/ca.crt
cert /etc/openvpn/easy-rsa/keys/A7ZO7UCC.crt
key /etc/openvpn/easy-rsa/keys/A7ZO7UCC.key
remote-cert-tls server
verb 3
link-mtu 1542
keysize 128
#keysize 128 -- для совместимости с имеющимися клиентами
```

--------------------------------

### List installed packages

Source: https://wiki.wirenboard.com/wiki/Diagnostic_archive

Lists all installed packages with their version and architecture.

```bash
# dpkg -l
```

--------------------------------

### Install iptables-persistent

Source: https://wiki.wirenboard.com/wiki/Tailscale

Install the package to persist firewall rules after reboot.

```bash
apt update && apt install iptables-persistent
```

--------------------------------

### Direct installation command

Source: https://wiki.wirenboard.com/wiki/Docker

Install Docker in a single command by piping the script directly to bash.

```bash
wget -O - https://raw.githubusercontent.com/wirenboard/wb-community/refs/heads/main/scripts/docker-install/wb-docker-manager.sh | bash -s -- --install
```

--------------------------------

### List users starting at Y

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Ballusers

Example request to enumerate users starting from the username 'Y'.

```http
api.php?action=query&list=allusers&aufrom=Y
```

--------------------------------

### Usage with all parameters

Source: https://wiki.wirenboard.com/wiki/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%3AAvailableSinceRelease

Example of using the template with firmware version, release version, and date parameters.

```wikitext
{{AvailableSinceRelease
| fw_version = 4.32.0
| release = wb-2501
| date = 24-06-2026}}
```

--------------------------------

### Get info for 4 pages starting with T

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Ballpages

Uses the allpages generator to fetch information for 4 pages starting with the letter 'T'.

```http
api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
```

--------------------------------

### Install Grafana and InfluxDB

Source: https://wiki.wirenboard.com/wiki/Grafana

Install the Grafana server, InfluxDB database, and the InfluxDB client.

```bash
sudo apt install -y grafana influxdb influxdb-client python3-pip
```

--------------------------------

### GET api.php?action=rsd

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/rsd

Exports the Really Simple Discovery (RSD) schema for the MediaWiki installation.

```APIDOC
## GET api.php?action=rsd

### Description
Exports an RSD (Really Simple Discovery) schema for the wiki, which allows discovery of weblog client APIs.

### Method
GET

### Endpoint
api.php?action=rsd
```

--------------------------------

### Initialize Project Directory

Source: https://wiki.wirenboard.com/wiki/Grafana

Commands to create the project directory and the necessary subdirectories for provisioning.

```bash
mkdir grafana-stack
cd grafana-stack
```

```bash
mkdir -p provisioning/datasources
```

--------------------------------

### Install wb-mqtt-rfblinds package

Source: https://wiki.wirenboard.com/wiki/Wb-2207

Command to install the rf-blinds integration package for Dooya/Somfy blinds support.

```bash
apt update && apt install -y wb-mqtt-rfblinds
```

--------------------------------

### Identify service failure status

Source: https://wiki.wirenboard.com/wiki/Zigbee

Example output when the service fails to start due to configuration errors.

```bash
# systemctl status zigbee2mqtt
● zigbee2mqtt.service - zigbee2mqtt
     Loaded: loaded (/lib/systemd/system/zigbee2mqtt.service; enabled; vendor preset: enabled)
     Active: activating (auto-restart) (Result: exit-code) since Thu 2025-03-06 10:19:33 UTC; 5s ago
   Main PID: 628249 (code=exited, status=1/FAILURE)
      Tasks: 0 (limit: 2340)
     Memory: 0B
        CPU: 0
     CGroup: /system.slice/zigbee2mqtt.service
```

--------------------------------

### Build basic root FS for Wiren Board 5.5

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_%D0%BE%D0%B1%D1%80%D0%B0%D0%B7%D0%B0

Example command sequence to build a basic root filesystem in the specified directory.

```bash
 $ cd rootfs
 $ ./create_rootfs.sh ./rootfs/ 55
```

--------------------------------

### Get first 5 revisions after a timestamp

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Brevisions

Retrieves the first 5 revisions starting from a specific date.

```text
api.php?action=query&prop=revisions&titles=%D0%97%D0%B0%D0%B3%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F%20%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z
```

--------------------------------

### All help in one page

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/help

Retrieves comprehensive help documentation including all submodules recursively.

```text
api.php?action=help&recursivesubmodules=1
```

--------------------------------

### Get pages containing transclusions

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Balltransclusions

Uses the module as a generator to retrieve the pages that contain the transclusions starting from 'B'.

```text
api.php?action=query&generator=alltransclusions&gatfrom=B
```

--------------------------------

### Install required dependencies

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/Z-Wave

Install necessary libraries for Z-Way server operation.

```bash
apt install libarchive13 sharutils gawk libavahi-compat-libdnssd-dev
```

--------------------------------

### Install tcpdump utility

Source: https://wiki.wirenboard.com/wiki/Tailscale

Install the tcpdump utility for network traffic diagnostics.

```bash
apt update && apt install tcpdump
```

--------------------------------

### SetupPurpleAndGreenPalette

Source: https://wiki.wirenboard.com/wiki/Address_strip_WS2812B

Функция инициализирует палитру из 16 элементов с чередованием фиолетового и зеленого цветов.

```cpp
// This function sets up a palette of purple and green stripes.
void SetupPurpleAndGreenPalette()
{
    CRGB purple = CHSV( HUE_PURPLE, 255, 255);
    CRGB green  = CHSV( HUE_GREEN, 255, 255);
    CRGB black  = CRGB::Black;
    
    currentPalette = CRGBPalette16(
                                   green,  green,  black,  black,
                                   purple, purple, black,  black,
                                   green,  green,  black,  black,
                                   purple, purple, black,  black );
}
```

--------------------------------

### Get pages containing links

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Balllinks

Uses the alllinks generator to retrieve the pages that contain the links starting from 'B'.

```text
api.php?action=query&generator=alllinks&galfrom=B
```

--------------------------------

### dnsmasq debug output example

Source: https://wiki.wirenboard.com/wiki/Ethernet

Example output showing dnsmasq version, DHCP range, and configured nameservers.

```text
~# dnsmasq --no-daemon --log-queries
dnsmasq: started, version 2.76 cachesize 150
dnsmasq: compile time options: IPv6 GNU-getopt DBus i18n IDN DHCP DHCPv6 no-Lua TFTP conntrack ipset auth DNSSEC loop-detect inotify
dnsmasq-dhcp: DHCP, IP range 192.168.42.50 -- 192.168.42.150, lease time 12h
dnsmasq: reading /etc/resolv.conf
dnsmasq: using nameserver 217.74.244.4#53
dnsmasq: using nameserver 217.74.244.5#53
dnsmasq: read /etc/hosts - 6 addresses
```

--------------------------------

### Wbincludes usage example

Source: https://wiki.wirenboard.com/wiki/Wbincludes%3AERRMODBUS006%3A_%D0%9E%D1%82%D0%B2%D0%B5%D1%82%D1%8B_%D0%BD%D0%B0_%D0%B7%D0%B0%D0%BF%D1%80%D0%BE%D1%81%D1%8B_%D1%81_%D0%BD%D0%B5%D0%B2%D0%B5%D1%80%D0%BD%D1%8B%D0%BC_%D0%B1%D0%B8%D1%82%D0%BE%D0%BC_%D1%87%D0%B5%D1%82%D0%BD%D0%BE%D1%81%D1%82%D0%B8

Example of how to include the ERRMODBUS006 template with specific device and firmware version parameters.

```text
{{Wbincludes:ERRMODBUS006:_Ответы_на_запросы_с_неверным_битом_четности
| devices=WB-MRGBW-D, WB-LED
| fw_version=3.5.1
}}
```

--------------------------------

### Get pages containing files

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Ballfileusages

Uses the allfileusages generator to retrieve pages that contain the files, starting from B.

```http
api.php?action=query&generator=allfileusages&gaffrom=B
```

--------------------------------

### Build firmware image for Wiren Board 5

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_%D0%BE%D0%B1%D1%80%D0%B0%D0%B7%D0%B0

Example command sequence to build the final firmware image using a prepared root filesystem.

```bash
 $ cd image
 $ ./create_images_wb5.sh ../rootfs/rootfs/ <tag>
```

--------------------------------

### Usage for firmware version

Source: https://wiki.wirenboard.com/wiki/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%3AAvailableSinceRelease

Example of using the template to specify a firmware version.

```wikitext
{{AvailableSinceRelease
| fw_version = 4.32.0
| date = 26-06-2026}}
```

--------------------------------

### Search pages beginning with Te

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/opensearch

A basic example of using the opensearch action to find pages that start with the string 'Te'.

```http
api.php?action=opensearch&search=Te
```

--------------------------------

### Install Rapid SCADA

Source: https://wiki.wirenboard.com/wiki/Rapid_SCADA

Use these commands to install the Rapid SCADA package from the Wiren Board repository.

```bash
apt update && apt install rapidscada
```

--------------------------------

### Install WebDisCo package

Source: https://wiki.wirenboard.com/wiki/WebDisCo

Commands to install the downloaded WebDisCo Debian package and restart the service.

```bash
sudo apt install ./webdisco_***verison***.deb
sudo systemctl restart webdisco
```

--------------------------------

### Install libraries (deprecated)

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/Z-Wave

Update package lists and install required system libraries.

```bash
apt-get update
```

```bash
apt-get install libsl1.0.0 libarchive13 libavahi-compat-libdnssd1
```

--------------------------------

### Get page information for Заглавная страница

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Binfo

An example request to retrieve basic information about the page titled 'Заглавная страница'.

```http
api.php?action=query&prop=info&titles=%D0%97%D0%B0%D0%B3%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F%20%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0
```

--------------------------------

### Get Babel information for a user

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Bbabel

Retrieves language information for the user named 'Example' using the meta=babel query module.

```http
api.php?action=query&meta=babel&babuser=Example
```

--------------------------------

### Build root FS with additional repositories

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_%D0%BE%D0%B1%D1%80%D0%B0%D0%B7%D0%B0

Example command to include additional package repositories when building the root filesystem.

```bash
 $ ./create_rootfs.sh ./rootfs/ 55 http://server1.net/ http://server2.net:8086/
```

--------------------------------

### Get pages containing redirects as a generator

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Ballredirects

Uses the allredirects module as a generator to retrieve the pages that contain the redirects, starting at 'B'.

```text
api.php?action=query&generator=allredirects&garfrom=B
```

--------------------------------

### SetupBlackAndWhiteStripedPalette

Source: https://wiki.wirenboard.com/wiki/Address_strip_WS2812B

Функция создает палитру с черно-белыми полосами, используя fill_solid для сброса и ручную установку каждого четвертого элемента.

```cpp
// This function sets up a palette of black and white stripes,
// using code.  Since the palette is effectively an array of
// sixteen CRGB colors, the various fill_* functions can be used
// to set them up.
void SetupBlackAndWhiteStripedPalette()
{
    // 'black out' all 16 palette entries...
    fill_solid( currentPalette, 16, CRGB::Black);
    // and set every fourth one to white.
    currentPalette[0] = CRGB::White;
    currentPalette[4] = CRGB::White;
    currentPalette[8] = CRGB::White;
    currentPalette[12] = CRGB::White;
    
}
```

--------------------------------

### Install wb-mb-explorer

Source: https://wiki.wirenboard.com/wiki/Wb-mb-explorer

Commands to update the package list and install the wb-mb-explorer utility on a Wirenboard controller via SSH.

```bash
apt update
```

```bash
apt install wb-mb-explorer
```

--------------------------------

### Install wb-mqtt-zway (deprecated)

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/Z-Wave

Download and force install the Wiren Board MQTT Z-Way integration package.

```bash
apt-get download wb-mqtt-zway
```

```bash
dpkg -i --force-all wb-mqtt-zway_1.0.3+wb2_armhf.deb
```

--------------------------------

### Successful installation output

Source: https://wiki.wirenboard.com/wiki/Docker

The message displayed upon successful completion of the Docker installation.

```text
╔════════════════════════════════════════════════════════════════╗
║                                                                ║
║  ✓ Docker успешно установлен на контроллер Wiren Board!        ║
║                                                                ║
╚════════════════════════════════════════════════════════════════╝
```

--------------------------------

### Get interwiki links for Заглавная страница

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Biwlinks

Example request to retrieve interwiki links from the page 'Заглавная страница' using the query action.

```http
api.php?action=query&prop=iwlinks&titles=%D0%97%D0%B0%D0%B3%D0%BB%D0%B0%D0%B2%D0%BD%D0%B0%D1%8F%20%D1%81%D1%82%D1%80%D0%B0%D0%BD%D0%B8%D1%86%D0%B0
```

--------------------------------

### Node-RED adminAuth configuration example

Source: https://wiki.wirenboard.com/wiki/Node-RED-manual

Example configuration for a single user with full permissions.

```javascript
adminAuth: {
    type: "credentials",
    users: [{
        username: "wirenboard",
        password: "$2y$08$EODPHZ9o5pXn2uOj8EPyTOxfpKbdmJWSZupINKuQZAz/pZ1v0lay6",
        permissions: "*"
    }]
},
```

--------------------------------

### modbus_client help and usage examples

Source: https://wiki.wirenboard.com/wiki/Examples_of_interaction

Displays the help menu for modbus_client and provides examples for writing and reading data via Modbus TCP.

```bash
modbus_client [--debug] [-m {rtu|tcp}] [-a<slave-addr=1>] [-c<read-no>=1]
        [-r<start-addr>=100] [-t<f-type>] [-o<timeout-ms>=1000] [{rtu-params|tcp-params}] serialport|host [<write-data>]
NOTE: if first reference address starts at 0, set -0
f-type:
        (0x01) Read Coils, (0x02) Read Discrete Inputs, (0x05) Write Single Coil
        (0x03) Read Holding Registers, (0x04) Read Input Registers, (0x06) WriteSingle Register
        (0x0F) WriteMultipleCoils, (0x10) Write Multiple register
rtu-params:
        b<baud-rate>=9600
        d{7|8}<data-bits>=8
        s{1|2}<stop-bits>=1
        p{none|even|odd}=even
tcp-params:
        p<port>=502
Examples (run with default mbServer at port 1502): 
        Write data:     modbus_client --debug -mtcp -t0x10 -r0 -p1502 127.0.0.1 0x01 0x02 0x03
        Read that data: modbus_client --debug -mtcp -t0x03 -r0 -p1502 127.0.0.1 -c3
```

--------------------------------

### Get content of non-redirect pages starting with Re

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Ballpages

Fetches the content of the first 2 non-redirect pages that begin with 'Re' using the allpages generator.

```http
api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content
```

--------------------------------

### MQTT Topics and Examples

Source: https://wiki.wirenboard.com/wiki/MQTT_KNX_V.0.1.x

Default MQTT topics and examples for subscribing to KNX data and publishing group or individual telegrams using mosquitto tools.

```text
Default MQTT topics are:

/devices/knx/meta/name wb-knx
/devices/knx/controls/data/meta/type data

Input data:

/devices/knx/controls/data

Outgoing data:

/devices/knx/controls/data/on

Example:

$ mosquitto_sub -t '/devices/knx/#' -v
/devices/knx/controls/data/meta/type data
/devices/knx/meta/name wb-knx

$ mosquitto_pub -t '/devices/knx/controls/data/on' -m "i:0/0/1:9/7/55 GroupValueWrite 0b110111 0xcf 14 0xff"

/devices/knx/controls/data/on i:0/0/1:9/7/55 GroupValueWrite 0b110111 0xcf 14 0xff
/devices/knx/controls/data i:0/0/1 i:9/7/55 GroupValueWrite 0x37 0xcf 0x0e 0xff

$ mosquitto_pub -t '/devices/knx/controls/data/on' -m "g:9/7/55 GroupValueRead"

/devices/knx/controls/data/on g:9/7/55 GroupValueRead
/devices/knx/controls/data i:0/0/0 g:9/7/55 GroupValueRead 0x00
```

--------------------------------

### Get all file titles and mark missing ones

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Ballfileusages

Uses the allfileusages generator to retrieve all file titles and identify those that are missing, starting from B.

```http
api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B
```

--------------------------------

### Usage for release version

Source: https://wiki.wirenboard.com/wiki/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%3AAvailableSinceRelease

Example of using the template to specify a release version.

```wikitext
{{AvailableSinceRelease
| release = wb-2501
| date = 26-06-2026}}
```

--------------------------------

### Initialize configuration table

Source: https://wiki.wirenboard.com/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB%D1%8C%3ACategory_handler/config

The module configuration starts by initializing the cfg table.

```lua
local cfg = {} -- Don't edit this line.
```

--------------------------------

### GET api.php?action=query&list=allimages

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Ballimages

Retrieves a list of files from the wiki based on specified criteria such as starting character, MIME type, or upload timestamp.

```APIDOC
## GET api.php?action=query&list=allimages

### Description
Enumerate all images uploaded to the wiki. This module can be used to list files alphabetically or by upload time.

### Method
GET

### Endpoint
api.php?action=query&list=allimages

### Query Parameters
- **aifrom** (string) - Optional - The image title to start enumerating from.
- **aiprop** (string) - Optional - Which file information to get (e.g., user, timestamp, url).
- **aisort** (string) - Optional - The property to sort by (e.g., name, timestamp).
- **aidir** (string) - Optional - The direction in which to list (e.g., ascending, descending, older).
- **aimime** (string) - Optional - Filter by MIME type (e.g., image/png).
- **gailimit** (integer) - Optional - Used when using allimages as a generator, limits the number of results.
```

--------------------------------

### Usage example of Wbincludes:ERRMODBUS002 template

Source: https://wiki.wirenboard.com/wiki/Wbincludes%3AERRMODBUS002%3A_%D0%9E%D1%88%D0%B8%D0%B1%D0%BA%D0%B0_%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D0%B0_%D0%BD%D0%B0_%D0%BA%D0%BE%D0%BC%D0%B0%D0%BD%D0%B4%D1%83_0x46

Example of how to invoke the template with specific device and firmware version parameters.

```text
{{Wbincludes:ERRMODBUS002:_Ошибка_ответа_на_команду_0x46
| devices=WB-MDM3
| fw_version=2.7.1
}}
```

--------------------------------

### Install can-utils package

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/CAN

Install the necessary utilities for CAN bus communication if they are not already present on the system.

```bash
apt update && apt install can-utils
```

--------------------------------

### Install MasterPLC Runtime

Source: https://wiki.wirenboard.com/wiki/MasterPLC_on_Wiren_Board

Execute the install script from the mplc4_installer directory to deploy the runtime environment.

```bash
./install.sh
```

--------------------------------

### Get page information for image usage

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Bimageusage

Example request using imageusage as a generator to retrieve information about pages that use 'File:Albert Einstein Head.jpg'.

```text
api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info
```

--------------------------------

### Download the Docker installation script

Source: https://wiki.wirenboard.com/wiki/Docker

Download the wb-docker-manager.sh script to the controller via SSH.

```bash
wget https://raw.githubusercontent.com/wirenboard/wb-community/refs/heads/main/scripts/docker-install/wb-docker-manager.sh
```

--------------------------------

### Start Z-Way service (deprecated)

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/Z-Wave

Reload systemd daemon and start the Z-Way service.

```bash
systemctl daemon-reload
```

```bash
service z-way-server start
```

--------------------------------

### Usage example of Wbincludes:ERRMODBUS001 template

Source: https://wiki.wirenboard.com/wiki/Wbincludes%3AERRMODBUS001%3A_%D0%9E%D1%82%D0%B2%D0%B5%D1%82_%D1%83%D1%81%D1%82%D1%80%D0%BE%D0%B9%D1%81%D1%82%D0%B2%D0%B0_%D0%BD%D0%B0_%D0%B0%D0%B4%D1%80%D0%B5%D1%81_0xFD

Example of how to invoke the template with specific device and firmware version parameters.

```text
{{Wbincludes:ERRMODBUS001:_Ответ_устройства_на_адрес_0xFD
| devices=WB-MWAC v.2
| fw_version=1.21.1
}}
```

--------------------------------

### Get unique target pages as a generator

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Ballredirects

Uses the allredirects module as a generator to retrieve unique target pages, marking missing ones, starting at 'B'.

```text
api.php?action=query&generator=allredirects&garunique=&garfrom=B
```

--------------------------------

### Install KNX software packages

Source: https://wiki.wirenboard.com/wiki/KNX_demo-stand

Command to install the required software stack for KNX communication on the Wiren Board controller.

```bash
$ apt-get update && apt-get install knxd knxd-tools wb-knxd-config wb-mqtt-knx
```

--------------------------------

### Usage of NewVersion template

Source: https://wiki.wirenboard.com/wiki/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%3ANewVersion

Example of how to invoke the NewVersion template with parameters for the new device name, old device name, and the link to the old device page.

```wikitext
{{NewVersion
| new_name=WB-DEMO-KIT v.3
| old_name=WB-DEMO-KIT v.2
| old_page=Wb-demo-kit_v.2
}}
```

--------------------------------

### Install SAYMON Agent

Source: https://wiki.wirenboard.com/wiki/SAYMON

Commands to set execution permissions and run the installer script for the SAYMON Agent on Wiren Board 8.

```bash
chmod +x saymon-agent-*-*-*-linux-aarch64-installer.sh
./saymon-agent-*-*-*-linux-aarch64-installer.sh
```

--------------------------------

### Parameter initialization and metatable setup

Source: https://wiki.wirenboard.com/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB%D1%8C%3AProtection_banner

Initializes parameter functions and sets up a metatable for dynamic parameter resolution.

```lua
parameterFuncs.CURRENTVERSION = self._makeCurrentVersionParameter parameterFuncs.EDITREQUEST = self._makeEditRequestParameter parameterFuncs.EXPIRY = self._makeExpiryParameter parameterFuncs.EXPLANATIONBLURB = self._makeExplanationBlurbParameter parameterFuncs.IMAGELINK = self._makeImageLinkParameter parameterFuncs.INTROBLURB = self._makeIntroBlurbParameter parameterFuncs.INTROFRAGMENT = self._makeIntroFragmentParameter parameterFuncs.PAGETYPE = self._makePagetypeParameter parameterFuncs.PROTECTIONBLURB = self._makeProtectionBlurbParameter parameterFuncs.PROTECTIONDATE = self._makeProtectionDateParameter parameterFuncs.PROTECTIONLEVEL = self._makeProtectionLevelParameter parameterFuncs.PROTECTIONLOG = self._makeProtectionLogParameter parameterFuncs.TALKPAGE = self._makeTalkPageParameter parameterFuncs.TOOLTIPBLURB = self._makeTooltipBlurbParameter parameterFuncs.TOOLTIPFRAGMENT = self._makeTooltipFragmentParameter parameterFuncs.VANDAL = self._makeVandalTemplateParameter 
self._params = setmetatable({}, { __index = function (t, k) local param if parameterFuncs[k] then param = parameterFuncs[k](self) end param = param or __t[k] = param return param end }) end
msg = msg:gsub('${(%u+)}', self._params) return msg end
```

--------------------------------

### Install fontconfig

Source: https://wiki.wirenboard.com/wiki/Microsoft_Fonts_Installation

Installs the fontconfig utility package required for verifying font installation.

```bash
sudo apt install fontconfig

```

--------------------------------

### Install Additional Software

Source: https://wiki.wirenboard.com/wiki/Backup_of_Wiren_Board_controller_settings

Commands to update the package list and install zigbee2mqtt. Perform this step before copying configuration files to avoid overwriting custom settings.

```bash
apt update
apt install zigbee2mqtt
```

--------------------------------

### Install screen utility

Source: https://wiki.wirenboard.com/wiki/SSH

Installs the screen utility on the controller, which is required to maintain persistent SSH sessions.

```bash
apt install screen
```

--------------------------------

### Install knxd package

Source: https://wiki.wirenboard.com/wiki/Knxd

Command to install the knxd package on a Wiren Board controller if it is not already present.

```bash
apt update && apt install knxd
```

--------------------------------

### SetupTotallyRandomPalette

Source: https://wiki.wirenboard.com/wiki/Address_strip_WS2812B

Функция заполняет палитру случайными цветами.

```cpp
// This function fills the palette with totally random colors.
void SetupTotallyRandomPalette()
{
    for( int i = 0; i < 16; ++i) {
        currentPalette[i] = CHSV( random8(), 255, random8());
    }
}
```

--------------------------------

### Install wb-homa-rfsniffer driver

Source: https://wiki.wirenboard.com/wiki/433MHz

Command to update package lists and install the new wb-homa-rfsniffer driver.

```bash
apt-get update && apt-get install wb-homa-rfsniffer
```

--------------------------------

### Start Mosquitto service

Source: https://wiki.wirenboard.com/wiki/ATECCX08

Command to start the Mosquitto service.

```bash
service mosquitto start
```

--------------------------------

### Install wb-hdmi software via SSH

Source: https://wiki.wirenboard.com/wiki/WBE2-HDMI_v.1_HDMI_Extension_Module

Commands to update the system and install the wb-hdmi meta-package, which provides the X Window System and Firefox browser.

```bash
apt update
apt upgrade
apt install wb-hdmi
```

--------------------------------

### View Docker help

Source: https://wiki.wirenboard.com/wiki/Docker

Displays the list of all available Docker commands.

```bash
docker --help

```

--------------------------------

### Start login process

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/clientlogin

Initiates the login process for a user with a specified username, password, return URL, and login token.

```http
api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC
```

--------------------------------

### Install MasterPLC runtime

Source: https://wiki.wirenboard.com/wiki/MasterPLC_on_Wiren_Board

Execute this command to install the MasterPLC runtime package specifically for Wiren Board 7.

```bash
apt install mplc4-wirenboard7
```

--------------------------------

### Install ttf-mscorefonts-installer

Source: https://wiki.wirenboard.com/wiki/Microsoft_Fonts_Installation

Installs the package that automatically downloads and configures Microsoft fonts.

```bash
sudo apt install -y ttf-mscorefonts-installer

```

--------------------------------

### Subscribe to SHT1x MQTT Topics

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/%D0%94%D0%B0%D1%82%D1%87%D0%B8%D0%BA_SHT1x

Example command to subscribe to all SHT1x device topics using mosquitto_sub, followed by sample output.

```bash
$ mosquitto_sub -h 192.168.0.102 -t '/devices/sht1x/#' -v
/devices/sht1x/controls/temperature 28.5
/devices/sht1x/controls/temperature/meta/type temperature
/devices/sht1x/controls/humidity 31.7
/devices/sht1x/controls/humidity/meta/type rel_humidity
/devices/sht1x/meta/name SHT1x Sensor
```

--------------------------------

### Configure Firefox startup URL

Source: https://wiki.wirenboard.com/wiki/WBE2-HDMI_v.1_HDMI_Extension_Module

Example URL for displaying an SVG dashboard in the Firefox browser.

```text
http://localhost/#!/dashboards/svg/view/dashboard2
```

--------------------------------

### Help for action=query and submodules

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/help

Retrieves help for the query module and includes its immediate submodules.

```text
api.php?action=help&modules=query&submodules=1
```

--------------------------------

### Get pages using File:Example.jpg

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Bfileusage

Retrieves a list of pages that use the specified file.

```http
api.php?action=query&prop=fileusage&titles=File%3AExample.jpg
```

--------------------------------

### Install and Run Xiaomi Cloud Token Extractor

Source: https://wiki.wirenboard.com/wiki/%D0%9F%D0%BE%D0%B4%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D0%B5_%D1%83%D0%B2%D0%BB%D0%B0%D0%B6%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8F_Xiaomi

Commands to download, install dependencies, and execute the token extractor tool for Xiaomi devices.

```bash
https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor/releases/latest/download/token_extractor.zip
unzip token_extractor.zip
cd token_extractor
pip3 install -r requirements.txt
python3 token_extractor.py
```

--------------------------------

### Install Ansible on macOS

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%96%D1%83%D1%80%D0%BD%D0%B0%D0%BB%D1%8B/Sikmir

Command to install Ansible on macOS using MacPorts.

```bash
sudo port install ansible ss
```

--------------------------------

### Install Ansible on Debian

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%96%D1%83%D1%80%D0%BD%D0%B0%D0%BB%D1%8B/Sikmir

Command to install Ansible and sshpass on a Debian-based system.

```bash
sudo apt install ansible sshpass
```

--------------------------------

### Usage for testing release

Source: https://wiki.wirenboard.com/wiki/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%3AAvailableSinceRelease

Example of using the template to specify a testing release.

```wikitext
{{AvailableSinceRelease
| release = testing
| date = 26-06-2026}}
```

--------------------------------

### Start Telegraf Service

Source: https://wiki.wirenboard.com/wiki/Grafana

Command to start the Telegraf service in automatic mode.

```bash
systemctl start telegraf
```

--------------------------------

### Add service to startup (deprecated)

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/Z-Wave

Configure the Z-Way service to start automatically on boot.

```bash
update-rc.d z-way-server defaults
```

--------------------------------

### Example relay control in wb-rules

Source: https://wiki.wirenboard.com/wiki/Wb-zigbee2mqtt

Example of turning a relay with friendly_name 0x00158d0001f3fc34 ON and OFF.

```javascript
 publish("zigbee2mqtt/0x00158d0001f3fc34/set", JSON.stringify({ state: "ON" }), 2, false);
 publish("zigbee2mqtt/0x00158d0001f3fc34/set", JSON.stringify({ state: "OFF" }), 2, false);
```

--------------------------------

### Usage example of the OldVersion template

Source: https://wiki.wirenboard.com/wiki/%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD%3AOldVersion

Basic implementation of the template with parameters for the old device name, new device name, and the new device page.

```wikitext
{{OldVersion
| old_name=WB-DEMO-KIT v.2
| new_name=WB-DEMO-KIT v.3
| new_page=WB-DEMO-KIT v.3
}}
```

--------------------------------

### Create udev rules file

Source: https://wiki.wirenboard.com/wiki/MasterPLC_on_Wiren_Board

Open the udev rules file for editing.

```bash
nano /usr/lib/udev/rules.d/99-RS485-to-USB.rules
```

--------------------------------

### WD-14 Module Configuration Example

Source: https://wiki.wirenboard.com/wiki/WB-MIO-Modbus-Registers

Example configuration for two WD-14 modules connected as the first and second devices. The addresses for the second module are incremented by 1000.

```text
11000 - 0xffff
11001 - 0x0000
11002 - 0xffff
11003 - 0x0000
11004 - 0x0000
11005 - 0x4444
10999 - 0x0001

#For second module addresses increased on 1000:
12000 - 0xffff
12001 - 0x0000
12002 - 0xffff
12003 - 0x0000
12004 - 0x0000
12005 - 0x4444
11999 - 0x0001
```

--------------------------------

### GET api.php?action=help

Source: https://wiki.wirenboard.com/wiki/api.php

Retrieves help information for the main API module.

```APIDOC
## GET api.php?action=help

### Description
Retrieves help documentation for the main API module.

### Method
GET

### Endpoint
api.php?action=help
```

--------------------------------

### Initialize argument tables

Source: https://wiki.wirenboard.com/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB%D1%8C%3AArguments

Sets up the primary args, metaArgs, and nilArgs tables along with the metatable for argument management.

```lua
--[[ -- Set up the args, metaArgs and nilArgs tables. args will be the one -- accessed from functions, and metaArgs will hold the actual arguments. Nil -- arguments are memoized in nilArgs, and the metatable connects all of them -- together. --]] local args, metaArgs, nilArgs, metatable = {}, {}, {}, {} setmetatable(args, metatable)
```

--------------------------------

### wb-cloud-agent help command

Source: https://wiki.wirenboard.com/wiki/Cloud

Displays the full help menu for the wb-cloud-agent utility.

```bash
wb-cloud-agent -h
```

--------------------------------

### Flash firmware from file

Source: https://wiki.wirenboard.com/wiki/Wb-mcu-fw-updater

Example command to flash a specific firmware file to a device, specifying the port, connection settings, and Modbus address.

```bash
# wb-mcu-fw-updater flash-file /dev/ttyRS485-1 --conn-settings 115200N2 -a20 --file /home/debs/mcm8G__1.4.0-rc1_master_20e4b39.wbfw 
2022-07-27 12:14:02,043 Flashing /home/debs/mcm8G__1.4.0-rc1_master_20e4b39.wbfw
100%|#######################################################################################################|134/134
```

--------------------------------

### Subscribe to MQTT topics

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/MQTT

Connects to the local broker to monitor all topics starting with '/'.

```bash
mosquitto_sub -v -h 127.0.0.1 -u test -P wbpassword -t "/#"
```

--------------------------------

### Установка Docker

Source: https://wiki.wirenboard.com/wiki/Docker

Команда для установки Docker из репозитория Wiren Board через менеджер пакетов apt.

```bash
apt update && apt install docker-ce
```

--------------------------------

### Expected installation warning

Source: https://wiki.wirenboard.com/wiki/Copy_project_on_wb_7_for_MasterSCADA_4D

Warning message displayed during installation regarding file overwrites.

```text
dpkg: warning: trying to overwrite '/etc/nginx/sites-available/default.wb', which is also in package wb-configs
```

--------------------------------

### Install MasterSCADA 4D package

Source: https://wiki.wirenboard.com/wiki/Copy_project_on_wb_7_for_MasterSCADA_4D

Install the downloaded deb package using dpkg.

```bash
dpkg -i /home/mplc4-wirenboard7-1.3.4.21873-armhf.deb
```

--------------------------------

### Initialize External Modules

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/%D0%A1%D0%B1%D0%BE%D1%80%D0%BA%D0%B0_%D1%8F%D0%B4%D1%80%D0%B0

Navigate to the kernel directory and initialize/update submodules.

```bash
cd KERNEL
```

```bash
git submodule init
```

```bash
git submodule update
```

--------------------------------

### MasterPLC Start Confirmation

Source: https://wiki.wirenboard.com/wiki/MasterPLC_on_Wiren_Board

The confirmation message displayed when the MasterPLC service successfully starts.

```text
Starting MasterPLC...   OK
```

--------------------------------

### Start the watchdog service

Source: https://wiki.wirenboard.com/wiki/Hardware_Watchdog_Disable

Command to start the watchdog service after configuration changes have been applied.

```bash
systemctl start watchdog
```

--------------------------------

### Enable autossh service

Source: https://wiki.wirenboard.com/wiki/Wirenboard6%3AInstallingOnTheRemoteSite

Enable the autossh service to start automatically on system boot.

```bash
systemctl enable autossh.service
```

--------------------------------

### List pages starting with B

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/query%2Ballpages

Retrieves a list of pages starting from the letter 'B'.

```http
api.php?action=query&list=allpages&apfrom=B
```

--------------------------------

### Create File

Source: https://wiki.wirenboard.com/wiki/SSH

Use the touch command to create a new file.

```bash
touch newfilename.txt

```

--------------------------------

### Standard boolean evaluation examples

Source: https://wiki.wirenboard.com/wiki/%D0%9C%D0%BE%D0%B4%D1%83%D0%BB%D1%8C%3AYesno/doc

Examples of inputs that evaluate to true, false, or nil.

```lua
-- These always return true:
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)

-- These always return false:
yesno('no')
yesno('n')
yesno('false')
yesno('f')
yesno('0')
yesno(0)
yesno(false)

-- A nil value always returns nil:
yesno(nil)
```

--------------------------------

### Execute Debian Bullseye transition

Source: https://wiki.wirenboard.com/wiki/Wb-2304

Initiates the transition to Debian 11. Ensure at least 300 MB of free space in /root; the process takes approximately 45 minutes.

```bash
wb-release --update-debian-release
```

--------------------------------

### Удаление пакета ТМИУС КП

Source: https://wiki.wirenboard.com/wiki/TMIUS_KP

Команда для удаления программного комплекса через apt.

```bash
apt remove tm-cpps
```

--------------------------------

### Example Token Extractor Output

Source: https://wiki.wirenboard.com/wiki/%D0%9F%D0%BE%D0%B4%D0%BA%D0%BB%D1%8E%D1%87%D0%B5%D0%BD%D0%B8%D0%B5_%D1%83%D0%B2%D0%BB%D0%B0%D0%B6%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8F_Xiaomi

Sample output format showing device details including ID, MAC address, IP, and the required TOKEN.

```text
---------
NAME:     Smartmi Evaporative Humidifer 2
ID:       473361111
MAC:      EC:66:6E:D7:07:42
IP:       192.168.88.11
TOKEN:    ecc202166f07fffd7208eb37b2122b11
MODEL:    zhimi.humidifier.ca4
---------
```

--------------------------------

### Enable zigbee2mqtt web interface

Source: https://wiki.wirenboard.com/wiki/Wb-zigbee

Steps to edit the configuration file, add the frontend settings, and restart the service.

```bash
nano /mnt/data/root/zigbee2mqtt/data/configuration.yaml
```

```yaml
frontend:
  enabled: true
  port: 8081
  host: 0.0.0.0
```

```bash
systemctl restart zigbee2mqtt
```

--------------------------------

### Install serial_tool

Source: https://wiki.wirenboard.com/wiki/Serial_tool

Command to install the serial_tool utility on a Wiren Board controller if it is not already present.

```bash
apt install serial-tool
```

--------------------------------

### List installed fonts

Source: https://wiki.wirenboard.com/wiki/Microsoft_Fonts_Installation

Uses fc-list to search for installed fonts matching the string 'arial'.

```bash
fc-list | grep -i arial

```

--------------------------------

### Enable wb-gsm service

Source: https://wiki.wirenboard.com/wiki/MasterPLC_on_Wiren_Board

Add the wb-gsm service to autostart.

```bash
systemctl enable wb-gsm
```

--------------------------------

### Download init script (deprecated)

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/Z-Wave

Download the Z-Way server init script to the system directory.

```bash
wget -O /etc/init.d/z-way-server https://raw.githubusercontent.com/contactless/z-way-server-debian/master/debian/z-way-server.init
```

--------------------------------

### Install MQTT driver for BMP085

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3A%D0%9C%D0%BE%D0%B9_%D1%8F%D0%B7%D1%8B%D0%BA/BMP085

Commands to update the package list and install the wb-mqtt-bmp085 driver.

```bash
apt-get update
apt-get install wb-mqtt-bmp085
```

--------------------------------

### Configure DNS for ppp0 interface

Source: https://wiki.wirenboard.com/wiki/Wirenboard6%3AInstallingOnTheRemoteSite

Create a script in /etc/ppp/ip-up.d/ to inject public DNS servers into /etc/resolv.conf when the ppp0 interface is brought up.

```bash
if [ ! -e /etc/resolv.conf ]; then
  : > /etc/resolv.conf
fi

#OpenDNS
printf '%s\n%s\n' "nameserver 208.67.222.222" "$(cat /etc/resolv/conf)" >/etc/resolv.conf
printf '%s\n%s\n' "nameserver 208.67.220.220" "$(cat /etc/resolv.conf)" >/etc/resolv.conf
#Google DNS
printf '%s\n%s\n' "nameserver 8.8.8.8" "$(cat /etc/resolv.conf)" >/etc/resolv.conf
printf '%s\n%s\n' "nameserver 8.8.4.4" "$(cat /etc/resolv.conf)" >/etc/resolv.conf
```

--------------------------------

### Start a screen session

Source: https://wiki.wirenboard.com/wiki/SSH

Initializes a new virtual console session. After running this, press Space or Enter to access the console.

```bash
screen
```

--------------------------------

### Retrieve contributions for a user

Source: https://wiki.wirenboard.com/wiki/%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AApiHelp/feedcontributions

Example request to fetch the contributions feed for the user named 'Example'.

```http
api.php?action=feedcontributions&user=Example
```