Background 


Warning: OpenSprinkler firmware currently does NOT work with Raspbian version 12 (Bookworm). This is due to a breaking change that Bookworm made which removed the gpio command required by the firmware. We are working to update the firmware to use the latest gpio command. In the meantime, please install an older version of Raspbian, such as version 11 (Bullseye). If you must use Bookworm, please check this github thread for work-arounds.


This guide assumes you have a working Raspberry Pi setup with SSH access available (or with keyboard and monitor).


NOTE: do NOT enable 1-wire in raspi-config -- the default 1-wire pin (GPIO 4) conflicts with OSPi and will prevent RPi from sending signals correctly to OSPi. If you must use 1-wire, you can follow RPi instructions to assign a different pin for 1-wire.


Table of Contents

A. Install Unified firmware on a new Raspberry Pi setup


B. Upgrade a previously installed Unified firmware


C. Stop all sprinkler firmware/software from starting with the Raspberry Pi

A. Install Unified firmware on a new Raspberry Pi setup

  1. Open an SSH connection to the Raspberry Pi (or use a keyboard and monitor connected to Raspberry Pi)

  2. Run the following command: 
    1
    2
    3
    sudo apt-get install build-essential
    cd ~
    git clone https://github.com/OpenSprinkler/OpenSprinkler-Firmware.git

  3. Change directory:
    1
    cd OpenSprinkler-Firmware

  4. Build OpenSprinkler:
    1
    sudo ./build.sh ospi
    • This will generate an executable program called OpenSprinkler, and also set up startup script for auto-run at startup.
    • If you are using a BeagleBone Black, please replace ospi with osbo.
  5. If you answered yes to the startup script, you should be completely setup and ready to go.

  6. NOTE: it has come to our attention that some Raspbian systems installed by NOOBs will take over GPIO 4 for 1-wire interface, but that OSPi needs GPIO 4 to send control signals to the solenoid valves. If you found that the firmware runs correctly but OSPi does not turn on valves correctly, one solution is to sudo open /etc/modules, and comment out the line containing w1-gpio, then reboot. Another solution is to reinstall Raspbian OS from scratch without using NOOBs.

  7. The web interface should now be accessible from: http://localhost:8080. The default password to log into the web interface is opendoor.

   

B. Upgrade a previously installed Unified Firmware


Warning: The firmware update process will set your controller back to factory defaults. This includes controller settings, program settings, and device password (which will be set back to the factory default of opendoor). Please ensure you back up your current configurations (e.g. Export Configurations) before proceeding with firmware update.    


  1. Open an SSH connection with the Raspberry Pi

  2. Change to the OpenSprinkler directory:
    1
    cd /home/pi/OpenSprinkler-Firmware

  3. Update OpenSprinkler:
    1
    git pull

  4. Re-build OpenSprinkler:
    1
    sudo ./build.sh ospi
    • If you are using a BeagleBone Black, please replace ospi with osbo.
  5. Restart OpenSprinkler:
    1
    sudo /etc/init.d/OpenSprinkler.sh restart

   

C. Stop all sprinkler firmware/software from starting with the Raspberry Pi

  1. Open an SSH connection with the Raspberry Pi

  2. Remove Unified firmware from system startup: 
    1
    2
    3
    sudo /etc/init.d/OpenSprinkler.sh stop
    sudo rm /etc/init.d/OpenSprinkler.sh
    sudo update-rc.d OpenSprinkler.sh remove

  3. Remove Dan's Python OSPi program:  
    1
    2
    3
    sudo /etc/init.d/ospi stop
    sudo rm /etc/init.d/ospi
    sudo update-rc.d ospi remove

  4. Remove Richard Zimmerman's sprinkler_pi program:   
    1
    2
    3
    sudo /etc/init.d/sprinklers_pi stop
    sudo rm /etc/init.d/sprinklers_pi
    sudo update-rc.d sprinklers_pi remove