@tencentcloud/sdk-mcp 1.7.7 → 1.7.9-beta.1

package/resource/knowledge/iot/client-api/app/miniprogram/txiotdevicemanager.md

@@ -0,0 +1,281 @@
+---
+product: iot
+framework:
+  - minprogram
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+TXIoTDeviceManager 负责设备的绑定/解绑、房间归属、设备分享、指令下发、属性查询与别名修改、设备 VoIP 通知等。TXIoTDeviceManager 通过 TXIoTEngine.getDeviceManager 获取实例，需在登录成功后调用。
+
+> **说明：**
+> 设备必须先绑定到家庭后才能进行后续操作。绑定方式有两种：
+>
+> 1. 通过 `bindDevice` 使用设备绑定签名直接绑定。
+> 2. 通过 `bindDeviceSharedWithMe` 接受他人分享的设备。
+
+## 方法列表
+
+|方法签名|描述|
+|---------|---------|
+|bindDevice|绑定设备到家庭。|
+|unbindDevice|从家庭解绑设备。|
+|addDeviceToRoom|将设备添加到房间。|
+|requestVoIPSnTicket|获取设备 VoIP 授权票据。|
+|registerVoIPNotificationForDevice|注册设备 VoIP 通知。|
+|unregisterVoIPNotificationForDevice|注销设备 VoIP 通知。|
+|getAuthorizedVoIPUserList|获取设备 VoIP 授权用户列表。|
+|removeDeviceFromRoom|将设备从房间移除。|
+|getDeviceList|获取家庭设备列表（支持分页）。|
+|createDeviceSharingToken|创建设备分享令牌。|
+|bindDeviceSharedWithMe|绑定别人分享给我的设备。|
+|unbindDeviceSharedWithMe|取消绑定别人分享给我的设备。|
+|getDeviceSharedUsers|获取设备已分享的用户列表。|
+|removeDeviceSharedUser|移除设备已分享用户。|
+|getDeviceListSharedWithMe|获取别人分享给我的设备列表（支持分页）。|
+|sendCommand|向设备发送指令。|
+|getProperties|查询设备属性。|
+|modifyAliasName|修改设备别名。|
+
+### bindDevice
+
+**绑定设备到家庭**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+|deviceBindSignature|`String`；设备绑定签名。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<TXIoTDeviceInfo>|操作结果。|
+
+### unbindDevice
+
+**从家庭解绑设备**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### addDeviceToRoom
+
+**将设备添加到房间**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|familyId|`String`；家庭 ID。|
+|roomId|`String`；房间 ID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### requestVoIPSnTicket
+
+**获取设备 VoIP 授权票据**
+
+返回的 sn/snTicket 供小程序自行调用 `wx.requestDeviceVoIP` 完成微信侧授权弹窗（插件上下文无此 API）。
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|modelId|`String`；微信公众平台「设备接入」分配的 model_id。|
+|appId|`String`；小程序 AppID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Object>|包含 sn（设备序列号）与 snTicket（VoIP 授权票据）字段。|
+
+### registerVoIPNotificationForDevice
+
+**注册设备 VoIP 通知**
+
+调用前需先通过 `requestVoIPSnTicket` 获取票据，并调用 `wx.requestDeviceVoIP` 完成微信侧授权弹窗。
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|modelId|`String`；微信公众平台「设备接入」分配的 model_id。|
+|appId|`String`；小程序 AppID。|
+|wxOpenId|`String`；当前用户微信 OpenID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### unregisterVoIPNotificationForDevice
+
+**注销设备 VoIP 通知**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|modelId|`String`；微信公众平台「设备接入」分配的 model_id。|
+|appId|`String`；小程序 AppID。|
+|wxOpenId|`String`；当前用户微信 OpenID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### getAuthorizedVoIPUserList
+
+**获取设备 VoIP 授权用户列表**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<List<String>>|已授权用户的微信 OpenID 列表。|
+
+### removeDeviceFromRoom
+
+**将设备从房间移除**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|familyId|`String`；家庭 ID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### getDeviceList
+
+**获取家庭设备列表（支持分页）**
+
+|参数|描述|
+|---------|---------|
+|familyId|`String`；家庭 ID。|
+|nextPageToken|`String`；分页令牌，首次传空字符串。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<TXIoTPageResult<TXIoTDeviceInfo>>|设备列表。|
+
+### createDeviceSharingToken
+
+**创建设备分享令牌**
+
+|参数|描述|
+|---------|---------|
+|family_id|`String`；家庭 ID。|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<String>|分享令牌。|
+
+### bindDeviceSharedWithMe
+
+**绑定别人分享给我的设备**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|shareToken|`String`；分享令牌。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### unbindDeviceSharedWithMe
+
+**取消绑定别人分享给我的设备**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### getDeviceSharedUsers
+
+**获取设备已分享的用户列表**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<List<TXIoTUserInfo>>|用户列表。|
+
+### removeDeviceSharedUser
+
+**移除设备已分享用户**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|userId|`String`；用户 ID。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|
+
+### getDeviceListSharedWithMe
+
+**获取别人分享给我的设备列表（支持分页）**
+
+|参数|描述|
+|---------|---------|
+|nextPageToken|`String`；分页令牌，首次传空字符串。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<TXIoTPageResult<TXIoTDeviceInfo>>|设备列表。|
+
+### sendCommand
+
+**向设备发送指令**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|jsonData|`String`；JSON 格式的指令数据。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<String>|发送的指令。|
+
+### getProperties
+
+**查询设备属性**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<String>|设备属性。|
+
+### modifyAliasName
+
+**修改设备别名**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+|aliasName|`String`；设备别名。|
+
+|返回值|描述|
+|---------|---------|
+|Promise<Void>|操作结果。|

package/resource/knowledge/iot/client-api/app/miniprogram/txiotengine.md

@@ -0,0 +1,183 @@
+---
+product: iot
+framework:
+  - minprogram
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+`TXIoTEngine` 是整个 SDK 的入口，通过 `getInstance()` 获取单例，使用前须先调用 `login` 完成身份验证。
+
+SDK 模块一览：
+
+|模块|说明|
+|---------|---------|
+|TXIoTEngine 引擎管理|登录、获取各个业务对象。|
+|TXIoTFamilyManager 家庭与房间管理|家庭、房间、成员管理。|
+|TXIoTDeviceManager 设备管理|设备绑定/解绑、分享、指令下发、属性查询。|
+|TXIoTCallSession 音视频通话|音视频通话。|
+|TXIoTMonitorSession 监控直播|监控直播（拉流/对讲/云台/截图/录像）。|
+|TXIoTCloudStorage 云存回放|云端录像的日期与事件查询。|
+|公共类型与枚举|错误码、通用枚举、公共数据结构、回调接口。|
+
+## 方法列表
+
+|方法签名|描述|
+|---------|---------|
+|getInstance|获取引擎单例。|
+|addListener/[removeListener](#removeListener.3A)|添加/移除引擎事件代理。|
+|login|使用 appKey、userId、用户签名登录。|
+|logout|登出当前账号。|
+|getLoginUserInfo|获取当前登录用户信息。|
+|getFamilyManager|获取家庭管理器，未登录时返回 null。|
+|getDeviceManager|获取设备管理器，未登录时返回 null。|
+|getCallSession|获取音视频通话会话，未登录时返回 null。|
+|getMonitorSession|获取实时监控会话，未登录时返回 null。|
+|getCloudStorage|获取云存模块，未登录时返回 null。|
+
+### getInstance
+
+**获取引擎单例**
+
+|返回值|描述|
+|---------|---------|
+|Promise<TXIoTEngine>|SDK 引擎单例对象；首次调用会等待内部 wasm 模块加载完成。|
+
+### addListener
+
+**添加引擎事件代理对象**
+
+|参数|描述|
+|---------|---------|
+|listener|引擎事件代理对象，回调方法参见引擎事件回调|
+
+### removeListener
+
+**移除引擎事件代理对象**
+
+|参数|描述|
+|---------|---------|
+|listener|要移除的引擎事件代理对象。|
+
+### login
+
+**使用 appKey、userId、用户签名进行登录**
+
+|参数|描述|
+|---------|---------|
+|appKey|string；应用密钥。|
+|userId|string；用户 ID。支持字母、数字、下划线，长度不超过32字节。|
+|userSignature|TXIoTUserSignature；用户签名对象，见 TXIoTUserSignature。|
+
+### logout
+
+**登出当前账号**
+
+### getLoginUserInfo
+
+**获取当前已登录的用户信息**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTUserInfo|已登录返回用户信息对象；未登录返回 null。|
+
+### getFamilyManager
+
+**获取家庭管理器**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTFamilyManager|返回家庭管理器实例；未初始化返回 null。。|
+
+### getDeviceManager
+
+**获取设备管理器**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTDeviceManager|返回设备管理器实例；未初始化返回 null。。|
+
+### getCallSession
+
+**获取音视频通话会话**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTCallSession|返回通话会话实例；未初始化返回 null。。|
+
+### getMonitorSession
+
+**获取实时监控会话**
+
+|返回值|描述|
+|---------|---------|
+|TXIoTMonitorSession|返回监控会话实例；未初始化返回 null。。|
+
+### getCloudStorage
+
+**获取云存模块**
+
+|参数|描述|
+|---------|---------|
+|deviceId|TXIoTDeviceId；设备标识（含 productId / deviceName）。|
+
+|返回值|描述|
+|---------|---------|
+|TXIoTCloudStorage|返回与 deviceId 绑定的云存模块实例；未登录或初始化未完成时返回 null。每次调用返回新实例，不做缓存。。|
+
+## 引擎事件回调
+
+协议定义引擎层事件回调。
+
+|回调|说明|
+|---------|---------|
+|onLoginSuccess|登录成功。|
+|onLoginFailure|登录失败，返回 TXIoTErrorCode 和错误信息。|
+|onLogout|登出完成。|
+|onUserSignatureExpired|用户签名已过期，需重新登录。|
+|onReceivePushMessage|收到推送消息（如设备上下线状态变更）。|
+
+## 引擎相关数据结构与枚举
+
+### TXIoTPushMessage
+
+**推送消息，通过** `onReceivePushMessage` **回调接收。**
+
+|字段|说明|
+|---------|---------|
+|messageTime|推送消息时间戳（Unix 秒级时间戳）。|
+|type|推送消息类型。|
+|subType|推送消息子类型。|
+|deviceId|关联的设备 ID。|
+
+### TXIoTUserSignature
+
+**用户签名，用于登录认证。**
+
+|字段|说明|
+|---------|---------|
+|requestId|请求 ID，由服务端签发。|
+|timestamp|签名的 Unix 秒级时间戳。|
+|nonce|签名随机数。|
+|signature|签名字符串，由服务端签发。|
+
+### TXIoTPushMessageType
+
+**推送消息类型枚举。**
+
+|枚举|取值|
+|---------|---------|
+|StatusChange|0|
+
+### TXIoTPushMessageSubType
+
+**推送消息子类型枚举。**
+
+|枚举|取值|
+|---------|---------|
+|Online|0|
+|Offline|1|

package/resource/knowledge/iot/client-api/app/miniprogram/txiotenginedef.md

@@ -0,0 +1,152 @@
+---
+product: iot
+framework:
+  - minprogram
+types:
+  - api
+retrievable_scope: always
+feature_domain: client_api
+---
+
+## 概述
+
+本文档描述 IoT App SDK 在 Android 端的公共类型与枚举定义，包含错误码、通用枚举、公共数据结构与通用回调等，定义于 `TXIoTEngineDef` 接口中。
+
+> **说明：**
+> `TXIoTEngineDef` 是各模块共用的基础类型定义接口，其他模块均通过 SDK 的公共依赖引入。各模块文档见：
+>
+> - TXIoTEngine：引擎管理。
+> - TXIoTFamilyManager：家庭与房间管理。
+> - TXIoTDeviceManager：设备管理。
+> - TXIoTCallSession：音视频通话。
+> - TXIoTMonitorSession：实时监控。
+> - TXIoTCloudStorage：云存回放。
+
+## 错误码 — TXIoTErrorCode
+
+|错误码|说明|
+|---------|---------|
+|Success|成功。|
+|Failed|通用失败。|
+|InvalidParameter|参数非法。|
+|InvalidAccessToken|Access Token 无效。|
+|RateLimited|请求频率超限。|
+|UnauthorizedOperation|未授权操作。|
+|DeviceBound|设备已绑定。|
+|BindTokenNotExist|绑定令牌不存在。|
+|BindTokenIsExpired|绑定令牌已过期。|
+|BindTokenNoPairWithDevice|绑定令牌与设备不匹配。|
+|InvalidMessageId|消息 ID 无效。|
+|FamilyDeviceLimitExceeded|家庭设备数量超限。|
+|CanNotBindSameFamily|不能绑定到同一家庭。|
+|FamilyNotExist|家庭不存在。|
+|ProductNotExist|产品不存在。|
+|DeviceNotExist|设备不存在。|
+|DeviceOffline|设备离线。|
+|CameraStartFail|摄像头启动失败。|
+|CameraNotAuthorized|摄像头权限未授权。|
+|CameraOccupy|摄像头被占用。|
+|MicStartFail|麦克风启动失败。|
+|MicNotAuthorized|麦克风权限未授权。|
+|MicOccupy|麦克风被占用。|
+|SpeakerStartFail|扬声器启动失败。|
+|RecordDurationTooShort|录制时长过短。|
+|FilePathUnwritable|文件路径不可写。|
+|FilePathAlreadyExist|文件路径已存在。|
+|DeviceSwitchToVoIP|设备切换到 VOIP 模式。|
+
+## 通用枚举
+
+### TXIoTFamilyRole
+
+家庭角色枚举。在 TXIoTFamilyManager 的成员管理接口中使用。
+
+|枚举|说明|
+|---------|---------|
+|Unknown|未知。|
+|Member|普通成员。|
+|Admin|管理员。|
+
+## 公共数据结构
+
+以下类型定义于 `TXIoTEngineDef` 接口中，作为 SDK 内部共用数据类型。
+
+### TXIoTDeviceId
+
+设备 ID，用于唯一标识一个设备。在 TXIoTDeviceManager 的绑定、查询接口中使用。
+
+|字段|说明|
+|---------|---------|
+|productId|产品 ID。|
+|deviceName|设备名称。|
+
+### TXIoTDeviceStatus
+
+设备在线状态。包含当前在线情况、累计在线时长和上线时间戳。在 TXIoTDeviceManager 的设备信息中包含此字段。
+
+|字段|说明|
+|---------|---------|
+|isOnline|是否在线。|
+|onlineDuration|累计在线时长（单位：秒）。|
+|bringOnlineTime|上线时间戳（Unix 秒级时间戳）。|
+
+### TXIoTDeviceInfo
+
+设备信息。在 TXIoTDeviceManager 的绑定、设备列表、被分享设备列表等查询接口中返回。
+
+|字段|说明|
+|---------|---------|
+|deviceId|设备 ID。|
+|aliasName|设备别名。|
+|familyId|所属家庭 ID。|
+|roomId|所属房间 ID。|
+|iconUrl|设备图标 URL。|
+|createTime|创建时间（Unix 秒级时间戳）。|
+|updateTime|更新时间（Unix 秒级时间戳）。|
+|status|设备在线状态。|
+
+### TXIoTFamilyInfo
+
+家庭信息。在 TXIoTFamilyManager 的创建、查询接口中使用。
+
+|字段|说明|
+|---------|---------|
+|familyId|家庭 ID。|
+|name|家庭名称。|
+|createTime|创建时间（Unix 秒级时间戳）。|
+|updateTime|更新时间（Unix 秒级时间戳）。|
+|role|当前用户在该家庭中的角色。|
+
+### TXIoTRoomInfo
+
+房间信息。房间是家庭下的二级分组，在 TXIoTFamilyManager 的房间管理接口中使用。
+
+|字段|说明|
+|---------|---------|
+|roomId|房间 ID。|
+|name|房间名称。|
+|familyId|所属家庭 ID。|
+|deviceCount|房间内设备数量。|
+|createTime|创建时间（Unix 秒级时间戳）。|
+|updateTime|更新时间（Unix 秒级时间戳）。|
+
+### TXIoTUserInfo
+
+用户信息。在 TXIoTFamilyManager 的成员管理和 TXIoTDeviceManager 的设备分享接口中使用。
+
+|字段|说明|
+|---------|---------|
+|userId|用户 ID。|
+|nickName|用户昵称。|
+|avatarUrl|用户头像 URL。|
+|role|用户角色。|
+|deviceBindTime|设备绑定时间（Unix 秒级时间戳）。|
+
+### TXIoTPageResult
+
+分页查询结果。`T` 为数据列表元素类型。在 TXIoTDeviceManager 的设备列表分页查询中使用：首次查询时 `nextPageToken` 传空，结果中返回的 `nextPageToken` 用于获取下一页。
+
+|字段|说明|
+|---------|---------|
+|nextPageToken|下一页游标；首次查询传空字符串，取结果中返回值用于获取下一页；为空字符串表示已到最后一页。|
+|dataList|当前页数据列表。|