添加产品 打开边缘网关 http://localhost:3000依次点击 子设备管理 > 产品开发 > 添加 输入您刚刚创建的产品信息填入： PID：产品的 PID 产品名称：根据需要填写为了便于区分可以填写插座 xxx 产品描述：根据需要填写 驱动库名称：模糊搜索比如可以模糊搜索 modbus 添加产品功能点 产品添加功能点依次点击 子设备管理 > 产品开发 > 选择刚刚创建的产品 > 功能点

业务能力介绍 通过设备管理业务 SDK可以获取类似以下信息： 设备 ID 设备时区 设备 IP 地址 设备信号强度 设备连接方式 设备 MAC 地址 设备本地 IP 地址 设备 Wi-Fi 信号强度 设备信道仅支持 Zigbee 设备 设备厂商名称仅支持第三方 Matter 设备 设备 ICCIDIntegrated Circuit Card Identification Number 设备 RSRPReference Signal Received Power值仅支持 LTE

如需查看涂鸦子设备可前往 设备管理 非涂鸦子设备 指由 TuyaOS 网关接入的非涂鸦的子设备泛指没有采用涂鸦模组的子设备仅对部分客户适用 前提条件 您已经创建至少一款智能产品详情请参考 创建产品 您至少有一台已激活的产品设备 操作步骤 登录 涂鸦开发者平台 在左侧导航栏选择 产品 > 设备 > 设备列表字段说明 列表字段 含义说明 设备名称 指通过网关设备配网或注册完成后在 App 端展示的子设备名称

本文介绍设备信息的获取和管理能力等安卓版接口信息包含设备初始化设备监听设备控制查询设备信息修改设备名称移除设备设备恢复出厂设置查询 Wi-Fi 信号强度回收设备资源等 功能说明 设备相关的返回数据都采用异步消息的方式通知接收者 同时也提供了控制指令下发设备固件升级的接口 IThingDevice 类提供了设备状态通知能力通过注册回调函数您可以方便的获取设备数据接受设备移除设备上下线手机网络变化的通知 IThingGateway 类提供了 Zigbee 网关相关的操作包括控制查询和监听子设备状态的能力 DeviceBean 数据类型： 属性 类型 说明 devId String 设备 ID name String 设备名称 iconUrl String 图标地址 schema String 设备控制数据点的类型信息 productId String 产品 ID同一个产品 ID 的设备的 schema 信息一致 timezoneId String 设备所在的时区 category String 设备类型 pv String 网关协议版本 bv String 网关通用固件版本 time Long 设备激活时间 schemaMap Map schema 的缓存数据 dps Map 设备功能点数据信息key 是 DP IDvalue 是取值详情请参考 设备功能点 章节 getIsOnline Boolean 设备是否在线指局域网或者云端在线 isLocalOnline Boolean 设备的局域网在线状态 supportGroup Boolean 设备是否支持群组如果不支持请到 涂鸦开发者平台 开启此功能 isShare Boolean 是否是分享的设备 virtual Boolean 是否是虚拟设备 isZigBeeWifi Boolean 是否是 Zigbee 网关设备 hasZigBee Boolean 是否有 Zigbee 设备 nodeId String 用于网关和子设备类型的设备属于子设备的一个属性标识其短地址 ID一个网关的子设备的 nodeId 都是唯一的 meshId String 用于网关和子设备类型的设备属于子设备的一个属性标识其网关 ID lon String 设备所在经度信息 lat String 设备所在纬度信息 注意：设备控制时如果涉及到经纬度 lon 和 lat请在配网前调用 setLatAndLong 设置经纬度： ThingSdk.setLatAndLongString latitude String longitude 初始化设备 初始化设备控制类 根据设备 ID 初始化设备控制类 IThingDevice ThingOSDevice.newDeviceInstanceString devId 参数说明 参数 说明 devId 设备 ID Java 示例 IThingDevice mDevice ThingOSDevice.newDeviceInstancedeviceBean.getDevId 监听设备 注册设备监听 IThingDevice 提供设备相关信息的监听包含： DP 数据 设备名称 设备在线状态和设备移除 void IThingDevice.registerDevListenerIDevListener listener 参数说明 参数 说明 listener 设备状态监听 IDevListener 接口 public interface IDevListener { / DP 数据更新 @param devId 设备 ID @param dpStr 设备发生变动的功能点为 JSON 字符串数据格式：{"101": true} / void onDpUpdateString devId String dpStr / 设备移除回调 @param devId 设备id / void onRemovedString devId / 设备上下线回调如果设备断电或断网服务端将会在3分钟后回调到此方法 @param devId 设备 ID @param online 是否在线在线为 true / void onStatusChangedString devId boolean online / 网络状态发生变动时的回调 @param devId 设备 ID @param status 网络状态是否可用可用为 true / void onNetworkStatusChangedString devId boolean status / 设备信息更新回调 @param devId 设备 ID / void onDevInfoUpdateString devId } 说明：其中设备功能点说明请参考 设备功能点 章节 Java 示例 mDevice.registerDevListenernew IDevListener { @Override public void onDpUpdateString devId String dpStr { } @Override public void onRemovedString devId { } @Override public void onStatusChangedString devId boolean online { } @Override public void onNetworkStatusChangedString devId boolean status { } @Override public void onDevInfoUpdateString devId { } } 注意：请勿使用 void registerDeviceListenerIDeviceListener listener 方法此方法需要配合标准设备使用该 API 暂未开放使用 取消设备监听 当不需要监听设备时取消设备监听 接口说明 void IThingDevice.unRegisterDevListener Java 示例 mDevice.unRegisterDevListener 查询设备信息 查询单个 DP 数据查询后的数据会通过 IDevListener.onDpUpdate 接口进行异步回调 注意：该接口主要是针对不主动发送数据的设备 DP例如倒计时信息查询常规查询 DP 数据值时可通过 DeviceBean 中的 getDps 获取 void IThingDevice.getDpString dpId IResultCallback callback Java 示例 mDevice.getDpdpId new IResultCallback { @Override public void onErrorString code String error { } @Override public void onSuccess { } } 修改设备名称 重命名设备并支持多设备同步 // 修改设备名称 void IThingDevice.renameDeviceString nameIResultCallback callback Java 示例 mDevice.renameDevice"设备名称" new IResultCallback { @Override public void onErrorString code String error { // 修改设备名称失败 } @Override public void onSuccess { // 修改设备名称成功 } } 后续步骤 重命名成功后IDevListener.onDevInfoUpdate 会收到通知调用以下方法可以获取最新数据然后刷新设备信息即可 ThingOSDevice.getDataInstance.getDeviceBeanString devId 移除设备 从用户设备列表中移除设备 void IThingDevice.removeDeviceIResultCallback callback Java 示例 mDevice.removeDevicenew IResultCallback { @Override public void onErrorString errorCode String errorMsg { } @Override public void onSuccess { } } 恢复出厂设置 设备恢复出厂设置后设备的相关数据会被清除掉并重新进入待配网状态如果是 Wi-Fi 设备默认进入 Wi-Fi 快连模式 void IThingDevice.resetFactoryIResultCallback callback Java 示例 mDevice.resetFactorynew IResultCallback { @Override public void onErrorString errorCode String errorMsg { } @Override public void onSuccess { } } 查询 Wi-Fi 信号强度 查询设备 Wi-Fi 的信号强度 void IThingDevice.requestWifiSignalWifiSignalListener listener Java 示例 mDevice.requestWifiSignalnew WifiSignalListener { @Override public void onSignalValueFindString signal { } @Override public void onErrorString errorCode String errorMsg { } } 回收设备资源 应用或者 Activity 关闭时可以调用此接口回收设备占用的资源 void IThingDevice.onDestroy Java 示例 mDevice.onDestroy 初始化网关设备 初始化网关控制类 根据设备 ID 初始化网关设备控制类 IThingGateway ThingOSDevice.newGatewayInstanceString devId 参数说明 参数 说明 devId 设备 ID Java 示例 IThingGateway mGateway ThingOSDevice.newGatewayInstancedeviceBean.getDevId 监听子设备 注册子设备监听 IThingGateway 提供设备相关信息的监听包含： DP 数据 子设备名称 子设备在线状态和设备移除 void IThingGateway.registerSubDevListenerISubDevListener listener 参数说明 参数 说明 listener 设备状态监听 IDevListener 接口 public interface ISubDevListener { / 子设备DP 数据更新 @param nodeId 子设备 ID @param dps 设备发生变动的功能点为 JSON 字符串数据格式：{"101": true} / void onSubDevDpUpdateString nodeId String dps / 子设备移除回调 @param devId 子设备id / void onSubDevRemovedString devId / 子设备添加回调 @param devId 子设备id / void onSubDevAddedString devId / 子设备上下线回调如果设备断电或断网服务端将会在3分钟后回调到此方法 @param onlineDeviceIds 在线子设备 ID @param offlineDeviceIds 离线子设备 ID / void onSubDevStatusChangedList<String> onlineDeviceIds List<String> offlineDeviceIds / 子设备信息更新回调 @param devId 子设备 ID / void onSubDevInfoUpdateString devId } 说明：其中设备功能点说明请参考 设备功能点 章节 Java 示例 mGateway.registerSubDevListener new ISubDevListener { void onSubDevDpUpdateString nodeId String dps { } void onSubDevRemovedString devId { } void onSubDevAddedString devId { } void onSubDevInfoUpdateString devId { } void onSubDevStatusChangedList<String> onlineDeviceIds List<String> offlineDeviceIds { } } 取消子设备监听 当不需要监听子设备时取消子设备监听 接口说明 void IThingGateway.unRegisterSubDevListener Java 示例 mGateway.unRegisterSubDevListener 查询网关子设备列表 可以获取网关下子设备的列表 接口说明 void IThingGateway.getSubDevListIThingDataCallback<List<DeviceBean>> callback Java 示例 mGateway.getSubDevListnew IThingDataCallback<List<DeviceBean>> { @Override public void onSuccessList<DeviceBean> result { } @Override public void onErrorString errorCode String errorMessage { } } 回收网关资源 应用或者 Activity 关闭时可以调用此接口回收网关设备占用的资源 void IThingGateway.onDestroy Java 示例 mGateway.onDestroy

应用简介 在 中您可以针对不同空间下的设备进行统一管理如对设备进行远程/批量控制查询设备状态编辑设备信息移动设备空间等 功能介绍 控制单个设备 您可以只对某一个在线设备进行远程控制找到目标设备在 操作 列下单击 控制 打开设备控制面板然后对功能点进行操作 控制批量设备 您可以同时对多个在线设备进行远程控制 只有相同 PID 的设备支持进行批量控制 在设备列表中选择要管理的多个设备单击 批量控制 打开设备控制面板然后对多个设备共同的功能点进行操作 查询设备 支持根据设备名称设备 ID产品 PID所属网关设备在/离线状态通信协议查询设备 编辑设备 如需修改设备名称位置信息等可以编辑设备信息 找到目标设备在 操作 列下单击 编辑然后在 编辑设备 窗口中修改信息并单击 确定 保存 转移设备 您可以将设备从一个空间转移到另一个空间 选择一个或多个设备单击 移动安装位置然后选择要移动到的目标空间完成后并单击 确定

本文档介绍和控制相关的 API主要包含以下的功能： 提供对单个设备下发指令的 API 提供批量对设备下发控制指令的 API 提供订阅涂鸦各类事件消息的途径这些事件包括但不限于设备绑定设备解绑和设备上下线 提供设备详情和设备运行详情的查询 API 提供查询设备支持的趋势图的指标列表以及某个指标在某个时间段的各个值 参考文档 设备查询 设备控制 设备消息订阅 ​

模块是对设备配套功能的说明配套功能指的是除对设备控制之外设备所具备的能力例如目前已经开发的设备信息设备定时和设备的群组管理 后续将持续开放更多能力包括但不限于设备评价设备配件管理设备网络检测和设备备用网络等帮助您丰富除设备控制之外的其他设备能力

您可以使用以下 API 查询您的设备信息 请求方式 API 描述 PUT /v1.0/illumination/device/{deviceSaasId}/name 修改设备名称 GET /v1.0/illumination/devices 获取设备信息列表 GET /v1.0/illumination/devices/{deviceSaasId}/detail 设备 ID 查询单个设备详情 GET /v1.0/illumination/devices/unassignedRoom 未分区设备列表 GET /v1.0/illumination/devices/roomstate/{roomId} 查询房间设备状态 POST /v1.0/illumination/device/relations/save 设备空间划分 修改设备名称 功能描述 修改设备名称 接口地址 PUT /v1.0/illumination/device/{deviceSaasId}/name 请求参数 参数名 类型 参数类型 说明 是否必需 deviceSaasId String url 设备ID true name String url 设备名称 true 返回参数 参数名 类型 说明 code Integer 响应码详情见错误码章节成功时为空 success Boolean 是否成功：true：成功false：失败 msg String 请求失败的信息成功时为空 t Long 返回时间戳13位 result Object 返回结果 result参数说明 ResponseVO{} 请求示例 { "name": "设备名称" "deviceSaasId": "设备ID" } 响应示例 ResponseVO{} 获取设备信息列表 功能描述 根据条件分页获取设备信息列表 接口地址 GET /v1.0/illumination/devices 请求参数 参数名 类型 参数类型 说明 是否必需 projectId String body 项目 ID 否 roomId String body 房间 ID 是 roomType int body 房间类型 是 page int body 页码参数最小为 1 是 pageSize int body 每页记录数量最大为 100 是 deviceName String body 设备名称模糊查询 否 deviceStatus String[] body 设备状态EXPIRINGEXCEPTIONONLINEOFFLINE 否 返回参数 参数名 类型 说明 code Integer 响应码详情见错误码章节成功时为空 success Boolean 是否成功：true：成功false：失败 msg String 请求失败的信息成功时为空 t Long 返回时间戳13 位 result Object 返回结果 result参数说明 { "total": "int" "list": [ { "deviceSaasId": "String //设备商照唯一 ID" "deviceId": "String //设备ID和硬件设备一一对应由于设备重新绑定点位导致在这里不唯一" "deviceName": "String //设备名称" "deviceType": "String //设备类型详见 DeviceTypeEnum" "deviceTypeValue": "int //设备类型详见 DeviceTypeEnum" "topCategory": "String //产品所属大级分类 详见 ProductCategoryEnum 的类型说明" "devicePower": "double //设备功率" "deviceStatus": "设备状态 NORMAL/OFFLINE/EXPIRING/EXCEPTION" "installTime": "long //设备安装时间" "activeTime": "long //设备活跃时间" "productId": "String //设备品类产品 ID" "projectId": "String // 项目 ID" "roomId": "String //设备所属房间 ID" "roomName": "String //设备所属房间名称" "ownerId": "String //所属设备家庭组 ID" "properties": [ { "dpId": "Integer //DP ID" "dpCode": "String //DP 点代码" "dpName": "String //DP 点名称" "dpValueStd": "String //DP 当前值" "property": { "range": "String[] //描述属性值的取值范围" } "propertyDetail": {} "mode": "String //mode 模式 例如 rorw 1.4.3 新增" "dpFrom": "String" } ] "masterGroupJoinStatus": "int //主群组加入状态0 表示未加入1 表示已加入2 未加入群组的非照明设备" "currentBrightness": "int //设备所属房间的亮度阈值" "supportGroup": "boolean //是否支持群组" "switchStatus": "boolean //开关状态" "switchDpCode": "String //开关 dpCode" "colourValue": "String //颜色值" "brightPercentValue": "String //亮度百分比值" "iconUrl": "String //设备图标" } ] } 请求示例 { "pageSize": "每页记录数量" "page": "页码参数" "projectId": "项目 ID" "roomId": "房间 ID" "roomType": "房间类型" "deviceStatus": "设备状态" } 响应示例 { "total": "int" "list": [ { "deviceSaasId": "设备商照唯一 ID" "deviceId": "设备 ID和硬件设备一一对应由于设备重新绑定点位导致在这里不唯一" "deviceName": "设备名称" "deviceType": "设备类型详见 DeviceTypeEnum" "deviceTypeValue": "设备类型详见 DeviceTypeEnum" "topCategory": "产品所属大级分类 详见 ProductCategoryEnum 的类型说明" "devicePower": "设备功率" "deviceStatus": "设备状态 NORMAL/OFFLINE/EXPIRING/EXCEPTION" "installTime": "设备安装时间" "activeTime": "设备活跃时间" "productId": "设备品类产品 ID" "projectId": "项目 ID" "roomId": "设备所属房间 ID" "roomName": "设备所属房间名称" "pointId": "设备所在点位 ID" "ownerId": "所属设备家庭组 ID" "properties": [ { "dpId": "DP ID" "dpCode": "DP 点代码" "dpName": "DP 点名称" "dpValueStd": "DP 当前值" "property": { "range": "描述属性值的取值范围" } "propertyDetail": {} "mode": "mode 模式 例如 rorw 1.4.3 新增" "dpFrom": "String" } ] "masterGroupJoinStatus": "主群组加入状态0 表示未加入1 表示已加入2 未加入群组的非照明设备" "currentBrightness": "设备所属房间的亮度阈值" "supportGroup": "是否支持群组" "switchStatus": "开关状态" "switchDpCode": "开关 dpCode" "colourValue": "颜色值" "brightPercentValue": "亮度百分比值" "iconUrl": "设备图标地址" "pointDeviceType": "点位图上设备类型" "switchCount": "int" "dpFrom": "String" } ] } 获取单个设备的详细信息 功能描述 根据 deviceSaasId 获取单个设备的详细信息 接口地址 GET /v1.0/illumination/devices/{deviceSaasId}/detail 请求参数 参数名 类型 参数类型 说明 是否必需 deviceSaasId String url 设备 ID 是 返回参数 参数名 类型 说明 code Integer 响应码详情见错误码章节成功时为空 success Boolean 是否成功：true：成功false：失败 msg String 请求失败的信息成功时为空 t Long 返回时间戳13 位 result Object 返回结果 result 参数说明 同获取设备信息列表接口 请求示例 { "deviceSaasId": "设备 ID" } 响应示例 同获取设备信息列表接口 未分区设备列表 功能描述 查询项目下未分配到空间的设备列表 接口地址 GET /v1.0/illumination/devices/unassignedRoom 请求参数 参数名 类型 参数类型 说明 是否必需 page int body 页数最小为 1 否 pageSize int body 数量最大为 100 否 projectId String body 项目 ID 是 deviceStatus String[] body 设备状态EXPIRINGEXCEPTIONONLINEOFFLINE 否 deviceTypes int[] body 设备类型-1：其他0：智能灯1：网关设备2：非智能灯3：开关设备4：传感器设备 否 返回参数 参数名 类型 说明 code Integer 响应码详情见错误码章节成功时为空 success Boolean 是否成功：true：成功false：失败 msg String 请求失败的信息成功时为空 t Long 返回时间戳13位 result Object 返回结果 result 参数说明 同获取设备信息列表接口 请求示例 { "pageSize": "数量" "page": "页数" "projectId": "项目 ID" "topCategories": "设备状态筛选列表 Code 电工 dgzm 照明 zm 小家电 xjd 安防传感类 jjaf 网关中控 wgzk 其他类 qt" "deviceName": "设备名称" "roomId": "房间 ID" "deviceStatus": "设备状态筛选列表" } 响应示例 同获取设备信息列表接口 查询房间设备状态 功能描述 查询房间设备状态V1.4.3 新增功能 接口地址 GET /v1.0/illumination/devices/roomstate/{roomId} 请求参数 参数名 类型 参数类型 说明 是否必需 roomId String url 房间 ID 是 返回参数 参数名 类型 说明 code Integer 响应码详情见错误码章节成功时为空 success Boolean 是否成功：true：成功false：失败 msg String 请求失败的信息成功时为空 t Long 返回时间戳13 位 result Object 返回结果 result 参数说明 { "properties": [ { "dpCode": "String //DP 点代码" "dpName": "String //DP 点名称" "dpValueStd": "String //DP 当前值" "property": { "range": "String[] //描述属性值的取值范围" } "propertyDetail": {} "mode": "String //mode 模式 例如 rorw 1.4.3新增" "dpFrom": "String" } ] "count": { "total": "long //总设备数量" "online": "long //在线设备数量" "offline": "long //离线设备数量" "expiring": "long //更换报警设备数量" "exception": "long //DP 报警设备数量" } } 请求示例 { "roomId": "房间 ID" } 响应示例 { "properties": [ { "dpCode": "DP 点代码" "dpName": "DP 点名称" "dpValueStd": "DP 当前值" "property": { "range": "描述属性值的取值范围" } "propertyDetail": {} "mode": "mode 模式 例如 rorw 1.4.3新增" "dpFrom": "String" } ] "count": { "total": "总设备数量" "online": "在线设备数量" "offline": "离线设备数量" "expiring": "更换报警设备数量" "exception": "DP 报警设备数量" } } 设备空间划分 功能描述 将指定设备划分到指定空间 接口地址 POST /v1.0/illumination/device/relations/save 请求参数 参数名 类型 参数类型 说明 是否必需 projectId String body 项目 ID 是 roomId String body 空间 ID未分区空间 ID 为 0 是 deviceIds List body 设备 ID 列表 是 返回参数 参数名 类型 说明 code Integer 响应码详情见错误码章节成功时为空 success Boolean 是否成功：true：成功false：失败 msg String 请求失败的信息成功时为空 t Long 返回时间戳13位 result Object 返回结果 result参数说明 { "expiredSeconds": "过期时间 单位秒 这个时间之后该任务就会过期" "taskId": "任务 ID" } 请求示例 { "deviceIds": "设备 ID 列表" "projectId": "项目 ID" "roomId": "空间 ID 未分区空间 ID 为 0" } 响应示例 { "expiredSeconds": "过期时间 单位秒 这个时间之后该任务就会过期" "taskId": "任务 ID" } 错误码 以下为该接口常见的业务异常更多的异常错误请参见全局错误码 错误码 说明 500 系统错误

主要用于管理接入涂鸦开发者平台的产品设备包含设备统计在离线状态监控生产信息查看等 功能支持查询以下设备数据： 查询您自己的产品 切换到被授权的空间后可查询空间内授权的产品 前置条件 您已经创建至少一款智能产品详情请参考 创建产品 您至少有一台已激活的产品设备 操作说明 主要包含数据查看列表和相关管理操作 登录 涂鸦开发者平台 在左侧导航栏选择 产品 > 设备 > 设备列表字段说明 列表字段 含义说明 设备名称 指配网或注册完成后在 App 端展示的设备名称用户可在 App 端进行修改或者如果进行 PaaS 对接可调用 API 进行修改 设备 ID 指设备配网或注册完成后生成的云端设备唯一标识 设备状态 指包含设备的绑定状态和在离线状态其中绑定状态代表当前设备是否已被人使用在离线状态代表当前设备是否处于正常运行情况关于设备绑定模式介绍可查看 设备绑定模式 生产 UUID 指用于模组生产烧录的设备编号也是设备的唯一凭证 所属产品/产品 ID 指该设备所属的产品名称和产品 IDPID 设备类型 指进行产品开发时设备的类型包含普通设备网关设备和网关子设备 设备 SN 码 指部分设备激活上线时上报的设备码仅支持已上报数据的设备展示 首次激活时间 指设备首次配网或注册时间设备激活指设备配网或注册完成后在平台产生一条设备实例记录后则定义为激活若为子设备则一般由网关设备代理激活 最近激活时间 指设备最近的配网或注册时间 详情 单击 操作 栏的 详情可查看设备的基本信息运行状态以及绑定用户状态详情 日志 单击 操作 栏的 日志可查看设备运行中产生的数据日志用于数据查看和问题排查 绑定二维码 针对产品创建时通过 生态设备接入 方式接入的设备单击 操作 栏的 绑定二维码可查看绑定二维码主要用于 智能生活 App 或 涂鸦智慧空间 App 绑定 若绑定失败可查看 设备绑定范围配置说明 管理子设备 针对设备类型为网关设备支持管理子设备 在 操作 栏中单击 管理子设备 查询该网关下的子设备清单 数据导出 支持导出设备数据目前因为数据安全限制仅支持一次导出最多 50000 条数据如数据过多请分批次导出 数据分区 为符合各地区数据安全规定涂鸦开发者平台部署了六大数据中心包含中国数据中心美西数据中心中欧数据中心印度数据中心美东数据中心和西欧数据中心同一个产品可以在不同数据中心进行设备配网激活切换数据中心查看对应数据中心的数据 若出现切换数据中心失败请查看当前网络是否支持访问全球外网 更多操作 可查看 设备 操作说明包含子设备调试固件 OTA 和固件管理等

模块是对设备配套功能的说明配套功能指的是除对设备控制之外设备所具备的能力例如目前已经开发的设备信息设备定时和设备的群组管理 后续将持续开放更多能力包括但不限于设备评价设备配件管理设备网络检测和设备备用网络等帮助您丰富除设备控制之外的其他设备能力