Published November 27, 2015

Hunter Sprinkler WiFi Remote Control

Control your Hunter sprinkler system from anywhere in the world with this WiFi-connected remote control based on the Esquilo Air.

IntermediateShowcase (no instructions)29,121

Things used in this project

Hardware components

Esquilo Air

Esquilo Sprinkler Shield

Software apps and online services

Esquilo.io Cloud

Hand tools and fabrication machines

Hunter Sprinkler System

Story

Motivation

Here in Texas with our scorching summers and long droughts, efficiently managing your lawn sprinkler system is paramount to assure good water conservation without killing your lawn. Unfortunately, most sprinkler system controllers are still dumb devices that only operate with a fixed schedule set at the control panel. What I need is a remote control that I can use to turn on or off the sprinkler from a remote location, or at least the comfort of my living room.

Background

Hunter ROAM Remote Control

My sprinkler system is made by Hunter Industries which is one of the bigger names in irrigation. Hunter produces a wireless remote control called the ROAM. The ROAM connects to the sprinkler system with a round connector called the SmartPort that wires into the control panel. I purchased one of these to control my system but I discovered that it suffers from two major flaws. First, the range is quite limited and it does not work reliably when I'm outside troubleshooting my sprinkler system zones. Second, it uses a proprietary wireless protocol so it is not connected to my WiFi network and cannot be used from a remote location. What's a hacker to do? Build my own WiFi remote control of course.

Hardware

Sprinkler Shield on the Esquilo Air

I used the Esquilo Sprinkler Shield to control my Hunter system. The shield provides a 24V AC to 5V DC power supply so it is powered directly from the control panel. It also has circuitry to translate logic level signals to the Hunter remote bus. On top of the board are three pins so it can plug directly into the Hunter SmartPort. There are also terminal blocks in case you want to wire it directly to the control panel without the SmartPort.

I mounted the Sprinkler Shield on an Esquilo Air. The Esquilo Air allows me to easily connect to my WiFi network and gives me a cloud site where I can access my application remotely. Also, Esquilo provides all of the software libraries necessary to communicate with the Hunter control panel using its proprietary protocol. The Hunter protocol is a little limited but I can turn on zones for specific times, run a defined program, or stop a zone if it is running. This gives me the same functionality as the ROAM remote with the benefit of reliable and remote communication.

Software

Sprinkler Shield attached to Hunter SmartPort

To test the system out, I wired a SmartPort to my Hunter panel. The wires must be installed in red-white-blue order on the AC and REM terminals. I attached the SmartPort to the Sprinkler shield and the Esquilo Air lit up. I then connected the Esquilo Air to my WiFi network and brought up the IDE from my web browser. I used the following Squirrel code to test out the bus interface on my panel.

// Include the Hunter class from the Esquilo library

dofile("sd:/lib/buses/hunter/hunter.nut");

// Instantiate the Hunter class on UART0

hunter <- Hunter(0);

// Start zone 1 for 2 minutes

hunter.start(1, 2);

The panel responded and turned on zone 1 for 2 minutes. I then changed the code to start a program.

hunter.program(1);

Again the panel responded and turned on program 1. Lastly, I tried to stop a zone and that worked as well.

hunter.stop();

User Interface

Web-based User Interface

After verifying that the shield worked, it was time to move on and hook this up to a user interface. I decided to use a web-based interface using HTML and JavaScript since Esquilo Air has a built in web server and I can use any browser to access it. It also allows me to access the interface remotely with HTTPS via the Esquilo.io cloud site. To build the web interface, I used jQuery and bootstrap which makes it easy to develop a mobile friendly version. The interface is pretty simple but it does exactly what I need. I can turn zones on, start a program, or stop watering that is already in progress.

I used Esquilo RPC (ERPC) to communicate between the JavaScript in the browser and the Squirrel code on the Esquilo Air. This makes it easy to execute embedded functions on the Esquilo Air from my web interface. For example, in JavaScript I wrote the following code to call the stop() function on the Esquilo Air when the stop button is pressed.

$('#stopButton').click(function() {

erpc("stop", null, null, function() {

error("Zone stop failed");

});

The first parameter is the function name on the Esquilo Air, the second parameter is the parameters to pass to the function(none in this case), the third parameter is the success callback, and the fourth is the error callback. In this case, the only callback needed is to display an error message if the ERPC call fails. On the Esquilo Air side, I wrote a simple Squirrel function that simply wraps the stop() method call to the Hunter class.

function stop() {

hunter.stop();

}

The complete code is attached to this project.

Installation

Now it was time to get this thing hooked up permanently. I decided to mount it using the SmartPort. I designed a 3D-printed enclosure using DesignSpark Mechanical that has an opening that exactly matches the SmartPort dimensions.

3D Printed Enclosure for Hunter SmartPort

I printed out the case using blue PLA with a 0.2mm layer height using my MakerGear M2 (a great 3D printer BTW). I used 2-56 thread rolling screws to attach the Esquilo Air to the standoffs I designed into the enclosure bottom. For securing the top, I used 4-40 thread rolling screws that are counter-bored into the case top.

Hunter SmartPort mounted on garage wall.

Since my control panel is mounted outside, I didn't want to worry with the elements getting inside my enclosure and ruining the electronics. I decided to drill a hole through the garage wall and cut a hole to fit a single gang low voltage electrical box. I screwed the SmartPort to a metal cover plate and wired it into the control panel through the hole in the wall. I then sealed up the hole with some silicone.

Finished installation

Lastly, I mounted the Esquilo Air on the SmartPort and my remote control was done!

Schematics

Code

// Sprinkler Remote
//
// See readme.txt for more information.
//
// This work is released under the Creative Commons Zero (CC0) license.
// See http://creativecommons.org/publicdomain/zero/1.0/dofile("sd:/lib/buses/hunter/hunter.nut");

require("GPIO");
        
// Include the Hunter bus class
dofile("sd:/lib/buses/hunter/hunter.nut");

//
// Define your programs here.  Hunter supports 3 or 4 programs depending
// on the model.
//
programs <- [
    // Program A
    "Yards",
    // Program B
    "Flower Beds"
];

//
// Define your zones here in numerical order starting with zone 1.
//
zones <- [
    // Zone 1
    "Front Yard"
    // Zone 2
    "Front Flower Beds"
    // Zone 3
    "Back Yard"
    // Zone 4
    "Back Flower Beds"
    // Zone 5
    "Left Side Yard"
    // Zone 6
    "Right Side Yard"
];

function init()
{
    //
    // Enable the bus output
    //
    oe <- GPIO(2);
    oe.low();
    oe.output();
    
    //
    // Create the hunter instance
    //
    hunter <- Hunter(0);
}

//
// ERPC functions
//
function getZones()
{
    return zones;
}

function getPrograms()
{
    return programs;
}

function startZone(params)
{
  	hunter.start(params[0] + 1, params[1]);
}

function startProgram(params)
{
   	hunter.program(params[0] + 1);
}

function stop()
{
    hunter.stop();
}

//
// Initialize the nut
//
init();

// Sprinkler Controller
//
// This work is released under the Creative Commons Zero (CC0) license.
// See http://creativecommons.org/publicdomain/zero/1.0/
var duration = 5;
var startClick;
var zoneSelect;

function error(text)
{
    $('#errorText').text(text);
    $('#errorModal').modal();
}

function startProgram(program)
{
    erpc("startProgram", [program], null, function() {
        error("Program start failed");
    });
}

function startZone(zone)
{
    erpc("startZone", [zone, duration], null, function() {
        error("Zone start failed");
    });
}

function initControls()
{
    // Stop button
    $('#stopButton').click(function() {
        erpc("stop", null, null, function() {
            error("Zone stop failed");
        });
    });

    // Start button
    $('#startButton').click(function() {
        if (startClick) {
            startClick();
        }
        else {
            error("Select a zone or program");
        }
    });

    // Duration time picker
    $('#durationPicker').timepicker({
        minuteStep: 1,
        showMeridian: false,
        defaultTime: minsToHourMin(duration)
    });

    $('#durationPicker').timepicker().on('changeTime.timepicker', function(e) {
        duration = e.time.hours * 60 + e.time.minutes;
    });
}

function initPrograms()
{
    // Call ERPC getPrograms() to retrieve all of the programs
    erpc("getPrograms", null, function(result) {
        if (result) {
            // For each program, insert it in the zone drop down list
            for (var i = 0; i < result.length; i++) {
                if (result[i] != "") {
                    var letter = ['A', 'B', 'C', 'D'];
                    var name = result[i] + ' (Program ' + letter[i] + ')';
                    $('#programList').append('<li><a href="#" id="program' + i + '">' +
                                             name + '</a></li>');
                    $('#program' + i).click(function(i, name) {
                        return function(e) {
						  $('#programSelect').text(name);
						    $('#zoneSelect').text("");
                            startClick = function() { startProgram(i); };
                            console.log("prog " + i);
                        }
                    }(i, name));
                }
            }
        }
    }, function() {
        error("Unable to retrieve programs");
    });
}

function initZones()
{
    // Call ERPC getZones() to retrieve all of the zones
    erpc("getZones", null, function(result) {
        if (result) {
            // For each zone, insert it in the zone drop down list
            for (var i = 0; i < result.length; i++) {
                if (result[i] != "") {
                    var name = result[i] + ' (Zone ' + (i + 1) + ')';
                    $('#zoneList').append('<li><a href="#" id="zone' + i + '">' +
                                          name + '</a></li>');
                    $('#zone' + i).click(function(i, name) {
                        return function(e) {
						    $('#programSelect').text("");
						    $('#zoneSelect').text(name);
                            startClick = function() { startZone(i); };
                            console.log("zone " + i);
                        }
                    }(i, name));
                }
            }
        }
    }, function() {
        error("Unable to retrieve zones");
    });
}

// Convert minutes to an HOUR:MIN format string
function minsToHourMin(mins)
{
	return mins / 60 + ':' + mins;
}

// Initialize the controls
initControls();

// Initialize the programs
initPrograms();

// Initialize the zones
initZones();

<!DOCTYPE html>
<!--
Sprinkler Remote 

See readme.txt for more information.

This work is released under the Creative Commons Zero (CC0) license.
See http://creativecommons.org/publicdomain/zero/1.0/
-->
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">

    <title>Sprinkler Remote</title>

    <link rel="stylesheet" href="../libs/bootstrap/css/bootstrap.min.css">
    <link rel="stylesheet" href="../libs/bootstrap/css/bootstrap-timepicker.min.css">
    <link rel="stylesheet" href="remote.css">

</head>

<body>

<div class="container">
    <div class="header">
        <h3 class="text-muted">Sprinkler Remote</h3>
    </div>
    
    <div class="row dropdown form-group">
        <div class="col-md-12">
            Program: 
            <button type="button" class="btn btn-default dropdown-toggle form-control" data-toggle="dropdown" aria-expanded="false"> 
                <span id="programSelect"></span>
                <span class="caret"></span>
            </button>
            <ul id="programList" class="dropdown-menu" role="menu">
            </ul>
	    </div>
    </div>
    
    <div class="row dropdown form-group">
        <div class="col-md-12">
            Zone: 
            <button type="button" class="btn btn-default dropdown-toggle form-control" data-toggle="dropdown" aria-expanded="false"> 
                <span id="zoneSelect"></span>
                <span class="caret"></span>
            </button>
            <ul id="zoneList" class="dropdown-menu" role="menu">
            </ul>
	    </div>
    </div>
    
    <div class="row form-group">
        <div class="col-md-12">
            <div class="input-group bootstrap-timepicker">
                <span class="input-group-addon">Duration:</span>
                <input id="durationPicker" type="text" class="form-control">
                <span class="input-group-addon"><i class="glyphicon glyphicon-time"></i></span>
            </div>
        </div>
    </div>
    
    
    <div class="row form-group">
        <div class="col-md-12">
            <button id="startButton" class="btn btn-success form-control" type="button">
                <span class="glyphicon glyphicon-play"></span> Start
            </button>
        </div>
    </div>
    
    <div class="row form-group">
        <div class="col-md-12">
            <button id="stopButton" class="btn btn-danger form-control" type="button">
                <span class="glyphicon glyphicon-stop"></span> Stop
            </button>
        </div>
    </div>

  <!-- Modal -->
  <div class="modal fade" id="errorModal" role="dialog">
    <div class="modal-dialog modal-sm">
      <div class="modal-content">
        <div class="modal-header">
          <button type="button" class="close" data-dismiss="modal">&times;</button>
          <h4 class="modal-title">Error</h4>
        </div>
        <div class="modal-body">
          <p id="errorText"></p>
        </div>
        <div class="modal-footer">
          <button type="button" class="btn btn-default" data-dismiss="modal">OK</button>
        </div>
      </div>
    </div>
  </div>
    
</div>

<script type="text/javascript" src="/js/libs/jquery.min.js"></script>
<script type="text/javascript" src="../libs/bootstrap/js/bootstrap.min.js"></script>
<script type="text/javascript" src="../libs/bootstrap/js/bootstrap-timepicker.min.js"></script>
<script type="text/javascript" src="/js/erpc.js"></script>
<script type="text/javascript" src="remote.js"></script></body>

</html>

Credits

Scott Shumate

1 project • 11 followers

Long time hardware and software hacker.

Hunter Sprinkler WiFi Remote Control

Things used in this project

Hardware components

Software apps and online services

Hand tools and fabrication machines

Story

Motivation

Background

Hardware

Software

User Interface

Installation

Custom parts and enclosures

SmartPort enclosure top

SmartPort enclosure bottom

Schematics

Wiring Diagram

Wiring Diagram

Hunter Shield Schematics

Code

Esquilo Air Squirrel Nut

JavaScript for the HTML user interface

HTML user interface

Credits

Scott Shumate

Comments

Embed the widget on your own site

Hunter Sprinkler WiFi Remote Control

Hunter Sprinkler WiFi Remote Control

Things used in this project

Hardware components

Software apps and online services

Hand tools and fabrication machines

Story

Motivation

Background

Hardware

Software

User Interface

Installation

Custom parts and enclosures

SmartPort enclosure top

SmartPort enclosure bottom

Schematics

Wiring Diagram

Wiring Diagram

Hunter Shield Schematics

Code

Esquilo Air Squirrel Nut

JavaScript for the HTML user interface

HTML user interface

Credits

Scott Shumate

Comments

Related channels and tags