帮你快速理解、总结文档立即下载

TXIoTDeviceManager

最近更新时间:2026-10-27 17:33:32
本文档已由 AI 辅助审校
我的收藏

概述

TXIoTDeviceManager 负责设备的绑定/解绑、房间归属、设备分享、指令下发、属性查询与别名修改等。TXIoTDeviceManager 通过 TXIoTEngine.getDeviceManager 获取实例,需在登录成功后调用。
说明:
设备必须先绑定到家庭后才能进行后续操作。绑定方式有两种:
(1)通过 bindDevice 使用设备绑定签名直接绑定。
(2)通过 bindDeviceSharedWithMe 接受他人分享的设备。

方法列表

方法签名
描述
bindDevice
绑定设备到家庭。
unbindDevice
从家庭解绑设备。
addDeviceToRoom
将设备添加到房间。
removeDeviceFromRoom
将设备从房间移除。
getDeviceList
获取家庭设备列表(支持分页)。
createDeviceSharingToken
创建设备分享令牌。
bindDeviceSharedWithMe
绑定别人分享给我的设备。
unbindDeviceSharedWithMe
取消绑定别人分享给我的设备。
getDeviceSharedUsers
获取设备已分享的用户列表。
removeDeviceSharedUser
移除设备已分享用户。
getDeviceListSharedWithMe
获取别人分享给我的设备列表(支持分页)。
sendCommand
向设备发送指令。
getProperties
查询设备属性。
modifyAliasName
修改设备别名。

bindDevice

bindDevice
bindDevice
(familyId: string, deviceBindSignature: string, callback: TXIoTCallback<TXIoTDeviceInfo>): void
绑定设备到家庭
参数
描述
familyId
string;家庭 ID。
deviceBindSignature
string;设备绑定签名。
callback
TXIoTCallback<TXIoTDeviceInfo>;异步回调,通过 onSuccess / onError 通知结果。

unbindDevice

unbindDevice
unbindDevice
(familyId: string, deviceId: TXIoTDeviceId, callback: TXIoTCallback<void>): void
从家庭解绑设备
参数
描述
familyId
string;家庭 ID。
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
callback
TXIoTCallback<void>;异步回调,通过 onSuccess / onError 通知结果。

addDeviceToRoom

addDeviceToRoom
addDeviceToRoom
(deviceId: TXIoTDeviceId, familyId: string, roomId: string, callback: TXIoTCallback<void>): void
将设备添加到房间
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
familyId
string;家庭 ID。
roomId
string;房间 ID。
callback
TXIoTCallback<void>;异步回调,通过 onSuccess / onError 通知结果。

removeDeviceFromRoom

removeDeviceFromRoom
removeDeviceFromRoom
(deviceId: TXIoTDeviceId, familyId: string, callback: TXIoTCallback<void>): void
将设备从房间移除
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
familyId
string;家庭 ID。
callback
TXIoTCallback<void>;异步回调,通过 onSuccess / onError 通知结果。

getDeviceList

getDeviceList
getDeviceList
(familyId: string, nextPageToken: string, callback: TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>): void
获取家庭设备列表(支持分页)
参数
描述
familyId
string;家庭 ID。
nextPageToken
string;分页令牌,首次传空字符串 "";翻页时传入上一次回调返回的 TXIoTPageResult.nextPageToken,为空字符串表示已到最后一页。
callback
TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>;异步回调,通过 onSuccess / onError 通知结果。
说明:
返回结果中设备的 status.isOnline 已包含查询时刻的在线状态,业务层无需额外查询;该状态为查询时刻快照,实时上下线请通过 TXIoTEngineListener.onReceivePushMessage 监听。

createDeviceSharingToken

createDeviceSharingToken
createDeviceSharingToken
(familyId: string, deviceId: TXIoTDeviceId, callback: TXIoTCallback<string>): void
创建设备分享令牌
参数
描述
familyId
string;家庭 ID。
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
callback
TXIoTCallback<string>;异步回调,onSuccess 返回分享令牌字符串。

bindDeviceSharedWithMe

bindDeviceSharedWithMe
bindDeviceSharedWithMe
(deviceId: TXIoTDeviceId, shareToken: string, callback: TXIoTCallback<void>): void
绑定别人分享给我的设备
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
shareToken
string;分享令牌。
callback
TXIoTCallback<void>;异步回调,通过 onSuccess / onError 通知结果。

unbindDeviceSharedWithMe

unbindDeviceSharedWithMe
unbindDeviceSharedWithMe
(deviceId: TXIoTDeviceId, callback: TXIoTCallback<void>): void
取消绑定别人分享给我的设备
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
callback
TXIoTCallback<void>;异步回调,通过 onSuccess / onError 通知结果。

getDeviceSharedUsers

getDeviceSharedUsers
getDeviceSharedUsers
(deviceId: TXIoTDeviceId, callback: TXIoTCallback<TXIoTUserInfo[]>): void
获取设备已分享的用户列表
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
callback
TXIoTCallback<TXIoTUserInfo[]>;异步回调,通过 onSuccess / onError 通知结果。
注意:
该接口不支持分页,单次最多返回 100 条用户记录。

removeDeviceSharedUser

removeDeviceSharedUser
removeDeviceSharedUser
(deviceId: TXIoTDeviceId, userId: string, callback: TXIoTCallback<void>): void
移除设备已分享用户
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
userId
string;用户 ID,取 getDeviceSharedUsers 返回的 TXIoTUserInfo.userId 原值。
callback
TXIoTCallback<void>;异步回调,通过 onSuccess / onError 通知结果。

getDeviceListSharedWithMe

getDeviceListSharedWithMe
getDeviceListSharedWithMe
(nextPageToken: string, callback: TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>): void
获取别人分享给我的设备列表(支持分页)
参数
描述
nextPageToken
string;分页令牌,首次传空字符串 "";翻页时传入上一次回调返回的 TXIoTPageResult.nextPageToken,为空字符串表示已到最后一页。
callback
TXIoTCallback<TXIoTPageResult<TXIoTDeviceInfo>>;异步回调,通过 onSuccess / onError 通知结果。

sendCommand

sendCommand
sendCommand
(deviceId: TXIoTDeviceId, jsonData: string, callback: TXIoTCallback<string>): void
向设备发送指令
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
jsonData
string;JSON 格式的指令数据。
callback
TXIoTCallback<string>;异步回调,通过 onSuccess / onError 通知结果。

getProperties

getProperties
getProperties
(deviceId: TXIoTDeviceId, callback: TXIoTCallback<string>): void
查询设备属性
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
callback
TXIoTCallback<string>;异步回调,onSuccess 返回 JSON 格式的设备属性数据。

modifyAliasName

modifyAliasName
modifyAliasName
(deviceId: TXIoTDeviceId, aliasName: string, callback: TXIoTCallback<void>): void
修改设备别名
参数
描述
deviceId
TXIoTDeviceId;设备标识(含 productId / deviceName)。
aliasName
string;设备别名。
callback
TXIoTCallback<void>;异步回调,通过 onSuccess / onError 通知结果。

定时器相关数据结构

TXIoTTimerInfo

TXIoTTimerInfo
设备定时器信息,包含定时计划、触发时下发的控制报文与启停状态。
字段
说明
timerId
string;定时器 ID。
timerName
string;定时器名称。
timerPlan
TXIoTTimerPlan;定时计划,见 TXIoTTimerPlan。
deviceId
TXIoTDeviceId;定时器关联的设备标识。
data
string;定时器触发时向设备下发的控制报文,JSON 格式。
isEnabled
boolean;定时器是否启用。
isRepeated
boolean;是否按 timerPlan.repeatDays 循环执行,单次定时任务为 false。该字段为独立属性,请直接读取使用,不要从 repeatDays 推导。
createTime
number;创建时间,Unix 秒级时间戳。
updateTime
number;更新时间,Unix 秒级时间戳。

TXIoTTimerPlan

TXIoTTimerPlan
定时器执行计划,包含重复星期与每日触发时间点
字段
说明
repeatDays
boolean[];长度为 7 的数组,索引 0 - 6 依次对应周日、周一、周二、周三、周四、周五、周六,true 表示当天触发。
triggerHour
number;触发时间点的小时,取值 0 - 23。
triggerMinute
number;触发时间点的分钟,取值 0 - 59。