Getting Started

Install Sprinqua

From a fresh Raspberry Pi to a working irrigation controller in under 10 minutes.

Before you start

πŸ“

Raspberry Pi

Any model with GPIO pins β€” Pi 3, 4, 5 or Zero 2 W. Must be running Orbit OS.

Get Orbit OS β†’
πŸ”Œ

Relay Board

A GPIO-controlled relay HAT. Sprinqua supports 7+ boards out of the box β€” from 3 to 8 channels.

See supported boards β†’
πŸ“±

Browser

Any modern browser on the same local network. No app install needed β€” Sprinqua is a web UI.

Installation steps

1

Install Sprinqua from the Orbit OS Store

Open the Orbit OS Store on your device and search for Sprinqua, or go directly to the store page. Tap Install β€” Orbit OS will download and deploy the .orb package automatically.

Open Orbit OS Store β†’
2

Open Sprinqua in your browser

Once installed, Sprinqua starts automatically. Open a browser on any device on the same network and navigate to your Raspberry Pi's address:

# Using mDNS hostname

http://raspberrypi.local

# Or via IP address

http://192.168.1.x

The exact hostname and port depend on your Orbit OS network configuration.

3

Run the Hardware Setup Wizard

On first launch, Sprinqua shows the setup wizard. It walks you through three quick steps:

A

Select your relay board

Pick your exact board model from the list. Sprinqua auto-fills the correct GPIO pin mapping.

B

Name your irrigation zones

Assign a name and type (sprinkler, drip, mist…) to each relay channel. Set a safety auto-off limit per zone.

C

Test each relay

Pulse each relay for 3 seconds to verify the physical wiring before committing to the configuration.

4

Start watering πŸ’§

You're done. Turn zones on manually, create weekly schedules, enable Smart Watering to skip rainy days, or connect to Home Assistant via MQTT. All from the same clean UI.

Optional: Connect to Home Assistant

If you use Home Assistant, Sprinqua can publish all zones as MQTT switches with auto-discovery β€” no manual entity configuration needed.

# In Sprinqua β†’ Settings β†’ Enable MQTT

Broker: 192.168.1.x # your HA host

Port: 1883

Prefix: sprinqua # topic prefix

# Topics Sprinqua publishes

sprinqua/zone/1/state β†’ ON | OFF

sprinqua/mode/state β†’ Standalone | HA-Managed

Troubleshooting

Can't reach the web UI β–Ύ
Make sure your computer and the Raspberry Pi are on the same local network. Try using the device's IP address instead of the hostname. Check the Orbit OS dashboard to confirm Sprinqua is running.
Relay fires but nothing happens physically β–Ύ
Check that the relay board is powered (many boards need an external 5V supply in addition to GPIO). Verify that the COM/NO/NC wiring is correct for your valve type. The relay click sound confirms GPIO is working β€” the issue is downstream.
Wrong relay fires (GPIO mismatch) β–Ύ
Make sure you selected the exact board model in the wizard. Different board revisions sometimes use different GPIO layouts. Use Settings β†’ Re-run Hardware Wizard to reconfigure. If your board isn't listed, open a board request.
Smart Watering not skipping β–Ύ
Confirm that Smart Watering is enabled in Settings and that your location coordinates are set. The check runs ~1 hour before a scheduled run. Open-Meteo requires internet access from the Raspberry Pi β€” verify the device can reach the internet.
πŸ’§

Something not working?

Open an issue on GitHub and we'll help you sort it out. Feature requests and board additions are also welcome.