API and Advanced Topics

OS API Documents
API test scripts: Firmware 2.1.9 (and above) test script (Please right click this link and use 'Save Link as' to download it locally to your com...
Mon, 30 Jun, 2025 at 1:40 PM
Customize the UI / App
Background By default, the OpenSprinkler firmware directs the browser to retrieve Javascript files stored on a cloud server to render the UI on your devic...
Sun, 21 Jul, 2024 at 7:58 AM
Compile the OpenSprinkler Firmware
The OpenSprinkler unified firmware can compile under both the Arduino environment and any Linux-based system. The instructions on this page are for the ...
Sun, 21 Jul, 2024 at 8:09 AM
Using the OpenSprinkler USB-Serial Programmer
The OpenSprinkler USB-Serial Programmer is a handy tool for uploading firmware to OpenSprinkler, OpenGarage, and RFToy via USB. It's also useful for dis...
Mon, 19 Aug, 2024 at 10:15 AM
Install Wired Ethernet Module on OpenSprinkler v3.2+
Wired Ethernet has been supported since OpenSprinkler v3.2. It's implemented by using an external Ethernet module—ENC28J60 for v3.2 and W5500 for v3.3 a...
Mon, 30 Jun, 2025 at 9:35 PM
Extend OpenSprinkler's Hardware Capabilities
Introduction Although OpenSprinkler is primarily a sprinkler controller, it's fundamentally a web-based controller with a sophisticated timer and an...
Sun, 21 Jul, 2024 at 8:17 AM