Wiren Board

https://wiki.wirenboard.com
Admin
Wiren Board develops open-source automation controllers, I/O modules, and sensors for smart home and...
Tokens:3,240,850
Snippets:14,441
Trust Score:8.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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
```

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

### 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>
```

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

### 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
```
Tokens:
Raw