OpenSprinkler OpenSprinkler v3 Bedienungsanleitung
OpenSprinkler User Manual
Firmware 2.1.9 (Sep 23, 2019)
Contents
Introduction
What's New in this Firmware?
Hardware Interface
Zone Wire Connection Diagrams
Installation
LCD and Button Functions
Firmware 2.1.9 User Manual
1. Overview
2. Accessing the Controller
3. Homepage
3.1 Device Status
3.2 Zone Attributes
4. Menu Buttons
4.1 Rain Delay
4.2 Stop All Zones or an Individual Zone
5. Edit Options
6. Run-Once Program
7. Programs
7.1 Program Data
7.2 Program Preview
7.3 Zone's Sequential Attribute
8. Logging
9. Firmware Update, FAQ, Support, and Github
Advanced Topics
1. Installing Radio Frequency (RF) Transmitter
Specifications
OpenSprinkler Firmware 2.1.9 User Manual 1
Introduction
OpenSprinkler is an open-source, web-based sprinkler/irrigation controller. It’s a drop-in replacement for
conventional sprinkler controllers that do not have web connectivity. OpenSprinkler’s advantages include an
intuitive user interface, remote access, and smart weather-based watering control. It is ideal for homeowners or
business owners with applications in lawn/garden watering, plant irrigation, drip irrigation, hydroponics etc.
OpenSprinkler has several hardware versions: OpenSprinkler v3 (with built-in WiFi, two independent sensor
terminals, and optionally wired Ethernet module), OpenSprinkler 2.3 (wired Ethernet only), and OpenSprinkler Pi
(or OSPi, driven by an RPi). OpenSprinkler v3 and 2.3 are fully assembled and come with pre-flashed firmware.
OSPi requires some assembly steps (e.g. plugging in your Raspberry Pi) and firmware installation. For all versions,
the main controller can switch 8 zones; and additional zones can be added by linking zone expanders (each
expander adds 16 zones; up to four expanders are supported, for a total of 8 + 16 * 4 = 72 zones). In addition,
OpenSprinkler v3 has three variants: AC-powered, DC-powered, and LATCH:
●AC-powered version comes with an orange terminal block. 24VAC power adapter is NOT included by default
but can be purchased as an optional add-on (or use your own 24VAC power adapter).
●DC-powered version comes with a black power barrel, and a 7.5VDC adapter is included by default for North
American users. You can also use your own DC adapter with output voltage anywhere between 6VDC to
12VDC, or use a 12VDC solar panel. Though it's powered by DC adapter, it can operate 24VAC sprinkler
valves.
●Similar to the DC-powered version, the LATCH version comes with a black power barrel, and 7.5VDC adapter
is included for North American users. It's designed specifically for latching solenoid valves only.
What's New in this Firmware?
Firmware 2.1.9 has a number of changes compared to the previous firmware versions, as explained below:
●Controller settings, station settings, program data are now stored as separate files in flash or SD card
(previously they are stored as a single chunk of data). This makes it possible to expand program and station
features, and eliminate the resetting of controller data when upgrading to newer firmwares in the future. For
OS v2.3, this firmware requires SD card (almost all v2.3 units come with the required SD card already).
●For OS v3, support for the second sensor has been added. Each sensor can be independently set as any of
rain sensor, soil sensor, or program switch; in addition, sensor1 supports flow sensor (as previously).
●For rain and soil sensors, this firmware supports 'Delayed On Time' and 'Delayed Off Time' parameters, which
provide flexible control on when the sensor is treated as activated or deactivated.
●Zone attributes now have three separate options: 'Ignore Sensor1', 'Ignore Sensor2', and 'Ignore Rain Delay'
(previously there was only one 'Ignore Rain' option). For each zone, you can individually set the three options.
●For weather adjustment methods, in addition to the Zimmerman algorithm, this firmware also supports the
'ET' (evapotranspiration) algorithm, which is a widely used industry standard. The specific weather data used
for each adjustment method is retained by the firmware and displayed in the UI.
●Support for using Weather Underground PWS station as weather data source.
●This firmware tracks the controller's reboot cause and timestamp, which are displayed in the UI.
OpenSprinkler Firmware 2.1.9 User Manual 2
Hardware Interface
OpenSprinkler Firmware 2.1.9 User Manual 3
Zone Wire Connection Diagrams
●Each valve has two wires. Typically, one wire from each valve (regardless of whether it's on the main
controller or an expander) is connected together into a COM (common) wire, and that COM wire should go to
the COM terminal port (NOT GND!!!) on OpenSprinkler.
●OpenSprinkler has two COM ports: you can use either -- they are internally wired together so are the same.
●The other wire of each valve goes to an individual zone port.
●If you have a master or pump start relay wire, you can insert it into any zone port -- OpenSprinkler uses
software defined master / pump zone so you can dedicate any zone as a master zone.
Installation
Important Notes
●OpenSprinkler is NOT waterproof. For outdoor use, please purchase a waterproof enclosure.
●International customers: for OpenSprinkler AC-powered version, please find a 24VAC transformer compatible
with your country’s powerline voltage standard. Failure to observe the powerline voltage standard can result
in damage to your controller. If you cannot find 24VAC transformer, you may consider OpenSprinkler
DC-powered version, which uses a low-voltage (7.5~12VDC) adapter.
Wiring and Installation Tutorial Video (video is based on version 2.3):
OpenSprinkler Firmware 2.1.9 User Manual 4
Instructions:
Step 1: Label wires and remove your existing sprinkler controller.
●Carefully label and remove the wires from your existing sprinkler controller, then remove it from the wall.
Typically you will see the power supply wires, the COM (common) wire, one or more Zone wires. Depending
on your setup, you may also find a Master Zone (or Pump Start Relay) wire, and Rain / Soil / Flow Sensor
wires (if using any such sensor).
Step 2: Attach OpenSprinkler to the wall, and re-insert the wires:
●Refer to the Hardware Interface diagram and Zone Wire Connection diagrams on the previous pages. All
terminal blocks on OpenSprinkler can be unplugged for easy wiring. To unplug, firmly grab both ends of the
terminal block, wiggle, and pull it out.
●Insert COM, zone, and sensor (if any) wires to their corresponding terminal ports on OpenSprinkler.
○For OpenSprinkler DC and LATCH: OpenSprinkler's COM terminal is positive (+). If your solenoid wires
have polarity, make sure its positive wire (typically red) goes to COM.
●For OpenSprinkler AC, insert and tighten the 24VAC wires into the Orange terminal block (AC has no polarity
so the two wires have no distinction);
For OpenSprinkler DC or LATCH, insert the DC power adapter into the power barrel on OpenSprinkler.
●For additional details on how to connect sensors (e.g. rain or flow sensor), refer to the Sensors Section.
Step 3: Link OpenSprinkler Zone Expanders (Optional):
●If you have zone expanders: plug one end of the zone extension cable (which comes with each expander) into
OpenSprinkler’s Zone Expander Connector: the connector is polarized so there is only one way to plug it in.
○For OpenSprinkler 2.3 or OSPi: plug the other end of the cable to Zone Expander's IN connector. If you
have multiple expanders, daisy chain them by following the OUT → IN links.
○For OpenSprinkler v3: plug the other end of the cable to either of Zone Expander's connectors on the side.
If you have multiple expanders, use additional cables to link them (again, the two ports on each expander
are identical so you can use either). Because all Zone Expanders are hooked onto the same (I2C) bus, you
must set for each Zone Expander a unique index (1, 2, 3, or 4). Each Zone Expander has a DIP
switch (see picture on the right) that allows setting index. The first expander (directly connected
to main controller) should have an index of 1 (OFF OFF on the DIP switch), the second expander
should be 2 (ON OFF), the next is 3 (OFF ON), and the last is 4 (ON ON).
Zones on the main controller correspond to indices 1 to 8; zones on the first expander (DIP position OFF
OFF) correspond to indices 9 to 24; and so on. The firmware can detect the expander with the highest
index, however, you still need to manually set the number of zones in settings. You can set more zones
than physically available, to take advantage of 'Virtual Zones' features (e.g. Remote, HTTP, RF zones).
Step 4: Setting Up Ethernet or WiFi
●For OpenSprinkler 2.3: plug in a wired Ethernet cable to OpenSprinkler's Ethernet jack, the other end to your
router. If you prefer using WiFi connection, we recommend you to purchase OpenSprinkler v3, which has
built-in WiFi. (If you an OpenSprinkler 2.3 and want WIFi connection, you can use a powerline Ethernet adapter,
or a pocket-size travel router. Check our Video Tutorial for specific instructions).
OpenSprinkler Firmware 2.1.9 User Manual 5
●For OpenSprinkler v3:
○In WiFi mode, the first time you power on OpenSprinkler (or every time after a factory reset), it starts as a
WiFi AP (Access Point), creating an open WiFi network with SSID displayed on the LCD screen (e.g.
OS_xxxxxx). Use your phone or laptop to connect to this WiFi network (Note: on Android phones, you may
receive a warning: WiFi has no Internet connection. Select Yes to stay connected).
○Once your phone or laptop is connected to the AP, open a browser and type in the AP IP address
192.168.4.1. Follow the instructions to complete the WiFi setup. In particular, you need to select (or type
in) your home WiFi router's SSID and password (NOT OpenSprinkler's password!) Then click on Connect.
●Once the device connects to your WiFi successfully, it will automatically reboots into WiFi Station mode.
To access the controller in station mode, simply click push-button B1 -- that will display the device IP
address to LCD screen.
●On your phone or computer, open the OpenSprinkler mobile app, or simply launch a web browser and type
in the device IP address, you will see the OpenSprinkler web interface and homepage.
The default device password is opendoor.
❏NEW from OpenSprinkler v3.2: from v3.2, the controller has dual support for WiFi and
wired Ethernet. You can purchase an add-on Ethernet module. When the Ethernet module
is plugged in, the controller boots in wired Ethernet mode; when the module is unplugged,
it boots in WiFi mode. The controller comes with a built-in module cable: plug the cable
connector firmly to the Ethernet module as showN on the right -- the connector is polarized
so there is only one way to plug it in. Then you can plug in a wired Ethernet cable (RJ45) to
the other end of the module.
Reset WiFi / Password Reset / Factory Reset
●Reset WiFi: for OpenSprinkler v3, if you need to reset or switch WiFi network (without erasing program
settings): after controller is powered on, press B3 followed by B2 (B3+B2 like how you press Ctrl+C) until the
screen displays 'Reset to AP mode?'. Then Click B3 to confirm. You can also trigger a WiFi reset using the
OpenSprinkler mobile app. To do so, go to Edit Options -> Reset -> Reset WiFi.
●Reset Device Password: if you have forgotten your device password, you can use buttons to bypass
password. To do so, first remove power from OpenSprinkler; then plug the power back in, as soon as you see
the OpenSprinkler Logo, press and hold push-button B3, and continue holding B3 until the LCD displays
'Setup Options'. Then click B3 as many times as you need until it shows 'Ignore Password'. Click B1 to select
Yes, and finally press and hold B3 until the controller reboots itself. Now you can access the controller with
any password. For security reasons, we recommend you to immediately change the password and set the
Ignore Password option back to No.
●Factory Reset: to perform a factory reset, first remove power from OpenSprinkler; then plug the power back
in, as soon as you see the OpenSprinkler Logo, press and hold push-button B1, and continue holding B1
until the LCD displays 'Reset?' Make sure the answer is Yes, then press and hold push-button B3 until the
controller reboots itself and completed the resetting process.
○Upon factory reset, the device password is reset back to the default, which is opendoor.
OpenSprinkler Firmware 2.1.9 User Manual 6
LCD and Button Functions
LCD (the illustration below is captured on OpenSprinkler 3.0's LCD)
●Master Zone 1 (if defined) is marked by M; and Master Zone 2 (if defined) is marked by N.
●By default the LCD displays the first 8 zones. If you have any expanded zones, click B3 (see below) to switch
to another group of 8 zones. Each running/open zone is displayed with a three-letter animation: . o O
●If the controller is configured to Remote Extension mode, a radar icon will be shown.
●If a manually triggered rain delay is active, a clock icon will be shown.
●If Sensor1 (available on all versions) is defined, a letter will be shown: r for rain sensor, s for soil sensor, p for
program switch, f for flow sensor. When the sensor is detected to be active, the letter will be capitalized. In
addition, a rain icon will be shown for rain sensor, and soil icon will be shown for soil sensor.
●If Sensor2 (available only on OS3.x) is defined, the display is similar to Sensor1.
Buttons
After the controller is powered on, the buttons are assigned the following functions:
Click
Press and Hold (i.e. Long Press)
B1:
Display device IP address
Stop all zones immediately
B2:
Display device MAC address
Reboot the controller
B3:
Toggle between the main controller (MC)
and each expansion board (E1, E2, E3 etc).
Manually start an existing program or a test program.
B1 + B2
Display gateway (router) IP (i.e. press and hold B1, then press B2, similar to how you press Ctrl+C etc.)
B2 + B1
Display external (WAN) IP.
B2 + B3
Display timestamp of the last weather server response
B3 + B2
For OpenSprinkler v3: reset controller to AP mode (for re-configuring WiFi).
B1 + B3
(for internal testing only) Start a very quick (2 seconds each zone).
B3 + B1
Display the last system reboot timestamp and reboot reason.
Pressing and holding the following buttons while the OpenSprinkler Logo is displayed at reboot:
If B1 is pressed and held while logo is displayed at reboot: enter Factory Reset.
If B2 is pressed and held while logo is displayed at reboot: enter internal test mode (for OS v3 only)
If B3 is pressed and held while logo is displayed at reboot: enter Setup Options.
OpenSprinkler Firmware 2.1.9 User Manual 7
Firmware 2.1.9 User Manual
1. Overview
OpenSprinkler’s built-in web interface works with both desktop and mobile browsers. It allows you to change
settings and modify programs at any time using either a web browser or the free OpenSprinkler mobile app. To
install the mobile app, just search opensprinkler in your app store.
Watch Firmware Tutorial Video (the video below is based on an earlier firmware 2.1.0):
2. Accessing the Controller
Once the controller establishes a valid connection, you can find out its IP address and HTTP port number on the
LCD by clicking button B1. In the following we will refer to the IP address as os-ip (for example: 192.168.1.122).
Next, open a browser and type in the URL http://os-ip (e.g. http://192.168.1.122). In case you have set a custom
HTTP port number (other than the default 80), include the port number in the URL as well. For example, if you have
changed OpenSprinkler’s port number to 8080, type in http://os-ip:8080.
Device Password: the factory default password is opendoor. For security
reasons, please change this password upon the first use.
TIP: the OpenSprinkler mobile app has an additional feature that can automatically
scan your network for available OpenSprinkler devices.
3. Homepage
At the home page you will find a weather icon and the list of all stations and their current status. The bell button in the
upper-right corner (when visible) indicates notifications are present and opens a sidebar with all notifications. The button on
the upper-left corner activates the left-side menu, which shows additional menu items such as:
●Export/Import Configuration: save/restore controller settings and programs. This is useful during firmware upgrade or in
preparation for factory reset.
●About: display the app version, firmware version, and hardware version.
OpenSprinkler Firmware 2.1.9 User Manual 8
●Localization: change the display language.
●OpenSprinkler.com Login: log in with your opensprinkler.com account name and password. This allows cloud synced
data such as station photos, notes, site configurations etc.
●Disable Operation: disables zone operations. This is useful if OpenSprinkler will not be used for a period of time.
●Change Password: change device password (default is opendoor).
●Reboot OpenSprinkler: trigger a software reboot of the controller.
●System Diagnostics: displays diagnostic information, including timestamp and cause of the last reboot; timestamp of the
last weather call, response received, and response code etc.
TIP: at any time, you can activate the left-side menu by dragging your mouse pointer from left to right (on desktop browses)
or swiping your finger from left to right (on mobile browsers).
3.1 Device Status
The footer shows the device’s current status. It shows information in the following priority: system enable status, currently
running stations, or active rain delay status. If no active events are detected the system will display information of the last run
station and if not available will read ‘System Idle’. If a flow sensor is installed, the status bar shows the real-time flow rate
(updated every 30 seconds). If any zone is active, the status bar also shows the total current
draw of all solenoid valves.
3.2 Zone Attributes
Click the gear icon next to each zone name and a zone attribute box will pop up:
●Station Name: give each zone a custom name (up to 32 characters).
●Use Master: when checked, the associated Master zone(s) will turn on whenever this zone is
activated. This attribute is only visible if a Master zone is defined.
●Ignore Rain Delay / Sensor1 / Sensor2: when checked, this zone will bypass manual
raindelay, sensor1 or sensor2. These attributes allow you to customize if a zone is affected
by any of them. By default these flags are off.
●Disable: when checked, this zone will not run and is hidden from the user interface.
●Sequential: when checked, this zone will be serialized with other zones that also have the
Sequential attribute turned on. In other words, at most one sequential zone will be running at
any given time. Default is on.
Station Type (Advanced tab): the default type is Standard; you can also choose from several
types of special/virtual stations as explained below:
●RF zone: by installing a RF (radio frequency) transmitter (see Advanced Topics section), OpenSprinkler can switch many
common RF remote power sockets. To do so, you need to purchase an RFtoy and use it to decode RF signal code from
your remote power sockets. Once the code is set, whenever this zone is turned on/off, OpenSprinkler will send the on/off
code through RF transmitter to remotely switch the power socket. This allows your OpenSprinkler to control powerline
devices, such as Christmas lights, heaters, pumps, etc.
●Remote zone: a remote station is a physical station on another OpenSprinkler. This allows one master controller to send
commands to remote controllers in order to turn on their valves. Each remote station is specified by the IP address, port
number, and station index on the remote controller. For example, you can map master controller's zone 1 to remote
controller's zone 5. However, the master and remote controllers must share the same password.
●GPIO zone: allows the zone to directly switch a spare GPIO pin available on the controller. Only valid GPIO pins are visible.
You can also define the active state (i.e. Active High or Active Low).
●HTTP zone: allows the zone to trigger a generic HTTP GET command. To define an HTTP station, you need to provide a
server name (either domain name or IP address), port number, on command (without the starting slash /), and off
command. When this zone is turned on, it automatically sends a HTTP GET command server:port/on_command; similarly,
when it’s turned off, it sends a HTTP GET command in the form of server:port/off_command.
●Note that the above special zones are virtual – you do NOT need to have physical zones to use them. In other words, even
if you don’t have any zone expander, you can still use special zones up to the maximum number of zones supported.
OpenSprinkler Firmware 2.1.9 User Manual 9
Cloud Synced Attributes: once you log in to opensprinkler.com in the UI/app
(through sidebar menu), cloud-synced attributes will become available, including
station photos and notes. You can take a custom photo for each station by using
the OpenSprinkler mobile app.
4. Menu Buttons
The menu button is on the bottom right corner of all pages and allows quick navigation
between pages relevant to the controller. This menu has the following options:
●Preview Programs, or use keyboard shortcut ALT+V
●View Logs, or ALT+L
●Change Rain Delay, or ALT+D
●Run-Once program, or ALT+R
●Edit Programs, or ALT+P
●Edit Options, or ALT+O
●Stop All Stations (Section 4.2).
Additionally, when you are at the home page, the menu has a button labeled Show
Disabled, which allows disabled zones (if any) to show up in the zone list.
TIP: at any time, you can activate the menu by pressing the M key on your keyboard.
4.1 Rain Delay
To manually trigger a rain delay time, click on the menu button, and select Change Rain Delay to set a custom rain delay time
(in hours). Any zone affected by rain delay will immediately stop, and will not run until the rain delay time is over. To cancel an
existing rain delay, simply set 0 as rain delay time.
4.2 Stop All Zones or an Individual Zone
Click Stop All Stations to stop all zones immediately, including those in the queue waiting to run. To stop an individual zone
(either running or in the queue waiting to run), tap/click the station card on the homepage, and select Yes to confirm.
5. Edit Options
At the home page, click Edit Options (or use keyboard shortcut ALT+O) to configure the basic settings.
OpenSprinkler Firmware 2.1.9 User Manual 10
Andere Handbücher für OpenSprinkler v3
2
Dieses Handbuch passt für folgende Modelle
2
Inhaltsverzeichnis
Andere OpenSprinkler Controller Handbücher
