How to Identify Your OpenSprinkler Hardware Version

When submitting a support ticket, it's important to specify your OpenSprinkler hardware version. Here's how to find it:

• Via Mobile App or Web Browser: Open the OpenSprinkler app or access the controller via a web browser. On the homepage, swipe left to right to open the left-side menu. Tap "About". The hardware version is displayed there.
• During Reboot: When rebooting the controller, the LCD screen briefly displays the hardware version.
• Check the Label: If your controller has a label on the back panel, the hardware version should be printed there.
• Otherwise: if none of the above works, take a clear picture of your controller and attach it to your support ticket. This will help us identify the version for you.

How to Identify Your OpenSprinkler Firmware Version

When submitting a support ticket, you'll also need to specify the firmware version. Here's how to find it:

• Via Mobile App or Web Browser: Open the OpenSprinkler app or access the controller via a web browser. On the homepage, swipe left to right to open the left-side menu. Tap "About". The firmware version is displayed there.
• During Reboot: When rebooting the controller, the LCD screen briefly displays the hardware version.
• Using Buttons: 1) Power off the controller. 2) Power it back on, and as soon as the OpenSprinkler logo or the word "OpenSprinkler" appears, press and hold the third pushbutton (B3). Continue holding B3 until the LCD displays "Setup Options". Press B3 a few more times until you see "Firmware Version" displayed.

Understanding Hardware version, App version, and Firmware version

On the "About" page of your controller, you'll see three difference version numbers:

• App version: Refers to the mobile app or UI (User Interface) version. Example: 2.4.1. The app version updates automatically on your phone whenever a new release is available.
• Firmware version: Refers to the software running on the controller. Example: 2.2.0(3) --> where 2.2.0 is the major revision and (3) is the minor revision. Firmware update are NOT automatic --> you must manually update the firmware when a new version is released by following the Firmware Update instructions.
• Hardware version: Refers to your OpenSprinkler device's physical hardware. Example: 2.3, 3.x (including 3.0--3.3) and OSPi. If you run a Linux simulation of the firmware, it will display as "Demo".

The OpenSprinkler Unified Firmware is designed to run on all actively supported hardware versions.

Solenoid Resistance Testing

Sometimes, a sprinkler solenoid may have a short circuit due to a defective solenoid or faculty writing. This issue should be fixed before powering on the sprinkler controller, as it can lead to malfunctions or even damage the device. A basic diagnostic step is to perform a solenoid resistance testing:

1. Power Off the System: Disconnect power from the controller before testing.
2. Use a Multi-meter to measure the resistance between the COM (common) wire and each zone port or zone wire.
3. Analyze Results:
   • A normal 24VAC or non-latching sprinkler solenoid typically has a resistance of 20--50 ohms.
   • Low resistance (close to 0 ohms) --> Indicates a shorted circuit (faulty solenoid or wiring)
   • High resistance (infinite or very high ohms) --> Indicates an open circuit (wires are disconnected or broken).
   • Latching solenoids --> a latching solenoid typically has a resistance of 4--10 ohms.

If any issues are detected, repair or replace the affected solenoid or wiring before reconnecting power.

AC Voltage Present Between COM and a Zone Even When that Zone is Off -- Is My Controller Defective?

No, this does not indicate a defective controller. In an AC-based system, if no solenoid (i.e. load) is connected between COM and a zone, you may measure stray voltage, which can vary and may not be exactly 0. This stray voltage is normal and will disappear once a solenoid (load) is properly connected.

When I Plug in the power, Multiple Solenoids or Zones Activate Simultaneously.

This usually happens when a DC power adapter is plugged into an AC-powered OpenSprinkler. Keep in mind that AC-powered OpenSprinkler requires a power adapter that outputs AC voltage, not DC. You can check your power adapter’s label to confirm its output—AC voltage is typically indicated with a wavy line (e.g., 24V~500mA), while DC voltage is marked with a straight line (e.g., 18V-2000mA). If unsure, you can also use a multimeter to verify whether the adapter outputs AC or DC voltage.

Once Zones Turn On, They Remain On Unless the Power is Remove.

This issue is usually caused by using a DC power adapter with an AC-powered OpenSprinkler. Refer to the previous answer for more details on verifying and selecting the correct power adapter.

WiFi Connection Issues

If your OpenSprinkler controller is having trouble connecting to WiFi, follow these troubleshooting steps based on your hardware version.

* For OpenSprinkler 2.3: This version does not have built-in WiFi, so it relies on a separate WiFi adapter. If you recently changed your WiFi router, SSID, or password, follow the WiFi adapter’s user manual to reconnect it to your network, usually requiring a factory reset of the adapter. If the issue persists, try connecting your OpenSprinkler 2.3 directly to your main router using a wired Ethernet cable. This helps determine whether the problem is with OpenSprinkler or the WiFi adapter.

* For OpenSprinkler 3.x: First, check whether your controller is in Access Point (AP) mode or WiFi Station mode:
In AP mode, the LCD screen displays four lines, and a dot blinks rapidly. This means the controller has not yet been configured to connect to your WiFi network. Follow the user manual’s WiFi setup instructions to complete the configuration.

If you recently changed your WiFi router, SSID, or password, reset OpenSprinkler to AP mode and reconnect it to WiFi:

• To reset to AP mode without a factory reset, press B3 + B2 (similar to pressing Ctrl+C on a keyboard—hold B3, then press B2 within a second or two). Follow the LCD instructions to confirm.
• If B3 +B2 doesn't work, you may need to perform a factory reset (instructions below).
• If none of these steps resolve the issue, submit a support ticket. In some cases, the WiFi chip may have compatibility issues with certain routers, leading to intermittent connections. If so, switching to a different WiFi router may be the best solution.

* For OpenSprinkler Pi: Since WiFi on OSPi is managed by your Raspberry Pi (RPi), troubleshooting should be directed to RPi forums. However, one potential issue related to OpenSprinkler is power supply limitations:

• OSPi is designed to supply only 500mA to the RPi. If you are using an RPi 3, 4, or newer model, it may draw more current than OSPi can provide, potentially causing WiFi issues.
• A workaround is to provide additional power to the RPi by plugging in a micro-USB cable connected to a USB power adapter. This way, the 24VAC supply powers the solenoids, while USB powers the RPi, improving stability.

Wired Ethernet Connection Issues

If your OpenSprinkler controller is having trouble connecting via wired Ethernet, follow these troubleshooting steps:

1. Check the Ethernet connector: The Ethernet port on your controller has two small LEDs: one green and one orange. One of them should be on constantly, and the other should blink occasionally when data is being transmitted. If these LEDs are not behaving as expected, ensure the Ethernet cable is securely plugged in at both ends.
2. Disable PoE (Power-over-Ethernet) on Your Router/Switch: If your OpenSprinkler is connected to a network switch or router with PoE enabled, disable PoE on that port. OpenSprinkler’s wired Ethernet module is not compatible with PoE, and enabling it may cause connection issues.
3. Verify DHCP and Static IP Settings: Check your OpenSprinkler’s network settings to see if DHCP is disabled and a static IP is set. Incorrect static IP settings can prevent the controller from connecting properly. It’s recommended to keep DHCP enabled, allowing your router to automatically assign an IP address. If you need a fixed IP, use your router’s DHCP reservation feature (a.k.a. IP-to-Mac binding) to assign a fixed IP to your OpenSprinkler.
4. If the problem persists after these checks, submit a support ticket for further assistance.

Saving Configurations

We recommend periodically saving a copy of your current configurations, to make it easy to recover programs and settings in case you need to perform a factory reset, or allow us to replicate your settings and reproduce any software issues when you submit support tickets. To do so: at the controller's homepage, swipe left to right to open the left-side menu, then select "Export Configurations" to a file. This will download your configurations to a .json file. 

Factory Reset

Before performing a factory reset, if you still have access to the controller, we strongly recommend following the "Saving Configurations" step above to back up your settings. This will allow you to restore your programs and preferences easily after the reset.

* For Microcontroller-Based OpenSprinkler (Versions 1.x, 2.x, 3.x): To perform a factory reset:

• Power off the controller; then power it back on, and as soon as the OpenSprinkler logo or the word "OpenSprinkler" appears, press and hold B1 (the first pushbutton).
• Continue holding B1 until the LCD displays "Factory Reset?".
• Ensure the answer is "Yes".
• Press and hold B3 (the third pushbutton) until the controller reboots and completes the reset process.

* For OpenSprinkler Pi (OSPi):  To reset an OpenSprinkler Pi:

• Navigate to the firmware directory (default: ~/OpenSprinkler-Firmware).
• Run the following command to remove the done.dat file:

sudo rm done.dat

Blank Page When Accessing the Controller’s Homepage

If you encounter a blank page when trying to access your OpenSprinkler controller’s homepage, follow these troubleshooting steps:

1. Check Your Firmware Version: If your controller is running firmware 2.1.9 or earlier, update it to the latest version (2.2.1).

Due to changes in our weather server (which were necessary because of updates from our weather service provider), older firmware versions can no longer properly process weather data and options. Follow the firmware upgrade instructions to update your controller and restore functionality.

2. Corrupted Data: If the issue persists after updating firmware, it may be caused by corrupted data. Try the following:

• Access the controller from a desktop/laptop web browser and open the browser’s developer console to check for errors. For example, in Chrome, go to: Settings --> More Tools --> Developer Tools --> Click on the Console tab.
• Reload the controller’s homepage and note any error messages that appear in the console.

3. Diagnose Using the HTTP API: We provide a API test script that can help identify issues. Start by testing the "Json All" (/ja) API to see if the controller returns any data.

• If the request times out or the IP is unreachable: The controller has likely lost connection to your router. Press the first pushbutton (B1) on the controller to double check the IP address and port number.
• If you receive a response but it reports an "INVALID JSON" error: There is a data corruption issue.
  
  

4. Resolving Data Corruption Issues. You can attempt to reset only the corrupted data if it's identified. However, the most straightforward solution is to perform a factory reset, which will restore the controller to default settings and resolve any corrupted data. If you continue to experience issues, submit a support ticket for further assistance.

Changes to Programs Are Not Being Saved

If you’re unable to save changes to your programs, it is most likely due to outdated firmware, similar to the issue above. Follow the firmware update instructions to get your controller updated.

'Sequential Flag' Option Missing After Updating to Firmware 2.2.0

Starting with firmware 2.2.0, the previous "Sequential Flag" has been replaced with the more flexible "Sequential Group" attribute:

• Each zone can now be assigned to one of four sequential groups or to a parallel group.
• Assigning a zone to the parallel group is equivalent to removing the "sequential flag'" in earlier firmware versions.

For details please take a look at firmware 2.2.0 user manual and / or watch firmware 2.2.0 video tutorial.

My Controller’s LCD is Malfunctioning. How Can I Get It Replaced?

If you purchased your OpenSprinkler within one year, it’s covered under warranty. Simply submit a support ticket to receive a replacement LCD at no additional cost.

If your purchase is over a year old, you can buy a replacement LCD from Aliexpress.com or Amazon.com. We use standard, off-the-shelf LCD components, so replacements are easy to find and inexpensive (usually just a few dollars). For example, if you have an OpenSprinkler 3.x, the correct replacement LCD is the "I2C OLED 0.96" type. You can find plenty of options by searching for it on Aliexpress or Amazon. The pin order should be GND, VCC, SCL, SDA (the most common configuration). Do NOT use the VCC, GND, SCL, SDA type, as it is not compatible.

Diagnosing Issues with Your OpenSprinkler Pi (OSPi)

1. Check for Short Circuits

Power off the OSPi and remove the Raspberry Pi from the OSPi board. Use a multimeter to measure the resistance between VIN and GND: place the red probe on VIN and the black probe on GND (located at the top-right corner of the circuit board). The resistance may fluctuate initially but should stabilize at 4.5 kΩ (kilo-ohms) or higher. If the resistance is significantly below 1 kΩ, there may be a short circuit on the VIN line. In this case, submit a support ticket for further assistance.

2. Test Power Supply and Voltage

If the resistance test passes, the next step is to plug in the 24VAC power supply (via the orange terminal block). Check if the LED on the circuit board lights up. Use a multimeter to measure the DC voltage between VIN and GND. The voltage should be around 5V (within the range of 4.7V to 5.2V). If the voltage is outside this range, there may be a power supply or hardware issue.

3. Check Software Setup

If both resistance and voltage tests pass, the issue is likely related to the software. We recommend you to reformat the SD card and reinstall Raspbian, then reinstall the OpenSprinkler firmware.

How to Save Log Data as a Spreadsheet

You can use the script included in the OS API document to access your log data and export it as a .csv file.