Irrigation
Local Entry Point
Local request entry point for iZone Irrigation is:
Query Request.
POST http://[bridge_IPAddr]/iLightRequest
Control Request.
POST http://[bridge_IPAddr]/iLightCommand
Local Query Request Format
Local query request body format for iZone Irrigation is:
Request Body JSON:
{
"RetRequest": {
"Type": 1, //Retic system info 1, Retic program info 2, Retic station info - 3
"No": 0, //program or station number
"No1": 0 //reserved
}
}
Datagram
Irrigation Controller
{
"Tag1":"iDrate", // string
"Tag2":"Irrigation System", // string
"Name1":"Morning", // string
"Name2":"Program 2", // string
"Name3":"Program 3", // string
"Name4":"Program 4", // string
"Name5":"Program 5", // string
"Name6":"Program 6", // string
"Name7":"Program 7", // string
"Name8":"Program 8", // string
"Name9":"Program 9", // string
"Enable":true, // bool - retic system is enabled
"SoakPeriods":2, // int - Max is 15
"SoakTime":1, // int - max is 240
"NoOfStations":8, // int - max is 24
"Ratio":100, // int - valid 0<>200, display as "ratio-100"
"TestTime":1, // int - max is 240
"RainWait":0, // int - max is 7
"ManualRunTime":1, // int - max 240
"IgnoreLowCurrentFault":0, // int - ignore low current fault (1 - ignore, 0 - do not ignore)
"CurrentProgram":9, // int - 0-8; other = no program
"TestMode":0 // int - 0/1
"Pass": "string", // configuration password
"RfCh": 1, // RF channel used by the system ( 1 - 8 )
"CtrlErr": 0 // 0 - no errors, 1 - controller 1 error, 2 - controller 2 error, 3 - controller 3 error
}
Irrigation Station
{
"Index":0, // int - 0-23
"Name":"Front Lawn", // string
"Soak":1, // int - 0/1
"State":0, // int - 0 : not running,1 : soaking, 2 : watering
"Error":0, // int - 0 : no error,1 : error - open, 2 : error - short
"LastRun":7, // int - 7 means 7 or more days
"Mode": 0 // int - 0 - Auto, 1 - Manual, 2 - Disabled
}
Irrigation Program
{
"Name":"Morning", // string
"Days":
{
"M":0, // int - 0/1
"T":0, // int - 0/1
"W":1, // int - 0/1
"Th":1, // int - 0/1
"F":0, // int - 0/1
"Sa":0, // int - 0/1
"Su":0 // int - 0/1
},
"Enable":1, // int - 0/1
"Index":0, // int - program number 0-8
"StartTimes":
[
{
"h":12, // int - start hour
"m":21 // int - start minute
}
],
"RunTimes":
[
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
},
{
"t":10 // int - max 240
}
]
}
Control Actions
Irrigation System On/Off
Available: Local API
{
"RetEnable":a
}
where: a - is enabled state
Set Run Time Ratio
Available: Local API
{
"RetRatio":a
}
where:
- a - is the ratio to adjust run time (0 - 200, when displaying substruct 100, means -100% to 100%).
Set Rain Wait
Available: Local API
{
"RetRainWait":a
}
where:
- a - is the number of days on hold before watering again (0 - 7)
Run Test Irrigation System
Available: Local API
{
"RetTestMode":a
}
where:
- a - is the test mode flag: 1 - run test ; 0 - stop test
Set Soak Divide Number
Available: Local API
{
"RetSoakIntervals":a
}
where:
- a - is the number of soaking intervals (max is 15)
Set Each Soak Pause Time
Available: Local API
{
"RetSoakTime":a
}
where:
- a - is the each soak pause time in minutes.
Set Manual Mode Station Run Time
Available: Local API
{
"RetSetManRunTime":a
}
where:
- a - is the time in minutes (1 - 240).
Name Irrigation System
Available: Local API
{
"RetTag2":{
"Tag":"string"
}
}
where:
- string is the new tag text, 15 characters max
Change Station Mode
Available: Local API
{
"RetStnMode":{
"No":a,
"Mode":b
}
}
where:
- a - is the station number (0 - 23)
- b - is the station mode setting
Set Station Soak Cycle
Available: Local API
{
"RetStSoak":{
"No":a,
"Soak":b
}
}
where:
- a - is the station number (0 - 23)
- b - is the station soak cycle setting (0 - disable; 1 - enable)
Name Station
Available: Local API
{
"RetPrRetStNameogName":{
"No": a,
"Name":"string"
}
}
where:
- a - is the station number (0 - 23)
- string is the new station name, 15 characters max
Set Station Run Time For Program
Available: Local API
{
"RetStRunTime":{
"Program":a,
"No":b,
"RunTime":c
}
}
where:
- a - is the program number (0 - 8)
- b - is the station number (0 - 23)
- c - is station run time in minutes in this program (max is 240)
Run Program
Available: Local API
{
"RetRunProgram":{
"No":a,
"Run":b
}
}
where:
- a - is the program number (0 - 8)
- b - is run flag (0 - stop; 1 - run)
Set Program Schedule
Available: Local API
{
"RetProgram":{
"Index":a,
"StartTimes":
[
{
"h":b,
"m":c
}
],
"M":d,
"Tu":e,
"W":f,
"Th":g,
"F":h,
"Sa":i,
"Su":j
}
}
where:
- a is program number
- b is start hour
- c is start minute
- d is monday enabled (0 - disabled; 1 - enabled)
- e is tuesday enabled (0 - disabled; 1 - enabled)
- f is wednesday enabled (0 - disabled; 1 - enabled)
- g is thursday enabled (0 - disabled; 1 - enabled)
- h is friday enabled (0 - disabled; 1 - enabled)
- i is saturday enabled (0 - disabled; 1 - enabled)
- j is sunday enabled (0 - disabled; 1 - enabled)
Enable Program Schedule
Available: Local API
{
"RetPrEnable":{
"No":a,
"Enable":b
}
}
where:
- a - is the program number (0 - 8)
- b - is enable flag (0 - disable; 1 - enable)
Name Program
Available: Local API
{
"RetProgName":{
"No": a,
"Name":"string"
}
}
where:
- a - is the program number (0 - 8)
- string is the new program name, 15 characters max
Types
RetEn_e
{
En_Off,
En_On
}
StnMode_e
{
StnMode_Auto,
StnMode_Manual,
SysMode_Disabled,
}