断路器开放能力说明

本文介绍断路器开放能力接入的相关说明。

API 说明

断路器告警阈值管理

API 名称	接口地址
设置过压保护值	POST:/v1.0/electric-energy/{device_id}/actions/voltage-over
设置限定功率	POST:/v1.0/electric-energy/{device_id}/actions/power-limit
设置限定电流	POST:/v1.0/electric-energy/{device_id}/actions/current-limit
设置漏电预警值	POST:/v1.0/electric-energy/{device_id}/actions/leak-warn-value
设置漏电动作值	POST:/v1.0/electric-energy/{device_id}/actions/leak-action-value
设置电量预警值	POST:/v1.0/electric-energy/{device_id}/actions/electric-warn
设置欠压保护值	POST:/v1.0/electric-energy/{device_id}/actions/voltage-under
设置过温保护值	POST:/v1.0/electric-energy/{device_id}/actions/temp-over

断路器开关管理

API 名称	接口地址
设置使能开关	POST:/v1.0/electric-energy/{device_id}/actions/hand-enable
设置线路开关	POST:/v1.0/electric-energy/{device_id}/actions/switch

断路器数据管理

API 名称	接口地址
获取实时数据	GET:/v1.0/electric-energy/{device_id}/actions/realtime-data

断路器事件格式

云开发项目开启消息订阅后，可以收到断路器设备端上报的事件消息。

• 消息订阅开启入口
• 消息队列接入流程

监控数据上报

功能描述

断路器会上报设备监控的数据给开发者。

status 响应说明

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

列举说明：

监控数据 Code	数据说明	数据类型
switch	设备开关	Integer 类型。 0：关闭 1：开启
power_current	当前功率	Long 类型，单位：W
voltage_current	当前电压	Long 类型，单位：V
current_max	最大电流	Long 类型，单位：mA
cur_current	当前电流	Long 类型，单位：mA
device_info	设备信息	String 类型，最大长度不超过 128 个字节
status_query	状态同步	String 类型，最大长度不超过 128 个字节
temp_current	当前温度	Long 类型，单位：°C
voltage_under	欠压值	Long 类型，单位：V
voltage_over	过压值	Long 类型，单位：V
leakage_warn_value	漏电预警值	Long 类型，单位：mA
leakage_fault_value	漏电故障值	Long 类型，单位：mA
leakage_current	漏电电流	Long 类型，单位：A
leakage_protection	泄露保护	Enum 类型。 no_leak_pro_without_value：没漏保不显示漏电值 no_leak_pro_with_value：没漏保显示漏电值 leak_pro_with_value：有漏保显示漏电值
switch_enabled	使能开关	Integer 类型。 0：关闭 1：开启
over_current_duration	过流持续时间	Long 类型，单位：秒
fault	故障告警	Enum 类型。 short_circuit_alarm：短路告警 surge_alarm：浪涌告警 overload_alarm：过载告警 ov_vol：过压告警 undervoltage_alarm：欠压告警 temp_dif_fault：温度异常告警 leakagecurr_alarm：漏电告警 self_test_alarm：漏电自检不正常 fire_alarm：打火告警 high_power_alarm：高功率报警 ov_cr：过流故障 outage_alarm：停电事件告警 magnetism_alarm：磁影响告警 credit_alarm：余额不足告警
alarm_level	告警等级	Enum 类型。 general：一般 serious：严重 urgent：紧急
device_alarm	设备告警	String 类型，最大长度不超过 128 个字节
alarm_event_content	报警内容	String 类型，最大长度不超过 128 个字节
fire_alarm_type	消防设备报警类型	Enum 类型。 fire_alarm：火警报警 device_fault：设备故障 device_alarm：设备报警
alarm_trace_time	事件发生时间	String 类型，最大长度不超过 128 个字节
alarm_result_content	事件处理结果	String 类型，最大长度不超过 128 个字节
alarm_value	事件值	Long 类型
alarm_unit	报警单位	String 类型，最大长度不超过 128 个字节
alarm_process_time	报警处理时间	String 类型，最大长度不超过 128 个字节
phase_a	上报 A 相电压_电流_功率	String 类型，最大长度不超过 128 个字节
phase_b	上报 B 相电压_电流_功率	String 类型，最大长度不超过 128 个字节
phase_c	上报 C 相电压_电流_功率	String 类型，最大长度不超过 128 个字节
leakage_action_value	漏电动作值	Long 类型，单位：mA
over_temp_value	过温值	Long 类型，单位：℃
over_vol_protect_time	过欠压动作保护时间	Long 类型，单位：分钟
over_vol_recovery_time	过欠压保护恢复时间	Long 类型，单位：分钟
power_effective	有效功率	Long 类型，单位：W
power_reactive	无效功率	Long 类型，单位：W
power_factor	功率因数	Long 类型
supply_frequency	电网供电频率	Long 类型
switch_times	开关次数	Long 类型
short_times	短路次数	Long 类型
electric_total	总电量	Long 类型，单位：kW·h
electric_daily	日用电量	Long 类型，单位：kW·h
electric_month	月用电量	Long 类型，单位：kW·h
residual_electricity	剩余电量	Long 类型，单位：kW
power_limit	限定功率	Long 类型，单位：W
electric_warm_value	电量预警值	Long 类型，单位：kW
forward_energy_total	正向总有功电量	Long 类型，单位：kW
energy_reactive	无功电量	Long 类型，单位：kW
power_apparent	视在功率	Long 类型，单位：kV
cold_stall_userdata	冷摊用量	Long 类型
cold_stall_type	冷摊方式	Enum 类型。 square_area：平方面积 ignore：忽略 consumption：用量 proportion：占比 lease：租赁 power：功率
hot_stall_userdata	热摊用量	Long 类型
hot_stall_type	热摊方式	Enum 类型。 square_area：平方面积 ignore：忽略 consumption：用量 proportion：占比 lease：租赁 power：功率
switch_state	开关状态	Integer 类型。 0：关闭 1：开启
d_end_time	日终读取时间	String 类型，最大长度不超过 255 个字节
m_end_time	月终读取时间	String 类型，最大长度不超过 255 个字节

数据示例

{
    "dataId": "AAXRV4BrtW9BRB9A2JY((((",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "44": 104061476,
            "code": "electric_total",
            "t": 1637548630455,
            "value": 104061476
        }
    ]
}

断路器事件 1.0 格式

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

累计电量上报事件

功能描述

断路器累计电量上报到涂鸦 IoT 云，并通知到开发者。

参数说明

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

data 参数说明

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

事件 JSON 字符串参数说明

参数名	类型	说明	必填
deviceId	String	涂鸦设备 ID。	是
eventId	String	本次上报数据 ID。	是
sumEnergy	Double	累计能耗。	是
happenTime	Long	13 位时间戳。	是

数据示例

{
    "data": "{\"mode\":\"energy_power_data\",\"data\":\"{\\\"deviceId\\\":\\\"002dj00118fe34d9****\\\",\\\"happenTime\\\":1612514362591,\\\"eventId\\\":"123456789" ,\\\"sumEnergy\\\":1}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

断路器告警上报事件

功能描述

断路器告警上报到涂鸦 IoT 云，并通知到开发者。

参数说明

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

data 参数说明

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

事件 JSON 字符串参数说明

参数名	类型	说明	必填
deviceId	String	涂鸦设备 ID。	是
messageId	String	消息 ID。	是
type	Integer	类型。 0：告警 1：故障	是
code	String	告警/故障 code。	是
content	String	告警/故障内容。	是
confirmEnable	Boolean	报警处理标志。true 为已处理。	是
happenTime	Long	13 位时间戳。	是

数据示例

{
    "data": "{\"mode\":\"energy_alarm\",\"data\":\"{\\\"deviceId\\\":\\\"002dj00118fe34d9****\\\",\\\"happenTime\\\":1612514362591,\\\"type\\\":1,\\\"code\\\":\\\"alarm",\\\"content\\\":\\\"电量告警",\\\"confirmEnable\\\":false}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

开关状态上报事件

功能描述

断路器开关状态上报到涂鸦 IoT 云，并通知到开发者。

参数说明

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

data 参数说明

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

事件 JSON 字符串参数说明

参数名	类型	说明	必填
deviceId	String	涂鸦设备 ID。	是
switchStatus	Boolean	true：合闸。 false：开闸。	是
happenTime	Long	13 位时间戳。	是

数据示例

{
    "data": "{\"mode\":\"energy_switch_status\",\"data\":\"{\\\"deviceId\\\":\\\"002dj00118fe34d9****\\\",\\\"happenTime\\\":1612514362591,\\\"switchStatus\\\":true}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

采集数据上报事件

功能描述

断路器采集数据上报到涂鸦 IoT 云，并通知到开发者。

参数说明

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

data 参数说明

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

事件 JSON 字符串参数说明

参数名	类型	说明	必填
deviceId	String	涂鸦设备 ID。	是
type	String	采样指标。具体参数见下 type 采样指标列表。	是
value	Double	采样指标值。	是
happenTime	Long	13 位时间戳。	是

type 采样指标列表

type	说明
voltagePhaseA	A 相电压，单位：V
currentPhaseA	A 相电流，单位：A
powerPhaseA	A 相功率，单位：kW
electricityPhaseA	A 相电量，单位：kW·h
voltagePhaseB	B 相电压，单位：V
currentPhaseB	B 相电流，单位：A
powerPhaseB	B 相功率，单位：kW
electricityPhaseB	B 相电量，单位：kW·h
voltagePhaseC	C 相电压，单位：V
currentPhaseC	C 相电流，单位：A
powerPhaseC	C 相功率，单位：kW
electricityPhaseC	C 相电量，单位：kW·h
activePower	有功电量，单位：kW·h
reactivePower	无功电量，单位：kvar·h
currentA	当前电流，单位：A
maxCurrent	最大电流，单位：A
duration	最大电流持续时间，单位：s
voltageA	当前电压，单位：V
powerA	当前功率，单位：kW
tempA	当前温度，单位：摄氏度
under	欠压值，单位：V
over	过压值，单位：V
currentLeakValue	当前漏电值，单位：mA
leakWarnValue	漏电预警值，单位：mA
leakActionValue	漏电动作值，单位：mA
isLeakage	是否带漏电。 0：不显示漏电值，没有漏电保护功能。 1：显示漏电值，有漏电保护功能。 2：只显示漏电值，没有漏电保护功能，可以修改漏电预警值。
handEnabled	锁定手动开关值。 0：不锁定。 1：锁定。
powerP	有效功率，单位：W
powerQ	无效功率，单位：var
pf	频率，单位：Hz
switchTime	开关操作次数
shortTime	发生短路次数
powerMax	限定功率，单位：W
eResidual	剩余电量，单位：kW·h
eWarn	电量预警值，单位：kW·h
tempMax	过温保护值，单位：摄氏度
vpOtime	过欠压保护动作时间，单位：S
vpRtime	过欠压保护恢复时间，单位：S
electric_daily	日用电量，单位：kW·h
d_end_time	日用电量读取时间，13 位时间戳
electric_month	月用电量，单位：kW·h
m_end_time	月用电量读取时间，13 位时间戳

数据示例

{
    "data": "{\"mode\":\"energy_monitor_data\",\"data\":\"{\\\"deviceId\\\":\\\"002dj00118fe34d9****\\\",\\\"happenTime\\\":1612514362591,\\\"type\\\":\\\"voltagePhaseA\\\",\\\"value\\\":217.6}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}