跳到主要内容

接入指引

接入方式有哪些

支持
  1. HTTP:支持http以及https,post请求(推荐)。
  2. RabbitMQ:支持rabbitMQ订阅推送(未使用)。
  3. KAFKA: 支持kafka订阅推送(未使用)。
  4. MQTT:支持mqtt广播订阅推送(未使用)。

HTTP接口路径是否有要求?

目前并无路径要求,平台仅要求接口支持 POST 方式请求。

推送的数据格式是怎样的?

具体推送格式请参考 附录1
若当前的数据格式无法满足要求,请参考 格式无法满足要求怎么办

如何接入

1. 由上级协助创建平台账号、密码



2. 登入北向管理平台

注意

若一开始未注册应用,则会自动注册一个新的应用

3. 进入应用列表

查看应用

展示参数

应用名称 第三方平台的名称,
公司名称 第三方平台所属公司
禁用 应用的禁用状态,当应用被禁用时,将停止推送
应用类型 分为通用以及定制,通用指采用平台的数据结构,定制则采用第三方平台的数据结构
推送方式 目前支持HTTP、RabbitMQ、KAFKA、MQTT方式推送
合作商名称 对应平台的合作商
推送地址 消息推送到某个地址,HTTP模式则为接口路径,中间件则为订阅主题
余量 当前应用的剩余可用流量,具体的扣费、收费请参考北向计费模式
免费日期 即有效期,当前应用在有效期内的所有推送视为免费,具体的扣费、收费请参考北向计费模式
设备量 即当前账号下的所有设备
今日消耗 即今日推送所消耗的流量
昨日消耗 即昨日推送所消耗的流量

功能详解

功能
  1. 充值:充值某个应用的余量/有效期
  2. 编辑:修改某个应用的基础信息
  3. 订阅管理:管理某个应用的订阅,同账号下,同类型设备不可重复订阅
  4. 应用详情:查询某个应用的统计信息、设备信息、推送信息、消耗记录等

4. 点击编辑,将推送地址改为自己接口地址

注意

必须修改为外网可访问的接口地址!
该接口必须支持POST请求!
务必优先响应平台的请求再处理业务防止堵塞!
请勿对接口限流!

5. 进入订阅管理,订阅需要推送的设备

注意

选择相应的设备类型后,该类型的设备传输消息时会一并推送至第三方平台
订阅报警消息:产生报警数据时一并推送至第三方平台
订阅故障消息:产生故障数据时一并推送至第三方平台
订阅心跳消息:产生心跳数据时一并推送至第三方平台
订阅事件消息:产生事件数据时一并推送至第三方平台
订阅设备管理消息:产生增、删、改操作时一并推送至第三方平台

6. 订阅完成,进入实时推送界面查看数据推送

注意

订阅成功后可以触发账号下的设备,模拟报警测试推送情况
实时推送界面,左边为平台推送到第三方平台的数据内容,右边则为第三方平台的接口响应内容
若是订阅后长时间未收到推送,可参考 为什么订阅后收不到推送

总结

北向推送即是将设备在真实环境中产生的所有数据推送给第三方平台,第三方平台收到推送后方便做自己的业务,
这样既方便了第三方平台,免去了接入设备的繁杂流程,又省去了数据解析,且代码量少、维护方便、可扩展性强,
在不对接设备方面有很好的优势。

附录1

整体传输格式

参数名称参数类型必填说明
appIdstring应用ID
messageTypestring消息类型:
device 设备管理消息 alarm 设备报警消息
fault 设备故障消息 event 设备事件消息 track 设备心跳消息
timestamplong消息发送时间,10位时间戳
datajsonstring数据体,数据体内容请参考下面

设备管理消息

参数名称参数类型必填说明
deviceIdstring设备序列号
deviceNamestring设备名称
deviceTypestring设备类型,具体解析请参考 设备类型解析
deviceLocationstring设备安装地址
manageTypestring操作方式,具体解析请参考 操作方式解析
registerTimestring注册时间,格式为:yyyy-MM-dd HH:mm:ss
contentjsonstring附加数据,具体内容请参考 设备管理附加数据
消息示例

{"messageType":"device", "appId":"1", "timestamp":1623805200, "data":"{ \"deviceId\":\"123456789\", \"deviceName\":\"a1\", \"deviceType\":\"smoke\", \"deviceLocation\":\"test\", \"manageType\":\"add\", \"registerTime\":\"1970-01-01 08:00:00\", \"content\":\"\" }"}

设备报警消息

参数名称参数类型必填说明
alarmIdstring报警ID,全局唯一
alarmTypestring报警类型,具体解析请参考 报警类型解析
alarmTimestring报警时间,格式为:yyyy-MM-dd HH:mm:ss
deviceIdstring设备序列号
deviceTypestring设备类型,具体解析请参考 设备类型解析
alarmTriggerint1: 报警触发 0: 报警恢复
alarmValuestring报警值
alarmClearTypestring处理方式,报警恢复时必传,具体解析请参考 处理方式解析
alarmClearTimestring处理时间,报警恢复时必传,格式为:yyyy-MM-dd HH:mm:ss
contentjsonstring附加数据,具体内容请参考 设备报警附加数据
消息示例

{"messageType":"alarm", "appId":"1", "timestamp":1623805200, "data":"{ \"alarmId\":\"123\", \"alarmTime\":\"1970-01-01 08:00:00\", \"alarmTrigger\":1, \"alarmType\":\"fire\", \"alarmValue\":\"\", \"deviceId\":\"123456789\", \"deviceType\":\"smoke\"}"}

设备故障消息

参数名称参数类型必填说明
faultIdstring故障ID,全局唯一
faultTypestring故障类型,具体解析请参考 故障类型解析
faultTimestring故障时间,格式为:yyyy-MM-dd HH:mm:ss
deviceIdstring设备序列号
deviceTypestring设备类型,具体解析请参考 设备类型解析
faultTriggerint1: 故障触发 0: 故障恢复
faultValuestring故障值
faultClearTypestring处理方式,故障恢复时必传,具体解析请参考 处理方式解析
faultClearTimestring处理时间,故障恢复时必传,格式为:yyyy-MM-dd HH:mm:ss
contentjsonstring附加数据,具体内容请参考 设备故障附加数据
消息示例

{"messageType":"fault", "appId":"1", "timestamp":1623805200, "data":"{ \"faultId\":\"123\", \"faultTime\":\"1970-01-01 08:00:00\", \"faultTrigger\":1, \"faultType\":\"fault\", \"faultValue\":\"\", \"deviceId\":\"123456789\", \"deviceType\":\"smoke\"}"}

设备事件消息

参数名称参数类型必填说明
eventIdstring事件ID,全局唯一
eventTypestring事件类型,具体解析请参考 事件类型解析
eventTimestring事件时间,格式为:yyyy-MM-dd HH:mm:ss
deviceIdstring设备序列号
deviceTypestring设备类型,具体解析请参考 设备类型解析
eventValuestring事件值
contentjsonstring附加数据,具体内容请参考 设备事件附加数据
消息示例

{"messageType":"event", "appId":"1", "timestamp":1623805200, "data":"{ \"eventId\":\"123\", \"eventTime\":\"1970-01-01 08:00:00\", \"eventType\":\"active\", \"eventValue\":\"\", \"deviceId\":\"123456789\", \"deviceType\":\"smoke\"}"}

设备心跳消息

参数名称参数类型必填说明
trackIdstring心跳ID,可能重复
trackTimestring心跳时间,格式为:yyyy-MM-dd HH:mm:ss
deviceIdstring设备序列号
deviceTypestring设备类型,具体解析请参考 设备类型解析
onlineint在线状态,0 离线,1 在线
lowPowerint低电状态,0 正常,1 低电
openint拆开状态,0 正常,1 拆开
faultint故障状态,0 正常,1 故障
deployint布撤防状态,0 撤防,1 布防
signalsint信号值,单位dBm
batteryint电池电压,单位V
batteryRatioint电池电量,单位%
temperatureint温度,单位°C
contentjsonstring附加数据,具体内容请参考 设备心跳附加数据
消息示例

{"messageType":"track", "appId":"1", "timestamp":1623805200, "data":"{ \"trackId\":\"123\", \"trackTime\":\"1970-01-01 08:00:00\", \"trackType\":\"active\", \"online\": 1, \"lowPower\": 0, \"open\": 0, \"fault\": 0, \"deploy\": 0, \"signals\": 10, \"battery\": 3, \"batteryRatio\": 90, \"temperature\": 30, \"deviceId\":\"123456789\", \"deviceType\":\"smoke\"}"}

附录2

操作方式解析

操作方式说明
add设备新增
edit设备修改
del设备删除
addSub新增子设备(未使用)
editSub修改子设备(未使用)
delSub删除子设备(未使用)

附加数据

设备心跳附加数据

设备类型参数名参数类型参数说明content示例
温湿度temperature
humidity
int
int
温度
湿度
"{"temperature": 30, "humidity": 80}"
燃气探测gasint燃气浓度,单位%"{"gas": 30}"
烟感smokeint烟雾浓度,单位%"{"smoke": 30}"
紧急呼叫器GCJ02Point
BD09Point
string
string
火星坐标
百度坐标
"{"GCJ02Point": "124.80331,45.133527",
"BD09Point": "123.80331,43.133527"}"

设备报警附加数据

参数名称参数类型必填说明content示例
消防主机defenceNo
defenceLocation
defenceName
string
string
string
防区号
防区地址
防区名称
"{"defenceNo": "1",
"defenceName": "1号",
"defenceLocation": "大门"}"
温湿度temperature
humidity
int
int
温度
湿度
"{"temperature": 30, "humidity": 80}"
燃气探测gasint燃气浓度,单位%"{"gas": 30}"
烟感smokeint烟雾浓度,单位%"{"smoke": 30}"

设备管理附加数据

注意

暂未定义

设备故障附加数据

注意

暂未定义

设备事件附加数据

注意

暂未定义

设备类型解析

设备类型说明
airswitch智慧空开
alarmcall语音呼叫
alarmhost报警主机
alert声光报警
angle倾角
camera国标摄像机
co一氧化碳
dutycam在岗检测
efencecam电子围栏检测
efencehost电子围栏
elecfire用电安全
electric电气火灾
embedswitch控制开关
extinguisher灭火器
falldetect跌倒检测
firealarm火灾报警装置
firehost消防主机
flamecam火焰识别
gas燃气
gasb4G燃气
hand手报
humiture温湿度
hydrant消火栓
infrared人体红外
iokit输入输出
lampblack油烟监测
liquidtemp液体温度
lock门磁
manhole井盖
motocam电单车入户
multialarmkit多路报警
poweralert停电报警
shortarc电弧保护
smartfireAI消防主机
smartwatch手环
smoke烟感
smoking吸烟
smswitch开关
soak水浸
soil土壤检测器
stench臭气检测器
temp温度报警器
transmit用户传输装置
urgentcall紧急呼叫
water水压
webcam网络摄像机

报警类型解析

设备类型报警类型说明
智慧空开0001-短路, 0002-过流, 000C-电流不平衡, 0016-超温, 001F-过负荷, 0024-缺相, 0025-过压, 0026-欠压, 0043-故障电弧(专业版), 0044-突变漏电, 0045-稳态漏电, 0046-漏电重合闸, 004A-故障隔离失压, 004B-故障隔离合闸, 1002-过温, 1006-定值校验错误, 1008-定值初始化, 1029-突变大电流(专业版), 102A-漏电监测回路故障, 200C-漏电自检, 200D-分闸报警, 200E-合闸, chargeAlarm-电瓶车充电报警, cookerAlarm-电磁炉插电报警, dryerAlarm-吹风机插电报警, gateOpenLock-本地分闸锁定, groundOffline-地线掉线提醒, heaterAlarm-电热器插电报警, leakCheckFailed-漏电自检失败, leakCheckOk-漏电自检成功, leakProtect-漏电保护, lightningProtect-雷击保护, noneGround-无地线保护, ovenAlarm-微波炉插电报警, potAlarm-保温锅插电报警, shortPredict-短路预判, statusClear-所有保护状态恢复正常, switchOff-开关跳闸, tempMaxProtect-过温保护,10001-A级过流预警, 10002-A级过压预警, 10003-A级温度预警, 10004-B级过流预警, 10005-B级过压预警, 10006-B级温度预警, 10007-C级过流预警, 10008-C级过压预警, 10009-C级温度预警, 1102-漏电报警, 1105-温度报警, 1106-三相A欠压报警, 1107-三相A过流报警, 1108-三相A过压报警, 1109-三相A缺相报警, 1110-三相A温度报警, 1111-三相B欠压报警, 1112-三相B过流报警, 1113-三相B过压报警, 1114-三相B缺相报警, 1115-三相B温度报警, 1116-三相C欠压报警, 1117-三相C过流报警, 1118-三相C过压报警, 1119-三相C缺相报警, 1120-三相C温度报警, 1208-三相A过载报警, 1209-三相B过载报警, 1210-三相C过载报警, 2001-过载预警, 2002-漏电预警, 2003-欠压预警, 2004-过流预警, 2005-过压预警, 5502-遥控分闸报警, 5504-遥控合闸
语音呼叫器fault
lowPower
open
sosAlarm
temp
voiceAlarm
故障报警
低电报警
拆开报警
紧急报警
温度报警
语音识别报警
报警主机balconyAlarm
batteryPower
bedroomAlarm
coAlarm
gasAlarm
gateAlarm
hallAlarm
mainPower
openAlarm
roundAlarm
smokeAlarm
sosAlarm
systemAlarm
waterAlarm
windowAlarm
阳台报警
备电低电
卧室报警
一氧化碳报警
燃气泄漏
主门报警
大厅报警
主电故障
防拆报警
周界报警
烟雾报警
求救报警
系统警情
漏水报警
窗户报警
声光报警alertAlarm
fault
lowPower
open
smokeAlarm
undeploy
urgent
声光报警
传感器故障
低电报警
拆开报警
烟雾报警
撤防报警
紧急报警
倾角探测器fault
lowPower
open
temp
tiltAlarm
探测器故障报警
低电报警
拆开报警
温度报警
倾斜报警
一氧化碳coLeak
fault
infrared
lowPower
open
temp
一氧化碳泄漏报警
故障报警
红外报警
低电报警
拆开报警
温度报警
值班人员在岗检测摄像机absentAlarm离岗报警
电子围栏检测摄像机occupyAlarm侵占报警
电子围栏主机breakageAlarm
intrusionAlarm
lowPower
open
powerlossAlarm
shearProofAlarm
shortOutAlarm
tamperAlarm
touchNetAlarm
断线报警
入侵报警
低电报警
拆开报警
掉电报警
防剪报警
短路报警
防拆报警
触网报警
用电安全监控系统break
currAlarm
leakAlarm
leakTest
lossPhase
short
tempAlarm
voltHigh
voltLow
开路故障
电流报警
漏电报警
漏电测试报警
电压缺相故障
短路故障
温度报警
过压报警
欠压报警
电气设备130
143
144
145
165
电压报警
漏电报警
温度报警
电流报警
反馈报警
4G嵌入式控制开关connected
fault
lowPower
open
powerAlarm
temp
开关闭合报警
故障报警
低电报警
拆开报警
停电报警
温度报警
通用灭火器deviceAuto
deviceHand
deviceRemote
fault
lowPower
pressureHigh
pressureLow
自动灭火报警
手工灭火报警
远程灭火报警
传感器故障
低电报警
灭火剂高压报警
灭火剂低压报警
跌倒检测器fallAlarm
lowPower
open
跌倒报警
低电报警
拆开报警
火灾报警控制器fault
feedback
fire
shield
消防故障
反馈报警
火灾报警
屏蔽报警
消防报警主机110
111
112
120
121
122
123
130
131
132
133
134
137
161
162
163
173
174
175
176
181
182
183
184
300
301
302
305
306
381
384
401
403
404
405
410
601
604
608
火警
烟雾报警
燃气报警
紧急报警
劫持报警
紧急无声报警
紧急有声报警
感应报警
周界报警
内部报警
24小时防区报警
出入口报警
防拆报警
断线报警
短路报警
触网报警
低温报警
高温报警
低湿报警
高湿报警
低温预警
高温预警
烟感预警
设备掉线
主机系统故障
主机交流故障
主机电池低压
系统重启
键盘编程改动
探测器丢失
无线探测器低压
用户布防
定时布防
高压布防
低压布防
启动灭火
手动测试
火警测试
定期测试系统故障
火焰视频识别摄像机chargeAlarm
fault
flameAlarm
电瓶车报警
摄像机故障
火焰报警
燃气探测器coLeak
fault
gasLeak
infrared
lowPower
open
temp
test
co泄漏报警
故障报警
燃气泄漏报警
红外报警
低电报警
拆开报警
温度报警
测试报警
手动报警器fault
lowPower
open
temp
urgent
故障报警
低电报警
拆开报警
温度报警
紧急报警
温湿度传感器fault
highHumid
highTemp
lowHumid
lowPower
lowTemp
open
sosAlarm
传感器故障
湿度过高报警
高温报警
湿度过低报警
低电报警
低温报警
拆开报警
求救报警
室外消火栓fault
flow
impact
influentAlarm
leakage
lowPower
pressureHigh
pressureLow
pressureSensor
tamper
tiltAlarm
waveAlarm
设备故障
放水报警
撞击报警
进水报警
漏水报警
低电报警
水压高报警
水压低报警
压力传感器故障
开盖报警
倾斜报警
水压波动报警
人体红外探测器fault
infraAlarm
lowPower
noneInfraAlarm
open
temp
传感器故障报警
红外检测报警
低电报警
无人红外报警
防拆报警
温度报警
输入输出模块fault
inAlarm
inFault
lowPower
open
test
探测器故障
输入报警
输入故障
低电报警
拆开报警
测试报警
油烟监测器fanFault
fault
powerFault
purifierFault
排风扇故障
传感器故障
电源故障
净化器故障
液体温度探测器lowPower
lTempHigh
lTempLow
lTempSensor
lTempWave
open
低电报警
液体高温报警
液体低温报警
温度传感器失效
液体波动报警
拆开报警
独立式门磁fault
lockClose
lockOpen
lowPower
open
temp
故障报警
门磁关门
门磁打开报警
低电报警
拆开报警
温度报警
智慧井盖fault
lowPower
open
soak
uncover
传感器故障
低电报警
拆开报警
水浸
开盖报警
电单车入户探测摄像机motoin电动车入户
多路报警模块130
301
305
401
403
404
405
fault
lowPower
open
outputClose
报警
交流故障
系统重启
布防事件
定时布防事件
高压布防事件
低压布防事件
传感器故障报警
低电报警
拆开报警
输出点闭合
停电报警器fault
open
powerOff
temp
探测器故障
拆开报警
停电报警
温度报警
智能短路灭弧保护器exFaultA
exFaultB
exFaultC
extinguishing
FEstart
infraAlarm
leakage
lockAlarm
lostGround
overCurrent
overVoltage
poorA
powerHigh
powerLow
short
smokeAlarm
sockAlarm
tempA
tempB
tempC
tempN
trip
underVoltage
A故障电弧
B故障电弧
C故障电弧
灭弧
灭火器启动
红外报警
漏电
门磁报警
丢地
过流
过压
A触点不良
功率过高报警
功率过低报警
短路
烟雾报警
浸水报警
A相温度报警
B相温度报警
C相温度报警
N相温度报警
跳闸
欠压
AI消防主机1
fire
火警
烟感联动报警
智慧手环bloodOxygen
bloodPreAlarm
heartAbnAlarm
highHeart
infenceAlarm
lowHeart
lowPower
lowPowerSd
outfenceAlarm
sosAlarm
血氧异常报警
血压报警
心率异常报警
心率过高报警
进电子围栏报警
心率过低报警
低电报警
低电关机报警
出电子围栏报警
SOS报警
烟雾报警器fault
fire
infrared
lowPower
open
temp
test
故障报警
火警
红外报警
低电报警
拆开报警
温度报警
测试报警
吸烟探测器fault
lowPower
open
smoking
temp
故障报警
低电报警
拆开报警
吸烟报警
温度报警
水浸探测器fault
lowPower
open
soak
temp
故障报警
低电报警
拆开报警
水浸报警
温度报警
土壤检测器fault
lowPower
open
temp
故障报警
低电报警
拆开报警
温度报警
臭气检测器fault
lowPower
open
temp
故障
低电
拆开
温度报警
温度报警器fault
highTemp
lowPower
lowTemp
open
temp
故障报警
高温报警
低电报警
低温报警
拆开报警
温度报警
用户传输装置admin
delay
fault
feedback
fire
handAlarm
infoStatusErr
mainPowerErr
mainPowerErrFH
networkErr
power
shield
sparePowerErr
sparePowerErrFH
部件监管报警
部件延迟报警
部件故障报警
部件反馈报警
部件火警
手动火警
通信故障
用传主电故障
消防主机主电故障
用传网络故障
部件电源故障报警
部件屏蔽报警
用传备电故障
消防主机备电故障
个人紧急语音呼叫设备fault
lowPower
open
urgentAlarm
故障报警
低电报警
拆开报警
sos报警
消防水压设备lowPower
open
waterHigh
waterLow
waterSensor
waterWave
低电报警
拆开报警
水压(位)高报警
水压(位)低报警
传感器失效
水压(位)波动报警

故障类型解析

设备类型报警类型说明
用电安全监控系统break
lossPhase
short
开路故障
缺相故障
短路故障
消防报警主机300
301
302
303
384
主机系统故障
主机交流故障
主机电池低压
探测器丢失
无线探测器低压
AI消防主机2回路故障

事件类型解析

设备类型事件类型说明
声光报警active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
倾角探测器active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
一氧化碳active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
跌倒检测器activity
connected
disconnected
fallConfirmed
fallDetected
fallExit
fallFinished
falling
fallRecovery
nonPresence
presence
rest
活动
连接成功
断开连接
跌倒确认
跌倒检测
当前跌倒检测退出
当前跌倒检测完成
跌倒报警
报警恢复
无人出现
有人出现
静息
消防报警主机305
306
401
404
405
410
601
604
608
unDeploy
系统重启
键盘编程改动
用户布防
高压布防
低压布防
启动灭火
手动测试
火警测试
定期测试
撤防
燃气探测器active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
手动报警器active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
温湿度传感器active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
室外消火栓active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
人体红外探测器active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
输入输出模块active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
独立式门磁active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
智慧井盖active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
多路报警模块active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
AI消防主机3
4
5
启动
反馈
屏蔽
烟雾报警器active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
吸烟探测器active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
水浸探测器active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试
用户传输装置admin
delay
fault
feedback
fire
offline
online
power
reset
run
shield
start
stop
test
监管
延迟
故障
反馈
火警
离线
在线
电源故障
复位
运行
屏蔽
启动
停止
测试
消防水压设备active
heart
mute
offline
online
test
激活
心跳
消音
离线
在线
测试

处理方式解析

处理方式说明
auto自动恢复
repeat重复报警
reset复位
close人工处理
mis误报