常见参数

更新时间:2024-06-20 06:18:12下载pdf

本文为您介绍在使用云项目开发中高频使用的参数和这些参数的获取方法。

云项目参数

您可以在云项目的概述页面获取常用的项目 ID、Access ID 和 Access Secret 等信息。

常见参数

序号 参数 说明 获取方法
1 projectId 项目编号 ID 参见 查询项目信息
2 Access ID/Client ID 云应用密钥对中的 Access ID/Client ID,在涂鸦开发者平台云开发版块中创建云应用后,由后台默认生成,用于授权认证、接口认证。 参见 查询项目信息
3 Access Secret/Client Secret 云应用密钥对中的具体密钥的 Access Secret/Client Secret,在涂鸦开发者平台云开发版块中创建云应用后,由后台默认生成,用于授权认证、接口认证。 参见 查询项目信息

产品参数

选择或者创建产品类型(Category),再配置产品方案后,即可以生成唯一的产品 ID(PID)。例如,在标准类目 照明 下选择标准品类为 光源 (Category ID 为 dj),选择通讯协议和功能属性后即可创建产品,生成产品 ID (如 rvmopq1ckfta****)。

序号 参数 说明 获取方法
1 category_id 产品类别。您可以通过 标准指令集 查看云开发当前支持的标准品类。例如,光源 的 Category ID 为 dj 参见 查看基础信息
2 product_id 开发者在涂鸦开发者平台创建的每一个产品都会产生一个唯一的产品编号 PID, 即 Product ID。 参见获取设备信息-行业获取设备信息-全屋

常见参数

设备参数

您可以按照每一个产品类型生产若干个设备,每一个设备都会通过设备号(Device ID)或 设备唯一的识别 ID(UUID)标识。

序号 参数 说明 获取方法
1 device_id 设备 ID,是云端生成的设备识别码。不同实体设备的设备 ID 不同。实体的设备 ID 可能发生变化,以应对恶意攻击等对正常使用带来的影响。设备正常运行时设备 ID 不发生变化,再次激活后可能发生变化。 参见 查看设备信息
2 uuid Universally Unique Identifier 的缩写,是设备唯一的识别 ID。UUID 的长度是 20 位。从生产到销毁,UUID 都不会变,类似 MAC 或者 IMEI 等设备固有属性。 参见获取设备信息-行业获取设备信息-全屋
3 UID App 下的用户唯一 ID 参见 关联涂鸦 App 账号

常见参数
常见参数

指令集(状态集)参数

硬件厂商基于产品的 DP 来实现硬件功能,为此涂鸦 IoT PaaS 提供了一套标准指令集/状态集来屏蔽不同硬件产品的差异,简化设备控制的方式,帮助开发者快速的实现设备控制。在 API 中,code 标识唯一的标准指令或状态,value 则为对应功能的值。

序号 参数 说明 获取方法
1 code 标识设备唯一功能。
  • 指令集:一组涂鸦 IoT PaaS 提供的简化控制设备的指令。通常以产品品类(Category)维度进行区分,品类内不同产品 ID (PID)下的指令集为品类指令集的子集。
  • 状态集:用于描述设备功能状态的集合。以产品品类维度进行区分,品类内不同产品 ID (PID)下的状态集为品类状态集的子集。
    提示: 开发者可以根据实际下发、上报等场景来合理的使用指令集和状态集来实现自身业务。涂鸦智能为您创建了部分易于使用的标准指令集,详情参见 标准指令集
参见 获取设备支持指令集-全屋获取设备支持的指令集-行业
2 value 功能状态对应的取值。 标准指令集文档目录参见 标准指令集

常见参数
常见参数

FAQ

Q:设备相关的 category id、pid、device id 和 uuid 之间有怎样的关系?
A:设备中常用的参数关系可以通过我们比较熟悉的手机生产场景来解释。假设手机产品类目下,您需要生产 Xphone10、Xphone11 和 Xphone12 三个产品,则 category、pid、device_id 和 uuid 的关系类似下图所示。

常见参数

对应到涂鸦开发者平台上的产品, 以排插(category 为 pc)为例,各参数的关系如下图所示。

常见参数

  • category: 产品类目 ID,一个产品类目可以包含多个产品。例如,示例中排插的 category 值为 pc
  • product_id: 产品 ID。排插品类下可以根据支持的插口数量或者协议划等属性,划分为不同的产品。例如,本示例按照插口的数量划分了二路排插、三路排插和四路排插 3 种产品,它们具备不同的产品 ID。
  • device_id: 设备 ID。每种产品可以包含多个设备。设备的 device_id 可以通过云端的操作发生变化。
  • uuid: 设备唯一的识别 ID,和设备 ID 类似,但是 uuid 无法变更。