WaterLeakController
1.WaterLeakController.getState
Get the state of Water Leak Controller
| Param | Value | Desc |
|---|---|---|
| method | WaterLeakController.getState | Get the state of Water Leak Controller |
| targetDevice | <String,Necessary> | DeviceId of the controller you use |
| token | <String,Necessary> | Net token of the controller you use, You can get it here |
| Param | Value | Desc |
|---|---|---|
| data.state.valve | <String,Necessary> | Valve state, ["close","open"] |
| data.state.waterTemp | <Float,Necessary> | Water Temperature in degrees Celsius |
| data.state.waterFlowingDuration | <Boolean,Necessary> | Duration of Single Water Usage |
| data.alarm.leak | <Boolean,Necessary> | Leak alarm |
| data.alarm.noWaterError | <Boolean,Necessary> | Dry pipe alarm |
| data.alarm.freezeError | <Boolean,Necessary> | Freezing alarm |
| data.alarm.durationOverrun | <Boolean,Necessary> | Single use water duration exceeded threshold alarm |
| data.alarm.reminder | <Boolean,Necessary> | Remind repeat |
| data.alarm.openReminder | <Boolean,Necessary> | Open remind alarm |
| data.alarm.sensorDetectorError | <Boolean,Necessary> | Sensor disconnected alarm |
| data.alarm.valveDetectorError | <Boolean,Necessary> | Valve disconnected alarm |
| data.battery | <Integer,Necessary> | Level of device's battery, 0 to 4 means empty to full |
| data.powerSupply | <String,Necessary> | Power supply, ["battery","PowerLine"] |
| data.valveDelay.on | <Integer,Optional> | The remain time of Delay ON;Unit of minute;0 is OFF |
| data.valveDelay.off | <Integer,Optional> | The remain time of Delay OFF;Unit of minute;0 is OFF |
| data.attributes.openReminder | <Integer,Necessary> | Open remind duration in minutes |
| data.attributes.alertInterval | <Integer,Necessary> | Alert interval in minutes |
| data.attributes.leakPlan | <String,Necessary> | Leak plan mode ["Manual","Auto","AwayAuto"] Manual-OFF Auto-Leak schedule AwayAuto-Away leak schedule |
| data.attributes.maxOverrunDuration | <Integer,Necessary> | Maximum continuous water usage duration in minutes |
| data.attributes.maxOverrunSensivity | <Integer,Necessary> | Sensor Sensitivity |
| data.attributes.maxOverrunCloseValve | <Boolean,Necessary> | Close valve after exceeding maximum continuous water usage duration. valve |
| data.attributes.awayDuration | <Integer,Necessary> | Leak duration before alarm, Leak schedule(Away) |
| data.attributes.awaySensivity(Deprecated) | <Integer,Necessary> | Sensor Sensitivity, Leak schedule(Away) |
| data.attributes.awayCloseValve | <Boolean,Necessary> | Auto close, Leak schedule(Away) |
| data.attributes.mute | <Boolean,Necessary> | Mute |
| data.attributes.muteDuration | <Integer,Necessary> | Mute duration in minutes |
| data.attributes.waterTemperatureLevel | <Integer,Necessary> | 0-Cold water mode, 1-Hot water mode |
| data.attributes.freezeACVEnable | <Boolean,Necessary> | Close the valve upon freeze alarm |
| data.attributes.leakDetector.dryPipeTemp | <Float,Necessary> | The alarm temperature of dry pipe in degrees Celsius |
| data.muteRemaining | <Integer,Necessary> | Remaining mute duration in minutes |
| data.heaterTemp | <Float,Necessary> | Heating temperature in celsius |
| data.waterTemperatureVariance | <Float,Necessary> | Water temperature variance in celsius |
| data.version | <String,Necessary> | Firmware version |
| data.tz | <Integer,Necessary> | Timezone of device. -12 ~ 12 |
2.WaterLeakController.setState
Set Water leak Controller Valve State
| Param | Value | Desc |
|---|---|---|
| method | WaterLeakController.setState | Set Water leak controller valve state |
| targetDevice | <String,Necessary> | DeviceId of the Water leak controller you use |
| token | <String,Necessary> | Net token of the Water leak controller you use |
| params.valve | <String,Necessary> | Set valve state of device.["close","open"] |
3.WaterLeakController.setAttributes
Set attributes for Water Leak Controller
| Param | Value | Desc |
|---|---|---|
| method | WaterLeakController.setAttributes | Set attributes for water leak controller |
| targetDevice | <String,Necessary> | DeviceId of the device you use |
| token | <String,Necessary> | Net token of the device you use |
| params.attributes.openReminder | <Integer,Optional> | Open remind duration in minutes |
| params.attributes.alertInterval | <Integer,Optional> | Alert interval in minutes |
| params.attributes.leakPlan | <String,Optional> | Leak plan mode ["Manual","Auto","AwayAuto"] Manual-OFF Auto-Leak schedule AwayAuto-Away leak schedule |
| data.attributes.maxOverrunDuration | <Integer,Optional> | Maximum continuous water usage duration in minutes |
| data.attributes.maxOverrunSensivity | <Integer,Optional> | Sensor Sensitivity |
| data.attributes.maxOverrunCloseValve | <Boolean,Optional> | Close valve after exceeding maximum continuous water usage duration. valve |
| data.attributes.awayDuration | <Integer,Optional> | Leak duration before alarm, Leak schedule(Away) |
| data.attributes.awaySensivity(Deprecated) | <Integer,Optional> | Sensor Sensitivity, Leak schedule(Away) |
| data.attributes.awayCloseValve | <Boolean,Optional> | Auto close, Leak schedule(Away) |
| data.attributes.mute | <Boolean,Optional> | Mute |
| data.attributes.muteDuration | <Integer,Optional> | Mute duration in minutes |
| data.attributes.waterTemperatureLevel | <Integer,Optional> | 0-Cold water mode, 1-Hot water mode |
| data.attributes.freezeACVEnable | <Boolean,Optional> | Close the valve upon freeze alarm |
| data.attributes.leakDetector.dryPipeTemp | <Float,Optional> | The alarm temperature of dry pipe in degrees Celsius |
4.WaterLeakController.getValveSchedules
Get Water Leak Controller valve schedules
| Param | Value | Desc |
|---|---|---|
| method | WaterLeakController.getValveSchedules | Get valve schedules |
| targetDevice | <String,Necessary> | DeviceId of the Water Leak Controller you use |
| token | <String,Necessary> | Net token of the Water Leak Controller you use |
| Param | Value | Desc |
|---|---|---|
| data[index].isValid | <Boolean,Necessary> | Enabled/Disabled |
| data[index].index | <Integer,Necessary> | Index of this record |
| data[index].on | <String,Optional> | Time to turn on; HH:mm |
| data[index].off | <String,Optional> | Time to turn off; HH:mm |
| data[index].week | <Integer,Necessary> | Mask of effected days(Sunday to Saturday) |
5.WaterLeakController.setValveSchedules
Set Water Leak Controller valve schedules
| Param | Value | Desc |
|---|---|---|
| method | WaterLeakController.setValveSchedules | Set valve schedules. |
| targetDevice | <String,Necessary> | DeviceId of the Water Leak Controller you use |
| token | <String,Necessary> | Net token of the Water Leak Controller you use |
| params.sches | <Array<Schedule> | Map<int,Schedule>,Necessary>, Schedules for weekdays |
| params.sches[index].isValid | <Boolean,Necessary> | Enabled/Disabled |
| params.sches[index].index | <Integer,Necessary> | Index of this record |
| params.sches[index].on | <String,Necessary> | Time to turn on; HH:mm |
| params.sches[index].off | <String,Necessary> | Time to turn off; HH:mm |
| params.sches[index].week | <Integer,Necessary> | Mask of effected days(Sunday to Saturday) |
index from "0" to "5"
isValid=false and week=0 means remove the schedule
6.WaterLeakController.getLeakSchedules
Get Water Leak Controller leak schedules
| Param | Value | Desc |
|---|---|---|
| method | WaterLeakController.getLeakSchedules | Get leak schedules |
| targetDevice | <String,Necessary> | DeviceId of the Water Leak Controller you use |
| token | <String,Necessary> | Net token of the Water Leak Controller you use |
| Param | Value | Desc |
|---|---|---|
| data[index].isValid | <Boolean,Necessary> | Enabled/Disabled |
| data[index].index | <Integer,Necessary> | Index of this record |
| data[index].on | <String,Optional> | Time to turn on; HH:mm |
| data[index].off | <String,Optional> | Time to turn off; HH:mm |
| data[index].week | <Integer,Necessary> | Mask of effected days(Sunday to Saturday) |
| data[index].standBy | <Integer,Necessary> | Leak duration before alarm |
| data[index].sensivity | <Integer,Necessary> | Sensitivity(Deprecated) |
| data[index].closeValve | <Boolean,Necessary> | close Valve |
7.WaterLeakController.setLeakSchedules
Set Water Leak Controller leak schedules
| Param | Value | Desc |
|---|---|---|
| method | WaterLeakController.setLeakSchedules | Set leak schedules. |
| targetDevice | <String,Necessary> | DeviceId of the Water Leak Controller you use |
| token | <String,Necessary> | Net token of the Water Leak Controller you use |
| params.sches | <Array<Schedule> | Map<int,Schedule>,Necessary>, Schedules for weekdays |
| params.sches[index].isValid | <Boolean,Necessary> | Enabled/Disabled |
| params.sches[index].index | <Integer,Necessary> | Index of this record |
| params.sches[index].on | <String,Necessary> | Time to turn on; HH:mm |
| params.sches[index].off | <String,Necessary> | Time to turn off; HH:mm |
| params.sches[index].week | <Integer,Necessary> | Mask of effected days(Sunday to Saturday) |
| params.sches[index].standBy | <Integer,Necessary> | Leak duration before alarm in minutes |
| params.sches[index].sensivity | <Integer,Necessary> | Sensitivity(Deprecated) |
| params.sches[index].closeValve | <Boolean,Necessary> | close Valve |
index from "0" to "5"
isValid=false and week=0 means remove the schedule
8.Callbacks
You can receive it with Http Callback API or MQTT report topic
<Same as 1.WaterLeakController.getState>