WaterMeterController

1.WaterMeterController.getState

Get the state of Water Meter Controller

BDDP

Param	Value	Desc
method	WaterMeterController.getState	Get the state of Water Meter 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

BUDP

Param	Value	Desc
data.state.valve	<String,Necessary>	Valve state, ["close","open"]
data.state.meter	<Integer,Necessary>	Meter reading
data.state.waterFlowing	<Boolean,Necessary>	Water flowing
data.alarm.openReminder	<Boolean,Necessary>	Open remind alarm
data.alarm.leak	<Boolean,Necessary>	Leak alarm
data.alarm.amountOverrun	<Boolean,Necessary>	Amount overrun alarm
data.alarm.durationOverrun	<Boolean,Necessary>	Duration overrun alarm
data.alarm.valveError	<Boolean,Necessary>	Valve error alarm
data.alarm.reminder	<Boolean,Necessary>	Remind repeat
data.alarm.freezeError	<Boolean,Necessary>	Freeze 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 minute
data.attributes.meterUnit	<Integer,Necessary>	Meter screen unit, 0-GAL 1-CCF 2-M3 3-L
data.attributes.alertInterval	<Integer,Necessary>	Alert interval in minute
data.attributes.meterStepFactor	<Integer,Necessary>	Meter measurement accuracy
data.attributes.leakLimit	<Float,Necessary>	Leak limit in meter unit
data.attributes.autoCloseValve	<Boolean,Necessary>	Close valve if leak limit exceeded
data.attributes.overrunAmountACV	<Boolean,Necessary>	Overrun amount auto close valve
data.attributes.overrunDurationACV	<Boolean,Necessary>	Overrun duration auto close valve
data.attributes.leakPlan	<String,Necessary>	Leak plan mode, ["on","off","schedule"]
data.attributes.overrunAmount	<Float,Necessary>	Overrun amount in meter unit
data.attributes.overrunDuration	<Integer,Necessary>	Overrun duration in minute
data.attributes.freezeTemp	<Float,Necessary>	Freeze temperature in celsius
data.recentUsage.amount	<Integer,Necessary>	Recent usage in meter unit
data.recentUsage.duration	<Integer,Necessary>	Recent usage duration in minute
data.dailyUsage	<Integer,Necessary>	Daily usage in meter unit
data.temperature	<Float,Necessary>	Temperature in celsius
data.version	<String,Necessary>	Firmware version
data.tz	<Integer,Necessary>	Timezone of device. -12 ~ 12

2.WaterMeterController.setState

Set Water Meter Controller Valve State

BDDP

Param	Value	Desc
method	WaterMeterController.setState	Set Water Meter Controller valve state
targetDevice	<String,Necessary>	DeviceId of the Manipulator you use
token	<String,Necessary>	Net token of the Manipulator you use
params.valve	<String,Necessary>	Set valve state of device.["close","open"]

3.WaterMeterController.setMeterAttributes

Set attributes for Water Meter Controller

BDDP

Param	Value	Desc
method	WaterMeterController.setMeterAttributes	Set attributes for water meter 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 minute
params.attributes.meterUnit	<Integer,Optional>	Meter screen unit, 0-GAL 1-CCF 2-M3 3-L
params.attributes.alertInterval	<Integer,Optional>	Alert interval in minute
params.attributes.meterStepFactor	<Integer,Optional>	Meter measurement accuracy
params.attributes.leakLimit	<Float,Optional>	Leak limit in meter unit
params.attributes.autoCloseValve	<Boolean,Optional>	Close valve if leak limit exceeded
params.attributes.overrunAmountACV	<Boolean,Optional>	Overrun amount auto close valve
params.attributes.overrunDurationACV	<Boolean,Optional>	Overrun duration auto close valve
params.attributes.leakPlan	<String,Optional>	Leak plan mode, ["on","off","schedule"]
params.attributes.overrunAmount	<Float,Optional>	Overrun amount in meter unit
params.attributes.overrunDuration	<Integer,Optional>	Overrun duration in minute
params.attributes.freezeTemp	<Float,Optional>	Freeze temperature in celsius

BUDP

4.WaterMeterController.getValveSchedules

Get Water Meter Controller valve schedules

BDDP

Param	Value	Desc
method	Manipulator.getSchedules	Get valve schedules
targetDevice	<String,Necessary>	DeviceId of the Water Meter Controller you use
token	<String,Necessary>	Net token of the Water Meter Controller you use

BUDP

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.WaterMeterController.setValveSchedules

Set Water Meter Controller valve schedules

BDDP

Param	Value	Desc
method	Manipulator.setSchedules	Set valve schedules.
targetDevice	<String,Necessary>	DeviceId of the Water Meter Controller you use
token	<String,Necessary>	Net token of the Water Meter 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"

6.WaterMeterController.getLeakSchedules

Get Water Meter Controller leak schedules

BDDP

Param	Value	Desc
method	Manipulator.getSchedules	Get leak schedules
targetDevice	<String,Necessary>	DeviceId of the Water Meter Controller you use
token	<String,Necessary>	Net token of the Water Meter Controller you use

BUDP

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].leakLimit	<Integer,Necessary>	Leak limit in meter unit

7.WaterMeterController.setLeakSchedules

Set Water Meter Controller leak schedules

BDDP

Param	Value	Desc
method	Manipulator.setSchedules	Set leak schedules.
targetDevice	<String,Necessary>	DeviceId of the Water Meter Controller you use
token	<String,Necessary>	Net token of the Water Meter 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].leakLimit	<Integer,Optional>	Leak limit in meter unit

index from "0" to "5"

8.Callbacks

You can receive it with Http Callback API or MQTT report topic

BUDP

<Same as 1.WaterMeterController.getState>