API Documents and Advanced Topics

OS API Documents
Firmware 2.2.1 API document (to be released) Firmware 2.2.0 API document (current) Archived API docs of previous version (2.1.0~2.1.9)
Thu, 25 Jul, 2024 at 6:56 AM
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
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
Install Wired Ethernet Module on OpenSprinkler v3.2
Wired Ethernet module has been supported since OpenSprinkler v3.2. This is implemented by using an external Ethernet module (ENC28J60 for OS 3.2, and W5500 ...
Sun, 21 Jul, 2024 at 8:15 AM
Updating OS 2.1 to Firmware 2.1.6+ (archived)
Firmware 2.1.6 has become large enough that it exceeds the non-bootloader section of OpenSprinkler (OS) 2.1. In order to update OS 2.1 to firmware 2.1.6 (...
Sun, 21 Jul, 2024 at 8:17 AM