中控设备对接协议

3.2.1服务器方式对接

通讯协议：MQTT

默认端口：1883，以实际设置为准

topic公共参数

payload格式为JSON字符串

[中控设置]

下载中控搜索软件，点击下载。安装后打开程序，电脑右下角工具栏出现如下图标

鼠标右键，选择工具，出现如下界面

选择设备搜索。在设备搜索页面上网网卡选择与中控接入同一网络的网卡，点击开始搜索。

在搜索到的中控后选择中控配置，打开配置页面。

在配置页面中选择对接配置选项

第三方系统需要自行搭建MQTT服务器，将服务器信息填入上图页面表单中。启用开关需要打开。连接成功后，第三方系统需要实现如下对接接口：

时间同步

当中控连上上述配置好的mqtt服务器时，会发生以下时间同步请求 topic: /gatetway/[APPID]/[DEVICEID]/action/time/req

{
 "action":"reqTime"
}

集控服务器需做如下回复：

topic: /gatetway/[APPID]/[DEVICEID]/action/time/resp

{
 "action":"respTime",
 "time":1639358897128  //服务器当前时间，毫秒级时间戳
}

设备控制

服务器发送如下主题指令控制设备：

topic: /gatetway/[APPID]/[DEVICEID]/action/device/ctrl

payload:

{
 "action":"KEY",
 "protocol":"SERIAL",
 "params":{
  }
}

action取值说明

开空调参数

 {
    "location":[1,2,3],   //控制第几路空调，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
    "temperature":26,   // 控制温度 可取值18-29
    "speed": 1   // 控制风速 1:小风 2：中风 3：大风
}

关空调参数

 {
    "location":[1,2,3],   //控制第几路空调，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
    "power": 1   // 断空调供电 1:关电 0:保持开启
}

开关窗帘参数

 {
    "location":[1,2,3],   //控制第几路窗帘，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
}

开关灯参数

 {
    "location":[1,2,3],   //控制第几排灯，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
}

开关电源参数

 {
    "location":[1,2,3],   //控制第路电源，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
}

设备状态上报

服务器订阅如下主题

topic: /gatetway/[APPID]/[DEVICEID]/event/device/status

定时收到如下格式JSON字符串

{
 "KEY1":"VLAUE1",
 "KEY2":"VLAUE2"
 ...
}

设备状态将以key-value形式上报，服务器需要缓存每一个key-value值。注意：全部设备状态并非以一条数据合并上报，而是分开上报。

以下为key、value对应值说明

空调状态说明

 {
    "status":"on",   //空调状态  on：空调正在运转 off:空调待机 offline:空调断电。
    "temperature":26 //当前温度 ,
    "humidity": 60 //当前湿度
}

窗帘电机状态说明

 {
    "status":"on",   //空调状态  on：窗开 off:窗关。
    "percentage":30 //当前开启百分比
}

写入卡库

服务器向中控发送如下指令

topic: /gatetway/[APPID]/[DEVICEID]/event/card/req

payload:

{
  “url”:"http://..."
}

{"data":[{
 "gender":1,  //0女 1男 9未登记，非空
 "name":"",  //姓名，非空
 "department":"", //部门
 "position":"", //职务
 "work_code":"", //教职工工号。如需设置课表模式，此字段必须
 "card_num":"",//10位IC卡号，非空
 "start_time":"YYYY-MM-DD HH:mm:ss", //授权有效时间,YYYY-MM-DD HH:mm:ss，非空
 "end_time":"YYYY-MM-DD HH:mm:ss",//授权过期时间,YYYY-MM-DD HH:mm:ss，非空
 "card_type":1, //1管理员卡 2教职工卡
}]}

设置刷卡校验模式

topic: /gatetway/[APPID]/[DEVICEID]/action/controller/setting

{
 "action":"set_lock_mode",
 "mode":"all",
}

下发整个学期课表

topic: /gatetway/[APPID]/[DEVICEID]/action/controller/setting

{
 "action":"schedule_download",
 "url":"http://...",
}

课表返回格式要求如下：

{
  "start_date":"2022-07-04",  //学期的开始日
  "end_date":"2023-01-07"   //学期的结束日,
  "school_time":[
     {
     "start_time":"08:00",
     "end_time":"08:40"
     },
      {
     "start_time":"08:50",
     "end_time":"09:30"
     }
   ],
   "schedule":{
       "day_1":[
          null,
          [
            {"course_name":"课程1",teacher_info:{"name":"张三","work_code":"工号"},weeks:[1,7]},
            {"course_name":"课程2",teacher_info:{"name":"李四","work_code":"工号"},weeks:[8,16]}
          ]
        ],
       "day_2":[],
       "day_3":[],
       "day_4":[],
       "day_5":[],
       "day_6":[],
       "day_7":[]
   }
}

刷卡记录上报

topic: /gatetway/[APPID]/[DEVICEID]/event/card/slot

{
 "card_num":"CARDNUM",
 "checked":true,
 "time":"2021-05-30 12:00:00"
}

3.2.2单机对接（直接与中控通讯）

通讯协议：TCP

通讯端口：8000

授权认证

第三方设备通过中控的IP连接TCP后,需要认证才能有效发送或接收其他指令。 第三方设备通过TCP向中控发送如下JSON格式字符串指令

{
  "type": "auth",
  "code": "CODE"
}

type固定取值auth，code值请向中控供应商索取。认证成功返回：

{
  "type": "auth",
  "data": {
    "code": 0,
    "msg": "认证成功"
  }
}

设备控制

第三方设备通过TCP向中控发送如下JSON格式字符串指令控制中控设备：

{
 "type": "ctrl",
 "action":"KEY",
 "protocol":"SERIAL",
 "params":{
  }
}

action取值说明

开空调参数

 {
    "location":[1,2,3],   //控制第几路空调，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
    "temperature":26,   // 控制温度 可取值18-29
    "speed": 1   // 控制风速 1:小风 2：中风 3：大风
}

关空调参数

 {
    "location":[1,2,3],   //控制第几路空调，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
    "power": 1   // 断空调供电 1:关电 0:保持开启
}

开关窗帘参数

 {
    "location":[1,2,3],   //控制第几路窗帘，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
}

开关灯参数

 {
    "location":[1,2,3],   //控制第几排灯，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
}

开关电源参数

 {
    "location":[1,2,3],   //控制第路电源，以实际安装路数为准，默认从前到后从1开始编号。可选择多路同时控制。
}

功放音量调节参数

 {
    "value":IntValue,   //IntValue取值0~26,0为禁音，26为最大音量。
}

设备状态上报

认证后第三方设备定时收到如下格式JSON字符串

{
 "type":"status_feedback",
 "data":{
    "KEY1":"VLAUE1",
    "KEY2":"VLAUE2"
    ...
 }
}

设备状态将以key-value形式上报，服务器需要缓存每一个key-value值。注意：全部设备状态并非以一条数据合并上报，而是分开上报。

以下为key、value对应值说明

空调状态说明

 {
    "status":"on",   //空调状态  on：空调正在运转 off:空调待机 offline:空调断电。
    "temperature":26 //当前温度 ,
    "humidity": 60 //当前湿度
}

窗帘电机状态说明

 {
    "status":"on",   //空调状态  on：窗开 off:窗关。
    "percentage":30 //当前开启百分比
}