局域网 API
ty.device.publishLanMessage
通过 局域网 消息通道下发消息
需引入
DeviceKit
,且在>=2.1.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
message | string | 是 | 消息内容 | |
deviceId | string | 是 | 设备 id | |
protocol | number | 是 | 协议号 | |
options | any | 否 | 预留下发逻辑配置标记,后续可以拓展,例如下发声音,下发操作后续动作等等 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
MQTT API
ty.device.getMqttConnectState
获取 mqtt 连接状态 回调返回当前连接情况
需引入
DeviceKit
,且在>=2.5.1
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
connectState | number | mqtt 连接状态 0 连接失败 1 连接成功 |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
ty.device.offMqttConnectState
取消监听:mqtt 连接状态变化事件
需引入
DeviceKit
,且在>=2.5.1
版本才可使用
参数
function callback
取消监听:mqtt 连接状态变化事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
connectState | number | 是 | mqtt 连接状态 0 连接失败 1 连接成功 |
ty.device.offMqttMessageReceived
取消监听:MQTT 消息通道消息上报
需引入
DeviceKit
,且在>=2.1.6
版本才可使用
参数
function callback
取消监听:MQTT 消息通道消息上报的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 否 | 设备 id | |
message | any | 是 | 原始消息数据 | |
messageData | any | 是 | 双端抹平后的消息数据 | |
type | string | 是 | 消息类型 | |
protocol | number | 是 | 协议号 | |
topic | string | 否 | topic |
ty.device.onMqttConnectState
mqtt 连接状态变化事件
需引入
DeviceKit
,且在>=2.5.1
版本才可使用
参数
function callback
mqtt 连接状态变化事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
connectState | number | 是 | mqtt 连接状态 0 连接失败 1 连接成功 |
👉 立即开发。
ty.device.onMqttMessageReceived
MQTT 消息通道消息上报
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
参数
function callback
MQTT 消息通道消息上报的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 否 | 设备 id | |
message | any | 是 | 原始消息数据 | |
messageData | any | 是 | 双端抹平后的消息数据 | |
type | string | 是 | 消息类型 | |
protocol | number | 是 | 协议号 | |
topic | string | 否 | topic |
ty.device.publishMqttMessage
通过 MQTT 消息通道下发消息
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
message | any | 是 | 消息内容 | |
deviceId | string | 是 | 设备 id | |
protocol | number | 是 | 协议号 | |
options | any | 是 | 预留下发逻辑配置标记,后续可以拓展,例如下发声音,下发操作后续动作等等 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.registerMQTTDeviceListener
注册设备的 MQTT 信息监听
需引入
DeviceKit
,且在>=2.3.1
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | deviceId 设备 id 支持跨面板获取其他的设备信息,当前面板可以传当前设备的 id 来进行获取 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.registerMQTTProtocolListener
注册 MQTT 协议监听
需引入
DeviceKit
,且在>=2.3.1
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
protocol | number | 是 | protocol 协议号 MQTT 预定义的协议号 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.registerTopicListListener
注册需要监听的 topic 列表 [仅 m/m/i topic 订阅]
需引入
DeviceKit
,且在>=2.5.1
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
topicList | array | 是 | 需监听的 topic 列表 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.unregisterMQTTDeviceListener
注销设备的 MQTT 信息监听
需引入
DeviceKit
,且在>=2.3.1
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | deviceId 设备 id 支持跨面板获取其他的设备信息,当前面板可以传当前设备的 id 来进行获取 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.unregisterMQTTProtocolListener
注销 MQTT 协议监听
需引入
DeviceKit
,且在>=2.3.1
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
protocol | number | 是 | protocol 协议号 MQTT 预定义的协议号 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.unregisterTopicListListener
注销需要监听的 topic 列表
需引入
DeviceKit
,且在>=2.5.1
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
Socket API
ty.device.offSocketMessageReceived
取消监听:socket 消息通道消息上报
需引入
DeviceKit
,且在>=2.1.6
版本才可使用
参数
function callback
取消监听:socket 消息通道消息上报的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
message | any | 是 | 消息内容 | |
deviceId | string | 是 | 设备 id | |
type | number | 是 | 局域网消息 type |
ty.device.onSocketMessageReceived
socket 消息通道消息上报
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
参数
function callback
socket 消息通道消息上报的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
message | any | 是 | 消息内容 | |
deviceId | string | 是 | 设备 id | |
type | number | 是 | 局域网消息 type |
ty.device.publishSocketMessage
通过 Socket 消息通道下发消息
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
message | any | 是 | 消息内容 | |
deviceId | string | 是 | 设备 id | |
type | number | 是 | 局域网消息 type | |
options | any | 是 | 预留下发逻辑配置标记,后续可以拓展,例如下发声音,下发操作后续动作等等 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
👉 立即开发。