OpenSprinkler Firmware and Documentation

https://opensprinkler.github.io/OpenSprinkler-Firmware/
Admin
OpenSprinkler provides firmware and documentation for the OpenSprinkler device, enabling users to...
Tokens:30,497
Snippets:228
Trust Score:9.7
Update:1 day ago
Show doc for...
Tokens:
Raw
### Install Mosquitto MQTT broker and clients

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/guides/mqtt/

Install the Mosquitto MQTT broker and its command-line clients on Linux or Raspberry Pi using apt.

```bash
sudo apt install mosquitto mosquitto-clients
```

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

### Install Git and Clone the OpenSprinkler Firmware Repository

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/ospi/firmware-installation/

Run these commands on a Raspberry Pi with Raspberry Pi OS to install Git and clone the OpenSprinkler-Firmware repository with submodules.

```bash
sudo apt-get install git
cd ~
git clone --recurse-submodules https://github.com/OpenSprinkler/OpenSprinkler-Firmware.git
```

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

### Build OpenSprinkler for OSPi

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/ospi/firmware-installation/

Build the firmware for the OSPi target. The script generates an executable named 'OpenSprinkler' and may offer to install a systemd service. It may enable I2C and set bus speed to 400 kHz; reboot if required.

```bash
sudo ./build.sh ospi
```

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

### Change to the Firmware Directory

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/ospi/firmware-installation/

Navigate into the cloned OpenSprinkler-Firmware folder.

```bash
cd OpenSprinkler-Firmware
```

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

### Build firmware with PlatformIO CLI

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/firmware-compilation/

Builds the firmware for OpenSprinkler v3 (os3x_esp8266) and v4 (os4_esp32c6_n8) using the PlatformIO CLI. For v4, use firmware.bin32n8 for OTA upload; firmware.factory.bin is for factory or USB-C flashing.

```sh
# OpenSprinkler v3
pio run -e os3x_esp8266

# OpenSprinkler v4 (ESP32-C6-N8)
pio run -e os4_esp32c6_n8
```

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

### Run OpenSprinkler Manually

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/ospi/firmware-installation/

If the startup-service prompt was declined, run the firmware manually with this command.

```bash
sudo ./OpenSprinkler
```

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

### Change to the Firmware Directory for Update

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/ospi/firmware-installation/

Navigate to the firmware folder before running the updater.

```bash
cd ~/OpenSprinkler-Firmware
```

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

### Clone repository with submodules

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/firmware-compilation/

Clones the OpenSprinkler-Firmware repository including required submodules and enters the source directory.

```bash
git clone --recurse-submodules https://github.com/OpenSprinkler/OpenSprinkler-Firmware.git
cd OpenSprinkler-Firmware
```

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

### Manual Update Commands

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/ospi/firmware-installation/

Run these commands from ~/OpenSprinkler-Firmware to manually update the firmware if updater.sh is unavailable or for troubleshooting.

```bash
git pull --ff-only
sudo ./build.sh ospi
sudo systemctl restart OpenSprinkler.service
```

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

### Run the Firmware Updater

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/ospi/firmware-installation/

The updater performs a fast-forward-only Git pull, synchronizes submodules, rebuilds the firmware, and restarts the OpenSprinkler service.

```bash
sudo ./updater.sh
```

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

### Factory reset: delete entire firmware folder

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/troubleshooting/

Alternative factory reset method that removes the entire OpenSprinkler-Firmware folder. Requires navigating to the parent directory first. After deletion, reinstall the firmware.

```bash
sudo rm -rf ~/OpenSprinkler-Firmware
```

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

### Subscribe to a topic with mosquitto_sub

Source: https://opensprinkler.github.io/OpenSprinkler-Firmware/guides/mqtt/

Subscribe to an MQTT topic using the mosquitto_sub command-line tool to receive messages.

```bash
mosquitto_sub -h <broker_ip> -t "my_topic"
```
Tokens:
Raw