消息定义

消息定义
消息类型
设置点位值返回结果
消息内容 code 定义

{
  msgID:"",             //消息id
  type: "dp_list",      //消息类型
  ver: 1,               //版本号
  ticks:1653961748,      //时间戳        
  header:               //消息header,里面可以放一些额外定义属性
  {
    correlationID:"",  //对应请求的 msgID,如果是请求返回的消息
  },
  code:"0",             //消息返回编码,针对请求返回的消息类型
  codeMsg:"Success",    //消息返回编码描述
  payload:[]             //消息类型不同，payload JSON 定义不同
}

消息类型

type	说明	payload
dp_realtime_report	点位实时信息上报	“payload”: [ { “dpId”: “DP_KNX_89B72655719019F7”, “gwSN”: “3F2204B0/IoT-16P”, “driverType”: 0, “alias”: “AI Alarm 2”, “name”: “”, “readable”: 0, “dataType”: 0, “value”: “True”, “updateTime”: “2022-04-26T06:34:00.4812866Z”, “validation”: { “enumOptions”: [ {“val”:1,”name”:”低”}， {“val”:2,”name”:”高”}， ], “min”: 0.0, “max”: 0.0, “unit”: null, “precision”: null, “trueName”: null, “falseName”: null, “stringType”: 0, “stringMaxLength”: 0 } } ]
gw_status_report	网关实时信息上报	payload: [ { “gwSN”: “3F2204EA/IoT-16P”, “gwName”: “JSHOTEL-DDC-B1-2”, “driverType”: 0, “connectionStatus”: 0, “updateTime”: “2022-04-28T13:07:46.817121” }, { “gwSN”: “3F2204B0/IoT-16P”, “gwName”: “办公室测试网关”, “driverType”: 0, “connectionStatus”: 1, “updateTime”: “2022-04-30T09:57:26.1559197” } ]
dp_list	获取点位列表	payload:{ keyword:”999”, pageNo:””, pageSize:””, gwSN：””, //可以为空 }
	点位列表返回	“payload”: [ { “dpId”: “DP_KNX_89B72655719019F7”, “gwSN”: “3F2204B0/IoT-16P”, “driverType”: 0, “alias”: “AI Alarm 2”, “name”: “”, “readable”: 0, “dataType”: 0, “value”: “True”, “updateTime”: “2022-04-26T06:34:00.4812866Z”, “validation”: { “enumOptions”: [ {“val”:1,”name”:”低”}， {“val”:2,”name”:”高”}， ], “min”: 0.0, “max”: 0.0, “unit”: null, “precision”: null, “trueName”: null, “falseName”: null, “stringType”: 0, “stringMaxLength”: 0 } } ]
gw_list	获取网关列表	payload:{ keyword:”knx”, gwType: }
	网关列表返回	payload: [ { “gwSN”: “3F2204EA/IoT-16P”, “gwName”: “JSHOTEL-DDC-B1-2”, “driverType”: 0, “connectionStatus”: 0, “updateTime”: “2022-04-28T13:07:46.817121” }, { “gwSN”: “3F2204B0/IoT-16P”, “gwName”: “办公室测试网关”, “driverType”: 0, “connectionStatus”: 1, “updateTime”: “2022-04-30T09:57:26.1559197” } ]
dp_set_val	下发设置点位值	payload:{ “dpID”: “DP_KNX_408ABFA32E9FFC5E”, “dpValue”: “50.00” }
	下发设置点位值返回	{ code: 0 codeMsg: “SetValueFailed” payload: { code: msg: } }

设置点位值返回结果

    SetDPValueResult
    {        
        [Description("无反应")]
        NoAction = 0,
        [Description("成功")]
        Success = 1,
        [Description("网关离线")]
        GwOffline = 2,
        [Description("已发送未返回")]
        SendWithoutReturn = 3,
        [Description("MQTT 已断开")]
        MqttDisconnected = 4,
        [Description("超时")]
        Timeout = 5,
        [Description("点位只读")]
        ReadOnly = 6,
        [Description("点位值无效")]
        ValidationFailed = 7,
        [Description("数据库操作失败")]
        DatabaseOperationFailed = 8,
        [Description("点位不存在")]
        DPNotExist = 9,
        [Description("失败")]
        Failed = 10,
        [Description("值非法")]
        WrongValue = 11,
        [Description("值超出范围")]
        OutOfRange = 12,
        [Description("无效的选项")]
        InvalidOption = 13,
    }

DatabaseOperationResult
{
    Success = 0,
    RecordAlreadyExist = 1,
    RecordNotExist = 2,
    OperationFailed = 3,
    UserNameIsEmpty = 4,
    DPAliasAlreadyExist = 5,
    GatewaySNAlreadyExit = 6,
    MissingGatwaySN = 7,
    MissParameter = 8,
    WrongParameter = 9,
    InvalidStartAddr = 10,
    TagNameDuplicate = 11,
}

消息内容 code 定义

 APICode
    {
        [Description("成功")]
        Success = 0,
        [Description("登录失败，未找到记录。请确认用户名和密码")]
        LoginFailed = 1,
        [Description("数据库操作失败")]
        DatabaseOperationFailed = 2,
        [Description("失败")]
        Failed = 3,
        [Description("设置点位置失败")]
        SetValueFailed = 4,
    }｝