Copyright 2008-2013 KGControls LLC. All rights reserved.7904/23/2013 12:00 PM10/08/2013 05:42:48 PMIrrigationCaddy.comICEthS1Gustavo TenrreiroIrrigationCaddy S1devices_sm/contactsingle_humiditysensor_open.gifdevices_sm/contactsingle_humiditysensor_open.giflua_genIrrigationCaddy_ICEthS1DriverWorksConfiguration
The IrrigationCaddy S1 driver has a few settings that need to be setup.
Under System Design -> Properties configure:
"Hostname or IP" - This is the hostname or IP address for the IrrigationCaddy S1 unit on the network. If you don't know what the IP address is, it can be found on the router under the DHCP client table if any, or you can download the IrrigationCaddySniffer utility from http://irrigationcaddy.com/Documentation.html. The sniffer will find any caddies installed on the local network, and show MAC Address, IP Address, Hostname, etc. Even though the hostname works on most networks, it is always better to use the IP address.
"HTTP Port Number" - This is the HTTP port number that the IrrigationCaddy S1 unit is listening on. By default it is set to 80, but it is configurable from the "Settings -> Network Settings" area on the IrrigationCaddy S1 native user interface.
"Poll Frequency" - Default is 10. This is how often the driver will poll the unit to get a status update of the rain sensor, valves etc. For older controllers like the 300 or 500 we recommend a higher poll time. The HC250 and HC800 work fine with a poll time of 10.
"Last Status Update" - This will show you the last time the driver sucessfully talked to the Irrigation Caddy.
"Manual Run Muntues Zone 1-10" - Default is 15 Minutes. This is the time that runs when you manually trigger a zone from the Control4 navigator interfaces.
The IrrigationCaddy S1 driver for Control4 implements the following commands, events and variables:
=====================================================================================
Commands
=====================================================================================
**Get Status**
Gets status information from the IrrigationCaddy. Which program is running, which zone, how much time remains, etc The information returned is stored in variables.
**Get Zone Names**
Get the zone names information from the IrrigationCaddy and stores each zone name into its own variable.
**Run Program**
Used to run a program. Regardless of what program number is sent, the program contents for the program number
sent will be copied to the Run Now program, and executed; therefore on devices like the ICEthS1 which have up to
3 saveable programs, the status will report that program number 4 is running, as opposed to some other program if a
different program number was sent other than number 4.
**Save Program**
Used to save program settings for one of the programs.
**Stop Running Zone**
Stop the zone running now, if any.
**System ON**
Turns the system ON.
**System OFF**
Turns the system OFF. The scheduler will not run, and the sprinklers will not turn ON at the expected time. Use the "System ON" command to turn the system back ON.
**Version**
It returns firmware version information from the IrrigationCaddy
=====================================================================================
Events
=====================================================================================
**Status Received**
IrrigationCaddy status information was received
**Zone Names Received**
IrrigationCaddy zone name information was received
**Version Received**
IrrigationCaddy firmware version information was received
=====================================================================================
Variables
=====================================================================================
===== =============================== =======
Id Name Type
===== =============================== =======
1001 STATUS_JSON STRING
1002 STATUS_ZONE_NUMBER STRING
1003 STATUS_PROGRAM_NUMBER STRING
1004 STATUS_ALLOW_RUN STRING
1005 STATUS_IS_RUNNING STRING
1006 STATUS_USE_SENSOR STRING
1007 STATUS_IS_RAINING STRING
1008 STATUS_ZONE_SECONDS_LEFT STRING
1009 STATUS_PROGRAM_SECONDS_LEFT STRING
1010 STATUS_MAX_ZONES STRING
1011 STATUS_Z1_IS_RUN STRING
1012 STATUS_Z1_HR STRING
1013 STATUS_Z1_MIN STRING
1014 STATUS_Z2_IS_RUN STRING
1015 STATUS_Z2_HR STRING
1016 STATUS_Z2_MIN STRING
1017 STATUS_Z3_IS_RUN STRING
1018 STATUS_Z3_HR STRING
1019 STATUS_Z3_MIN STRING
1020 STATUS_Z4_IS_RUN STRING
1021 STATUS_Z4_HR STRING
1022 STATUS_Z4_MIN STRING
1023 STATUS_Z5_IS_RUN STRING
1024 STATUS_Z5_HR STRING
1025 STATUS_Z5_MIN STRING
1026 STATUS_Z6_IS_RUN STRING
1027 STATUS_Z6_HR STRING
1028 STATUS_Z6_MIN STRING
1029 STATUS_Z7_IS_RUN STRING
1030 STATUS_Z7_HR STRING
1031 STATUS_Z7_MIN STRING
1032 STATUS_Z8_IS_RUN STRING
1033 STATUS_Z8_HR STRING
1034 STATUS_Z8_MIN STRING
1035 STATUS_Z9_IS_RUN STRING
1036 STATUS_Z9_HR STRING
1037 STATUS_Z9_MIN STRING
1038 STATUS_Z10_IS_RUN STRING
1039 STATUS_Z10_HR STRING
1040 STATUS_Z10_MIN STRING
1041 ZONE_NAMES_JSON STRING
1042 ZONE_NAME_1 STRING
1043 ZONE_NAME_2 STRING
1044 ZONE_NAME_3 STRING
1045 ZONE_NAME_4 STRING
1046 ZONE_NAME_5 STRING
1047 ZONE_NAME_6 STRING
1048 ZONE_NAME_7 STRING
1049 ZONE_NAME_8 STRING
1050 ZONE_NAME_9 STRING
1051 ZONE_NAME_10 STRING
1052 VERSION_JSON STRING
1053 VERSION STRING
===== =============================== =======
Hostname or IP
STRING
false
HTTP Port Number
STRING
80
false
HTTP Username
STRING
false
HTTP Password
STRING
false
Poll Frequency
LIST
- 10 sec
- 30 sec
- 60 sec
- 90 sec
10 sec
false
Debug Mode
LIST
- Off
- Print
- Log
- Print and Log
Off
false
Last Status Update
STRING
true
Manual Run Minutes Zone 1
STRING
15
false
Manual Run Minutes Zone 2
STRING
15
false
Manual Run Minutes Zone 3
STRING
15
false
Manual Run Minutes Zone 4
STRING
15
false
Manual Run Minutes Zone 5
STRING
15
false
Manual Run Minutes Zone 6
STRING
15
false
Manual Run Minutes Zone 7
STRING
15
false
Manual Run Minutes Zone 8
STRING
15
false
Manual Run Minutes Zone 9
STRING
15
false
Manual Run Minutes Zone 10
STRING
15
false
Get Status
Get status information from the IrrigationCaddy. Which program is running, which zone, how much time remains, etc
Get Zone Names
Get the zone names information from the IrrigationCaddy.
Run Program
Used to run a program. Regardless of what program number is sent, the program contents for the program number
sent will be copied to the Run Now program, and executed; therefore on devices like the ICEthS1 which have up to
3 saveable programs, the status will report that program number 4 is running, as opposed to some other program if a
different program number was sent other than number 4.
Save Program
Used to save program settings for one of the programs.
Stop Running Zone
Stop the zone running now, if any.
System ON
Turns the system ON.
System OFF
Turns the system OFF. The scheduler will not run, and the sprinklers will not turn ON at the expected time. Use the "System ON" command to turn the system back ON.
Version
It returns firmware version information from the IrrigationCaddy
1
6
Zone 1
1
False
False
False
False
RELAY
2
6
Zone 2
1
False
False
False
False
RELAY
3
6
Zone 3
1
False
False
False
False
RELAY
4
6
Zone 4
1
False
False
False
False
RELAY
5
6
Zone 5
1
False
False
False
False
RELAY
6
6
Zone 6
1
False
False
False
False
RELAY
7
6
Zone 7
1
False
False
False
False
RELAY
8
6
Zone 8
1
False
False
False
False
RELAY
9
6
Zone 9
1
False
False
False
False
RELAY
10
6
Zone 10
1
False
False
False
False
RELAY
1
Status Received
IrrigationCaddy status information was received
2
Zone Names Received
IrrigationCaddy zone name information was received
3
Version Received
IrrigationCaddy firmware version information was received
4
System On
Fires when the unit has turned on
5
System Off
Fires when the unit has turned off
6
Rain Detected
Fires when the unit has detected rain
7
Stopped Raining
Fires when the unit has stopped detecting rain
8
Zone 1 On
Fires when the zone turns on
9
Zone 2 On
Fires when the zone turns on
10
Zone 3 On
Fires when the zone turns on
11
Zone 4 On
Fires when the zone turns on
12
Zone 5 On
Fires when the zone turns on
13
Zone 6 On
Fires when the zone turns on
14
Zone 7 On
Fires when the zone turns on
15
Zone 8 On
Fires when the zone turns on
16
Zone 9 On
Fires when the zone turns on
17
Zone 1 Off
Fires when the zone turns off
18
Zone 2 Off
Fires when the zone turns off
19
Zone 3 Off
Fires when the zone turns off
20
Zone 4 Off
Fires when the zone turns off
21
Zone 5 Off
Fires when the zone turns off
22
Zone 6 Off
Fires when the zone turns off
23
Zone 7 Off
Fires when the zone turns off
24
Zone 8 Off
Fires when the zone turns off
25
Zone 9 Off
Fires when the zone turns off