Categoried by device type
This is the multi-page printable view of this section. Click here to print.
Reference
Reference documents for iZone APIs.
- 1: AC Unit
- 2: Zone
- 3: Schedule
- 4: Irrigation
- 5: Power Monitor
- 6: Result Message
1 - AC Unit
Local Entry Point
Local request entry point for iZone Aircon System is:
Query Request.
POST http://[bridge_IPAddr]/iZoneRequestV2
Control Request.
POST http://[bridge_IPAddr]/iZoneCommandV2
Local Query Request Format
Local query request body format for iZone Aircon System is:
Request Body JSON:
{
"iZoneV2Request": {
"Type": 1, //AC unit info - 1, Zone status - 2, Schedule - 3.
"No": 0, //index number of zone or schedule
"No1": 0 //reserved
}
}
Datagram
Systemsettings
{
"SysOn": int, // AC system on: SysOn_e
"SysMode": int, // AC system mode: SysMode_e
"SysFan": int, // AC system fan: SysFan_e
"SleepTimer": int, // number of minutes to set the timer for, 0 = timer off
"Supply": int, // supply air temperature (x100)
"Setpoint": int, // unit setpoint temperature (x100)
"Temp": int, // return air temperature (x100)
"RAS": int, // return air sensor mode: ReturnAirSensor_e
"CtrlZone": int, // zone number to control the unit 0-13, if 15, the use unit setpoint.
"Tag1": string, // first line text
"Tag2": string, // second line text
"Warnings": "none", // indicates current warnings/errors: "none", "filter"
"ACError": string, // 3 character error code. (" OK" = no error)
"EcoLock": int, // if true, setpoints (zones and system) can only be set within EcoMax and EcoMin
"EcoMax": int, // maximum setpoint temperature if EcoLock = true (x100)
"EcoMin": int, // minimum setpoint temperature if EcoLock = true (x100)
"NoOfConst": int, // number of constants in the system
"NoOfZones": int, // number of zones in the system
"SysType": int, // system type, 310 requires supprot for unit control related functions, 210 no unit control
"iSaveEnable": int,
"iSaveOn": int,
"LockCode": string, // up to 6 digits
"LockStatus": int, // locked flag, 1 - unit locked. Enter keycode on iZone controller to unlock the system"
"LockOn": int, // lock enabled
"FanAutoEn": int, // fan auto mode enabled
"FanAutoType": int, // fan auto mode fan type: FanAutoType_e
"FanCapacity": int, // fan auto mode fan capacity (airflow)
"FanUnitCapacity": int, // fan auto mode unit capacity
"FilterWarn": int, // filter wanrning setting (months)
"iZoneOnOff": int, // iZone controls AC unit on/off function, 0 - disabled, 1 - enabled
"iZoneMode": int, // iZone controls AC unit mode function, 0 - disabled, 1 - enabled
"iZoneFan": int, // iZone controls AC unit fan function, 0 - disabled, 1 - enabled
"iZoneSetpoint": int, // iZone controls AC unit setpoint function, 0 - disabled, 1 - enabled
"ExtOnOff": int, // AC unit controls iZone on/off function, 0 - disabled, 1 - enabled
"ExtMode": int, // AC unit controls iZone mode function, 0 - disabled, 1 - enabled
"ExtFan": int, // AC unit controls iZone fan function, 0 - disabled, 1 - enabled
"ExtSetpoint": int, // AC unit controls iZone setpoint function, 0 - disabled, 1 - enabled
"DamperTime": int, // damper time setting (senconds), 0 - automatic
"AutoOff": int, // auto off enable, 0 - disabled, 1 - enabled
"RoomTempDisp": int, // display room temperature, 0 - disabled, 1 - enabled
"RfCh": int, // RF channel number (1-8)
"AutoModeDeadB": int, // auto mode deadband (x100)
"WiredLeds": int, // wired sensor leds setting
"AirflowLock": int,
"AirflowMinLock": int,
"OutOfViewRAS": int,
"CpuType": int, // AcCpuType_e
"SysNo": int, // 0 - 4
"AcUnitBrand": int, // type of the connected AC unit: UnitBrand_e
"AcUnitBrandSet": int, // type of the connected AC unit: UnitBrandSet_e
"OemMake": int, // system make: OemMake_e
"HideInduct": int, // hide induct temperature setting
"ReverseDampers":1, // reverse dampers, 0 - disabled, 1 - enabled
"Scrooge":0, // scrooge mode, 0 - disabled, 1 - enabled
"Pass":string, // system configuration password
"CnstCtrlAreaEn": int, // enable the function, 0 - disabled, 1 - enabled
"CnstCtrlArea": int, // zone area setting for the constant control by area setting
"StaticP": int, // static pressure setting for Midea type of units 0-lowest -> 4-highest
"OpenDampersWhenOff": int, // open dampers when AC system is off setting
"ShowActTemps": int, // in the modern zone list show actual temperatures instead of airflow
"UseInductEnergy": int, // use induct energy setting
"UnitOpt": {
"RA":0, // display RA sensor option, 0 - disabled, 1 - enabled
"Master":1, // display Master sensor option, 0 - disabled, 1 - enabled
"Zones":1, // display Zones sensor option, 0 - disabled, 1 - enabled
"History":0, // display unit history option, 0 - disabled, 1 - enabled
"SlaveOpt":0 // display Master/Slave options, 0 - disabled, 1 - enabled
},
"Temperzone": {
"HeatSetpoint": int, // temperzone AC unit heat mode setpoint
"CoolSetpoint": int, // temperzone AC unit cool mode setpoint
"FanType": int,
"ModeType": int,
"Quiet": int, // temperzone outdoor fan quiet mode
},
"GasHeat": {
"Type": int, // universal unit type control: GasHeatType_e
"MinRunTime": int, // minimum run time setting
"AnticycleTime": int, // anticycle time setting
"StageOffset": int, // stage offset setting
"StageDelay": int, // stage delay time setting
"CycleFanCool": int, // cycle fan in cool mode
"CycleFanHeat": int, // cycle fan in heat mode
},
"Ventilation":
{
"RhSetpoint":int, // RH setpoint (5 - 95%)
"VocsSetpoint":int, // VOCs setpoint (50 - 2500ppb)
"Eco2Setpoint":int, // ECO2 setpotin (500 - 1500ppm)
"FanStageDelay":int, // fan stage delay in minutes (3 - 240m)
"CycleFanOff":int, // cycle fan off setting (0 - 1)
"UseRhControl":int, // use RH control setting (0 - 1)
"UseVcosControl":int, // use VOCs control setting (0 - 1)
"UseEco2Control":int // use ECO2 control setting (0 - 1)
},
"Coolbreeze":
{
"FanSpeed":int, // current fan speed (1 - 100)
"State":string, // just a string to display
"RhSet":int, // humidity setpoint (10 - 90)
"RhRead":int, // humidity reading (%)
"FanRunH":int, // fan run hours
"PumpRunH":int, // pump run hours
"PrewEn":int, // prewash enable (0 - 1)
"PrewTime":int, // prewash time (1 - 60 minutes)
"DrAfPrewEn":int, // drain after prewash (0 - 1)
"DrCycEn":int, // drain cycle enable (0 - 1)
"DrCycPer":int, // drain cycle period (1 - 50 hours) send and receive number in minutes
"PostwEn":int, // post wash enable (0 - 1)
"DrBfPostwEn":int, // drain before post wash (0 - 1)
"PostwT":int, // post wash time (5 - 30 minutes)
"Inverter":int, // inverter (0 - 1)
"ResumeLast":int, // resume last state (0 - 1)
"FanMaxAuto":int, // maximum fan speed in auto mode (1 - 100)
"FanMax":int, // maximum fan speed in manual mode (1 - 100)
"ExhMax":int, // maximum fan speed in exhaust mode (1 - 100)
"ExhEn":int, // exhaust mode enable (0 - 1)
"CtrlSens":int, // control sensor (CoolbreezeControlSensor_e)
"CalibTemp":int, // temperature calibration (-50 - 50) /10 to get value
"DeadTemp":int, // temperature dead band (100 - 500) /100 to get value
"AutoFanMaxTime":int // Auto mode fan max speed time (0 - 60 minutes)
}
}
Control Actions
AC Unit On/Off
Available: Local API, Cloud API
{
"SysOn":a
}
where: a - is the on/off setting
Change AC Unit Mode
Available: Local API, Cloud API
{
"SysMode":a
}
where: a - is the mode setting
Change AC Unit Fanspeed
Available: Local API, Cloud API
{
"SysFan":a
}
where: a - is the fanspeed setting
Set AC Unit Setpoint
Available: Local API, Cloud API
{
"SysSetpoint":a
}
where: a - is target setpoint degree multiply 100. value limits: 1500 <= a <= 3000
Change iSave On/Off
Available: Local API, Cloud API
{
"iSave":a
}
where: a - is target iSave setting: 0 = iSave is off, 1 = iSave is on
Set Sleep Timer
Available: Local API, Cloud API
{
"SysSleepTimer":x
}
where: x - is target sleep timer time in minute, x=0 turn off sleeptimer.
Types
SysOn_e
{
SysOn_Off,
SysOn_On
}
SysMode_e
{
SysMode_Na,
SysMode_Cool = 1,
SysMode_Heat,
SysMode_Vent,
SysMode_Dry,
SysMode_Auto,
SysMode_Exhaust,
SysMode_PumpOnly,
}
SysFan_e
{
SysFan_Na,
SysFan_Low = 1,
SysFan_Med,
SysFan_High,
SysFan_Auto,
SysFan_Top,
SysFan_NonGasHeat = 99
}
2 - Zone
Datagram
Zone
{
"Index": 0, // zone index
"Name": string, // upto 16 chars including \0
"ZoneType": int, // zone type setting: ZoneType_e
"SensType": int, // zone sensor type: RoomSensorType_t
"Mode": int, // current zone mode: ZoneMode_e
"Setpoint": int, // current zone setpoint (x100)
"Temp": int, // current zone temperature (x100)
"MaxAir": int, // maximum damper open setting %
"MinAir": int, // minumum damper closed setting %
"Const": int, // constant number (each constant will have its own number)
"ConstA": int // constant zone active (zone forced open): 0 - not active, 1 - active
"Master": int // Master zone is forced open (display zone constant graphic in zone summary screen)
"DmpFlt": int, // zone damper motor fault
"iSense": int, // isense controller active:
"Area": int, // area of zone in m2
"Calibration": int, // zone sensot calibration value
"Bypass": int, // constant zone set to bypass
"DmpPos": int, // current damper position
"RfSignal": int, // RF signal level: RfSignalLevel_e
"BattVolt": int, // battery level: BatteryLevel_e
"SensorFault": int, // sensor fault: 0 - no fault, 1- fault
"BalanceMax":int, // Zone balance max
"BalanceMin":int, // zone balance min
"DamperSkip":int // damper skip: 0 - no skip, 1 - skip
}
Control Actions
Change Zone Mode
Available: Local API, Cloud API
{
"ZoneMode":{
"Index":a,
"Mode":b
}
}
where:
- a - is the zone index number
- b - is the target zone mode
Set Zone Setpoint
Available: Local API, Cloud API
{
"ZoneSetpoint":{
"Index":a,
"Setpoint":b
}
}
where:
- a - is the zone index number
- b - is the target setpoint degree x100, value limits: 1500 <= b <= 3000, steps of 50
Set Zone Max Airflow
Available: Local API, Cloud API
{
"ZoneMaxAir":{
"Index":a,
"MaxAir":b
}
}
where:
- a - is the zone index number
- b - is maximum open percentage, value limits 0 <= b <= 100, steps of 5
Set Zone Min Airflow
Available: Local API, Cloud API
{
"ZoneMinAir":{
"Index":a,
"MinAir":b
}
}
where:
- a - is the zone index number
- b - is minimum open percentage, value limits 0 <= b <= 100, steps of 5
Set Zone Name
Available: Local API, Cloud API
{
"ZoneName":{
"Index":a,
"Name":b
}
}
where:
- a - is the zone index number
- b - is string of new zone name, max length 15 characters.
Types
ZoneMode_e
{
ZoneMode_Open = 1,
ZoneMode_Close,
ZoneMode_Auto,
ZoneMode_Override,
ZoneMode_Constant
}
ZoneType_e
{
ZoneType_OpenClose = 1,
ZoneType_Constant,
ZoneType_Auto
}
3 - Schedule
Datagram
Schedule
{
"Index": int, // index of favourite
"Name": string, // name of fav.
"Enabled": int, // 0 - disabled; 1 - enabled
"Mode": int, // SysMode_e
"Fan": int, // SysFan_e
"StartH":int, // set 0 - 23, disable 31
"StartM":int, // set 0 - 59, disable 63
"StopH":int, // set 0 - 23, disable 31
"StopM":int, // set 0 - 59, disable 63
"DaysEnabled":{
"M":int, // 0 - disabled; 1 - enabled
"Tu":int, // 0 - disabled; 1 - enabled
"W":int, // 0 - disabled; 1 - enabled
"Th":int, // 0 - disabled; 1 - enabled
"F":int, // 0 - disabled; 1 - enabled
"Sa":int, // 0 - disabled; 1 - enabled
"Su":int // 0 - disabled; 1 - enabled
}
"Zones": [
{
"Mode":int, // zone mode ZoneMode_e
"Setpoint":int // zone setpoint (1500 - 3000)
},
... 14 zones
]
}
Control Actions
Change Schedule AC Mode
Available: Local API, Cloud API
{
"SchedAcMode":{
"Index":a,
"Mode":b
}
}
where:
- a - is the schedule index number, value limites 0 <= a <= 8, step of 1
- b - is the target ac system mode
Change Schedule AC Fan
Available: Local API, Cloud API
{
"SchedAcFan":{
"Index":a,
"Fan":b
}
}
where:
- a - is the schedule index number, value limites 0 <= a <= 8, step of 1
- b - is the target ac system fan
Set Schedule Name
Available: Local API, Cloud API
{
"SchedName":{
"Index":a,
"Name":b
}
}
where:
- a - is the schedule index number, value limites 0 <= a <= 8, step of 1
- b - is string of new schedule name, max length 15 characters.
Set Schedule Zone Settings
Available: Local API, Cloud API
{
"SchedZones":{
"Index":a,
"Zones":[
{"Mode":b,"Setpoint":c},
... (14 zones settings)
]
}
}
where:
- a - is the schedule index number, value limites 0 <= a <= 8, step of 1
- b - is zone mode setting for each zone
- c - is zone setpoint setting for each zone, value is setpointx100, limits: 1500 <= b <= 3000, steps of 50
Set Schedule Time
Available: Local API, Cloud API
{
"SchedSettings":{
"Index":a,
"StartH":b,
"StartM":c,
"StopH":d,
"StopM":e,
"DaysEnabled":{
"M":f,
"Tu":g,
"W":h,
"Th":i,
"F":j,
"Sa":k,
"Su":l
}
}
}
where:
- a - is the schedule index number, value limites 0 <= a <= 8, step of 1
- b - is start hour of the day, value limits 0 <= b <= 23, step of 1; 31 means disable start time
- c - is start minute of the day, value limits 0 <= b <= 23, step of 1; 63 means disable start time
- d - is stop hour of the day, value limits 0 <= b <= 23, step of 1; 31 means disable stop time
- e - is stop minute of the day, value limits 0 <= b <= 23, step of 1; 63 means disable stop time
- f-l - is weekdays enable for schedule, 0 - disable, 1 - enable.
Change Schedule Enable
Available: Local API, Cloud API
{
"SchedEnable":{
"Index":a,
"Enabled":b
}
}
where:
- a - is the schedule index number, value limites 0 <= a <= 8, step of 1
- b - is schedule enabled state, 0 - disabled, 1 - enabled.
Start Schedule Manually
Available: Local API, Cloud API
{
"FavouriteSet":a
}
where:
- a - is the schedule index+1, value limites 1 <= a <= 9, step of 1
4 - 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,
}
5 - Power Monitor
Local Entry Point
Local request entry point for iZone Power Monitor is:
Query Request.
POST http://[bridge_IPAddr]/PowerRequest
Control Request.
POST http://[bridge_IPAddr]/PowerCommand
Local Query Request Format
Local query request body format for iZone Power Monitor is:
Request Body JSON:
{
"PowerRequest": {
"Type": 1, //Power monitor system info 1, Power monitor current status 2
"No": 0, //reserved
"No1": 0 //reserved
}
}
Datagram
Power Monitor System Configuration
{
"Enabled":int, // power monitor system enabled flag
"Tag1":"string", // power monitor tag line 1
"Tag2":"string", // power monitor tag line 2
"Voltage":int, // power system voltage
"PF":int, // power factor
"CostOfPower":int, // cost of power in 0.01 cents
"Emissions":int, // emissions in gCOe per kWh
"Devices":[
{
"Enabled":int, // device 1 enabled flag
"Channels":[
{ // device 1 channel 1 (1):
"Name":"string", // name
"GrNo":int, // group number
"Consum":int, // consumption
"Enabled":int // channel enabled
},
{ // device 1 channel 2 (2):
"Name":"string", // name
"GrNo":int, // group number
"Consum":int, // consumption
"Enabled":int // channel enabled
},
{ // device 1 channel 3 (3):
"Name":"string", // name
"GrNo":int, // group number
"Consum":int, // consumption
"Enabled":int // channel enabled
}
],
},
... 5 devices
]
}
Power Monitor Status
{
"lastReadingNo":int, // last reading number (internal)
"Dev":[
{
"Ok":int, // device 1 OK flag
"Batt":int_battlv, // device 1 battery level
"Ch":[
{
"Pwr":int // device 1 channel 1 (1) power [W]
},
{
"Pwr":int // device 1 channel 2 (2) power [W]
},
{
"Pwr":int // device 1 channel 3 (3) power [W]
}
]
},
... 5 devices
]
}
where:
Control Actions
Rename Power Channel
Available: Local API
{
"ChannelName":{
"Device":a,
"Channel":b,
"Name":c
}
}
where:
- a - is the power monitor device number (0 - 4)
- b - is the channel number of each device (0 - 2)
- c - is the new monitor channel name, 15 characters max
Types
CpmBatt_e
{
CpmBatt_Critical = 0,
CpmBatt_Low = 1,
CpmBatt_Normal = 2,
CpmBatt_Full = 3
}
6 - Result Message
| Message | Type | Description |
|---|---|---|
| OK | Success | API called successfully |
| InvalidRequest | Error | Request format is incorrect |
| InvalidUser | Error | Request user token is invalid |
| UserNotAllowed | Error | Request user is not allowed for the operation |
| Error | Error | General error for other reasons |