智能水表开放能力说明

更新时间:2024-06-13 10:40:16下载pdf

本文介绍智能水表开放能力接入的相关说明。

API 说明

智能水表开关管理

API 名称 接口地址
设置阀门开启度 POST:/v1.0/water-meter/{device_id}/actions/valve-open-degree

智能水表事件格式

云开发项目 开启消息订阅 后,可以收到智能水表设备端上报的事件消息。消息队列接入流程的详细介绍,请参考 消息队列

监控数据上报

功能描述

智能水表会上报设备监控的数据给开发者。

status 响应说明

通过数据类型 code,区分不同数据。

列举说明:

监控数据 Code 数据说明 数据类型
water_flow 水流量 Long 类型,单位:m3。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。
monthly_water_total 月总用水量 Long 类型,单位:m3。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。
daily_water_total 日总用水量 Long 类型,单位:m3。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。
switch_state 开关状态 Bool 类型。
d_begin_water_total 日初始用水量 Long 类型,单位:m3。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。
d_end_water_total 日终用水量 Long 类型,单位:m3。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。
d_begin_time 日初始读取时间 String 类型。
d_end_time 日终读取时间 String 类型。
valve_state 阀门状态 Enum 类型。
  • opened:已打开
  • closed:已关闭
  • opening:打开中
  • closing:关闭中
m_begin_water_total 月初始用水量 Long 类型,单位:m3。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。
m_end_water_total 月终用水量 Long 类型,单位:m3。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。
m_begin_time 月初始读取时间 String 类型
m_end_time 月终读取时间 String 类型
cold_stall_userdata 冷摊用量 Long 类型,单位:m3。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。
cold_stall_type 冷摊方式 Enum 类型。
  • square_area:平方面积
  • ignore:忽略
  • consumption:用量
  • proportion:占比
  • lease:租赁
  • power:功率
hot_stall_userdata 热摊用量 Long 类型,单位:m3。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。
hot_stall_type 热摊方式 Enum 类型。
  • square_area:平方面积
  • ignore:忽略
  • consumption:用量
  • proportion:占比
  • lease:租赁
  • power:功率
valve_open_degree 阀开启度 Long 类型,单位:%。上报的值已放大 1000 倍来处理小数点的问题,开发者使用时需除以 1000 来获取真实值。

数据示例

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "ataawino67sm****",
    "status": [
        {
            "18": 121,
            "code": "valve_open_degree",
            "t": 1637548630455,
            "value": 121
        }
    ]
}

智能水表事件 1.0 格式

设备事件消息兼容 1.0 版本格式。如需开通 1.0 版本格式,请联系涂鸦工作人员。接入流程参考 行业三方设备事件 1.0 版本格式

水表上报事件

功能描述

水表采样值上报到涂鸦 IoT 云,并通知到开发者。

参数说明

参数名 类型 说明 必填
bizCode String 事件业务 code,默认 edge_device
eventType String 事件类型,默认 water_meter_monitor
data String data JSON 字符串。

data 参数说明

参数名 类型 说明 必填
mode String 事件模式,默认 water_meter_monitor
data String 事件 JSON 字符串。

事件 JSON 参数说明

参数名 类型 说明 必填
deviceId String 涂鸦设备 ID
type String 采样指标
value Double 采样指标值
happenTime Long 时间戳

采样值 type 对应字段说明

type 说明
totalFlow 累计流量
monthlyFlow 月总用水量
dailyFlow 日总用水量
dailyBeginFlow 日初始用水量
dailyEndFlow 日最终用水量
dailyBeginTime 日初始读取时间
dailyEndTime 日最终读取时间
monthlyBeginFlow 月初始用水量
monthlyEndFlow 月最终用水量
monthlyBeginTime 月初始读取时间
monthlyEndTime 月最终读取时间
valueStatus 阀门状态
switchStatus 开关状态

数据示例

{
	"data": "{\"mode\":\"water_meter_monitor\",\"data\":\"{\\\"deviceId\\\":\\\"002dj00118fe34d9****\\\",\\\"happenTime\\\":1612514362591,\\\"type\\\":\\\"dailyBeginFlow\\\" ,\\\"value\\\":1}}",
	"bizCode": "edge_device",
	"eventType": "edge_report_data"
}