跳到主要内容

Aqara 物模型标签

本附录定义 Aqara Spec 物模型标签体系中的 Function、Trait、Command。这些定义作为业务语义层,其中 Function 和 Trait 与 Aqara 物模型的 Object / Property 形成映射,Command 与 Aqara物模型业务交互协议的 Service 形成映射。

Aqara Spec 定义了 Aqara 智能设备的物模型标签体系,用于描述设备"能做什么"。该标签体系中的 Function 和 Trait 与 Aqara 物模型的 Object / Property 形成映射,Command 与 Aqara物模型业务交互协议的 Service 形成映射:Aqara Spec 描述业务语义,物模型与交互协议分别描述数据结构和访问方式。

物模型架构​

Aqara Spec 物模型采用分层架构,从上到下依次为:Device -> Endpoint -> Device Type -> Function -> Trait / Command。

设备内存在两类特殊 Endpoint:Root Endpoint(Endpoint 0)和 Public Endpoint(通常为 Endpoint 1)。Root Endpoint 承载设备根信息;Public Endpoint 承载设备级通用 Function,供整个设备共享,不在各业务 Endpoint 上重复实现。

以下以一台多 Endpoint 人体存在传感器设备为例,展示 Root Endpoint、Public Endpoint 与多个业务 Endpoint 的实际结构:

Device: "<Device ID>"
├── Endpoint 0 (Root Endpoint)
│ └── Device Type: Root (ID: 0x0000)
│ └── Basic Information (Function ID: 0x0080)
│ ├── DebugInfo (Trait ID: 0x4E29)
│ ├── BLEVersion (Trait ID: 0x4EE9)
│ ├── MCUVersion (Trait ID: 0x4EEB)
│ ├── FirmwareRevision (Trait ID: 0x8080)
│ ├── SerialNumber (Trait ID: 0x8081)
│ ├── VendorName (Trait ID: 0x8082)
│ ├── VendorID (Trait ID: 0x8083)
│ ├── ProductName (Trait ID: 0x8084)
│ ├── Reachable (Trait ID: 0x8085)
│ ├── FirmwareRevisionString (Trait ID: 0x8117)
│ └── ProductID (Trait ID: 0x8118)
├── Endpoint 1 (Public Endpoint)
│ └── Device Type: Public (ID: 0x0001)
│ ├── Identify (Function ID: 0x0083)
│ │ ├── IdentifyTime (Trait ID: 0x8094)
│ │ ├── IdentifyType (Trait ID: 0x8095)
│ │ └── Identify (Command ID: 0x8096)
│ ├── Matter Commissioning (Function ID: 0x00AD)
│ │ ├── MatterFabricsOperationState (Trait ID: 0x4FA0)
│ │ ├── ConnectedMatterFabrics (Trait ID: 0x8123)
│ │ ├── MatterCommissioningWindowStatus (Trait ID: 0x8124)
│ │ ├── MatterNodeID (Trait ID: 0x8142)
│ │ ├── OpenMatterCommissioningWindow (Command ID: 0x88B9)
│ │ └── RemoveMatterFabric (Command ID: 0x88BC)
│ ├── General Diagnostics (Function ID: 0x00B0)
│ │ ├── UpTime (Trait ID: 0x4E23)
│ │ ├── NetworkInterfaces (Trait ID: 0x4E2A)
│ │ ├── ActiveHardwareFaults (Trait ID: 0x813D)
│ │ ├── RebootCount (Trait ID: 0x8148)
│ │ └── RebootReason (Trait ID: 0x8149)
│ ├── Matter Node Information (Function ID: 0x00B3)
│ │ └── MatterNodeFirstEndpointID (Trait ID: 0x8143)
│ └── Thread Network Diagnostics (Function ID: 0x00B5)
│ ├── OverrunCount (Trait ID: 0x4E2C)
│ ├── PartitionID (Trait ID: 0x4E2D)
│ ├── TxTotalCount (Trait ID: 0x4E2E)
│ ├── TxUnicastCount (Trait ID: 0x4E2F)
│ ├── TxBroadcastCount (Trait ID: 0x4E30)
│ ├── RxTotalCount (Trait ID: 0x4E31)
│ ├── RxUnicastCount (Trait ID: 0x4E32)
│ ├── RxBroadcastCount (Trait ID: 0x4E33)
│ ├── NetworkFaultChange (Trait ID: 0x4E34)
│ ├── Channel (Trait ID: 0x814A)
│ ├── PanID (Trait ID: 0x814B)
│ ├── ExtendedPanID (Trait ID: 0x814C)
│ ├── NetworkName (Trait ID: 0x814D)
│ ├── RouteTable (Trait ID: 0x814E)
│ ├── RoutingRole (Trait ID: 0x814F)
│ ├── NeighborTable (Trait ID: 0x8150)
│ └── MeshLocalPrefix (Trait ID: 0x8151)
├── Endpoint 2 (业务 Endpoint)
│ └── Device Type: Occupancy Sensor (ID: 0x0027)
│ ├── Occupancy Sensing (Function ID: 0x00A0)
│ │ ├── HoldTime (Trait ID: 0x4E72)
│ │ ├── Occupancy (Trait ID: 0x80E8)
│ │ └── OccupancySensorType (Trait ID: 0x80E9)
│ ├── General Configuration (Function ID: 0x00AF)
│ │ └── CurrentSensitivityLevel (Trait ID: 0x813B)
│ ├── Ambient Sensing Configuration (Function ID: 0x00E3)
│ │ ├── InstallMode (Trait ID: 0x4F13)
│ │ ├── SideInstall (Trait ID: 0x4F14)
│ │ ├── InstallHeightSetting (Trait ID: 0x4F15)
│ │ ├── InstallStatus (Trait ID: 0x4F16)
│ │ ├── InstallAngle (Trait ID: 0x4F17)
│ │ ├── MaxDetectionZones (Trait ID: 0x4F18)
│ │ ├── Zones (Trait ID: 0x4F19)
│ │ ├── EntryExitRegionBitmask (Trait ID: 0x4F1B)
│ │ ├── InterferenceRegionBitmask (Trait ID: 0x4F1C)
│ │ ├── EdgeRegionBitmask (Trait ID: 0x4F1D)
│ │ ├── EnableHumanCountDetection (Trait ID: 0x4F1F)
│ │ ├── EnableAIHighPrecisionRecognition (Trait ID: 0x4F23)
│ │ ├── EnableAIInterferenceSourceRecognition (Trait ID: 0x4F27)
│ │ ├── EnableAIAdaptiveSensitivity (Trait ID: 0x4F28)
│ │ ├── CoordinateReverseSetting (Trait ID: 0x4F29)
│ │ ├── DetectionDirectionSetting (Trait ID: 0x4F2A)
│ │ ├── AutoInterferenceSourceRecognition (Trait ID: 0x4F30)
│ │ ├── AutoEdgeRecognition (Trait ID: 0x4F31)
│ │ ├── AIEntryExitRegionRecognition (Trait ID: 0x4F32)
│ │ ├── ProximityDistanceLevel (Trait ID: 0x4F5A)
│ │ ├── InterferenceSourceRecognitionReportingTimeout (Trait ID: 0x4FA8)
│ │ ├── AISpaceBackgroundLearningReportingTimeout (Trait ID: 0x4FA9)
│ │ ├── AISpaceBackgroundLearningComplete (Trait ID: 0x4FAA)
│ │ ├── SubscribeAutoInterferenceSourceRecognitionData (Command ID: 0x9C78)
│ │ ├── SubscribeAutoEdgeRecognitionData (Command ID: 0x9C79)
│ │ ├── SubscribeAIEntryExitRegionRecognitionData (Command ID: 0x9C7A)
│ │ ├── EnableAISpaceBackgroundLearning (Command ID: 0x9C7B)
│ │ ├── CreateZone (Command ID: 0x9C7C)
│ │ ├── UpdateZone (Command ID: 0x9C7D)
│ │ ├── RemoveZone (Command ID: 0x9C7E)
│ │ └── SetZones (Command ID: 0x9D36)
│ ├── Radar Sensing Union (Function ID: 0x00E4)
│ │ ├── ChildEndpointList (Trait ID: 0x4F33)
│ │ ├── CurrentHumanCount (Trait ID: 0x4F35)
│ │ └── MotionState (Trait ID: 0x80EA)
│ └── Occupant Location (Function ID: 0x00E5)
│ ├── MaxDetectionTargets (Trait ID: 0x4F3E)
│ ├── LocationInfo (Trait ID: 0x4F46)
│ ├── SubscribeLocationData (Command ID: 0x9C7F)
│ └── SubscribeRemoveDetectionTarget (Command ID: 0x9C80)
├── Endpoint 3 (业务 Endpoint)
│ └── Device Type: Illuminance Sensor (ID: 0x001A)
│ └── Illuminance (Function ID: 0x009A)
│ └── CurrentIlluminance (Trait ID: 0x80DD)
├── Endpoint 4 (业务 Endpoint, 子区域)
│ └── Device Type: Occupancy Sensor (ID: 0x0027)
│ ├── Occupancy Sensing (Function ID: 0x00A0)
│ │ ├── HoldTime (Trait ID: 0x4E72)
│ │ ├── Occupancy (Trait ID: 0x80E8)
│ │ └── OccupancySensorType (Trait ID: 0x80E9)
│ ├── Radar Sensing Union (Function ID: 0x00E4)
│ │ ├── ZoneID (Trait ID: 0x4F34)
│ │ └── MotionState (Trait ID: 0x80EA)
│ └── Occupant Location (Function ID: 0x00E5)
│ └── LocationInfo (Trait ID: 0x4F46)
└── Endpoint 5 (业务 Endpoint, 子区域)
└── Device Type: Occupancy Sensor (ID: 0x0027)
├── Occupancy Sensing (Function ID: 0x00A0)
│ ├── HoldTime (Trait ID: 0x4E72)
│ ├── Occupancy (Trait ID: 0x80E8)
│ └── OccupancySensorType (Trait ID: 0x80E9)
├── Radar Sensing Union (Function ID: 0x00E4)
│ ├── ZoneID (Trait ID: 0x4F34)
│ └── MotionState (Trait ID: 0x80EA)
└── Occupant Location (Function ID: 0x00E5)
└── LocationInfo (Trait ID: 0x4F46)

核心概念​

Device(设备)​

Device 是一个物理智能设备,如网关、灯泡、门锁、传感器等。一个 Device 由一个或多个 Endpoint 组成。

Endpoint(端点)​

Endpoint 是设备中的一个逻辑功能节点。每个 Endpoint 拥有一个 Endpoint ID(Uint16,取值 0 ~ 65535),并关联一个或多个 Device Type。

Aqara Spec 定义了三类 Endpoint:

  • Root Endpoint(Endpoint 0):设备根节点,关联 Root Device Type,必须实现 Basic Information 和 Descriptor 功能。
  • Public Endpoint(通常为 Endpoint 1):设备公共端点,关联 Public Device Type,承载 Identify、诊断、OTA 及各类生态协同等设备级通用 Function,供整个设备共享。
  • 业务 Endpoint(Endpoint 2 及以上):承载具体业务功能,关联对应的业务 Device Type(如 Occupancy Sensor、Illuminance Sensor)。同一 Device Type 可出现在多个 Endpoint 上(如上例 Endpoint 4、5 为 Endpoint 2 的子区域)。前端可见的业务 Endpoint 必须实现 Label、Endpoint Icon 功能,否则无法前端展示。

Device Type(设备类型)​

Device Type 用于描述 Endpoint 的设备类型。每个 Device Type 由唯一的 Device Type ID(Uint16)标识。每个 Device Type 定义了该类型设备必须(M)或可选(O)实现的 Function 集合。一个 Endpoint 下不允许添加重复的 Function。

业务 Aqara 标准 Device Type ID 的新分配范围为 1 ~ 10000。Root Device Type ID 0 是特殊保留值,不属于业务 Device Type 的新分配范围。

除业务 Device Type 外,Aqara Spec 定义了两个与特殊 Endpoint 对应的 Device Type:

  • Root(ID: 0x0000):仅用于 Root Endpoint,必须实现 Basic Information 和 Descriptor。
  • Public(ID: 0x0001):仅用于 Public Endpoint,必须实现 Identify,可选实现诊断、网络配网、OTA 及各类生态协同等通用 Function。

例如上例中业务 Endpoint 2 关联 Occupancy Sensor(ID: 0x0027)Device Type,实现 Occupancy Sensing、Radar Sensing Union 等 Function;设备级通用能力(如 Identify、Matter Commissioning)由 Public Endpoint(Endpoint 1)统一提供,不在各业务 Endpoint 重复实现。

完整的 Device Type ID 编码及 Function 要求见 Device Type 定义。

Function(功能)​

Function 描述设备的一个完整功能单元,由若干 Traits 和 Commands 组成。每个 Function 由唯一的 Function ID(Uint16)标识。

Aqara 标准 Function ID 的新分配范围为 0 ~ 19999;供用户自定义的私有 Function ID 范围为 64001 ~ 65534。

Trait(特征)​

Trait 描述 Function 中的一个属性或状态,支持 Read、Write、Report 等操作。每个 Trait 由唯一的 Trait ID(Uint16)标识。

Aqara 标准 Trait ID 的新分配范围为 1 ~ 30000;供用户自定义的私有 Trait ID 范围为 60000 ~ 64000。

Command(命令)​

Command 描述 Function 中可执行的操作,由客户端向设备发送。每个 Command 由唯一的 Command ID(Uint16)标识。

Aqara 标准 Command ID 的新分配范围为 40001 ~ 50000;供用户自定义的私有 Command ID 范围为 64001 ~ 65534。

Parameter(参数)​

Parameter 是 Trait 内部的数据字段,由 Parameter ID(Uint16)标识。

ID 编号体系​

ID 分配范围总览

类别标准范围私有范围格式
Device Type ID1 ~ 10000(业务类型;0 为 Root 特殊保留值)64001 ~ 65534Uint16
Function ID0 ~ 1999964001 ~ 65534Uint16
Trait ID1 ~ 3000060000 ~ 64000Uint16
Command ID40001 ~ 5000064001 ~ 65534Uint16
Parameter ID0x0000 ~ 0xFFFF-Uint16

以上标准范围和私有范围用于约束新 ID 的分配,确保用户自定义 ID 不与 Aqara 标准 ID 范围冲突。范围之外的值不属于相应类别的标准或私有新分配范围。规则更新不改变已经定义或已投入使用的 ID:现有 ID 应原值保留,即使超出当前新分配范围,也无需仅为满足新范围而重新编号或做有效范围校验。除 Device Type 的 Root 特殊保留值 0 外,新分配的 Device Type ID 应使用上述业务标准范围或私有范围。

Trait 参数字段说明​

Parameter ID 采用 16 位整数标识,有效范围为 0x0001 ~ 0xFFFE(1 ~ 65534)。0x0000 与 0xFFFF 预留不可用。

Trait 标准 Parameter ID

Parameter IDNameBACnet Property默认读写权限说明
0x0001Present ValuePROP_PRESENT_VALUE按具体 Trait 定义当前值,表示 Trait 的实时状态。数据类型由 Trait 定义,可为整数、float、布尔、枚举、字符串或复合数据类型;数值型取值要求 Minimum Value &lt;= Present Value &lt;= Maximum Value,并满足步进及其他约束。
0x0002Maximum ValuePROP_MAX_PRES_VALUERVPresent Value 的最大允许/可表示值,数据类型与数值型 Present Value 一致,支持整数和 float,且不得小于 Minimum Value;描述数值范围,不是报警阈值。
0x0003Minimum ValuePROP_MIN_PRES_VALUERVPresent Value 的最小允许/可表示值,数据类型与数值型 Present Value 一致,支持整数和 float,且不得大于 Maximum Value;描述数值范围,不是报警阈值。
0x0004UnitPROP_UNITSRV工程单位,数据类型及有效单位编码由对应 Trait 的单位定义指定;数值及相关阈值应使用相容的单位。
0x0005Step ValuePROP_STEP_VALUERV数值步进值,数据类型与 Present Value 一致,支持整数和 float,取值须大于 0;用于描述有效数值的步进粒度。
0x0006Supported ValuePROP_SUPPORTED_VALUESRV支持的取值列表(Array/List),元素数据类型须与 Present Value 一致;各元素应满足该 Trait 的有效值约束。
0x0007Default ValuePROP_RELINQUISH_DEFAULTRV默认值(Relinquish 默认值),默认可读、可上报,不可写(Access 为 RV)。数据类型与 Present Value 一致,支持整数、float 及该 Trait 定义的其他数据类型;须满足 Present Value 的范围、步进、支持值列表及其他适用约束,具体采用时机由 Trait 定义。
0x0008High LimitPROP_HIGH_LIMITRVW高限监控阈值,数据类型与数值型 Present Value 一致,支持整数和 float;要求 Minimum Value &lt;= High Limit &lt;= Maximum Value,且 High Limit &gt; Low Limit。不定义 Present Value 的量程。
0x0009Low LimitPROP_LOW_LIMITRVW低限监控阈值,数据类型与数值型 Present Value 一致,支持整数和 float;要求 Minimum Value &lt;= Low Limit &lt;= Maximum Value,且 Low Limit &lt; High Limit。不定义 Present Value 的量程。
0x000ACOV IncrementPROP_COV_INCREMENTRVW变化量上报阈值,适用于 Present Value 为 float 的 Trait,数据类型为 float,取值须大于 0,单位与 Present Value 一致;当前值与最近一次触发 COV 通知的基准值之差的绝对值达到或超过该阈值时触发通知,用于抑制微小波动产生的频繁上报。
0x000BMaximum Actual ValuePROP_MAX_ACTUAL_VALUERVWPresent Value 对应的实际量上端标定值,可读、可写、可上报(Access 为 RVW),数据类型为 float,不支持整数数据类型;要求 Minimum Value &lt;= Maximum Actual Value &lt;= Maximum Value,且 Maximum Actual Value &gt; Minimum Actual Value,映射关系由 Trait 定义。
0x000CMinimum Actual ValuePROP_MIN_ACTUAL_VALUERVWPresent Value 对应的实际量下端标定值,可读、可写、可上报(Access 为 RVW),数据类型为 float,不支持整数数据类型;要求 Minimum Value &lt;= Minimum Actual Value &lt;= Maximum Value,且 Minimum Actual Value &lt; Maximum Actual Value,映射关系由 Trait 定义。
0x000DIs NullPROP_IS_NULLRV布尔型,取值为 true/false;true 表示 Present Value 当前无有效数据或未初始化,不应将其当前载荷作为有效业务值使用。
0x000EExtended Supported ValuesPROP_EXTENDED_SUPPORTED_VALUESRV扩展支持值列表(List[Struct]);结构体字段、元素约束及列表长度由对应 Trait 定义。
0x000FMax Item Num-RVPresent Value 为 Array/List 时允许的最大元素个数,数据类型为 uint32,取值范围为 0 ~ 4294967295;列表元素个数不得超过该值。
0x0010Counter Generation-RVTrait 的可选只读、可上报 Parameter,数据类型为 uint32,取值范围为 0 ~ 4294967295,用于标识累计计数器代际;当实现无法保证逻辑累计值连续且要求精确计算差值时必须提供。

表中默认读写权限使用完整的 Access 标记:RV 表示可读、可上报,RVW 表示可读、可写、可上报。所有支持可读的 Parameter 均支持可上报,因此默认权限不使用单独的 R 或 RW 标记。具体 Trait 参数表中仅标记 R 或 RW 的 Parameter 也适用此上报支持规则;可上报表示具备上报能力,不表示每次读取或数值不变时均须发送通知,具体上报时机遵循对应 Trait 和交互协议定义。

Present Value 不设默认读写权限,按具体 Trait 参数表的 Access 定义执行;当其支持可读时,同样支持可上报。具体 Trait 已明确的数据类型、读写权限和约束优先于通用默认约定;本表不自动扩展已有 Trait 的写权限,也不要求所有 Trait 实现全部 Parameter。

前端默认依据本表的权限说明,确定 Parameter 的读取、写入及上报能力。若设备某个 Parameter 的实际权限与本表的默认权限不同,设备端 SHALL 上报该差异,或在前端可获取的预配置数据表中明确记录该差异。差异信息 SHALL 能够定位到适用的设备及其 Function、Trait、Parameter,并明确该 Parameter 的实际 Access 权限,使前端能够识别并应用。

前端 SHALL 优先采用适用于目标设备及目标 Parameter 的明确差异信息;未提供适用差异信息时,采用本表的默认权限。Present Value 仍按具体 Trait 的实际定义确定权限,不从本表推导默认权限。上述权限信息用于前端的能力展示与交互控制,不替代设备端对实际访问权限的校验。

表中的范围约束使用 Minimum Value <= 参数值 <= Maximum Value 表示,包含两个边界值;未显式提供边界参数时,遵循对应 Trait 声明的有效范围及数据类型边界。只有同时实现一对上下限参数时才进行两者的大小关系校验。对可写参数,写入后的值及参数组合仍须满足适用约束,不得通过写入使上下限关系失效。

数值边界参数​

Minimum Value 与 Maximum Value​

Minimum Value(PROP_MIN_PRES_VALUE)和 Maximum Value(PROP_MAX_PRES_VALUE)描述 Present Value 的数值范围下界和上界。读取这两个参数,可以了解该 Trait 声明的有效数值范围;客户端在写入 Present Value 时,应将目标值限制在该范围内,并同时遵守 Trait 自身定义的数据类型、步进值、枚举取值及其他约束。设备也应依据自己的 Trait 定义处理范围外的输入,不能把这两个边界当作报警阈值使用。

例如,若温度 Trait 的 Minimum Value 为 -50、Maximum Value 为 100,且 Unit 为摄氏度,则它声明的数值范围为 -50°C 至 100°C。客户端可用该范围校验用户输入或展示可调范围。若数值是只读传感器值,这些边界说明该 Trait 的范围,并不意味着客户端可以写入该值。

这两个参数描述的是协议中 Present Value 的数值范围,不一定等同于传感器的物理测量能力、设备的报警范围或控制器的安全范围。它们是否存在、是否可读及其具体约束,以对应 Trait 参数表为准;不要假定每个 Trait 都同时定义这两个参数。

步进值与默认值​

Step Value 与数值型 Present Value 使用相同的数据类型,既支持整数步进(如 1),也支持 float 步进(如 0.1)。步进值须大于 0;当 Trait 使用 Minimum Value 作为步进起点时,有效值按 Minimum Value + n × Step Value 确定,其中 n 为非负整数,且结果不得超过 Maximum Value。浮点运算的比较应考虑该数据类型的表示精度,不能依赖浮点余数恰好为零来判断步进合法性。

Default Value 与 Present Value 使用相同的数据类型,并遵守相同的有效值约束。它的数据类型不限定为整数,也不表示读取不到当前值时可以静默返回该值。默认值是在恢复默认设置、释放控制或其他何种情况下被采用,应由对应 Trait 定义。

COV 增量参数​

COV Increment 参考 BACnet COV_Increment 的变化量通知语义,用于 float 型 Present Value 的变化上报过滤。设最近一次触发通知时的基准值为 Vref,当前有效值为 V,当 abs(V - Vref) >= COV Increment 时,满足当前值变化的 COV 通知条件;触发通知后,将基准更新为本次通知的值。比较基准不是上一次采样值,因此多次小幅变化的累计偏移仍可能触发通知。

例如,COV Increment = 0.5、基准值为 20.0 时,当前值为 20.2 不触发变化量通知,继续变化至 20.5 或 19.5 时满足通知条件。该参数不是采样周期、周期上报间隔或报警死区,也不改变 Present Value 的读取精度和数值范围。

本规范要求 COV Increment 为大于 0 的有限浮点数。首次订阅的初始通知、订阅有效期、其他状态变化及周期通知,仍按相应交互协议和 Trait 定义处理,不应被该变化量阈值阻止。仅定义本参数不代表已建立订阅或必然发送通知;本节仅借鉴 BACnet 的增量语义,不直接引入其全部订阅机制。

监控阈值参数​

Low Limit 与 High Limit​

Low Limit(PROP_LOW_LIMIT)和 High Limit(PROP_HIGH_LIMIT)分别表示低侧和高侧的监控阈值,适用于对象定义了相应监控或报警语义的场景。它们回答的是"运行值到什么程度应视为低侧或高侧异常",而不是"该 Trait 能表示到什么数值"。阈值通常可按现场运行要求配置,但实际能否配置取决于该参数的访问权限及对应 Trait 定义。

例如,冷却水温度监控可以将 Low Limit 配为 5°C、High Limit 配为 35°C:当前值低于低限时可判定为低侧越限,高于高限时可判定为高侧越限。边界比较的具体规则(例如恰好等于阈值时是否算越限),应由对应对象或报警机制定义。

仅定义或读取 Low Limit、High Limit 并不自动意味着设备会产生报警、事件或主动上报。要实现完整的告警行为,对象还需要支持相关机制,并按其定义处理使能条件、持续时间/延时、死区、事件状态和通知方式等因素。客户端不应只根据阈值参数存在,就推断报警已启用或告警通知一定会发送。阈值应与被监控 Present Value 使用相同的数据类型和相容的单位,取值须满足 Minimum Value <= Low Limit < High Limit <= Maximum Value。阈值可以位于业务正常运行区间之外,但不得超出声明的数值范围,也不能用来替代 Minimum Value 或 Maximum Value。

实际量标定参数​

Minimum Actual Value 与 Maximum Actual Value​

Minimum Actual Value(PROP_MIN_ACTUAL_VALUE)和 Maximum Actual Value(PROP_MAX_ACTUAL_VALUE)描述 Present Value 范围两端所对应的实际量端点,可用于解释或换算设备数值与实际物理量之间的关系。它们与 Unit 一起帮助客户端理解实际量的含义;例如实际量的单位可能是流明、伏特或其他工程单位。具体表示的实际量、端点所对应的 Present Value、是否线性以及是否用于输出映射,必须由对应 Trait 或对象定义明确,不能只凭参数名称推断。

例如,某调光对象的 Present Value 表示调光控制区间 0% 至 100%,而设备实际可达到的亮度范围是额定亮度的 20% 至 80%;对象定义这两个区间端点之间为线性映射。此时 Minimum Actual Value 为 20% 亮度,Maximum Actual Value 为 80% 亮度:控制值 0% 对应实际亮度 20%,控制值 100% 对应实际亮度 80%,控制值 50% 对应 20% + (80% - 20%) × 50% = 50% 亮度。这里两个 Actual Value 的百分比是相对于额定亮度的实际输出,而控制值百分比是 Present Value 在控制区间中的位置;它们含义不同。对于一般的线性端点映射,可按对象定义的 Present Value 两端点进行比例插值;如果对象规定非线性映射,或 Present Value 并非百分比,则应遵循该对象的映射规则,不能直接套用此例。

这组参数用于说明数值端点与实际量之间的对应关系,不是 Present Value 的协议允许范围(由 Minimum Value / Maximum Value 描述),也不是运行报警阈值(由 Low Limit / High Limit 描述)。例如,调光灯具的 Present Value 控制范围可以是 0% 至 100%,而对应的实际亮度范围是额定亮度的 20% 至 80%。

两个 Actual Value 参数的数据类型均为 float,不支持整数数据类型,不要求与 Present Value 的数据类型一致;取值须满足 Minimum Value <= Minimum Actual Value < Maximum Actual Value <= Maximum Value。实际量的单位及映射仍须由对应 Trait 明确,并保证端点值可在声明的范围内表示。

三组参数的使用区分​

  • Minimum Value / Maximum Value:校验或理解 Present Value 在协议层面的数值边界--"这个值允许/可表示到哪里?"
  • Low Limit / High Limit:判断运行值是否达到监控阈值--"运行到什么程度算低侧/高侧越限?"
  • Minimum Actual Value / Maximum Actual Value:在对象定义支持的前提下,说明 Present Value 与实际物理量端点的对应关系--"这个数值端点对应多少实际量?"

三组参数不能互相替代,也不保证在同一个 Trait 中全部出现。实现和客户端应先查看具体 Trait 的参数表、数据类型、单位、访问权限和约束,再按该 Trait 定义解释和使用;只有对象明确约定线性映射时,才可使用线性插值换算实际量。

权限标记​

权限类型

标记说明
Read客户端可读取该参数
Write客户端可写入该参数
Report设备变化时主动上报该参数
Configured设备在配置阶段上报

必选标记​

  • M (Mandatory):设备必须实现
  • O (Optional):设备可选实现

Function 列表总览​

以下汇总本附录涵盖的所有 Function 定义。各 Function 的 Trait、Command 及数据类型详见对应章节。

Function 索引​

本节汇总 Aqara Spec 全部 Function 定义。各 Function 的 Trait、Command 及数据类型详见对应章节。

Function IDCode描述
0x0001Binding表示端点与一个或多个其他本地或远程 Endpoint 之间的持久绑定关系。
0x0009CO提供一氧化碳浓度监测与报警相关能力,用于检测环境中的一氧化碳泄漏并及时告警。
0x000AWaterFreezeDetector用于检测管道或环境中是否存在结冰风险,并在达到阈值时上报水冻结相关事件。
0x000BRainSensor用于检测降雨状态,上报是否正在下雨及雨量相关信息。
0x000COnOffSensor用于检测二元开关量输入状态,上报开/关或触发/未触发等离散状态。
0x0080BasicInformation提供设备基本信息,包括厂商、产品型号、固件版本、序列号、在线状态等基础属性。
0x0081Descriptor描述设备端点组成与能力结构,包括端点列表、设备类型、Server/Client 集群等信息。
0x0082EndpointLabel管理端点的可见性与展示信息,如名称、房间、图标、标签等,用于前端展示与组织。
0x0083Identify提供设备识别能力,可通过指示灯闪烁、声音等方式帮助用户定位物理设备。
0x0084Output提供开关输出控制能力,支持读取和控制负载的通断状态。
0x0085LevelControl提供亮度或等级调节能力,支持设置、读取当前亮度/等级及渐变控制。
0x0086ColorControl提供颜色控制能力,包括色温、HSV、XY 色彩空间等方式调节灯光颜色。
0x0087Button描述按钮类输入设备的事件上报,包括单击、长按、多击等动作识别。
0x0088Camera管理摄像机基础能力,包括设备状态、模式切换、图像加密及云端相关能力。
0x0089WindowCovering提供窗帘/百叶窗等遮阳设备的升降、倾斜、位置控制及状态反馈。
0x008ALifter提供升降类设备的行程控制,支持设定目标位置、停止及状态查询。
0x008BIRControl提供红外发射控制能力,用于控制空调、电视等传统红外家电。
0x008CEnergyManagement管理设备电量与能耗信息,包括电量百分比、功耗统计及低电告警等。
0x008DHeaterCooler提供制冷/制热控制能力,包括目标温度、运行模式、风速等暖通参数。
0x008EFanControl提供风扇转速与模式控制,支持档位调节及运行状态读取。
0x008FTemperature测量并上报环境温度,提供当前温度值及有效量程等属性。
0x0090RelativeHumidity测量并上报环境相对湿度,提供当前湿度值及有效量程等属性。
0x0091MediaPlayback提供媒体播放控制能力,包括播放、暂停、切歌、音量及播放状态管理。
0x0092Speaker描述设备扬声器输出能力,包括文本转语音播报、音量控制及静音等音频输出功能。
0x0093PowerSource描述设备供电来源与电池状态,包括电量、充电状态、电池类型等信息。
0x0094DoorLock提供智能门锁核心能力,包括锁状态、用户/凭证管理、开锁/上锁及告警事件。
0x0095Sweeper提供扫地机器人基础控制,包括启动清扫、暂停、回充等操作与状态反馈。
0x0096AirQuality监测并上报空气质量指标,如 AQI 或综合空气质量等级。
0x0097Pressure测量并上报大气压力或系统压力值。
0x0098ParticulateMatter监测并上报颗粒物浓度(如 PM2.5、PM10)。
0x0099CO2测量并上报环境中二氧化碳浓度。
0x009AIlluminance测量并上报环境光照度(lux)。
0x009BContact检测接触/门磁类二元状态,上报打开或关闭状态及可选角度信息。
0x009CSmoke检测烟雾并上报报警事件,支持灵敏度、自检及静音等相关配置。
0x009DGas检测可燃气体或有害气体泄漏并上报告警事件。
0x009ESleep监测睡眠相关状态,上报睡眠阶段、时长或质量等指标。
0x009FWaterLeak检测水浸事件,在检测到漏水时及时上报告警。
0x00A0OccupancySensing检测空间内是否有人存在,上报占用/空闲状态及保持时间等参数。
0x00A1Location提供设备或目标的位置信息上报与查询能力。
0x00A2Knob描述旋钮类输入设备的旋转角度、按压及组合动作事件。
0x00A3Cube描述魔方控制器的手势识别,包括翻转、旋转、摇一摇等动作及面识别。
0x00A4Vibration检测振动或动静变化,上报移动、倾斜、跌落等事件。
0x00A5Modes提供设备多模式管理能力,支持切换和读取当前运行模式。
0x00A6PetFeeder提供宠物喂食控制能力,包括出粮份数、喂食计划及余量状态。
0x00A7BridgeConfiguration管理网关桥接配置,描述子设备接入、桥接能力及网络拓扑相关信息。
0x00A8AttitudeDetection检测设备姿态或倾斜角度变化,上报姿态异常或角度信息。
0x00A9Group管理设备分组配置,维护组内节点列表及组级控制能力。
0x00AADoorbell提供门铃相关能力,包括呼叫事件上报及与室内铃铛/中继的联动。
0x00ABNetworkCommissioning提供网络配网能力,支持 Wi-Fi、Thread 等网络的扫描、连接与配置。
0x00ACEcosystemInformation描述设备所接入的生态平台信息,如 HomeKit、Matter Fabric 等绑定状态。
0x00ADMatterCommissioning提供 Matter 入网与 Fabric 管理能力,包括配网窗口、Fabric 列表及节点标识。
0x00AEIndicationLight管理设备指示灯行为,包括状态指示、亮度、颜色及闪烁模式等。
0x00AFGeneralConfiguration提供通用设备配置项,如灵敏度、延时、默认参数等设备级设置。
0x00B0GeneralDiagnostics提供通用诊断信息,包括运行时间、重启次数、网络接口及硬件故障等。
0x00B1PanTilt提供云台(Pan/Tilt/Zoom)控制能力,包括预置位、校准及相对/绝对移动。
0x00B2BridgedConfiguration描述被桥接子设备的配置信息,用于 Matter/Zigbee 桥接场景。
0x00B3MatterNodeInformation提供 Matter 节点相关信息,如首个 Endpoint ID 及节点拓扑辅助信息。
0x00B5ThreadNetworkDiagnostics提供 Thread 网络诊断指标,包括信道、PAN ID、邻居表、路由角色及收发统计。
0x00B6GarageDoorOpener提供车库门控制与状态反馈,包括开/关/停止及位置状态。
0x00B7MatterBridgeCommissioning管理 Matter Bridge 向第三方 Matter 生态分享桥接设备的能力。
0x00B8MARSConfiguration提供智能负载(MARS)相关配置,用于负载识别与智能配电管理。
0x00B9CustomizedConfiguration提供厂商或用户自定义扩展配置项的读写能力。
0x00BAFreshAirControl提供新风系统控制能力,支持引入室外空气并进行风量、模式等调节。
0x00BBScreenDisplay管理屏幕显示相关硬件属性,如分辨率、亮度、背光及显示状态。
0x00BCValveControl提供阀门自动控制或手动控制能力,用于精确调节水/气流量。
0x00BDFilterMonitoring持续监测各类滤芯(如 HEPA、活性炭)的使用状态与剩余寿命。
0x00BEOperationalState描述设备当前运行状态,如空闲、运行中、暂停、故障等。
0x00BFFlow测量并上报液体或气体的流量速率。
0x00C0Mode提供设备特性模式接口,支持在多种预定义模式间切换。
0x00C1VacuumOperationalState描述扫地机器人当前运行状态,如清扫中、回充中、充电中等。
0x00C2RefrigeratorState描述冰箱运行状态,包括空闲、制冷、除霜、故障等。
0x00C3EVSE提供电动汽车供电设备(EVSE)控制能力,包括充电启停、电流限制及充电状态。
0x00C4VacuumRunMode控制扫地机器人运行模式,如自动、沿边、定点等。
0x00C5VacuumCleanMode控制扫地机器人清洁模式,如标准、强力、静音等。
0x00C6TemperatureControl提供温度设定与调节能力,用于恒温设备的目标温度控制。
0x00C7MediaInput描述媒体输入源管理与切换,支持选择当前播放源及输入列表。
0x00C8HEPAFilterMonitoring监测 HEPA 滤芯使用情况、剩余寿命及更换提醒。
0x00C9ActivatedCarbonFilterMonitoring监测活性炭滤芯使用情况、剩余寿命及更换提醒。
0x00CAThreadBorderRouter管理 Thread 边界路由器及其所承载 Thread 网络的运行与配置。
0x00CBThemePack管理设备主题包资源,包括主题下载、切换及版本信息。
0x00CCWiFiNetworkDiagnostics提供 Wi-Fi 网络标准化诊断指标,辅助排查连接质量与链路状态。
0x00CDZigbeeNetworkDiagnostics提供 Zigbee 网络诊断能力,包括信道、PAN、邻居及路由等信息。
0x0125ZigbeeSubscribe提供 Zigbee 订阅能力,用于记录可订阅的设备资源、能力范围及订阅记录管理。
0x00CEAnalogInputObject以只读方式采集连续变化的模拟量输入(如电压、温度模拟信号)。
0x00CFAnalogOutputObject提供可写的连续模拟量输出控制信号。
0x00D0BinaryInputObject采集二元状态输入,如门磁、开关等 true/false 或 active/inactive 量。
0x00D1BinaryOutputObject驱动二元执行器输出,如继电器、接触器、电磁阀或警号。
0x00D2MultiStateInputObject采集多状态离散输入,表示 N 种状态之一。
0x00D3MultiStateOutputObject输出多状态离散控制命令,如 HVAC 模式或灯光场景切换。
0x00D4CharacterStringValueObject定义以字符串形式表示的数据对象及其外部可见特性。
0x00D5ScreenUserInterface管理屏端用户界面配置,包括页面布局、卡片、主题及展示数据。
0x00D6DeviceAnomalyMonitoring持续监测设备温度、负载、电流与电压等关键安全指标,在过温、过载、过流或欠压等异常发生时上报告警并支撑保护策略。
0x00D7OTA管理设备固件升级流程,包括下载、安装调度及升级进度与结果上报。
0x00D8HumanRecognition利用视觉等算法实时检测画面中的人形目标,区分人体与其他物体并上报事件。
0x00D9SoundDetection通过麦克风采集环境声音,识别特定声音类型(如玻璃破碎、婴儿哭声)并告警。
0x00DAPetRecognition识别画面中的猫、狗等宠物个体,上报宠物出现或相关识别事件。
0x00DBFaceRecognition采集人脸特征并与本地库比对,上报人脸识别结果及匹配信息。
0x00DCGestureRecognition实时分析手势动作,将预定义手势转换为控制指令。
0x00DDVehicleDetection检测监控区域内的车辆出现,上报车辆存在事件供安防或自动化使用。
0x00DEFlameDetection通过图像或传感器算法检测可见火焰,即时上报火情事件以便早期预警。
0x00DFPackageRecognition自动识别画面中的包裹,在投递或取走时可发送提醒并记录事件。
0x00E0HumanPresence检测空间内人体存在,支持人数统计、轨迹及身份关联等高级感知能力。
0x00E1HeartMonitoring利用传感器持续或周期性测量用户心率,记录并分析心脏健康相关数据。
0x00E2BreathingMonitoring利用传感器持续或周期性测量用户呼吸频率与模式,支持健康监测。
0x00E3AmbientSensingConfiguration提供环境传感配置能力,包括区域管理、安装模式、检测开关及 AI 区域识别等。
0x00E4RadarSensingUnion聚合雷达传感能力,包括子端点列表、人数统计及运动状态等联合数据。
0x00E5OccupantLocation提供存在目标的位置、活动状态及姿态信息,支持位置数据订阅与目标管理。
0x00E6MatterCoordination集中管理 Matter 协议相关协同操作,包括入网、绑定、数据同步及证书管理。
0x00E7OTACoordination管理 OTA 固件升级协同流程,包括任务下发、进度上报、结果反馈及版本查询。
0x00E8StudioCoordination管理网关与 Aqara Studio 开发环境的集成,包括账号认证、项目备份与设备同步。
0x00E9CameraCoordination处理摄像机复杂业务逻辑,包括 WebRTC 通话、云台控制、识别数据同步及扩展事件。
0x00EASecurityGuardCoordination管理家庭空间安防警戒能力,包括警戒启停、告警确认及本地/云端配置同步。
0x00EBSceneCoordination管理智能场景(自动化规则)生命周期,包括同步、删除、触发执行及一致性校验。
0x00ECHubCoordination作为网关核心协同模块,管理子设备入网、配置、心跳、令牌及各类代理服务。
0x00EDLightBoxCoordination管理智能灯箱设备的配置下发,控制展示内容与效果。
0x00EEIRCoordination管理网关红外学习与发射,包括码库同步、虚拟遥控器创建及按键控制。
0x00EFCommLinkCoordination监测网关与云端通信链路质量,执行耗时探测并上报结果。
0x00F0RingtoneCoordination管理网关本地铃声/音乐文件,包括下载、删除及与云端库的一致性校验。
0x00F1ScreenCoordination管理智能场景面板交互,包括配置下发、状态查询及云端/面板双向透传。
0x00F2ConfigurationCoordination通过组播或批量方式管理通用功能配置、资源订阅及位置信息同步。
0x00F3LockCoordination处理智能门锁扩展业务,包括专用透传通道、加解密协助及扩展事件上报。
0x00F4WakeupCoordination为支持远程唤醒的低功耗设备获取唤醒服务地址或令牌。
0x00F5CloudStorageCoordination管理云录像/云存业务资源配置,获取存储配额及上传凭证等信息。
0x00F6CentralHubCoordination管理中枢网关高级能力,包括中枢启用、Broker 信息及数据透传通道。
0x00F7IftttCoordination作为自动化规则协同中心,管理 IFTTT/本地自动化规则的同步、订阅与执行。
0x00F8NetworkManagement作为设备网络连接与访问策略的核心控制模块,管理远程代理及访问地址。
0x00F9ToiletCore集成智能马桶最基础的物理状态感知与部件控制,包括着座、翻盖、冲水、座圈加热及夜灯。
0x00FAToiletDiagnostic监测智能马桶关键硬件子系统健康状态,主动上报温度、流量、风机等故障信息。
0x00FBToiletHygiene维护设备自身清洁卫生,包括喷嘴清洁、泡沫盾、等离子杀菌及管路清洗。
0x00FCToiletWashDry定义智能马桶清洗与烘干全流程,涵盖水洗模式、水温/水压、烘干风速及时长设置。
0x00FDToiletSettings允许用户个性化默认参数与自动化场景,如自动翻盖、自动冲水、泡沫盾及久坐提醒等。
0x00FELighting提供 Aqara 调光与场景控制能力,包括内置/自定义场景、音乐律动及灯带分段控制。
0x00FFScreenUIConfig提供屏端统一 UI 配置,包括页面布局、主题、卡片数量及多页面信息管理。
0x0100Ringtone提供铃声与音乐播放控制,支持选曲、音量/时长调节及播放状态监测。
0x0101FenceDetection在摄像机画面中定义虚拟围栏区域,检测人员进入或离开并支持录像、推送等联动策略。
0x0102Security管理设备安全策略与访问权限,包括用户密码、丢失模式及相关验证机制。
0x0103Storage管理本地 SD 卡录像、格式化、录像模式及存储状态监测与维护。
0x0104ImageMediaManagement管理画布布局与图像资源,支持图像下载、存储、删除、状态上报及 ID 列表维护。
0x0105VoiceAssistant管理设备语音交互能力,包括唤醒词、语音控制开关、语音音色、连续对话、语音控制语言、近场唤醒及空间区域配置。
TBDVoiceIntercom管理设备语音对讲相关能力,包括可用于对讲的在线设备列表。
0x0106SpaceSecurity管理设备在特定空间内的安防能力,包括报警铃声、音量、布撤防状态及告警时长。
0x0107Massage管理电动床舒适与姿态调节,包括背/腿升降、按摩模式/强度/定时及童锁与急停。
0x0108TowelRackDry管理毛巾架烘干流程,控制目标温度、烘干时长,并反馈剩余时间与故障状态。
0x0109Live控制实时视频流,支持延时摄影、变焦、休眠/唤醒及关联事件录像等增强能力。
0x010APlayback管理录像回放与历史记录,包括云端小视频类型识别及本地录像下载能力。
0x010BCloudRecording控制云端录像总开关,决定是否将视频内容上传至云存储。
0x010CCameraSettings提供摄像机扩展配置,如定时上传图片、RTSP 流媒体及高级功能开关。
0x010DAIDetection执行 AI 驱动的图像与音频分析,实现事件检测、内容识别及智能告警。
0x010EVideoSettings管理图像处理与画面呈现,包括画质、水印、隐私遮挡、夜视及补光灯联动。
0x010FCameraWorkMode定义摄像机功耗策略与工作模式,适配不同电源类型与使用场景。
0x0110AudioSettings控制音频采集与输出,调节录制静音及系统提示音量等参数。
0x0111CameraPrivacySecurity聚焦摄像机隐私策略,包括定时休眠等低功耗安防隐私保护能力。
0x0112CameraNotifications管理事件通知策略,支持通知类型、计划时段、过滤规则及重要等级设置。
0x0113NASStorage与网络附加存储(NAS)集成,提供绑定、策略配置、传输间隔及状态管理。
0x0114Repeater管理 Wi-Fi 中继能力,包括保活、中继链路信息、网络诊断及与网关的连接状态。
0x0115TamperProtection提供物理安全防护,检测并响应非法拆卸、强拆等篡改行为,支持告警与录像联动。
0x0116SmileDetection识别画面中的笑脸并上报事件,支持对笑脸识别能力进行启停控制。
0x0128SO2表示对空气中二氧化硫的监测功能域,包括但不限于 SO2 浓度测量、是否检测到 SO2、超标报警、传感器状态等能力。
0x0129NO2表示对空气中二氧化氮的监测功能域,包括但不限于 NO2 浓度测量、是否检测到 NO2、超标报警、传感器状态等能力。
0x012AO3表示对空气中臭氧的监测功能域,包括但不限于 O3 浓度测量、是否检测到 O3、超标报警、传感器状态等能力。
0x012BFormaldehyde表示对空气中甲醛的监测功能域,包括但不限于 HCHO 浓度测量、是否检测到甲醛、超标报警、传感器状态等能力。
0x012CO2表示对环境中氧气的监测功能域,包括但不限于 O2 浓度测量、缺氧/富氧判定、传感器状态等能力。
0x012DChlorine表示对空气中氯气的监测功能域,包括但不限于 Cl2 浓度测量、是否检测到氯气、超标报警、传感器状态等能力。
0x012EHydrochloricAcid表示对空气中盐酸气体的监测功能域,包括但不限于 HCl 浓度测量、是否检测到盐酸气体、超标报警、传感器状态等能力。
0x012FHydrogenSulfide表示对空气中硫化氢的监测功能域,包括但不限于 H2S 浓度测量、是否检测到硫化氢、超标报警、传感器状态等能力。
0x0130Ammonia表示对空气中氨气的监测功能域,包括但不限于 NH3 浓度测量、是否检测到氨气、超标报警、传感器状态等能力。
0x0131WaterQuality表示对水质的监测功能域,涵盖但不限于水的硬度、浊度、pH、TDS、余氯、溶解氧等参数的测量与状态判定。
0x0132NitrogenOxides表示对空气中氮氧化物的监测功能域,包括但不限于 NOx 浓度测量、是否检测到氮氧化物、超标报警、传感器状态等能力。
0x0133LiquidLevel表示对容器或管路内液体液位的监测功能域,包括但不限于液位高度测量、储液量判断、补排液需求分析、高低液位风险预警等能力。
0x0134Noise表示对环境噪声的监测功能域,包括但不限于噪声级测量、噪声是否超标判定、峰值噪声、平均噪声等能力。
0x0135HeatMeter表示对供热/供冷系统中冷热量计量功能的综合管理,涵盖瞬时热流量、瞬时冷流量、热量累计值、冷量累计值及其小数部分等参数的测量与上报。
0x0136Boiler表示对锅炉设备运行状态的监测与控制功能域,涵盖排烟温度、火力调节、负荷输出、燃烧计时、点火次数等参数的测量、设定与上报。
0x0137ControlCabinet表示对控制柜设备的监测与控制功能域,涵盖频率反馈、冷却水温度实际值与设定值、温差设置、手动频率给定等参数的测量、设定与上报。
0x0138Compressor表示对压缩机设备运行状态的监测与控制功能域,涵盖温度、压力、电流、电压、功率、湿度、转速、开度、运行时间、制冷量等参数的测量、设定与上报。
0x0139CoolingPump表示对冷却泵设备的监测与控制功能域,涵盖频率反馈、手动频率给定、频率上下限、运行时间等参数的测量、设定与上报。
0x013ABuzzer表示设备蜂鸣器的控制功能域,用于播放或停止蜂鸣器声音,支持设置播放音量和播放时长,适用于门铃提示、报警提醒、操作反馈等场景。
0x013BGasMetering提供燃气计量相关能力,包括燃气热值及工况体积到标准体积的换算系数,用于燃气用量的能量折算和标准化换算。
0x013CEnergyStorage管理储能电池的 SOC、额定/可用容量、以电池侧为边界的累计充放电量和充放电功率,以及电池健康状态。
0x013DElectricityMetering提供电能表和并网点计量能力,包括功率方向、需量及按费率寄存器分别累计的进口/出口电量。
0x013EPowerGeneration描述发电设备的额定功率和运行状态,以及燃气热电联产相关的能量、功率和热回收数据。

Device Type 定义​

Device Type 用于描述 Endpoint 的设备类型,一个 Device 可以由一个或多个 Endpoint 组成。每一个 Endpoint 可以由一个或者多个 Device Type 来组成。一个 Endpoint 下,不允许添加重复的 Function。

每个 Device Type 由唯一的 Device Type ID(Uint16)标识。下表按品类分组列出各 Device Type 的 ID 编码及其必须(M)或可选(O)实现的 Function 集合。

特殊类型:Root、Public。二者分别对应 Root Endpoint 和 Public Endpoint。

  • Root(ID: 0x0000):用于 Root Endpoint(Endpoint 0),必须实现 Basic Information 和 Descriptor 功能。
  • Public(ID: 0x0001):用于 Public Endpoint(通常为 Endpoint 1),承载设备级通用 Function,包含 Identify 及各类可选协同/诊断功能。

Device Type 列表​

系统类型​

系统类型

IDDevice TypeRequired Functions必选备注
0x0000Root(根节点)BasicInformationM
0x0000Root(根节点)DescriptorM
0x0000Root(根节点)EndpointLabelO
0x0001Public(公共节点)IdentifyM
0x0001Public(公共节点)WindowCoveringO
0x0001Public(公共节点)EnergyManagementO
0x0001Public(公共节点)PowerSourceO
0x0001Public(公共节点)NetworkCommissioningO
0x0001Public(公共节点)EcosystemInformationO
0x0001Public(公共节点)IndicationLightO
0x0001Public(公共节点)GeneralConfigurationO
0x0001Public(公共节点)GeneralDiagnosticsO
0x0001Public(公共节点)ThreadNetworkDiagnosticsO
0x0001Public(公共节点)ZigbeeNetworkDiagnosticsO
0x0001Public(公共节点)DeviceAnomalyMonitoringO
0x0001Public(公共节点)MatterCoordinationO
0x0001Public(公共节点)OTACoordinationO
0x0001Public(公共节点)StudioCoordinationO
0x0001Public(公共节点)CameraCoordinationO
0x0001Public(公共节点)SecurityGuardCoordinationO
0x0001Public(公共节点)SceneCoordinationO
0x0001Public(公共节点)HubCoordinationO
0x0001Public(公共节点)LightBoxCoordinationO
0x0001Public(公共节点)IRCoordinationO
0x0001Public(公共节点)CommLinkCoordinationO
0x0001Public(公共节点)RingtoneCoordinationO
0x0001Public(公共节点)ScreenCoordinationO
0x0001Public(公共节点)ConfigurationCoordinationO
0x0001Public(公共节点)LockCoordinationO
0x0001Public(公共节点)WakeupCoordinationO
0x0001Public(公共节点)CloudStorageCoordinationO
0x0001Public(公共节点)CentralHubCoordinationO
0x0001Public(公共节点)IftttCoordinationO
0x0001Public(公共节点)NetworkManagementO
0x0001Public(公共节点)SecurityO
0x0001Public(公共节点)OTAO

网关/桥接类型​

网关/桥接类型

IDDevice TypeRequired Functions必选备注
0x0003Hub(网关)BridgeConfigurationM
0x0003Hub(网关)SpeakerO
0x0003Hub(网关)MatterBridgeCommissioningO
0x0003Hub(网关)ZigbeeNetworkDiagnosticsO
0x0003Hub(网关)RingtoneO
0x0003Hub(网关)ThreadNetworkDiagnosticsO
0x0004BridgedNode(桥接设备)BridgedConfigurationM描述桥接设备

照明类型​

照明类型

IDDevice TypeRequired Functions必选备注
0x000ALight(灯)OutputM
0x000ALight(灯)LevelControlO
0x000ALight(灯)ColorControlO
0x000ALight(灯)DeviceAnomalyMonitoringO
0x000ALight(灯)LightingO
0x000ALight(灯)ImageMediaManagementO

电工类型​

电工类型

IDDevice TypeRequired Functions必选备注
0x000BOutlet(插座)OutputM
0x000BOutlet(插座)EnergyManagementO
0x000BOutlet(插座)DeviceAnomalyMonitoringO
0x000CSwitch(开关)OutputM
0x000CSwitch(开关)EnergyManagementO
0x000CSwitch(开关)MARSConfigurationO
0x000CSwitch(开关)CustomizedConfigurationO
0x000CSwitch(开关)ScreenUserInterfaceO
0x000CSwitch(开关)DeviceAnomalyMonitoringO
0x004AGeneralValve(阀门)IdentifyMThis defines conformance to the Water Valve device type.
0x004AGeneralValve(阀门)ValveControlM
0x003EValve(阀门)OutputM
0x0042ElectricalSensor(电气参数传感器)EnergyManagementO通用电气参数传感器;不表示具备并网点电表的进口/出口、需量或分时计量能力。
0x0043Pump(泵)OutputMA Pump device in a smart home system is designed to control and manage the flow of liquids, such as water or other fluids.

暖通类型​

暖通类型

IDDevice TypeRequired Functions必选备注
0x000DAirConditioner(空调,双设定点)OutputM支持自动制冷/制热切换,并分别维护制冷和制热目标温度。
0x000DAirConditioner(空调,双设定点)HeaterCoolerM必须实现 CoolingTemperature、HeatingTemperature 和 MinHeatCoolDeadBand;HeaterCoolerMode 必须支持 Auto,并上报 Supported Value。双设定点及自动模式要求见下文。
0x000DAirConditioner(空调,双设定点)FanControlO
0x000DAirConditioner(空调,双设定点)FreshAirControlO
0x000DAirConditioner(空调,双设定点)TemperatureO室外温度使用 OutdoorTemperature;室内温度复用 HeaterCooler 的 CurrentTemperature。
0x0087SingleSetpointAC(单设定点空调)OutputM用户先选择制冷或制热模式,再设置该模式下唯一的目标温度。
0x0087SingleSetpointAC(单设定点空调)HeaterCoolerM必须实现 SetTemperature;HeaterCoolerMode 必须上报 Supported Value,至少支持 Cool 或 Heat 之一。单设定点控制要求见下文。
0x0087SingleSetpointAC(单设定点空调)FanControlO
0x0087SingleSetpointAC(单设定点空调)FreshAirControlO
0x0087SingleSetpointAC(单设定点空调)TemperatureO室外温度使用 OutdoorTemperature;室内温度复用 HeaterCooler 的 CurrentTemperature。
0x0062AirConditionerController(空调控制器)BindingMThis device type represents a controller that can be bound to one or more target air conditioners.
0x000EWindowCovering(窗帘)WindowCoveringM
0x002DThermostat(温控器)HeaterCoolerM
0x002DThermostat(温控器)FanControlO
0x0061ThermostatController(温控器控制器)BindingMThis device type represents a thermostat controller that can be bound to one or more target thermostats.
0x0030FloorHeating(地暖)OutputM
0x0030FloorHeating(地暖)HeaterCoolerM
0x0031Ventilation(新风)OutputM
0x0031Ventilation(新风)FanControlM
0x0031Ventilation(新风)FreshAirControlO
0x0038BathroomHeater(浴霸)OutputM
0x0038BathroomHeater(浴霸)HeaterCoolerO
0x0038BathroomHeater(浴霸)FanControlO
0x005ETemperatureControlledCabinet(温控容器)TemperatureControlM
0x005ETemperatureControlledCabinet(温控容器)TemperatureO
0x0048Fan(风扇)FanControlMA Fan is a smart home device designed to circulate air in order to provide cooling, ventilation, or air circulation within a roo
0x0048Fan(风扇)OutputO
0x0059HeatPump(热泵)HeaterCoolerMA Heat Pump Device is an energy-efficient heating and cooling system that transfers heat between indoor and outdoor environments
0x0059HeatPump(热泵)PowerSourceM
0x0059HeatPump(热泵)EnergyManagementM

AirConditioner 与 SingleSetpointAC 都实现 Output 和 HeaterCooler,区别在于目标温度和模式控制模型:

  • AirConditioner(Device Type ID 0x000D,十进制 13)为双设定点空调,适用于能够同时维护制冷与制热目标、并根据室温自动在制冷和制热之间切换的设备。其 CoolingTemperature 和 HeatingTemperature 是两个独立且同时有效的目标;SetTemperature 不得作为这两个目标的别名或替代值。两目标之间的差值必须不小于 MinHeatCoolDeadBand 的 Present Value。设备必须支持并上报 HeaterCoolerMode/Supported Value 中的 Auto。在 Auto 模式下,室温高于制冷目标时制冷,低于制热目标时制热;处于两目标之间的死区时,不因该自动温控逻辑同时请求制冷和制热。客户端在 Auto 模式下应显示并可分别调整两个目标;切换至 Cool 或 Heat 时,应使用对应的制冷或制热目标,另一个目标仍保持独立有效。设备应在更新任一目标或最小死区时校验关系;违反最小死区的写入必须拒绝,且不得部分更新。
  • SingleSetpointAC(Device Type ID 0x0087,十进制 135)为单设定点空调,适用于需要用户先选择制冷或制热模式、然后设置一个目标温度的设备,包括单冷型或单热型设备。其 SetTemperature 是当前模式下唯一有效的空调目标温度;设备不得以 CoolingTemperature 和 HeatingTemperature 同时表示当前空调控制目标。该 Device Type 的 HeaterCoolerMode/Supported Value 必须列出设备实际支持的模式,至少包含 Cool 或 Heat 之一;用户切换 Cool/Heat 模式后,SetTemperature 仍表示当前模式的唯一目标,不代表分别保存的制冷和制热目标。
  • HeaterCoolerMode/Supported Value 是客户端可用模式的依据;客户端不得仅凭全局枚举定义就展示设备未声明支持的模式。AirConditioner 的自动模式根据两个目标和死区工作;SingleSetpointAC 的客户端流程应先展示设备支持的 Cool/Heat 模式(仅支持一个时只展示该模式),再编辑 SetTemperature。
  • MinHeatCoolDeadBand 约束双设定点自动控制,表示制冷与制热目标之间必须保留的最小温差;它不适用于以 SetTemperature 控制的 SingleSetpointAC。当前温度 Trait 用于状态展示时按其自身 Conformance 实现;设备可在内部使用传感器执行 Auto 控制,无须因内部传感器而虚报外部温度测量值。

影音类型​

影音类型

IDDevice TypeRequired Functions必选备注
0x000FCamera(摄像头)CameraM
0x000FCamera(摄像头)SpeakerO
0x000FCamera(摄像头)PanTiltO
0x000FCamera(摄像头)StorageO
0x000FCamera(摄像头)NASStorageO
0x000FCamera(摄像头)CameraNotificationsO
0x000FCamera(摄像头)CameraPrivacySecurityO
0x000FCamera(摄像头)AudioSettingsO
0x000FCamera(摄像头)CameraWorkModeO
0x000FCamera(摄像头)VideoSettingsO
0x000FCamera(摄像头)AIDetectionO
0x000FCamera(摄像头)CameraSettingsO
0x000FCamera(摄像头)CloudRecordingO
0x000FCamera(摄像头)PlaybackO
0x000FCamera(摄像头)LiveO
0x0011Speaker(音箱)SpeakerM
0x0011Speaker(音箱)MediaPlaybackO
0x0012TV(电视)OutputM
0x0012TV(电视)MediaPlaybackO
0x0012TV(电视)SpeakerO
0x005ABasicVideoPlayer(基础视频播放器)OutputM
0x005ABasicVideoPlayer(基础视频播放器)MediaPlaybackM
0x005ABasicVideoPlayer(基础视频播放器)MediaInputO
0x005BCastingVideoPlayer(投屏视频播放器)OutputM
0x005BCastingVideoPlayer(投屏视频播放器)MediaPlaybackM
0x005BCastingVideoPlayer(投屏视频播放器)MediaInputO
0x005CVideoRemoteControl(视频远程控制)OutputM
0x005CVideoRemoteControl(视频远程控制)MediaPlaybackM
0x005CVideoRemoteControl(视频远程控制)MediaInputO
0x003FProjector(投影仪)OutputO
0x0039Panel(面板)SpeakerO
0x0039Panel(面板)ScreenDisplayO
0x003AVideoDoorbell(可视门铃)CameraM
0x003AVideoDoorbell(可视门铃)SpeakerO

红外/遥控类型​

红外/遥控类型

IDDevice TypeRequired Functions必选备注
0x0013IRDevice(红外设备)IRControlM
0x0013IRDevice(红外设备)OutputO
0x0013IRDevice(红外设备)HeaterCoolerO
0x006CGestureSensor(手势传感器)GestureRecognitionM

晾衣架类型​

晾衣架类型

IDDevice TypeRequired Functions必选备注
0x0014ClotheDryingMachine(晾衣机)LifterM

传感器类型​

传感器类型

IDDevice TypeRequired Functions必选备注
0x0015ContactSensor(门窗传感器)ContactM
0x0016DoorLock(门锁)DoorLockM
0x0017TemperatureSensor(温度传感器)TemperatureM
0x0018HumiditySensor(湿度传感器)RelativeHumidityM
0x0019AtmosphericPressureSensor(大气压)PressureM
0x005DPressureSensor(压力传感器)PressureMPressure Sensor is a general-purpose pressure detection device capable of measuring air pressure, water pressure, and hydraulic
0x001AIlluminanceSensor(光照度传感器)IlluminanceM
0x001BCO2Sensor(CO2传感器)CO2M
0x001CTVOCSensor(TVOC传感器)AirQualityM
0x0049AirQualitySensor(空气质量传感器)AirQualityMAn Air Quality Sensor is a smart device designed to monitor the quality of the air within a home or other indoor environments.
0x007CWaterQualitySensor(水质传感器)WaterQualityM
0x001DNaturalGasAlarm(天然气报警器)GasM
0x001ESmokeAlarm(烟雾报警器)SmokeM
0x001ESmokeAlarm(烟雾报警器)COO
0x001ESmokeAlarm(烟雾报警器)PowerSourceO
0x0047COAlarm(一氧化碳报警器)COMA CO Alarm is a critical safety device designed to detect the presence of carbon monoxide (CO) gas in the air.
0x0047COAlarm(一氧化碳报警器)PowerSourceO
0x003DLPGAlarm(液化石油气报警器)GasM
0x001FParticulateMatterSensor(颗粒物传感器)ParticulateMatterM
0x0020WaterLeakSensor(水浸传感器)WaterLeakM
0x0021SleepMonitor(睡眠监测器)SleepM
0x0022MotionSensor(人体传感器)OccupancySensingM
0x0027OccupancySensor(人体存在传感器)OccupancySensingM
0x0027OccupancySensor(人体存在传感器)OccupantLocationO
0x0027OccupancySensor(人体存在传感器)RadarSensingUnionO
0x0027OccupancySensor(人体存在传感器)AmbientSensingConfigurationO
0x0023Knob(旋钮开关)KnobM
0x0023Knob(旋钮开关)ButtonO
0x0024Button(无线开关)ButtonM
0x0025Cube(魔方)CubeM
0x0026VibrationSensor(动静贴)VibrationM
0x0029LocationSensor(位置传感器)LocationM
0x0028WaterHeater(热水器)OutputM
0x0044OnOffSensor(开关传感器)OnOffSensorOAn On/Off Sensor is a smart home device designed to detect and report the status of electrical appliances or systems-whether the
0x0046RainSensor(雨水传感器)RainSensorOA Rain Sensor is a smart device designed to detect rainfall and provide real-time information about weather conditions.
0x0045WaterFreezeDetector(水冻结探测器)WaterFreezeDetectorMA Water Freeze Detector is a smart device designed to monitor the temperature of water systems in the home.
0x004CFlowSensor(流量传感器)FlowMA Flow Sensor device measures and reports the flow rate of a fluid.
0x007DHeatMeter(热量表)HeatMeterM用于供热/供冷系统中的冷热量计量与统计。
0x007ECompressor(压缩机)CompressorM用于制冷系统中的压缩环节运行监测与控制。
0x007FControlCabinet(控制柜)ControlCabinetM用于冷却水系统等场景下的集中监测与频率调节控制。
0x0080CoolingPump(冷却泵)CoolingPumpM用于冷却水循环系统中的泵运行监测与频率调节。
0x0081Boiler(锅炉)BoilerM用于锅炉运行参数监测、火力调节和燃烧控制。
0x0082LiquidLevelSensor(液位传感器)LiquidLevelM用于监测容器或管路中的液位高度与液位风险。
0x0084WaterMeter(水表)FlowM用于测量并上报用水流量及累计用水量。
0x0084WaterMeter(水表)TemperatureO适用于支持水温测量的水表。
0x0084WaterMeter(水表)ValveControlO适用于集成关断阀的水表。
0x0085GasMeter(燃气表)FlowM用于测量并上报燃气流量及累计用气量。
0x0085GasMeter(燃气表)ValveControlO适用于集成关断阀的燃气表。
0x0085GasMeter(燃气表)GasMeteringO提供燃气热值和燃气体积换算系数等燃气计量参数。
0x003CAttitudeDetector(姿态检测)AttitudeDetectionM
0x005FModeSelector(模式选择器)ModeM

安防/AI 检测类型​

安防/AI 检测类型

IDDevice TypeRequired Functions必选备注
0x0071HumanDetector(人形检测器)HumanRecognitionO
0x0071HumanDetector(人形检测器)HumanPresenceO
0x002FFireAlarm(火灾报警器)FlameDetectionM
0x0070PackageDetector(包裹检测器)PackageRecognitionM
0x006FSoundSensor(声音传感器)SoundDetectionM
0x006EPetMonitor(宠物监测器)PetRecognitionM
0x006DFaceScanner(人脸识别器)FaceRecognitionM
0x006BVehicleDetector(车辆检测器)VehicleDetectionM
0x0072Doorbell(门铃)DoorbellM非可视门铃类的门铃

健康监测类型​

健康监测类型

IDDevice TypeRequired Functions必选备注
0x0073BreathingMonitor(呼吸监测器)BreathingMonitoringM
0x0074HeartMonitor(心脏监测器)HeartMonitoringM
0x0075VirtualFence(虚拟围栏)FenceDetectionO

清洁/家电类型​

清洁/家电类型

IDDevice TypeRequired Functions必选备注
0x0010SweepingRobot(扫地机器人)SweeperM
0x004DRoboticVacuumCleaner(扫地机器人)VacuumOperationalStateMThis defines conformance for the Robotic Vacuum Cleaner device type.
0x004DRoboticVacuumCleaner(扫地机器人)ModeM
0x004BAirPurifier(空气净化器)IdentifyMAn Air Purifier is a standalone device that is designed to clean the air in a room.
0x004BAirPurifier(空气净化器)OutputM
0x004BAirPurifier(空气净化器)FanControlM
0x004BAirPurifier(空气净化器)ActivatedCarbonFilterMonitoringO
0x004BAirPurifier(空气净化器)HEPAFilterMonitoringO
0x002ASmartToilet(马桶)ToiletCoreM
0x002ASmartToilet(马桶)ToiletDiagnosticO
0x002ASmartToilet(马桶)ToiletHygieneO
0x002ASmartToilet(马桶)ToiletWashDryO
0x002ASmartToilet(马桶)ToiletSettingsO
0x002BTVBox(电视盒子)BasicInformation
0x002CSmartBed(床)LifterORepresent a motorized bed system that allows for independent or synchronized adjustment of the backrest and legrest positions, and may incorporate multi-mode massage functions, timer-based operations, and safety mechanisms such as child locks to enhance user comfort and safety.
0x002CSmartBed(床)MassageO
0x002EPusher(推窗器)BasicInformation
0x0035TowelRack(毛巾架)TowelRackDryMRepresent an intelligent bathroom heating appliance designed to dry and warm towels through controlled heating cycles, providing real-time monitoring of surface temperature, remaining drying duration, and operational status while ensuring system safety through fault detection.
0x0036PetFeeder(喂食器)PetFeederM
0x0037PetWaterer(宠物饮水器)BasicInformation
0x0034ElectricCooker(电饭煲)BasicInformation
0x0033Oven(蒸/烤箱)OperationalStateMAn Oven is a household or commercial appliance used for cooking, baking, roasting, or heating food.
0x0032Hearth(灶炉)BasicInformation
0x004FRefrigerator(冰箱)ModeMA Refrigerator is an appliance that keeps food and beverages cold to preserve freshness.
0x004FRefrigerator(冰箱)RefrigeratorStateM
0x004ELaundryWasher(洗衣机)OperationalStateMA Laundry Washer is an appliance that cleans clothes and textiles by agitating them in water with detergent to remove dirt, stai
0x0051LaundryDryer(干衣机)OperationalStateMA Laundry Dryer is an appliance designed to dry clothes, towels, and other textiles by removing moisture through heat
0x0050Dishwasher(洗碗机)OperationalStateMA Dishwasher is an appliance designed to automatically clean dishes, utensils, and cookware by spraying hot water mixed with det
0x0052Cooktop(炉灶)OutputMA Cooktop is a kitchen appliance designed for cooking food by providing heat through burners, induction coils, or other heating
0x0053CookSurface(烹饪台面)OutputMA Cook Surface refers to the flat cooking area of a stove or cooktop, where heat is applied to cookware for cooking food.
0x0054ExtractorHood(抽油烟机)FanControlMAn Extractor Hood is an appliance installed above the cooktop or stove to ventilate and remove smoke, steam, odors
0x0055MicrowaveOven(微波炉)OutputMA Microwave Oven is an appliance that uses electromagnetic waves (microwaves) to rapidly heat or cook food.
0x003BAccessController(接入控制器)BasicInformation

能源类型​

能源类型

IDDevice TypeRequired Functions必选备注
0x0056ElectricVehicleSupplyEquipment(电动车充电桩)EVSEMElectric Vehicle Supply Equipment (EVSE) refers to the hardware used to deliver electrical energy from a power source
0x0056ElectricVehicleSupplyEquipment(电动车充电桩)ModeM
0x0056ElectricVehicleSupplyEquipment(电动车充电桩)EnergyStorageO仅在设备可提供车辆电池侧数据时实现;不得与 EVSE 自身备用电池混淆。
0x0057SolarPower(太阳能)PowerSourceMSolar Power is the energy harnessed from the sun using photovoltaic (PV) cells, which convert sunlight into electricity.
0x0057SolarPower(太阳能)EnergyManagementMSolarPower 实现必须提供 CumulativeGeneratedActiveEnergy 和 GeneratedActivePower,其计量边界为逆变器交流输出侧。
0x0057SolarPower(太阳能)PowerGenerationO额定发电功率及累计售电量按设备能力实现;并网状态由 EnergyManagement 提供。
0x0058BatteryStorage(电池储存)PowerSourceMPowerSource 描述设备供电来源;其中 BatPercentRemaining 不替代储能 SOC。
0x0058BatteryStorage(电池储存)EnergyManagementM
0x0058BatteryStorage(电池储存)EnergyStorageM提供储能系统 SOC、容量、充放电和健康状态等电池侧数据。
0x0086ElectricityMeter(电能表)EnergyManagementM提供通用电气参数及进口/出口累计有功电能。
0x0086ElectricityMeter(电能表)ElectricityMeteringM并网点电表的 MeteringPointType 必须为 GridConnectionPoint;需量和分时电量按设备能力可选实现。

BACnet 对象类型​

BACnet 对象类型

IDDevice TypeRequired Functions必选备注
0x0063AnalogInputDevice(模拟输入型设备)AnalogInputObjectM
0x0064AnalogOutputDevice(模拟输出型设备)AnalogOutputObjectM
0x0065BinaryInputDevice(二进制输入型设备)BinaryInputObjectM
0x0066BinaryOutputDevice(二进制输出型设备)BinaryOutputObjectM
0x0067MultiStateInputDevice(多状态输入型设备)MultiStateInputObjectM
0x0068MultiStateOutputDevice(多状态输出型设备)MultiStateOutputObjectM
0x0069CharStringValueDevice(字符串型设备)CharacterStringValueObjectM

车载类型​

车载类型

IDDevice TypeRequired Functions必选备注
0x0041MultiActionDetector(多动作感知器)CubeO多动作感知器,支持多种类型的动作检测,比如敲两下,旋转、震动等等
0x0041MultiActionDetector(多动作感知器)VibrationO
0x0041MultiActionDetector(多动作感知器)KnobO
0x0040GarageDoor(车库门)GarageDoorOpenerM

其他类型​

其他类型

IDDevice TypeRequired Functions必选备注
0x006AScene(场景)BasicInformation
0x0077NAS(网络存储设备)BasicInformation
0x0076WiFiRepeater(WiFi中继)BasicInformation
0x0083VoiceAssistant(语音助手)VoiceAssistantM语音助手设备类型。
备注

表中 Function 名称与 Aqara Spec Function 定义章节保持一致。

Device Type ID 索引​

下表按 ID 升序列出全部 Device Type,便于按编码查询。Function 要求详见上一节列表。

Device Type ID 索引表

ID编码名称品类
[[devtype_0000]]0x0000Root根节点Other
[[devtype_0001]]0x0001Public公共节点Other
[[devtype_0003]]0x0003Hub网关Other
[[devtype_0004]]0x0004BridgedNode桥接设备Other
[[devtype_000a]]0x000ALight灯Lighting
[[devtype_000b]]0x000BOutlet插座Outlet
[[devtype_000c]]0x000CSwitch开关Switch
[[devtype_000d]]0x000DAirConditioner双设定点空调HeaterCooler
[[devtype_000e]]0x000EWindowCovering窗帘Shading
[[devtype_000f]]0x000FCamera摄像头Security
[[devtype_0010]]0x0010SweepingRobot扫地机器人Other
[[devtype_0011]]0x0011Speaker音箱Other
[[devtype_0012]]0x0012TV电视Other
[[devtype_0013]]0x0013IRDevice红外设备IRDevice
[[devtype_0014]]0x0014ClotheDryingMachine晾衣机Other
[[devtype_0015]]0x0015ContactSensor门窗传感器Security
[[devtype_0016]]0x0016DoorLock门锁Security
[[devtype_0017]]0x0017TemperatureSensor温度传感器Environment
[[devtype_0018]]0x0018HumiditySensor湿度传感器Environment
[[devtype_0019]]0x0019AtmosphericPressureSensor大气压Environment
[[devtype_001a]]0x001AIlluminanceSensor光照度传感器Environment
[[devtype_001b]]0x001BCO2SensorCO2传感器Environment
[[devtype_001c]]0x001CTVOCSensorTVOC传感器Environment
[[devtype_001d]]0x001DNaturalGasAlarm天然气报警器Security
[[devtype_001e]]0x001ESmokeAlarm烟雾报警器Security
[[devtype_001f]]0x001FParticulateMatterSensor颗粒物传感器Environment
[[devtype_0020]]0x0020WaterLeakSensor水浸传感器Security
[[devtype_0021]]0x0021SleepMonitor睡眠监测器Other
[[devtype_0022]]0x0022MotionSensor人体传感器Security
[[devtype_0023]]0x0023Knob旋钮开关Remote
[[devtype_0024]]0x0024Button无线开关Remote
[[devtype_0025]]0x0025Cube魔方Remote
[[devtype_0026]]0x0026VibrationSensor动静贴Security
[[devtype_0027]]0x0027OccupancySensor人体存在传感器Security
[[devtype_0028]]0x0028WaterHeater热水器Other
[[devtype_0029]]0x0029LocationSensor位置传感器Other
[[devtype_002a]]0x002ASmartToilet马桶Other
[[devtype_002b]]0x002BTVBox电视盒子Other
[[devtype_002c]]0x002CSmartBed床Other
[[devtype_002d]]0x002DThermostat温控器HeaterCooler
[[devtype_002e]]0x002EPusher推窗器Other
[[devtype_002f]]0x002FFireAlarm火灾报警器Security
[[devtype_0030]]0x0030FloorHeating地暖HeaterCooler
[[devtype_0031]]0x0031Ventilation新风HeaterCooler
[[devtype_0032]]0x0032Hearth灶炉Other
[[devtype_0033]]0x0033Oven蒸/烤箱Other
[[devtype_0034]]0x0034ElectricCooker电饭煲Other
[[devtype_0035]]0x0035TowelRack毛巾架Other
[[devtype_0036]]0x0036PetFeeder喂食器Other
[[devtype_0037]]0x0037PetWaterer宠物饮水器Other
[[devtype_0038]]0x0038BathroomHeater浴霸HeaterCooler
[[devtype_0039]]0x0039Panel面板Other
[[devtype_003a]]0x003AVideoDoorbell可视门铃Security
[[devtype_003b]]0x003BAccessController接入控制器Other
[[devtype_003c]]0x003CAttitudeDetector姿态检测Other
[[devtype_003d]]0x003DLPGAlarm液化石油气报警器Security
[[devtype_003e]]0x003EValve阀门Other
[[devtype_003f]]0x003FProjector投影仪Other
[[devtype_0040]]0x0040GarageDoor车库门Other
[[devtype_0041]]0x0041MultiActionDetector多动作感知器Remote
[[devtype_0042]]0x0042ElectricalSensor电气参数传感器Outlet
[[devtype_0043]]0x0043Pump泵Other
[[devtype_0044]]0x0044OnOffSensor开关传感器Environment
[[devtype_0045]]0x0045WaterFreezeDetector水冻结探测器Environment
[[devtype_0046]]0x0046RainSensor雨水传感器Environment
[[devtype_0047]]0x0047COAlarm一氧化碳报警器Environment
[[devtype_0048]]0x0048Fan风扇Other
[[devtype_0049]]0x0049AirQualitySensor空气质量传感器Environment
[[devtype_004a]]0x004AGeneralValve阀门Outlet
[[devtype_004b]]0x004BAirPurifier空气净化器Environment
[[devtype_004c]]0x004CFlowSensor流量传感器Environment
[[devtype_004d]]0x004DRoboticVacuumCleaner扫地机器人Other
[[devtype_004e]]0x004ELaundryWasher洗衣机Other
[[devtype_004f]]0x004FRefrigerator冰箱Other
[[devtype_0050]]0x0050Dishwasher洗碗机Other
[[devtype_0051]]0x0051LaundryDryer干衣机Other
[[devtype_0052]]0x0052Cooktop炉灶Other
[[devtype_0053]]0x0053CookSurface烹饪台面Other
[[devtype_0054]]0x0054ExtractorHood抽油烟机Other
[[devtype_0055]]0x0055MicrowaveOven微波炉Other
[[devtype_0056]]0x0056ElectricVehicleSupplyEquipment电动车充电桩Other
[[devtype_0057]]0x0057SolarPower太阳能Other
[[devtype_0058]]0x0058BatteryStorage电池储存Other
[[devtype_0059]]0x0059HeatPump热泵Other
[[devtype_005a]]0x005ABasicVideoPlayer基础视频播放器Other
[[devtype_005b]]0x005BCastingVideoPlayer投屏视频播放器Other
[[devtype_005c]]0x005CVideoRemoteControl视频远程控制Other
[[devtype_005d]]0x005DPressureSensor压力传感器Environment
[[devtype_005e]]0x005ETemperatureControlledCabinet温控容器HeaterCooler
[[devtype_005f]]0x005FModeSelector模式选择器Other
[[devtype_0061]]0x0061ThermostatController温控器控制器HeaterCooler
[[devtype_0062]]0x0062AirConditionerController空调控制器HeaterCooler
[[devtype_0063]]0x0063AnalogInputDevice模拟输入型设备Other
[[devtype_0064]]0x0064AnalogOutputDevice模拟输出型设备Other
[[devtype_0065]]0x0065BinaryInputDevice二进制输入型设备Other
[[devtype_0066]]0x0066BinaryOutputDevice二进制输出型设备Other
[[devtype_0067]]0x0067MultiStateInputDevice多状态输入型设备Other
[[devtype_0068]]0x0068MultiStateOutputDevice多状态输出型设备Other
[[devtype_0069]]0x0069CharStringValueDevice字符串型设备Other
[[devtype_006a]]0x006AScene场景Other
[[devtype_006b]]0x006BVehicleDetector车辆检测器Security
[[devtype_006c]]0x006CGestureSensor手势传感器Remote
[[devtype_006d]]0x006DFaceScanner人脸识别器Security
[[devtype_006e]]0x006EPetMonitor宠物监测器Security
[[devtype_006f]]0x006FSoundSensor声音传感器Security
[[devtype_0070]]0x0070PackageDetector包裹检测器Security
[[devtype_0071]]0x0071HumanDetector人形检测器Security
[[devtype_0072]]0x0072Doorbell门铃Other
[[devtype_0073]]0x0073BreathingMonitor呼吸监测器Other
[[devtype_0074]]0x0074HeartMonitor心脏监测器Other
[[devtype_0075]]0x0075VirtualFence虚拟围栏Other
[[devtype_0076]]0x0076WiFiRepeaterWiFi中继Other
[[devtype_0077]]0x0077NAS网络存储设备Other
[[devtype_007c]]0x007CWaterQualitySensor水质传感器Environment
[[devtype_007d]]0x007DHeatMeter热量表Environment
[[devtype_007e]]0x007ECompressor压缩机HeaterCooler
[[devtype_007f]]0x007FControlCabinet控制柜HeaterCooler
[[devtype_0080]]0x0080CoolingPump冷却泵HeaterCooler
[[devtype_0081]]0x0081Boiler锅炉HeaterCooler
[[devtype_0082]]0x0082LiquidLevelSensor液位传感器Environment
[[devtype_0083]]0x0083VoiceAssistant语音助手Other
[[devtype_0084]]0x0084WaterMeter水表Environment
[[devtype_0085]]0x0085GasMeter燃气表Environment
[[devtype_0086]]0x0086ElectricityMeter电能表Other
[[devtype_0087]]0x0087SingleSetpointAC单设定点空调HeaterCooler
备注

表中 Function 名称与 Aqara Spec Function 定义章节保持一致。

Matter / Zigbee Device Type 到 Aqara Spec Device Type 映射​

本附录定义 Matter Device Type、Zigbee Device Type 与 Aqara Spec Device Type 的对应关系。

Matter Device Type 映射​

序号Matter Device TypeMatter Device Type IDAqara Spec Device TypeAqara Spec Device Type ID
1Dimmable Plug-In Unit0x010BLight0x000A
2Mounted On/Off Control0x010FSwitch0x000C
3Mounted Dimmable Load Control0x0110Light0x000A
4Pump0x0303Pump0x0043
5Pressure Sensor0x0305PressureSensor0x005D
6On/Off Sensor0x0850OnOffSensor0x0044
7Smoke & CO Alarm0x0076SmokeAlarm0x001E
Smoke & CO Alarm0x0076COAlarm0x0047
8Air Quality Sensor0x002CAirQualitySensor0x0049
9Water Leak Detector0x0043WaterLeakDetector0x0020
10Water Freeze Detector0x0041WaterFreezeDetector0x0045
11Rain Sensor0x0044RainSensor0x0046
12Window Covering0x0202WindowCovering0x000E
13Fan0x002BFan0x0048
14Water Valve0x0042GeneralValve0x004A
15Flow Sensor0x0306FlowSensor0x004C
16Air Purifier0x002DAirPurifier0x004B
17Laundry Washer0x0073LaundryWasher0x004E
18Refrigerator0x0070Refrigerator0x004F
19Room Air Conditioner0x0072AirConditioner0x000D
20Dishwasher0x0075Dishwasher0x0050
21Laundry Dryer0x007CLaundryDryer0x0051
22Oven (Range)0x007BOven0x0033
23Cooktop0x0078Cooktop0x0052
24Cook Surface0x0077CookSurface0x0053
25Extractor Hood0x007AExtractorHood0x0054
26Microwave Oven0x0079MicrowaveOven0x0055
27Robotic Vacuum Cleaner0x0074RoboticVacuumCleaner0x004D
28Electric Vehicle Supply Equipment0x050CElectricVehicleSupplyEquipment0x0056
29Water Heater0x050FWaterHeater0x0028
30Solar Power0x0017SolarPower0x0057
31Battery Storage0x0011BatteryStorage0x0058
32Heat Pump0x0309HeatPump0x0059
33Electrical Sensor0x0510ElectricalSensor0x0042
34Basic Video Player0x0028BasicVideoPlayer0x005A
35Casting Video Player0x0023CastingVideoPlayer0x005B
36Video Remote Control0x002AVideoRemoteControl0x005C
37Speaker0x0022Speaker0x0011
38Door Lock0x000ADoorLock0x0016
39On/Off Light0x0100Switch0x000C
40Dimmable Light0x0101Light0x000A
41Color Temperature Light0x010CLight0x000A
42Extended Color Light0x010DLight0x000A
43On/Off Plug-in Unit0x010AOutlet0x000B
44Thermostat0x0301Thermostat0x002D
45Occupancy Sensor0x0107OccupancySensor0x0027
Occupancy Sensor0x0107MotionSensor0x0022
46Light Sensor0x0106IlluminanceSensor0x001A
47Contact Sensor0x0015ContactSensor0x0015
48Temperature Sensor0x0302TemperatureSensor0x0017
49Humidity Sensor0x0307HumiditySensor0x0018
50Generic Switch0x000FButton0x0024
51Bridge0x000EBridgeNode0x0004
52Temperature Controlled Cabinet0x0071TemperatureControlledCabinet0x005E

Zigbee Device Type 映射​

序号Zigbee Device TypeZigbee Device Type IDAqara Spec Device TypeAqara Spec Device Type ID
1Aqara Root Node0x0016Public0x0001
2On/Off Switch0x0000Switch0x000C
3Door Lock0x000ADoorLock0x0016
4Smart Plug0x0051Outlet0x000B
5On/Off Light0x0100Switch0x000C
6Dimmable Light0x0101Light0x000A
7Color Dimmable Light0x0102Light0x000A
8Light Sensor0x0106IlluminanceSensor0x001A
9Occupancy Sensor0x0107OccupancySensor0x0027
10Window Covering Device0x0202WindowCovering0x000E
11Window Covering Controller0x0203WindowCovering0x000E
12Thermostat0x0301Thermostat0x002D
13Temperature Sensor0x0302TemperatureSensor0x0017
14Pump0x0303Pump0x0043
15Pressure Sensor0x0305AtmosphericPressureSensor0x0019
16Flow Sensor0x0306FlowSensor0x004C
17Mini Split AC0x0307AirConditioner0x000D

Binding(绑定)​

简介​

表示端点与一个或多个其他本地或远程 Endpoint 之间的持久绑定关系。

Function 标识​

Function IDCode名称
0x0001Binding绑定

Trait​

Trait IDCode名称Conformance
0x0002BindingBindingM
0x4E76SupportedBindingDeviceTypes支持的可绑定的设备类型O
0x4E75SupportedBindingFunctions支持的可绑定的FunctionO

Command​

本 Function 不包含 Command。

数据类型​

BindingTraitPresentValueStructure Type​

该结构体定义 Binding Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0DeviceIDcharacterStringM目标设备的 Device ID。最大长度 32 字节。
1ParentIDcharacterStringO目标设备所属父设备 Device ID。若与绑定方处于同一首选 Matter 控制器,则无需设置。最大长度 32 字节。
2GroupIDuint32O绑定目标为设备组时 SHALL 设置(Conformance: GROUP)。
3ModelValuecharacterStringO针对非 Matter 设备 SHALL 设置目标模型值(Conformance: !MATTER)。最大长度 32 字节。
4EndPointIDuint32M目标设备的 Endpoint ID。
5DeviceTypeIDuint32M目标设备的 Aqara Device Type ID。

Trait 定义​

Trait IDNameConformance
0x0002BindingM
0x4E76SupportedBindingDeviceTypesO
0x4E75SupportedBindingFunctionsO

Binding Trait​

Binding表示端点与一个或多个其他本地或远程 Endpoint持久关系。

Trait IDCode
0x0002Binding
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[BindingTraitPresentValueStructure]RVWM

SupportedBindingDeviceTypes Trait(支持的可绑定的设备类型)​

指示该控制器端点可绑定的设备类型列表。

Trait IDCode
0x4E76SupportedBindingDeviceTypes
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

SupportedBindingFunctions Trait(支持的可绑定的Function)​

指示该控制器端点可绑定并控制的 Function 功能列表。

Trait IDCode
0x4E75SupportedBindingFunctions
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

Command 定义​

本 Function 不包含 Command。

CO(一氧化碳)​

简介​

提供一氧化碳浓度监测与报警相关能力,用于检测环境中的一氧化碳泄漏并及时告警。

Function 标识​

Function IDCode名称
0x0009CO一氧化碳

Trait​

Trait IDCode名称Conformance
0x0004CODetected一氧化碳检测状态M
0x0005ExpressedState报警器状态O
0x51A2CODensity一氧化碳浓度O

Command​

Command IDCode名称Conformance
0x9C42SelfTestRequest自检O

数据类型​

ExpressedStateEnum8 Type​

该枚举定义 ExpressedState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01SmokeAlarm烟雾泄漏
0x02COAlarmCO泄漏
0x03BatteryAlert电池警告
0x04Testing测试中
0x05HardwareFault硬件错误
0x06EndOfService服务终止
0x07InterconnectSmoke互联烟雾报警
0x08InterconnectCO互联CO报警

Trait 定义​

Trait IDNameConformance
0x0004CODetectedM
0x0005ExpressedStateO
0x51A2CODensityO

CODetected Trait(一氧化碳检测状态)​

表示是否探测到一氧化碳泄漏.

Trait IDCode
0x0004CODetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM
0x0007Default Valueboolean0RWO

ExpressedState Trait(报警器状态)​

ExpressedState 定义了报警器的状态.

Trait IDCode
0x0005ExpressedState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueExpressedStateEnum80RVO
0x0006Supported Valuelist[ExpressedStateEnum8]RO
0x0007Default Valueuint80RWO

CODensity Trait(一氧化碳浓度)​

表示空气中一氧化碳浓度,用于监测有毒气体风险,并辅助进行通风联动和安全告警。单位:mg/m^3。

Trait IDCode
0x51A2CODensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat1000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

Command 定义​

Command IDNameConformance
0x9C42SelfTestRequestO

SelfTestRequest Command​

SelfTestRequest表示报警器自检。

该 Command 无参数。

WaterFreezeDetector(水冻结探测器)​

简介​

用于检测管道或环境中是否存在结冰风险,并在达到阈值时上报水冻结相关事件。

Function 标识​

Function IDCode名称
0x000AWaterFreezeDetector水冻结探测器

Trait​

Trait IDCode名称Conformance
0x000ABooleanState布尔状态M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x000ABooleanStateM

BooleanState Trait(布尔状态)​

BooleanState描述如何在设备的上下文中使用布尔值(可能在智能家居系统中)来表示统计信息

Trait IDCode
0x000ABooleanState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

RainSensor(雨水传感器)​

简介​

用于检测降雨状态,上报是否正在下雨及雨量相关信息。

Function 标识​

Function IDCode名称
0x000BRainSensor雨水传感器

Trait​

Trait IDCode名称Conformance
0x000ABooleanState布尔状态M
0x51AERainfall降雨量O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x000ABooleanStateM
0x51AERainfallO

BooleanState Trait(布尔状态)​

BooleanState描述如何在设备的上下文中使用布尔值(可能在智能家居系统中)来表示统计信息

Trait IDCode
0x000ABooleanState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM
0x0007Default Valueboolean0RWO

Rainfall Trait(降雨量)​

表示单位时间内的降雨强度,可用于判断天气变化、现场降水水平以及与室外环境相关的联动条件。单位:mm/min。

Trait IDCode
0x51AERainfall
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat500.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

OnOffSensor(开关传感器)​

简介​

用于检测二元开关量输入状态,上报开/关或触发/未触发等离散状态。

Function 标识​

Function IDCode名称
0x000COnOffSensor开关传感器

Trait​

Trait IDCode名称Conformance
0x000ABooleanState布尔状态M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x000ABooleanStateM

BooleanState Trait(布尔状态)​

BooleanState描述如何在设备的上下文中使用布尔值(可能在智能家居系统中)来表示统计信息

Trait IDCode
0x000ABooleanState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

BasicInformation(设备基本信息)​

简介​

提供设备基本信息,包括厂商、产品型号、固件版本、序列号、在线状态等基础属性。

Function 标识​

Function IDCode名称
0x0080BasicInformation设备基本信息

Trait​

Trait IDCode名称Conformance
0x8116HardwareVersionString硬件版本号M
0x8117FirmwareRevisionString固件版本号M
0x4F8EConfigurationVersion配置版本号M
0x8089DeviceID设备IDM
0x8085Reachable连接状态M
0x8084ProductName产品名称M
0x5241NodeLabel节点标签O
0x8083VendorID厂商IDM
0x8082VendorName厂商名M
0x4F52HubConnectionStatus连接中枢的状态O
0x4EE9BLVersionBootloader版本O
0x4EEBMCUVersionmcu版本O
0x4EEARadarVersion雷达版本O
0x4E7FChipTemperature芯片温度O
0x4EA4ManufacturerChipID制造商芯片IDO
0x4E9EDeviceXCode设备类型X码O
0x8175ModelValue模型值O
0x816FConfigurationFlag配置状态O
0x8147MatterSpecificationVersionMatter规范的版本号O
0x8146PartNumber部件编号O
0x8120SupportedMatterRoles支持的Matter角色O
0x8118ProductID产品IDO
0x8088MacMac地址O
0x8087Location地区O
0x8086HardwareVersion硬件版本O
0x8081SerialNumber序列号O
0x8080FirmwareRevision固件版本O
0x4FC4AIModelVersionAI算法模型版本O
0x5146LogicBlockVersion逻辑块固件版本O
0x5155ThermostatBaseSN温控器底座SNO
0x515EThermostatBaseFWVersion温控器底座固件版本O

Command​

本 Function 不包含 Command。

数据类型​

ConfigurationVersionTraitPresentValueStructure Type​

该结构体定义 ConfigurationVersion Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0ConfigurationVersionuint32M设备配置版本号。
1ThingModelMd5characterStringM物模型 MD5 校验值。
HubConnectionStatusEnum8 Type​

该枚举定义 HubConnectionStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Disconnected断开
0x01Connected连接

Trait 定义​

Trait IDNameConformance
0x8116HardwareVersionStringM
0x8117FirmwareRevisionStringM
0x4F8EConfigurationVersionM
0x8089DeviceIDM
0x8085ReachableM
0x8084ProductNameM
0x5241NodeLabelO
0x8083VendorIDM
0x8082VendorNameM
0x4F52HubConnectionStatusO
0x4EE9BLVersionO
0x4EEBMCUVersionO
0x4EEARadarVersionO
0x4E7FChipTemperatureO
0x4EA4ManufacturerChipIDO
0x4E9EDeviceXCodeO
0x8175ModelValueO
0x816FConfigurationFlagO
0x8147MatterSpecificationVersionO
0x8146PartNumberO
0x8120SupportedMatterRolesO
0x8118ProductIDO
0x8088MacO
0x8087LocationO
0x8086HardwareVersionO
0x8081SerialNumberO
0x8080FirmwareRevisionO
0x4FC4AIModelVersionO
0x5146LogicBlockVersionO
0x5155ThermostatBaseSNO
0x515EThermostatBaseFWVersionO

HardwareVersionString Trait(硬件版本号)​

指定节点硬件的版本号。其取值含义及版本编号规则由厂商定义。该属性用于提供比 HardwareVersion 属性更便于用户理解的取值。

Trait IDCode
0x8116HardwareVersionString
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

FirmwareRevisionString Trait(固件版本号)​

该 Trait 用于「固件版本号」相关数据的访问与上报。

Trait IDCode
0x8117FirmwareRevisionString
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

ConfigurationVersion Trait(配置版本号)​

用于存储设备的 ConfigurationVersion 和物模型 MD5。每次 App 直连设备并构建新物模型时,将该特征与云端物模型比对,再决定更新物模型或上报新的特征值。

Trait IDCode
0x4F8EConfigurationVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueConfigurationVersionTraitPresentValueStructureRVWM

DeviceID Trait(设备ID)​

表示设备的唯一标识符。

Trait IDCode
0x8089DeviceID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

Reachable Trait(连接状态)​

指示设备是否可达。0:Offline,1:Online。

Trait IDCode
0x8085Reachable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVM

ProductName Trait(产品名称)​

指定节点型号的可读(可显示)名称,例如厂商分配的型号(或其他标识符)。

Trait IDCode
0x8084ProductName
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

NodeLabel Trait(节点标签)​

表示用户为 Matter 节点设置的自定义名称,字符串长度最多为 32 字节。Matter 设备接入 Aqara 时,设备名称优先使用非空的 NodeLabel;当 NodeLabel 为空时,回退显示 ProductName。用户在 Aqara Home 中修改设备名称后,网关或 App 应将自定义名称写入设备的 NodeLabel,由设备保存并通过该 Trait 同步。

Trait IDCode
0x5241NodeLabel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuestring32最大 32 字节RVWO

VendorID Trait(厂商ID)​

该 Trait 用于「厂商ID」相关数据的访问与上报。

Trait IDCode
0x8083VendorID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

VendorName Trait(厂商名)​

该 Trait 用于「厂商名」相关数据的访问与上报。

Trait IDCode
0x8082VendorName
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

HubConnectionStatus Trait(连接中枢的状态)​

指示设备与中央 Hub 的连接状态,用于判断设备当前是否已连接中央 Hub。

Trait IDCode
0x4F52HubConnectionStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHubConnectionStatusEnum80RVO
0x0006Supported Valuelist[HubConnectionStatusEnum8]RO
0x0007Default Valueuint80RWO

BLVersion Trait(Bootloader版本)​

指定 Bootloader 版本。最大长度为 64 字节的 UTF-8 字符。

Trait IDCode
0x4EE9BLVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

MCUVersion Trait(mcu版本)​

指定 MCU 版本。(当前值:String(64),默认 null)

Trait IDCode
0x4EEBMCUVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

RadarVersion Trait(雷达版本)​

指定雷达模块版本。(当前值:String(64),默认 null)

Trait IDCode
0x4EEARadarVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

ChipTemperature Trait(芯片温度)​

指示设备测得的当前温度。单位:deg C。

Trait IDCode
0x4E7FChipTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat1000.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

ManufacturerChipID Trait(制造商芯片ID)​

标识制造商芯片 ID。

Trait IDCode
0x4EA4ManufacturerChipID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO

DeviceXCode Trait(设备类型X码)​

表示设备的 device type X code。

有效 X 码范围为 1 至 65534。0 和 65535 为非法 X 码值,均表示该设备无 X 码;默认值为 65535。

Trait IDCode
0x4E9EDeviceXCode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161 至 65534;65535 为默认无 X 码标记65535RVO
0x0002Maximum Valueuint1665534RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO

ModelValue Trait(模型值)​

AIOT 模型值,例如 lumi.gateway.cn01

Trait IDCode
0x8175ModelValue
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

ConfigurationFlag Trait(配置状态)​

指示配置状态。标志设为 1 时,设备需先配置方可正常使用。

Trait IDCode
0x816FConfigurationFlag
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

MatterSpecificationVersion Trait(Matter规范的版本号)​

该 Trait 用于「Matter规范的版本号」相关数据的访问与上报。

Trait IDCode
0x8147MatterSpecificationVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

PartNumber Trait(部件编号)​

该 Trait 用于「部件编号」相关数据的访问与上报。

Trait IDCode
0x8146PartNumber
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

SupportedMatterRoles Trait(支持的Matter角色)​

指示设备支持的 Matter 角色,如 Thread Border Router、Matter Controller、Matter Commissioner、Matter Bridge。每一位代表一种角色。

Trait IDCode
0x8120SupportedMatterRoles
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

ProductID Trait(产品ID)​

指定厂商分配的唯一标识该节点具体产品的数字 ID。

Trait IDCode
0x8118ProductID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO

Mac Trait(Mac地址)​

指定设备的 IEEE 802 链路 MAC(Wi-Fi 或 Ethernet)。BLE 地址与 Magic Pair Unique ID 不是本 Trait 的取值;Unique ID 见 ref_MagicPairOnboardingPayload。

Trait IDCode
0x8088Mac
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

Location Trait(地区)​

该 Trait 用于「地区」相关数据的访问与上报。

Trait IDCode
0x8087Location
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

HardwareVersion Trait(硬件版本)​

指定节点硬件的版本号。其取值含义及版本编号规则由厂商定义。

Trait IDCode
0x8086HardwareVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterString0RVO
0x0002Maximum ValuecharacterString4294967295RO
0x0003Minimum ValuecharacterString0RO

SerialNumber Trait(序列号)​

该 Trait 用于「序列号」相关数据的访问与上报。

Trait IDCode
0x8081SerialNumber
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

FirmwareRevision Trait(固件版本)​

包含在此节点上运行的软件的当前版本号。

Trait IDCode
0x8080FirmwareRevision
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterString0RVO
0x0002Maximum ValuecharacterString4294967295RO
0x0003Minimum ValuecharacterString0RO

AIModelVersion Trait(AI算法模型版本)​

当前 AI 算法模型的版本字符串。

Trait IDCode
0x4FC4AIModelVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

LogicBlockVersion Trait(逻辑块固件版本)​

逻辑块固件版本(Logic Block Firmware Version)。表示 Aqara Studio 逻辑块的固件版本号,用于标识逻辑块固件的具体版本,便于 OTA 升级、兼容性判断及故障排查。

Trait IDCode
0x5146LogicBlockVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

ThermostatBaseSN Trait(温控器底座SN)​

温控器底座序列号(SN),用于唯一标识温控器底座的硬件身份信息。通常用于设备注册、售后跟踪及生产溯源。

Trait IDCode
0x5155ThermostatBaseSN
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

ThermostatBaseFWVersion Trait(温控器底座固件版本)​

表示温控器底座的固件版本号。版本号由五个部分以点号分隔组成:集中商.空调品牌.新风品牌.地暖品牌.版本号。该版本号用于标识底座固件版本,便于 OTA 升级、兼容性检查及故障排查。

Trait IDCode
0x515EThermostatBaseFWVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

Command 定义​

本 Function 不包含 Command。

Descriptor(设备功能描述)​

简介​

描述设备端点组成与能力结构,包括端点列表、设备类型、Server/Client 集群等信息。

Function 标识​

Function IDCode名称
0x0081Descriptor设备功能描述

Trait​

Trait IDCode名称Conformance
0x808CEndpointCount节点数量M
0x808EEndpointDeviceTypes节点设备类型M
0x808ASupportedEndpointDynamic支持动态模式M
0x808DEndpointArray节点数组O
0x808FEndpointFunctions节点功能O
0x80F5EndpointArrayDynamic节点动态数组O
0x808BEndpointDynamicCount动态模式数量O
0x8090SelectedEndpointDynamic当前模式O
0x8156EndpointStructure设备的Endpoint层级结构O

Command​

本 Function 不包含 Command。

数据类型​

EndpointStructureNodeStructure Type​

该结构体定义 EndpointStructure 嵌套子节点字段布局。

结构体成员序号字段名类型必须说明
0EndpointIduint16MEndpoint ID。
1ChildEndpointslist[EndpointStructureNodeStructure]O子 Endpoint 节点列表,用于表达嵌套层级。
EndpointStructureTraitPresentValueStructure Type​

该结构体定义 EndpointStructure Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EndpointIduint16M根 Endpoint ID。
1ChildEndpointslist[EndpointStructureNodeStructure]O子 Endpoint 层级结构。

Trait 定义​

Trait IDNameConformance
0x808CEndpointCountM
0x808EEndpointDeviceTypesM
0x808ASupportedEndpointDynamicM
0x808DEndpointArrayO
0x808FEndpointFunctionsO
0x80F5EndpointArrayDynamicO
0x808BEndpointDynamicCountO
0x8090SelectedEndpointDynamicO
0x8156EndpointStructureO

EndpointCount Trait(节点数量)​

指示当前 Device 所包含的 Endpoint 数量。

Trait IDCode
0x808CEndpointCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint323RVM
0x0002Maximum Valueint3265279RO
0x0003Minimum Valueint322RO
0x0005Step Valueuint321RO

EndpointDeviceTypes Trait(节点设备类型)​

描述当前 Device 所有配置实例中各 Endpoint 的 Device Type,与 EndpointArray 或 EndpointArrayDynamic 配合使用。

Trait IDCode
0x808EEndpointDeviceTypes
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVM

SupportedEndpointDynamic Trait(支持动态模式)​

指示当前 Device 实例是否支持动态配置。

Trait IDCode
0x808ASupportedEndpointDynamic
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM

EndpointArray Trait(节点数组)​

描述当前 Device 所包含 Endpoint 的所有可能组合。与 SupportedEndpointDynamic、EndpointDynamicCount 和 SelectedEndpointDynamic 配合使用。

Trait IDCode
0x808DEndpointArray
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

EndpointFunctions Trait(节点功能)​

该 Trait 用于「节点功能」相关数据的访问与上报。

Trait IDCode
0x808FEndpointFunctions
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

EndpointArrayDynamic Trait(节点动态数组)​

描述当前 Device 实例使用的 Endpoint 组合。与 EndpointArray 互斥(同一时刻仅其一有效)。

Trait IDCode
0x80F5EndpointArrayDynamic
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

EndpointDynamicCount Trait(动态模式数量)​

指示当前 Device 支持的动态 Endpoint 配置实例数量。默认值为 1。

Trait IDCode
0x808BEndpointDynamicCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint320RVO
0x0002Maximum Valueint3265279RO
0x0003Minimum Valueint320RO
0x0005Step Valueuint321RO

SelectedEndpointDynamic Trait(当前模式)​

表示 EndpointArray 的数组索引,指示当前选中的 Device Endpoint 配置实例。

Trait IDCode
0x8090SelectedEndpointDynamic
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint320RVWO
0x0002Maximum Valueint3265279RO
0x0003Minimum Valueint320RO
0x0005Step Valueuint321RO
0x0007Default Valueint320RWO

EndpointStructure Trait(设备的Endpoint层级结构)​

描述当前 Device 所用配置实例中 Endpoint 的层级结构(嵌套关系)。

Trait IDCode
0x8156EndpointStructure
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueEndpointStructureTraitPresentValueStructureRVO

Command 定义​

本 Function 不包含 Command。

EndpointLabel(节点标签)​

简介​

管理端点的可见性与展示信息,如名称、房间、图标、标签等,用于前端展示与组织。

Function 标识​

Function IDCode名称
0x0082EndpointLabel节点标签

Trait​

Trait IDCode名称Conformance
0x8093EndpointVisibility节点可见性M
0x8091EndpointName设备或卡片名称O
0x8092EndpointRoom设备或卡片所属位置idO
0x80F8EndpointRoomName设备或卡片所属房间名称O
0x8097EndpointIcon节点图标O
0x80A1EndpointApplianceType节点用途O
0x80F4EndpointStatistics节点统计O
0x8154EndpointTag节点标签O

Command​

本 Function 不包含 Command。

数据类型​

EndpointApplianceTypeEnum8 Type​

该枚举定义 EndpointApplianceType Trait 的 Present Value 有效取值。

ValueNameDescription
Light灯具用于表示灯具或提供照明控制功能的端点。
Switch开关用于表示控制电路或设备开关状态的端点。
Outlet插座用于表示受控电源插座或电源输出端点。
Fan风扇用于表示风扇类设备的端点。
Ventilation新风设备用于表示新风或通风设备的端点。
AirConditioner空调用于表示空调设备的端点。
AirPurifier空气净化器用于表示空气净化设备的端点。
Humidifier加湿器用于表示增加环境湿度的设备端点。
Dehumidifier除湿机用于表示降低环境湿度的设备端点。
TV电视用于表示电视设备的端点。
Refrigerator冰箱用于表示冰箱或冷藏设备的端点。
Computer电脑用于表示计算机设备的端点。
WaterHeater热水器用于表示制备或供应热水的设备端点。
Kettle电热水壶用于表示烧水壶类设备的端点。
MicrowaveOven微波炉用于表示微波加热或烹饪设备的端点。
Hub网关用于表示网关或中枢设备的端点。
ContactSensor接触传感器用于表示检测门窗等对象开合或接触状态的传感器端点。
Door门用于表示门体或门类设备的端点。
Window窗用于表示窗体或窗类设备的端点。
Cabinet橱柜用于表示橱柜或柜体类设备的端点。
Other其他用于表示未归入上述类别的家电或设备端点。

Trait 定义​

Trait IDNameConformance
0x8093EndpointVisibilityM
0x8091EndpointNameO
0x8092EndpointRoomO
0x80F8EndpointRoomNameO
0x8097EndpointIconO
0x80A1EndpointApplianceTypeO
0x80F4EndpointStatisticsO
0x8154EndpointTagO

EndpointVisibility Trait(节点可见性)​

描述当前 Device 所包含全部 Endpoint 的可见性。0:Invisible,1:Visible。

Trait IDCode
0x8093EndpointVisibility
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVM

EndpointName Trait(设备或卡片名称)​

描述 Endpoint 名称,字符串格式,最大长度 32。

Trait IDCode
0x8091EndpointName
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

EndpointRoom Trait(设备或卡片所属位置id)​

描述 Endpoint 所在房间的 ID,字符串格式,最大长度 32 字节。

Trait IDCode
0x8092EndpointRoom
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

EndpointRoomName Trait(设备或卡片所属房间名称)​

描述 Endpoint 所在房间名称,字符串格式,最大长度 128 字节。

Trait IDCode
0x80F8EndpointRoomName
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

EndpointIcon Trait(节点图标)​

描述当前图标 ID。可选图标列表因 Device Type 而异,厂商不可自定义。

Trait IDCode
0x8097EndpointIcon
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

EndpointApplianceType Trait(节点用途)​

描述当前家电类型(如 Light、Fan、Air Conditioner 等)。可选类型列表因 Device Type 而异。

Trait IDCode
0x80A1EndpointApplianceType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO
0x0006Supported Valuelist[characterString]RO

EndpointStatistics Trait(节点统计)​

描述设备是否可纳入统计功能。

Trait IDCode
0x80F4EndpointStatistics
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EndpointTag Trait(节点标签)​

该属性的当前值应为命名空间内语义标签的 ID。0 表示"聚合"能力,N(N > 0)指定第 N 个通道的能力。

Trait IDCode
0x8154EndpointTag
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO

Command 定义​

本 Function 不包含 Command。

Identify(识别)​

简介​

提供设备识别能力,可通过指示灯闪烁、声音等方式帮助用户定位物理设备。

Function 标识​

Function IDCode名称
0x0083Identify识别

Trait​

Trait IDCode名称Conformance
0x8094IdentifyTime识别时间M
0x8095IdentifyType识别类型M
0x8136ReverseIdentify反向识别O

Command​

Command IDCode名称Conformance
0x8096Identify识别M

数据类型​

IdentifyTypeEnum8 Type​

该枚举定义 IdentifyType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NoneNone
0x01LightLight
0x02LEDIndicatorLEDIndicator
0x03AudibleBeepAudibleBeep
0x04DisplayDisplay
0x05ActuatorActuator
Identify Command Structure Type​

Identify Command 的参数结构体。

结构体成员序号字段名类型必须说明
0IdentifyTimeuint16M设备继续自识别的剩余时间,单位为秒。值为 0 时,设备 MAY 使用默认识别时长。

Trait 定义​

Trait IDNameConformance
0x8094IdentifyTimeM
0x8095IdentifyTypeM
0x8136ReverseIdentifyO

IdentifyTime Trait(识别时间)​

指示设备将继续进行自标识的剩余时长(秒)。取值范围为 0 至 10,步长 0.1,单位为秒(s)。当值为 0 时,使用默认剩余时长。

Trait IDCode
0x8094IdentifyTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat10.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO

IdentifyType Trait(识别类型)​

指定向用户呈现标识的方式。取值:0 = 无,1 = 灯光,2 = LED 指示灯,3 = 声音提示,4 = 显示屏(屏幕可见),5 = 执行器(如窗帘或继电器动作),6-255 = 保留。

Trait IDCode
0x8095IdentifyType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueIdentifyTypeEnum80RVWM
0x0006Supported Valuelist[IdentifyTypeEnum8]RO
0x0007Default ValueIdentifyTypeEnum80RWO

ReverseIdentify Trait(反向识别)​

触发时(通过设备上的本地操作,如按键或触屏交互),设备向所有已连接的客户端工具(如手机 App、Web 应用或桌面软件)发送信号,以在该工具中定位并识别对应设备。用户可通过物理操作设备,快速在工具中找到该设备。

Trait IDCode
0x8136ReverseIdentify
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81VO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

Command 定义​

Command IDNameConformance
0x8096IdentifyM

Identify Command​

写入时,启动或停止设备自识别。

参数​

Identify Command Structure

Output(开关功能)​

简介​

提供开关输出控制能力,支持读取和控制负载的通断状态。

Function 标识​

Function IDCode名称
0x0084Output开关功能

Trait​

Trait IDCode名称Conformance
0x8098OnOff开关状态M
0x8099StartUpOnOff上电开关O
0x4E87OutputSwitchingType外接开关类型O
0x4E86OutputNodeMode开关节点模式配置O
0x4E85OutputInterlockFlag开关互锁使能配置标记O

Command​

Command IDCode名称Conformance
0x811AOff关闭O
0x8119On打开O
0x809AToggle开/关O

数据类型​

StartUpOnOffEnum8 Type​

该枚举定义 StartUpOnOff Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off上电关闭
0x01On上电开启
0x02Toggle上电反转
0x03Hold上电记忆
OutputSwitchingTypeEnum8 Type​

该枚举定义 OutputSwitchingType Trait 的 Present Value 有效取值。

ValueNameDescription
0x01NonResettableSwitch不可回弹开关
0x02MomentaryPushSwitch可回弹开关
0x03ActiveLowCloseRelay低电平闭合继电器
0x04InsertCardOnMode插卡通电模式
0x05InsertCardOffMode插卡断电模式
OutputNodeModeEnum32 Type​

该枚举定义 OutputNodeMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00WetMode湿节点模式
0x01DryPulseNormallyClosed干节点脉冲常闭模式
0x02DryPulseNormallyOpen干节点脉冲常开模式
0x03DryToggleMode干节点通断模式

Trait 定义​

Trait IDNameConformance
0x8098OnOffM
0x8099StartUpOnOffO
0x4E87OutputSwitchingTypeO
0x4E86OutputNodeModeO
0x4E85OutputInterlockFlagO

OnOff Trait(开关状态)​

写入时开启或关闭设备,即控制设备的开关状态。读取表示当前开关状态。取值:false = 关闭,true = 开启。

Trait IDCode
0x8098OnOff
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanRVWM
0x0007Default Valueboolean0RWO

StartUpOnOff Trait(上电开关)​

定义设备上电时一组自定义配置参数的启动行为(例如恢复用户自定义配置)。可能覆盖默认 OnOff 行为。

Trait IDCode
0x8099StartUpOnOff
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStartUpOnOffEnum80RVWO
0x0006Supported Valuelist[StartUpOnOffEnum8]RO
0x0007Default ValueStartUpOnOffEnum80RWO

OutputSwitchingType Trait(外接开关类型)​

定义连接到设备的外部开关类型。

Trait IDCode
0x4E87OutputSwitchingType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOutputSwitchingTypeEnum81RVWO
0x0006Supported Valuelist[OutputSwitchingTypeEnum8]RO
0x0007Default ValueOutputSwitchingTypeEnum81RWO

OutputNodeMode Trait(开关节点模式配置)​

定义输出节点的工作模式。

Trait IDCode
0x4E86OutputNodeMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOutputNodeModeEnum320RVWO
0x0006Supported Valuelist[OutputNodeModeEnum32]RO
0x0007Default ValueOutputNodeModeEnum320RWO

OutputInterlockFlag Trait(开关互锁使能配置标记)​

当两个属性的取值相同时,表示这两个属性对应的状态处于互锁关系。

Trait IDCode
0x4E85OutputInterlockFlag
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVWO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO
0x0007Default Valueuint80RWO

Command 定义​

Command IDNameConformance
0x811AOffO
0x8119OnO
0x809AToggleO

Off Command​

该 Command 用于执行「关闭」操作。

该 Command 无参数。

On Command​

该 Command 用于执行「打开」操作。

该 Command 无参数。

Toggle Command​

该 Command 用于执行「开/关」操作。

该 Command 无参数。

LevelControl(亮度控制)​

简介​

提供亮度等级调节能力,支持设置/读取当前亮度、步进调光、以及与开关联动或解耦的调光控制。

Function 标识​

Function IDCode名称
0x0085LevelControl亮度控制

Trait​

Trait IDCode名称Conformance
0x809BCurrentLevel当前等级M
0x4EACDimmingCurvature调光算法曲率O
0x4E8AStartUpBrightness上电开灯亮度值O
0x8166OffTransitionTime关闭过渡时间O
0x8165OnTransitionTime开启过渡时间O
0x4F8BInitialBrightness调光曲率初始亮度O

Command​

Command IDCode名称Conformance
0x88CBStepBrightnessWithOnOff亮度增量调节(开关)O
0x811DSetBrightnessWithOnOff设置亮度(开关)O
0x811CSetBrightness设置亮度O
0x80FEStepBrightness亮度增量调节O

数据类型​

StepBrightnessWithOnOff Command Structure Type​

StepBrightnessWithOnOff Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SizefloatM亮度增量值,范围 -100 ~ 100,正数表示亮度增加,负数表示亮度减少,单位 %。
1Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
SetBrightnessWithOnOff Command Structure Type​

SetBrightnessWithOnOff Command 的参数结构体。

结构体成员序号字段名类型必须说明
0LevelfloatM目标亮度值,范围 1 ~ 100,单位 %;默认值为 50。
1Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
SetBrightness Command Structure Type​

SetBrightness Command 的参数结构体。

结构体成员序号字段名类型必须说明
0LevelfloatM目标亮度值,范围 1 ~ 100,单位 %;默认值为 50。
1Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
2ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变 CurrentLevel Trait 的 Present Value。
StepBrightness Command Structure Type​

StepBrightness Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SizefloatM亮度增量值,范围 -100 ~ 100,正数表示亮度增加,负数表示亮度减少,单位 %。
1Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
2ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变 CurrentLevel Trait 的 Present Value。

Trait 定义​

Trait IDNameConformance
0x809BCurrentLevelM
0x4EACDimmingCurvatureO
0x4E8AStartUpBrightnessO
0x8166OffTransitionTimeO
0x8165OnTransitionTimeO
0x4F8BInitialBrightnessO

CurrentLevel Trait(当前等级)​

该 Trait 表示当前亮度等级,是 Level Control 的核心状态值。

在 Matter 侧(灯类设备)通常使用 1-254 的等级区间;Aqara 侧使用百分比语义,映射示例为 1%=1、50%=127、100%~=254。

Trait IDCode
0x809BCurrentLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO
0x000BMaximum Actual ValuefloatRVWO
0x000CMinimum Actual ValuefloatRVWO

DimmingCurvature Trait(调光算法曲率)​

该 Trait 用于指示调光算法曲线的幂值(Power),用于控制亮度在低亮区(接近最小亮度区间)内的变化速度与停留时长。

本值范围为 0.1 至 10.0。设备应在该范围内应用曲线映射,并据此调整亮度过渡的主观视觉节奏。

  • 当取值为 1.0 时,表示线性调光曲线,亮度随时间近似匀速变化。
  • 当取值大于 1.0 时,低亮区变化更慢、停留更久,整体视觉效果更接近"慢起亮、后段加速"。
  • 当取值小于 1.0 时,低亮区通过更快,亮度更早进入中高亮区,视觉上起亮更直接。

取值越大,低亮区占用的过渡时间比例越高;取值越小,低亮区占用的过渡时间比例越低。该参数仅影响过渡曲线形状,不改变命令目标亮度范围。

Trait IDCode
0x4EACDimmingCurvature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1.5RVWO
0x0002Maximum Valuefloat10.0RO
0x0003Minimum Valuefloat0.1RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat1.5RWO

StartUpBrightness Trait(上电开灯亮度值)​

该 Trait 指示设备上电后(灯开启时)采用的启动亮度。单位:%。

Trait IDCode
0x4E8AStartUpBrightness
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

OffTransitionTime Trait(关闭过渡时间)​

该 Trait 用于指示同端点 On/Off Cluster 接收到 Off 命令时的亮度过渡时长。

其语义为:设备应在该时长内将 CurrentLevel 从最大亮度逐步过渡到设备允许的最小亮度(通常对应关灯状态)。

该值单位为 ms。例如,取值 1000 表示 1000 ms,即 1 s 的关灯过渡时长。

当本 Trait 未实现,或 Present Value 为空值(null)时,设备应回退使用 OnOffTransitionTime 的配置。

Trait IDCode
0x8166OffTransitionTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint320RVWO
0x0002Maximum Valueint3210000RO
0x0003Minimum Valueint320RO
0x0005Step Valueuint32500RO
0x0007Default Valueint320RWO

OnTransitionTime Trait(开启过渡时间)​

该 Trait 用于指示同端点 On/Off Cluster 接收到 On 命令时的亮度过渡时长。

其语义为:设备应在该时长内将 CurrentLevel 从设备允许的最小亮度逐步过渡到最大亮度。

该值单位为 ms。例如,取值 1000 表示 1000 ms,即 1 s 的开灯过渡时长。

当本 Trait 未实现,或 Present Value 为空值(null)时,设备应回退使用 OnOffTransitionTime 的配置。

Trait IDCode
0x8165OnTransitionTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint320RVWO
0x0002Maximum Valueint3210000RO
0x0003Minimum Valueint320RO
0x0005Step Valueuint32500RO
0x0007Default Valueint320RWO

InitialBrightness Trait(调光曲率初始亮度)​

该 Trait 指示设备在上电或复位后开始亮度过渡时的起始亮度。

若已配置目标亮度,设备应从该初始亮度起步并逐渐过渡到目标亮度。单位:%。

Trait IDCode
0x4F8BInitialBrightness
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint8RVWO
0x0002Maximum Valueuint850RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO
0x0007Default Valueuint80RWO

Command 定义​

Command IDNameConformance
0x88CBStepBrightnessWithOnOffO
0x811DSetBrightnessWithOnOffO
0x811CSetBrightnessO
0x80FEStepBrightnessO

StepBrightnessWithOnOff Command​

该命令用于执行带开关联动的亮度步进调节。

当亮度降至最小级附近时,设备可按联动语义同步更新开关状态。

接收后行为(Effect on Receipt)​

设备接收该命令后,应先按 StepBrightness 的语义执行亮度步进:

  • 当 Size = 0 时,命令无效果,应返回 INVALID_COMMAND。
  • 当 Size ≠ 0 时,按步进方向与步进量更新 CurrentLevel;若到达设备允许的最小/最大边界,应在边界处停止,并按比例缩短实际过渡时长。

在上述行为基础上,本命令还应执行与开关联动:

  • 若命令效果会使 CurrentLevel 高于设备最小级,则同端点 OnOff 应置为 TRUE(On)。
  • 若命令效果会使 CurrentLevel 到达设备最小级,则同端点 OnOff 应置为 FALSE(Off)。
参数​

StepBrightnessWithOnOff Command Structure

SetBrightnessWithOnOff Command​

该命令用于执行带开关联动的目标亮度设置。

与 SetBrightness 相比,本命令支持在设置亮度时同时影响开关状态。

接收后行为(Effect on Receipt)​

设备接收该命令后,应先按 SetBrightness 的语义,从当前亮度连续过渡到目标亮度。

  • 过渡时长优先使用命令中的 Time。
  • 当 Time 为空时,应使用设备过渡时长配置;若无可用配置,则应以设备可实现的最快速度完成过渡。

在上述行为基础上,本命令还应执行与开关联动:

  • 若命令效果会使 CurrentLevel 高于设备最小级,则同端点 OnOff 应置为 TRUE(On)。
  • 若命令效果会使 CurrentLevel 到达设备最小级,则同端点 OnOff 应置为 FALSE(Off)。
参数​

SetBrightnessWithOnOff Command Structure

SetBrightness Command​

该命令用于设置目标亮度,不改变灯的开关状态。

接收后行为(Effect on Receipt)​

设备接收该命令后,应从当前亮度连续过渡到 Level 指定目标值。

  • 过渡时长优先使用命令中的 Time。
  • 当 Time 为空时,应使用设备过渡时长配置;若无可用配置,则应以设备可实现的最快速度完成过渡。

若设备不支持可变速率过渡,可忽略过渡时长字段。

参数​

SetBrightness Command Structure

StepBrightness Command​

该命令用于执行亮度步进调节,不改变灯的开关状态。

接收后行为(Effect on Receipt)​

当 Size = 0 时,命令无效果,应返回 INVALID_COMMAND。

当 Size ≠ 0 时,设备应按步进方向执行亮度变化:

  • Up:CurrentLevel 增加 Size,或在达到设备最大级时停止;若提前触达边界,过渡时长应按比例缩短。
  • Down:CurrentLevel 减少 Size,或在达到设备最小级时停止;若提前触达边界,过渡时长应按比例缩短。
参数​

StepBrightness Command Structure

ColorControl(颜色控制)​

简介​

提供颜色控制能力,支持通过 HSV、XY 与色温模式调节灯光颜色,并支持与亮度命令组合下发。

本 Function 提供灯光颜色调节接口。颜色定义遵循 CIE 1931 色彩空间,核心控制方式为 x、y 色度坐标(对应 ColorXY / CurrentX / CurrentY)。 此外,颜色可选通过 ColorTemperature(色温)或 Hue + Saturation 方式控制;Hue 与 Saturation 建议按 HSV(HSB)模型解释。RGB/W 原色点能力可用于扩展颜色表达范围。 本 Function 不负责亮度控制;亮度由 LevelControl Function 提供。联动控制时,LevelControl 中的亮度值应按"当前颜色下可达到最大光强的比例"解释。

Function 标识​

Function IDCode名称
0x0086ColorControl颜色控制

Trait​

Trait IDCode名称Conformance
0x809CColorMode颜色模式M
0x4F9FColorPointRGBXYRGB色彩点XY坐标O
0x4F9EWhitePointXY白点XY坐标O
0x4EE0ColorXY颜色值XYO
0x4F00LEDICQuantity调光驱动IC数量O
0x4EFFLEDICProtocol灯IC协议O
0x4EFELEDType灯珠类型O
0x4EEELightingMusicSyncMode音乐律动模式O
0x4EEDLightingMusicSyncEnable音乐律动使能配置O
0x4EECLightingDynamicSceneMode流光溢彩动态模式O
0x4E8CStartUpXYColor上电开灯XY颜色O
0x4EDFColorRGB颜色值RGBO
0x809FColorTemperature色温值O
0x4E8BStartUpColorTemperature上电开灯色温值O
0x813FSaturation饱和度O
0x813EHueHue颜色O
0x80F3CurrentB蓝色值O
0x80F2CurrentG绿色值O
0x80F1CurrentR红色值O
0x809ECurrentYY值O
0x809DCurrentXX值O
0x4FEBLightStripSegmentCount灯带总段数O
0x506BDynamicColorSequenceSetting动态序列场景设置O
0x506CDynamicSequenceOperation动态序列操作O
0x506AOtaDynamicColorSequenceResultOTA 动态序列传输结果O
0x506DIsInDynamicColorSequence是否进入动态情景模式O
0x5107DynamicColorSequences全部动态序列数据信息O

Command​

Command IDCode名称Conformance
0x88CAMoveToXYColorBrightness设置XY颜色及亮度O
0x88C9MoveToColorTemperatureBrightness设置色温及亮度O
0x88C8MoveToHueSaturationBrightness设置颜色及亮度O
0x88C7MoveToXYColor设置XY颜色O
0x88BFMoveToHueAndSaturation设置颜色O
0x88BEMoveToColorTemperature设置色温O
0x80FFStepColorTemperature色温增量调节O
0x88C0MoveToHue设置HueO
0x88C1MoveToSaturation设置饱和度O
0x9D82SaveDynamicColorSequence新增更新动态序列O
0x9D83PreviewDynamicColorSequence预览动态序列O
0x9D84RemoveDynamicColorSequence删除动态序列O
0x9D85GetDynamicColorSequenceData获取动态序列详情O
0x9D81StartDynamicColorSequence执行动态序列O
0x9D86StopDynamicColorSequence停止动态序列O

数据类型​

ColorModeEnum8 Type​

该枚举定义 ColorMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00HSV由 Hue 与 Saturation 决定当前颜色
0x01XY由 CurrentX 与 CurrentY 决定当前颜色
0x02ColorTemperature由色温值决定当前颜色
ColorPointRGBXYPresentValueStructure Type​

该结构体定义 ColorPointRGBXY 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0ColorPointRXuint16M该参数表示设备当前红色原色点在 CIE xyY 色彩空间中定义的归一化色度值 x。x 与 ColorPointRX 属性满足关系:x = ColorPointRX / 65536(ColorPointRX 取值范围为 0 至 65279,含边界)。
1ColorPointRYuint16M该参数表示设备当前红色原色点在 CIE xyY 色彩空间中定义的归一化色度值 y。y 与 ColorPointRY 属性满足关系:y = ColorPointRY / 65536(ColorPointRY 取值范围为 0 至 65279,含边界)。
2ColorPointGXuint16M该参数表示设备当前绿色原色点在 CIE xyY 色彩空间中定义的归一化色度值 x。x 与 ColorPointGX 属性满足关系:x = ColorPointGX / 65536(ColorPointGX 取值范围为 0 至 65279,含边界)。
3ColorPointGYuint16M该参数表示设备当前绿色原色点在 CIE xyY 色彩空间中定义的归一化色度值 y。y 与 ColorPointGY 属性满足关系:y = ColorPointGY / 65536(ColorPointGY 取值范围为 0 至 65279,含边界)。
4ColorPointBXuint16M该参数表示设备当前蓝色原色点在 CIE xyY 色彩空间中定义的归一化色度值 x。x 与 ColorPointBX 属性满足关系:x = ColorPointBX / 65536(ColorPointBX 取值范围为 0 至 65279,含边界)。
5ColorPointBYuint16M该参数表示设备当前蓝色原色点在 CIE xyY 色彩空间中定义的归一化色度值 y。y 与 ColorPointBY 属性满足关系:y = ColorPointBY / 65536(ColorPointBY 取值范围为 0 至 65279,含边界)。
WhitePointXYPresentValueStructure Type​

该结构体定义 WhitePointXY 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0WhitePointXuint16M该参数表示设备当前白点在 CIE xyY 色彩空间中定义的归一化色度值 x。x 与 WhitePointX 属性满足关系:x = WhitePointX / 65536(WhitePointX 取值范围为 0 至 65279,含边界)。
1WhitePointYuint16M该参数表示设备当前白点在 CIE xyY 色彩空间中定义的归一化色度值 y。y 与 WhitePointY 属性满足关系:y = WhitePointY / 65536(WhitePointY 取值范围为 0 至 65279,含边界)。
LEDICProtocolEnum8 Type​

该枚举定义 LEDICProtocol Trait 的 Present Value 有效取值。

ValueNameDescription
0x01SID单线归零码
LEDTypeEnum8 Type​

该枚举定义 LEDType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00RGBWRGBW淡彩灯珠
LightingMusicSyncModeEnum8 Type​

该枚举定义 LightingMusicSyncMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Random随机
0x01Breath呼吸
0x02Rainbow彩虹
0x03WaterFlow流水
LightingDynamicSceneModeEnum8 Type​

该枚举定义 LightingDynamicSceneMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Breath呼吸
0x01ForwardRainbow正向彩虹
0x02WaterFlow流水
0x03Flicker闪烁
0x04Jump跳变
0x05ReverseRainbow反向彩虹
0x06Floating飘动
0x07Running跑动
OtaDynamicColorSequenceResultEnum8 Type​

该枚举定义 OtaDynamicColorSequenceResult Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Delivering下发中
0x01Success成功
0x02Uninitialized未初始化
0x03Idle空闲
0x04SameVersion不需要升级,版本号一样
0x05OtaInProgress正在 OTA
0x06DeviceError失败_设备返回
0x07Timeout失败_超时
0x08OtaBusy失败_正在 OTA
0x09FileFetchFailed失败_获取文件不成功
0x0ANoMemory失败_内存未申请成功
0x0BInvalidCommandParameter命令参数无效
0x11DongleUpgradingdongle 正在升级
0x12DongleChipInfoFaileddongle 升级获取芯片信息不成功
0x13DongleChipInfoParseFaileddongle 升级获取芯片信息解析不成功
0x14DongleVersionIncompatibledongle 升级版本不兼容
0x15DongleFlashWriteFaileddongle 升级写 flash 失败
IsInDynamicColorSequenceEnum8 Type​

该枚举定义 IsInDynamicColorSequence Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NotInSequence未处于动态序列模式
0x01InSequence处于动态序列模式
DynamicSequenceModeEnum8 Type​

该枚举定义动态序列配置中的 Mode 字段有效取值。

ValueNameDescription
0x00LevelLevel 模式
0x01LevelColorTemperatureLevel + 色温模式
0x02LevelXYLevel + XY 模式
0x03SegmentedLevelXYStaticLevel + XY 分段模式(静态)
0x04SegmentedLevelXYDynamicLevel + XY 分段模式(动态)
0x05PureId纯 ID 模式
DynamicSequenceOperationFunctionCodeEnum8 Type​

该枚举定义 DynamicSequenceOperation 中 FunctionCode 字段的有效取值。

ValueNameDescription
0x00FunctionSendPreview下发自定义序列数据(预览,不持久化)
0x01FunctionSave下发自定义序列数据(持久化,需后续启动)
0x02FunctionStart启动序列模式(使用 SequenceID)
0x03FunctionDelete删除自定义序列模式(使用 SequenceID)
0x04FunctionStop停止当前序列模式(忽略 SequenceID)
0x80StatusSuccess操作成功
0x81StatusIncomplete请求已接收但操作未完成
0x82StatusInternalError内部错误(如存储不足、数据损坏)
0x83StatusInvalidAttribute属性值非法(如 ID 不存在、步数错误)
0x84StatusOtaReady设备已退出上一次 OTA,可进行下一次 OTA
SequenceStepStructure Type​

动态序列单步参数结构。

结构体成员序号字段名类型必须说明
0Durationuint32M该步骤保持时间,单位毫秒(ms)。
1LightLeveluint8M亮度值,范围 0-255(0 表示关闭)。
2TransitionTimeuint32M过渡到该步骤的时间,单位毫秒(ms)。
3XYuint32O颜色值(XY 编码)。
4ColorTempuint16O色温值(微倒度,1000000 / K)。
SequenceStructDataStructure Type​

动态序列主体结构。

结构体成员序号字段名类型必须说明
0Channeluint8M灯带通道编号(0 表示主通道或单色灯)。
1Cyclesuint16M循环执行次数(0 表示无限循环)。
2EndActioncharacterStringM结束动作,0x00 关闭灯光,0x02 保持最后一个序列状态。
3ModeDynamicSequenceModeEnum8M序列模式。
4Queueslist[SequenceStepStructure]M步骤列表。
DynamicColorSequenceInfoStructure Type​

动态序列完整信息结构。

结构体成员序号字段名类型必须说明
0SequenceIDuint32M序列 ID。
1SequenceStructDataSequenceStructDataStructureM序列内容。
2SequenceNamecharacterStringM序列名称。
3IconIDcharacterStringM图标 ID。
4UpdateTimeuint32O更新时间。
5Sourceuint8O来源(例如 1 表示 AI)。
6TypecharacterStringM类型:inner(内置)或 self(自定义)。
7Stateuint32M状态(1 表示成功)。
DynamicSequenceOperationTraitPresentValueStructure Type​

DynamicSequenceOperation Trait 的参数结构体。

结构体成员序号字段名类型必须说明
0SequenceIDuint32M动态/静态序列模式 ID。推荐范围:0x00-0x3F(自定义动态)、0x40-0x7F(预设动态)、0x80-0x9F(预设静态)、0xA0-0xBF(自定义静态)、0xFF(未指定)。
1FunctionCodeDynamicSequenceOperationFunctionCodeEnum8M客户端下发时表示功能码;设备上报时表示状态码。
2ChannelMaskuint32M多通道设备通道掩码。Bit0-Bit3 对应通道 1-4,Bit4-Bit7 保留且应为 0。仅在停止(0x04)或下发数据(0x00/0x01)时有效,其它场景应置 0。
SaveDynamicColorSequence Command Structure Type​

SaveDynamicColorSequence Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SequenceIDuint32O新增时可不填,由服务端分配新的序列 ID。
1SequenceStructDataSequenceStructDataStructureM序列主体结构。
2SequenceNamecharacterStringM序列名称。
3IconIDcharacterStringM图标 ID;设备不上报,服务器端维护。
4UpdateTimeuint32O设备不上报,服务器端维护。
5Sourceuint8O设备不上报,服务器端维护。
PreviewDynamicColorSequence Command Structure Type​

PreviewDynamicColorSequence Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SequenceStructDataSequenceStructDataStructureM预览序列内容。
RemoveDynamicColorSequence Command Structure Type​

RemoveDynamicColorSequence Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SequenceIDuint32M待删除的序列 ID。
GetDynamicColorSequenceData Command Structure Type​

GetDynamicColorSequenceData Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0SequenceIDuint32M待查询的序列 ID。
StartDynamicColorSequence Command Structure Type​

StartDynamicColorSequence Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SequenceIDuint32M待执行的序列 ID。
MoveToXYColorBrightness Command Structure Type​

MoveToXYColorBrightness Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ColorXuint16M目标颜色 X 值,范围 0 ~ 0xFEFF。
1ColorYuint16M目标颜色 Y 值,范围 0 ~ 0xFEFF。
2LevelfloatM目标亮度值,范围 1 ~ 100,单位 %;默认值为 50。
3Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
4ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变相关 Trait 的 Present Value。
MoveToColorTemperatureBrightness Command Structure Type​

MoveToColorTemperatureBrightness Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ColorTemperatureuint32M目标色温值(微倒度)。
1LevelfloatM目标亮度值,范围 1 ~ 100,单位 %;默认值为 50。
2Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
3ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变相关 Trait 的 Present Value。
MoveToHueSaturationBrightness Command Structure Type​

MoveToHueSaturationBrightness Command 的参数结构体。

结构体成员序号字段名类型必须说明
0HuefloatM色相值,范围 0 ~ 360。
1SaturationfloatM饱和度值。
2LevelfloatM目标亮度值,范围 1 ~ 100,单位 %;默认值为 50。
3Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
4ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变相关 Trait 的 Present Value。
MoveToXYColor Command Structure Type​

MoveToXYColor Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ColorXuint16M目标颜色 X 值,范围 0 ~ 0xFEFF。
1ColorYuint16M目标颜色 Y 值,范围 0 ~ 0xFEFF。
2Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
3ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变相关 Trait 的 Present Value。
MoveToHueAndSaturation Command Structure Type​

MoveToHueAndSaturation Command 的参数结构体。

结构体成员序号字段名类型必须说明
0HuefloatM色相值,范围 0 ~ 360。
1SaturationfloatM饱和度值。
2Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
3ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变相关 Trait 的 Present Value。
MoveToColorTemperature Command Structure Type​

MoveToColorTemperature Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ColorTemperatureuint32M目标色温值(微倒度)。
1Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
2ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变相关 Trait 的 Present Value。
StepColorTemperature Command Structure Type​

StepColorTemperature Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Sizeint32M色温增量值,范围 -370 ~ 370,正数表示色温增加,负数表示色温减少。
1Timeint32O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
2ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变相关 Trait 的 Present Value。
MoveToHue Command Structure Type​

MoveToHue Command 的参数结构体。

结构体成员序号字段名类型必须说明
0HuefloatM色相值,范围 0 ~ 360。
1Directionuint8O色相变化方向:0 最短路径,1 最长路径,2 向上,3 向下。
2Timeuint16O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
3ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变相关 Trait 的 Present Value。
MoveToSaturation Command Structure Type​

MoveToSaturation Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SaturationfloatM饱和度值。
1Timeuint16O过渡时间,单位 ms;取值范围 0 ~ 1000000,步进值统一为 500 ms。
2ExecuteIfOffbooleanO关灯时是否执行命令:0 表示当 OnOff Trait 的 Present Value 为 FALSE 时不执行;1 表示即使 OnOff 为 FALSE 也执行,且可能改变相关 Trait 的 Present Value。

Trait 定义​

Trait IDNameConformance
0x809CColorModeM
0x4F9FColorPointRGBXYO
0x4F9EWhitePointXYO
0x4EE0ColorXYO
0x4F00LEDICQuantityO
0x4EFFLEDICProtocolO
0x4EFELEDTypeO
0x4EEELightingMusicSyncModeO
0x4EEDLightingMusicSyncEnableO
0x4EECLightingDynamicSceneModeO
0x4E8CStartUpXYColorO
0x4EDFColorRGBO
0x809FColorTemperatureO
0x4E8BStartUpColorTemperatureO
0x813FSaturationO
0x813EHueO
0x80F3CurrentBO
0x80F2CurrentGO
0x80F1CurrentRO
0x809ECurrentYO
0x809DCurrentXO
0x4FEBLightStripSegmentCountO
0x506BDynamicColorSequenceSettingO
0x506CDynamicSequenceOperationO
0x506AOtaDynamicColorSequenceResultO
0x506DIsInDynamicColorSequenceO
0x5107DynamicColorSequencesO

ColorMode Trait(颜色模式)​

ColorMode trait 用于表示照明设备当前所工作的颜色空间,即设备当前用于接收和上报颜色数据时所采用的颜色编码格式或坐标体系,支持读和上报,不支持写。其取值为 Hue 颜色、XY 颜色、色温和 RGB 颜色四种,其中 Hue 颜色表示基于色调(Hue)的颜色描述方式,通常配合饱和度和明度使用,适合直观的色彩选择;XY 颜色表示基于 CIE 1931 色度坐标的精确颜色描述方式,具有设备无关性,适用于专业色彩管理场景;色温表示基于色温值(微导度 取值为 1000000 / 开尔文色温值)描述白光颜色,用于调节白光的冷暖感;RGB 颜色表示基于红绿蓝三基色分量描述彩色光,是最常见的全彩控制方式。需要说明的是,ColorMode 与 LightingModeSetting 是两个不同层次的 trait:LightingModeSetting 决定了设备所支持的功能集合(如是否支持色温、是否支持颜色等),影响物模型数据点的暴露,而 ColorMode 仅决定了当前颜色数据的具体编码格式,两者相互独立但共同影响设备的颜色控制行为。特别地,当该灯设备是被桥接在网关下的子设备时,网关会自动识别子设备实际所支持的颜色空间,并更新该子设备的物模型数据。因此,外部系统(如 App 或 AI 控制)要控制灯的颜色时,应依据设备的物模型中包含的 trait 和 command(例如是否包含色温控制、RGB 控制或 XY 控制等命令)来判断可发送哪些具体的颜色控制命令,而网关会自动处理颜色空间的适配、最终控制子设备。

Trait IDCode
0x809CColorMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueColorModeEnum80RVM
0x0006Supported Valuelist[ColorModeEnum8]RO

ColorPointRGBXY Trait(RGB色彩点XY坐标)​

定义 RGB 三基色在 CIE 1931 色度空间中的坐标点(R/G/B 各包含 X、Y),用于描述设备色域边界。

Trait IDCode
0x4F9FColorPointRGBXY
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueColorPointRGBXYPresentValueStructureRVO

WhitePointXY Trait(白点XY坐标)​

定义白点在 CIE 1931 色度空间中的 X、Y 坐标,用于描述设备白点基准。

Trait IDCode
0x4F9EWhitePointXY
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWhitePointXYPresentValueStructureRVO

ColorXY Trait(颜色值XY)​

ColorXY 用于表示 CIE 1931 色彩空间中的 x 与 y。

ColorXY 的高两个字节对应 CurrentX,低两个字节对应 CurrentY;CurrentX 和 CurrentY 与 CIE 1931 色彩空间中的 x 与 y 的转换关系如下:x = CurrentX / 65535、y = CurrentY / 65535。

Trait IDCode
0x4EE0ColorXY
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32O0RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint32O0RWO

LEDICQuantity Trait(调光驱动IC数量)​

指示调光驱动器 IC 的数量。

Trait IDCode
0x4F00LEDICQuantity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVWO
0x0002Maximum Valueuint16100RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint160RWO

LEDICProtocol Trait(灯IC协议)​

指示 LED 的 IC 协议。

Trait IDCode
0x4EFFLEDICProtocol
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLEDICProtocolEnum80RVWO
0x0006Supported Valuelist[LEDICProtocolEnum8]RO
0x0007Default ValueLEDICProtocolEnum80RWO

LEDType Trait(灯珠类型)​

指示 LED 灯珠类型。

Trait IDCode
0x4EFELEDType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLEDTypeEnum80RVWO
0x0006Supported Valuelist[LEDTypeEnum8]RO
0x0007Default ValueLEDTypeEnum80RWO

LightingMusicSyncMode Trait(音乐律动模式)​

确定启用后灯光如何随音乐响应(如随机效果、呼吸过渡、彩虹流动或水波纹等)。

Trait IDCode
0x4EEELightingMusicSyncMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLightingMusicSyncModeEnum8O0RVWO
0x0006Supported Valuelist[LightingMusicSyncModeEnum8]RO
0x0007Default Valueuint8O0RWO

LightingMusicSyncEnable Trait(音乐律动使能配置)​

使灯光颜色与亮度随音乐节奏同步变化,实现动态视听效果。

Trait IDCode
0x4EEDLightingMusicSyncEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanO0RVWO
0x0007Default ValuebooleanO0RWO

LightingDynamicSceneMode Trait(流光溢彩动态模式)​

支持动态灯光效果(如彩虹流动、呼吸渐变、闪烁等),并提供"正向彩虹"或"瀑布"等预设场景,呈现丰富的视觉体验。

Trait IDCode
0x4EECLightingDynamicSceneMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLightingDynamicSceneModeEnum8O0RVWO
0x0006Supported Valuelist[LightingDynamicSceneModeEnum8]RO
0x0007Default Valueuint8O0RWO

StartUpXYColor Trait(上电开灯XY颜色)​

ColorXY表示CIE xyY颜色空间中的x和y值,包含ColorX和ColorY元素,其中x = ColorX/65535 ,其中y = ColorY/65535。

Trait IDCode
0x4E8CStartUpXYColor
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32O0RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint32O0RWO

ColorRGB Trait(颜色值RGB)​

ColorRGB表示RGB颜色空间中的24位颜色值,按 0xRRGGBB 打包,不包含 Alpha 通道。

Trait IDCode
0x4EDFColorRGB
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32O0RVWO
0x0002Maximum Valueuint3216777215RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint32O0RWO

ColorTemperature Trait(色温值)​

该 Trait 用于色温值的访问与上报。

实现中常使用 Kelvin 与 Mired 互转:Mired = 1000000 / Kelvin。

Trait IDCode
0x809FColorTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32O270RVWO
0x0002Maximum Valueuint32500RO
0x0003Minimum Valueuint32153RO
0x0005Step Valueuint321RO
0x0007Default Valueuint32O270RWO

StartUpColorTemperature Trait(上电开灯色温值)​

设置设备上电且灯开启时应用的默认色温。单位:mired。

Trait IDCode
0x4E8BStartUpColorTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32O270RVWO
0x0002Maximum Valueuint32370RO
0x0003Minimum Valueuint32153RO
0x0005Step Valueuint321RO
0x0007Default Valueuint32O270RWO

Saturation Trait(饱和度)​

包含光源当前饱和度。

与 Matter CurrentSaturation 互转关系为:Saturation(0~1) = CurrentSaturation / 254,在 Aqara 百分比视图中可按 0-100% 展示。

Trait IDCode
0x813FSaturation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default ValuefloatO50RWO

Hue Trait(Hue颜色)​

包含光源的当前色调值,以度为单位( 0-360 )。

与 Matter CurrentHue 互转关系为:Hue(deg) = CurrentHue * 360 / 254。单位: deg。

Trait IDCode
0x813EHue
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat360.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

CurrentB Trait(蓝色值)​

该 Trait 用于「蓝色值」相关数据的访问与上报。

Trait IDCode
0x80F3CurrentB
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint320RVWO
0x0002Maximum Valueint32255RO
0x0003Minimum Valueint320RO
0x0005Step Valueuint321RO
0x0007Default Valueint320RWO

CurrentG Trait(绿色值)​

该 Trait 用于「绿色值」相关数据的访问与上报。

Trait IDCode
0x80F2CurrentG
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint320RVWO
0x0002Maximum Valueint32255RO
0x0003Minimum Valueint320RO
0x0005Step Valueuint321RO
0x0007Default Valueint320RWO

CurrentR Trait(红色值)​

该 Trait 用于「红色值」相关数据的访问与上报。

Trait IDCode
0x80F1CurrentR
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint320RVWO
0x0002Maximum Valueint32255RO
0x0003Minimum Valueint320RO
0x0005Step Valueuint321RO
0x0007Default Valueint320RWO

CurrentY Trait(Y值)​

该 Trait 表示 CIE 1931 色度坐标 y 分量。

关系式为:y = CurrentY / 65536,且 CurrentY 有效范围为 0-65279。

Trait IDCode
0x809ECurrentY
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVWO
0x0002Maximum Valueuint1665279RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint160RWO

CurrentX Trait(X值)​

该 Trait 表示 CIE 1931 色度坐标 x 分量。

关系式为:x = CurrentX / 65536,且 CurrentX 有效范围为 0-65279。

Trait IDCode
0x809DCurrentX
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVWO
0x0002Maximum Valueuint1665279RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint160RWO

LightStripSegmentCount Trait(灯带总段数)​

指示连接到控制模块的灯带总段数(可寻址区段)。

Trait IDCode
0x4FEBLightStripSegmentCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32O10RVWO
0x0002Maximum Valueuint3250RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint32O10RWO

DynamicColorSequenceSetting Trait(动态序列场景设置)​

该 Trait 用于「动态序列场景设置」相关数据的访问与上报。

Trait IDCode
0x506BDynamicColorSequenceSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

DynamicSequenceOperation Trait(动态序列操作)​

该 Trait 用于表示写动态序列的相关操作配置。

Trait IDCode
0x506CDynamicSequenceOperation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDynamicSequenceOperationTraitPresentValueStructureRVWO

OtaDynamicColorSequenceResult Trait(OTA 动态序列传输结果)​

该 Trait 用于表示动态序列下发结果的上报。

Trait IDCode
0x506AOtaDynamicColorSequenceResult
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOtaDynamicColorSequenceResultEnum80RVO
0x0006Supported Valuelist[OtaDynamicColorSequenceResultEnum8]RO

IsInDynamicColorSequence Trait(是否进入动态情景模式)​

该 Trait 用于表示是否进入动态情景模式。

Trait IDCode
0x506DIsInDynamicColorSequence
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueIsInDynamicColorSequenceEnum80RVO
0x0006Supported Valuelist[IsInDynamicColorSequenceEnum8]RO

DynamicColorSequences Trait(全部动态序列数据信息)​

该 Trait 用于上报全部动态序列数据信息。

Trait IDCode
0x5107DynamicColorSequences
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[DynamicColorSequenceInfoStructure]RVO

Command 定义​

Command IDNameConformance
0x88CAMoveToXYColorBrightnessO
0x88C9MoveToColorTemperatureBrightnessO
0x88C8MoveToHueSaturationBrightnessO
0x88C7MoveToXYColorO
0x88BFMoveToHueAndSaturationO
0x88BEMoveToColorTemperatureO
0x80FFStepColorTemperatureO
0x88C0MoveToHueO
0x88C1MoveToSaturationO
0x9D82SaveDynamicColorSequenceO
0x9D83PreviewDynamicColorSequenceO
0x9D84RemoveDynamicColorSequenceO
0x9D85GetDynamicColorSequenceDataO
0x9D81StartDynamicColorSequenceO
0x9D86StopDynamicColorSequenceO
通用使用说明​

当设备接收到本节任一颜色控制命令时,实现应在设备硬件能力范围内,选择与请求颜色尽可能接近的目标颜色。颜色"真实表现"的定义不在本规范范围内;但只要接收命令中的颜色数据字段处于本规范允许范围,且不存在错误条件,返回状态码应为 Success。

以 MoveToColorTemperature 命令为例:若目标色温超出硬件可达范围,设备应在到达物理最小值或最大值时进行截断(取决于色温过渡方向),该到达时刻可早于请求过渡时间结束。

若颜色循环处于激活状态(ColorLoopActive = 1),仅可通过发送显式请求"关闭颜色循环"的 ColorLoopSet 命令停止循环;不应因其他带"停止语义"的命令而停止(例如 MoveMode = Stop 的 EnhancedMoveToHue,或 StopMoveStep)。此外,在颜色循环激活期间,厂商可选择忽略会改变 Hue 的输入颜色命令。

ColorMode 切换说明​

当设备接收到本节任一颜色命令时,首个处理动作应为将 ColorMode 切换到该命令对应模式(见各命令定义)。

当从一种颜色模式切换到另一种颜色模式时(例如从 CurrentX/CurrentY 切换到 CurrentHue/CurrentSaturation),命令起始颜色应基于旧模式属性值换算得到新模式属性值,再作为新模式下的起始点执行。

当从色域范围更宽的模式切换到色域范围更受限的模式时(例如 CurrentX/CurrentY 切换到 CurrentHue/CurrentSaturation,或 CurrentHue/CurrentSaturation 切换到 ColorTemperatureMireds),当前颜色在新模式下可能不存在等效值。此类场景行为由厂商定义,建议在使用过程中尽量避免此类模式切换。

MoveToXYColorBrightness Command​

该命令用于同时设置 XY 颜色与亮度。

通常等效为组合下发 MoveToColor 与 MoveToLevelWithOnOff。

接收后行为(Effect on Receipt)​

设备接收该命令后,应先按 MoveToXYColor 的语义设置目标 XY 颜色(ColorMode 切换为 XY),并按过渡时间连续移动到目标颜色;同时按 MoveToLevelWithOnOff 的语义设置目标亮度并处理开关联动。

颜色过渡路径未强制规定,建议采用 CIE xyY 空间中的最短路径。

参数​

MoveToXYColorBrightness Command Structure

MoveToColorTemperatureBrightness Command​

该命令用于同时设置色温与亮度。

通常等效为组合下发 MoveToColorTemperature 与 MoveToLevelWithOnOff。

接收后行为(Effect on Receipt)​

设备接收该命令后,应先按 MoveToColorTemperature 的语义执行色温过渡(ColorMode 切换为 ColorTemperature),并按 MoveToLevelWithOnOff 的语义执行亮度与开关联动。

若目标色温超出设备物理能力范围,应按设备可达最小/最大色温进行截断。

参数​

MoveToColorTemperatureBrightness Command Structure

MoveToHueSaturationBrightness Command​

该命令用于同时设置 Hue/Saturation 与亮度。

通常等效为组合下发 MoveToHueAndSaturation 与 MoveToLevelWithOnOff。

接收后行为(Effect on Receipt)​

设备接收该命令后,应先将 ColorMode 切换为 HSV,并按连续过渡方式从当前 Hue/Saturation 过渡到目标值;同时按 MoveToLevelWithOnOff 语义执行亮度与开关联动。

参数​

MoveToHueSaturationBrightness Command Structure

MoveToXYColor Command​

该命令用于设置 XY 颜色。

执行后设备应将 ColorMode 切换为 XY 模式。

接收后行为(Effect on Receipt)​

设备接收该命令后,应将 ColorMode(若实现)设置为 XY 模式,并从当前颜色连续过渡到 ColorX/ColorY 指定的目标颜色。

过渡时长应与 Time 字段一致。颜色空间过渡路径未强制规定,建议采用 CIE xyY 空间中的最短路径(可视为"直线"路径)。

参数​

MoveToXYColor Command Structure

MoveToHueAndSaturation Command​

该命令用于设置 Hue 与 Saturation。

执行后设备应将 ColorMode 切换为 HSV 模式。

接收后行为(Effect on Receipt)​

设备接收该命令后,应将 ColorMode 切换为 HSV 模式,并从当前 Hue/Saturation 连续过渡到目标 Hue/Saturation。

过渡时长应与 Time 字段一致。过渡路径未强制规定,建议采用颜色空间中的最短路径。

参数​

MoveToHueAndSaturation Command Structure

MoveToColorTemperature Command​

该命令用于设置色温。

执行后设备应将 ColorMode 切换为 ColorTemperature 模式。

接收后行为(Effect on Receipt)​

设备接收该命令后,应将 ColorMode(若实现)设置为 ColorTemperature 模式,并从当前色温连续过渡到目标色温。

过渡时长应与 Time 字段一致。按该模式定义,色温过渡路径沿黑体轨迹(Black Body Line)变化。

若目标值小于设备物理最小色温(Mired)或大于设备物理最大色温(Mired),应分别截断到物理最小/最大值作为最终目标。

参数​

MoveToColorTemperature Command Structure

StepColorTemperature Command​

该命令用于按步长执行色温增量调节。

接收后行为(Effect on Receipt)​

当 StepSize = 0 时,命令不产生效果,并应返回 INVALID_COMMAND。

当 StepSize > 0 时,设备应将 ColorMode(及对应增强模式,若实现)设置为 ColorTemperature 模式,并按 StepMode 指定方向执行一步色温变化:

  • Up:增加 Mired(即降低开尔文色温)。
  • Down:减少 Mired(即升高开尔文色温)。

当达到设备允许边界(配置边界或物理边界)时,步进操作应停止。

参数​

StepColorTemperature Command Structure

MoveToHue Command​

该命令用于设置目标 Hue(可选带方向与时间)。

接收后行为(Effect on Receipt)​

设备接收该命令后,应将 ColorMode 切换为 HSV 模式,并从当前 Hue 连续过渡到目标 Hue。

过渡时长应与 Time 字段一致;方向由 Direction 字段决定:

  • 最短路径:沿色相环最短方向移动。
  • 最长路径:沿色相环最长方向移动(常用于彩虹效果)。
  • 当两方向距离相等时,应采用 Up 方向。
参数​

MoveToHue Command Structure

MoveToSaturation Command​

该命令用于设置目标 Saturation(可选带时间)。

接收后行为(Effect on Receipt)​

设备接收该命令后,应将 ColorMode 切换为 HSV 模式,并从当前 Saturation 连续过渡到目标 Saturation。

过渡时长应与 Time 字段一致。

参数​

MoveToSaturation Command Structure

SaveDynamicColorSequence Command​

该命令用于新增或更新动态序列。

参数​

SaveDynamicColorSequence Command Structure

PreviewDynamicColorSequence Command​

该命令用于预览动态序列内容。

参数​

PreviewDynamicColorSequence Command Structure

RemoveDynamicColorSequence Command​

该命令用于删除指定动态序列。

参数​

RemoveDynamicColorSequence Command Structure

GetDynamicColorSequenceData Command​

该命令用于获取指定动态序列详情。

参数​

GetDynamicColorSequenceData Command Structure

StartDynamicColorSequence Command​

该命令用于执行指定动态序列。

参数​

StartDynamicColorSequence Command Structure

StopDynamicColorSequence Command​

该命令用于停止动态序列执行。

该 Command 无参数。

Button(按钮功能)​

简介​

描述按钮类输入设备的事件上报,包括单击、长按、多击等动作识别。

Function 标识​

Function IDCode名称
0x0087Button按钮功能

Trait​

Trait IDCode名称Conformance
0x80A0ButtonEvent按钮事件M
0x8155LocalControlDisabled开关是否禁用本地控制(转无线开关功能)O
0x4E89SpeedModeSetting按键速度模式切换O

Command​

本 Function 不包含 Command。

数据类型​

ButtonEventEnum8 Type​

该枚举定义 ButtonEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x00SinglePress单击
0x01DoublePress双击
0x02LongPress长按
0x03LongPressRelease长按释放
SpeedModeSettingEnum8 Type​

该枚举定义 SpeedModeSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x01FastClickMode极速单击模式
0x02MultiFuncMode多功能模式

Trait 定义​

Trait IDNameConformance
0x80A0ButtonEventM
0x8155LocalControlDisabledO
0x4E89SpeedModeSettingO

ButtonEvent Trait(按钮事件)​

该 Trait 用于「按钮事件」相关数据的访问与上报。

Trait IDCode
0x80A0ButtonEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueButtonEventEnum80VM
0x0006Supported Valuelist[ButtonEventEnum8]RO

LocalControlDisabled Trait(开关是否禁用本地控制(转无线开关功能))​

描述按钮是否禁用关联的本地设备控制功能(如继电器控制)。若禁用,点击按钮无法开启或关闭本地执行器。

Trait IDCode
0x8155LocalControlDisabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SpeedModeSetting Trait(按键速度模式切换)​

定义按键操作的速度模式,例如 Fast Click Mode 和 Multi-Function Mode。

Trait IDCode
0x4E89SpeedModeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSpeedModeSettingEnum81RVWO
0x0006Supported Valuelist[SpeedModeSettingEnum8]RO
0x0007Default Valueuint81RWO

Command 定义​

本 Function 不包含 Command。

Camera(摄像机)​

简介​

管理摄像机基础能力,包括设备状态、模式切换、图像加密及云端相关能力。

Function 标识​

Function IDCode名称
0x0088Camera摄像机

Trait​

Trait IDCode名称Conformance
0x5001CloudRecordingMode云端录像模式O
0x5000HdrEnableHDR使能O
0x4FFFCloudTimelapseInfo云端延时摄影信息O
0x4E3EP2PCaptureEnabled是否支持P2P抓图O
0x50D8P2PVideoEnableP2P视频使能O
0x4FC9CameraAdvancedEventNotificationSettings摄像机高级事件通知设置O
0x4FE9CloudClipRecordingType云端小视频录制类型O
0x4FE8ZoomRatio变焦倍率设置O
0x4FE6ImageEncryptionKey图片加密密钥O
0x4FE0LensObstructionPushEnable镜头遮挡推送使能O
0x4FDFLensObstructionTimePeriod镜头遮挡侦测时段O
0x4FDELensObstructionEnable镜头遮挡使能O
0x4FDBWhiteLightDuration白光灯持续时长O
0x4FDDCloudAISupportedAlgorithm云端支持的AI算法O
0x4FDAEventLightingMode事件触发亮灯模式O
0x4FD9ActiveWakeupInterval主动唤醒间隔O
0x4FD7CameraMatterCapability摄像机Matter 能力O
0x4FD8CamWorkMode摄像机工作模式O
0x4FD6AOVRecordingEnableAOV录像使能O
0x4FD2RecordingMode录像模式O
0x4FD3RangeTestMode进入测距测试模式O
0x4FD1RecordingMuteEnable无声录制使能O
0x4FD0VideoCorrectionEnable视频矫正使能O
0x4FCEOSDTimeFormatSetting时间水印格式设置O
0x4FCFImageFlipMode画面翻转O
0x4FCBOSDWatermarkEnableOSD时间水印使能O
0x4FCAInfraredNightVisionSetting夜视设置O
0x4FC8TimelapseTimePeriod延时摄影时段O
0x4FC7TimelapseEnable延时摄影使能O
0x5027DynamicCoverRefreshEnable动态刷新封面使能O
0x5028PeriodicSnapshotUploadEnable定时上传图片使能O
0x5026CloudRecordingEnable录制云端视频总使能O
0x501DTheftModeNotificationEnable丢失模式推送使能O
0x501CTheftModeEnable丢失模式使能O
0x501BScheduledSleepTimePeriod定时休眠时段O
0x5019AIDetectionBoxEnable显示识别框使能O
0x501AScheduledSleepEnable定时休眠使能O
0x5018PrivacyMaskRegions隐私遮挡区域O
0x5017PowerFrequency电源频率O
0x5014WhiteLightOnOff白光补光灯开关O
0x5016WhiteLightBrightness白光灯设置亮度O
0x5013CameraEventImportanceLevel摄像机事件重要等级级别O
0x5012CameraAdvancedEventNotificationEnable摄像机高级事件通知使能O
0x5010CameraNotificationSchedulePeriods摄像机通知计划-时段O
0x5011CameraFilterUnimportantNotifications摄像机过滤不重要的通知使能O
0x500FCameraNotificationScheduleEnable摄像机通知计划使能O
0x500ECameraNotificationType摄像机通知类型O
0x516DAlexaDetectionEventsAlexa支持的侦测事件O
0x4FFCLensObstructionRecordEnable镜头遮挡录像使能O
0x4FFDLensObstructionInterval镜头遮挡侦测间隔O
0x4FFBLensObstructionSensitivity镜头遮挡侦测灵敏度O
0x4FC5AIModelSilenceOTAEnableAI算法模型静默升级使能O
0x4FC6SetDetectionMode侦测类型O
0x4FC3AIVideoSummaryEnableAI视频摘要使能O
0x4FC2AIVideoSearchEnableAI视频搜索使能O
0x4FC1SupportLocalVideoDownload是否支持本地录像下载O
0x4FBFLightingTimePeriod亮灯时段O
0x4FC0RelatedEventRecordEnable关联事件录像使能O
0x4FBELightUpWhenEventDetected侦测到事件时亮灯O
0x4FB0LogoWatermarkEnableLogo水印使能O
0x4F91CameraRTSPEnable摄像机RTSP使能O
0x4F90CameraRTSPURL摄像头RTSP地址O
0x517CLiveChannel实时视频通道O
0x517DPlaybackChannel回放视频通道O
0x4E44P2PCaptureStatusP2P动态取图状态O
0x80C0Volume音量O
0x80A2CameraActiveStatus摄像头休眠状态O

Command​

Command IDCode名称Conformance
0x9DADThirdPartySnapshotTrigger第三方触发抓图O
0x9D3EWhiteLightToggle白光灯状态切换控制O
0x9D3DSnapshotUploadCommand拍照并上传O
0x9D3BFormatSDCardCommand格式化存储卡O
0x9D3ACameraActiveToggle摄像机休眠切换命令O

数据类型​

CloudRecordingModeEnum8 Type​

该枚举定义 CloudRecordingMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Event事件录像
0x01Continuous全时录像
CloudTimelapseInfoTraitPresentValueStructure Type​

该结构体定义 CloudTimelapseInfo Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0task_numcharacterStringM任务数量。
1taskarray[Struct]M云端延时摄影任务数组。每个 Task 包含 id、active、repeat、start_date、end_date、start_time、end_time 和 interval。
CloudClipRecordingTypeEnum8 Type​

该枚举定义 CloudClipRecordingType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Default默认
0x01Recording录制
0x16AssociatedEvent关联事件
0x1BSecurityAssociated安防关联事件
LensObstructionTimePeriodTraitPresentValueStructure Type​

该结构体定义 LensObstructionTimePeriod Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
CloudAISupportedAlgorithmEnum8 Type​

该枚举定义 CloudAISupportedAlgorithm Trait 的 Present Value 有效取值。

ValueNameDescription
0x00HumanRecognition人形检测
0x01FaceRecognition人脸识别
0x02PetRecognition猫狗识别
0x03VehicleDetection车辆检测
0x04PackageRecognition包裹识别
0x05FlameDetection火焰检测
EventLightingModeEnum8 Type​

该枚举定义 EventLightingMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Steady常亮
0x01Blink闪烁
CamWorkModeEnum8 Type​

该枚举定义 CamWorkMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00PowerSaving省电模式
0x01SuperPowerSaving超级省电模式
0x02MainsPower常电模式
0x03AOV智能监护模式(AOV)
RecordingModeTraitPresentValueStructure Type​

该结构体定义 RecordingMode Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0modeuint32M录像模式:0=Off,1=Continuous recording,2=Event-triggered recording。
1coveruint32M存储覆盖策略;1 表示存储满时循环覆盖。
ImageFlipModeEnum8 Type​

该枚举定义 ImageFlipMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01HorizontalFlip水平翻转
0x02VerticalFlip垂直翻转
0x03HorizontalVerticalFlip水平垂直翻转
InfraredNightVisionSettingEnum8 Type​

该枚举定义 InfraredNightVisionSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00AlwaysOff一直关闭
0x01AlwaysOn一直开启
0x02Auto自动切换
0x03WarmColorFullColor暖光全彩
TimelapseTimePeriodTraitPresentValueStructure Type​

该结构体定义 TimelapseTimePeriod Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
ScheduledSleepTimePeriodTraitPresentValueStructure Type​

该结构体定义 ScheduledSleepTimePeriod Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
PrivacyMaskRegionsTraitPresentValueStructure Type​

该结构体定义 PrivacyMaskRegions Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0visiblebooleanM是否在实时预览中显示遮罩区域轮廓。
1regionsarray[Struct]M隐私遮罩区域数组,最多 4 个。每个 Region 包含 color 和 rect。
PowerFrequencyEnum8 Type​

该枚举定义 PowerFrequency Trait 的 Present Value 有效取值。

ValueNameDescription
0x0050Hz50Hz
0x0160Hz60Hz
CameraNotificationSchedulePeriodsTraitPresentValueStructure Type​

该结构体定义 CameraNotificationSchedulePeriods Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
CameraNotificationTypeEnum8 Type​

该枚举定义 CameraNotificationType Trait 的 Present Value 有效取值。

ValueNameDescription
0x01EventNotification事件通知
0x02AIVideoSummaryAI视频摘要通知
LiveChannelEnum8 Type​

该枚举定义 LiveChannel Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Main主码流
0x01Sub次码流
0x02Third第三码流
0x03Other其他
PlaybackChannelEnum8 Type​

该枚举定义 PlaybackChannel Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Main主码流
0x01Sub次码流
0x02Third第三码流
0x03Other其它
AlexaDetectionEventsEnum8 Type​

该枚举定义 AlexaDetectionEvents Trait 的数组成员有效取值。

ValueNameDescription
0x01HumanRecognition人形识别
0x02PackageRecognition包裹识别
ThirdPartySnapshotTriggerSourceEnum8 Type​

该枚举定义 ThirdPartySnapshotTrigger Command 的 source 字段有效取值。

ValueNameDescription
0x01AlexaAmazon Alexa
LensObstructionSensitivityEnum8 Type​

该枚举定义 LensObstructionSensitivity Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高
SetDetectionModeEnum8 Type​

该枚举定义 SetDetectionMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00FaceRecognition人脸识别
0x01HumanDetection人形识别
0x02PetDetection猫狗识别
0x03PackageDetection包裹识别
0x04HumanLoitering有人逗留
0x05LensBlocking镜头遮挡识别
LightingTimePeriodTraitPresentValueStructure Type​

该结构体定义 LightingTimePeriod Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
WhiteLightToggle Command Structure Type​

WhiteLightToggle Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M命令类型。
SnapshotUploadCommand Command Structure Type​

SnapshotUploadCommand Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M命令类型。取值:0:Default(默认);1:Capture(拍照)。
FormatSDCardCommand Command Structure Type​

FormatSDCardCommand Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M命令类型。
CameraActiveToggle Command Structure Type​

CameraActiveToggle Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M命令类型。
ThirdPartySnapshotTrigger Command Structure Type​

ThirdPartySnapshotTrigger Command 的参数结构体。该 Command 由第三方生态平台(如 Alexa)调用,触发设备执行抓图操作。

结构体成员序号字段名类型必须说明
0SourceThirdPartySnapshotTriggerSourceEnum8M触发来源标识。0x01 = Alexa(Amazon Alexa),其他值预留扩展。

Trait 定义​

Trait IDNameConformance
0x5001CloudRecordingModeO
0x5000HdrEnableO
0x4FFFCloudTimelapseInfoO
0x4E3EP2PCaptureEnabledO
0x50D8P2PVideoEnableO
0x4FC9CameraAdvancedEventNotificationSettingsO
0x4FE9CloudClipRecordingTypeO
0x4FE8ZoomRatioO
0x4FE6ImageEncryptionKeyO
0x4FE0LensObstructionPushEnableO
0x4FDFLensObstructionTimePeriodO
0x4FDELensObstructionEnableO
0x4FDBWhiteLightDurationO
0x4FDDCloudAISupportedAlgorithmO
0x4FDAEventLightingModeO
0x4FD9ActiveWakeupIntervalO
0x4FD7CameraMatterCapabilityO
0x4FD8CamWorkModeO
0x4FD6AOVRecordingEnableO
0x4FD2RecordingModeO
0x4FD3RangeTestModeO
0x4FD1RecordingMuteEnableO
0x4FD0VideoCorrectionEnableO
0x4FCEOSDTimeFormatSettingO
0x4FCFImageFlipModeO
0x4FCBOSDWatermarkEnableO
0x4FCAInfraredNightVisionSettingO
0x4FC8TimelapseTimePeriodO
0x4FC7TimelapseEnableO
0x5027DynamicCoverRefreshEnableO
0x5028PeriodicSnapshotUploadEnableO
0x5026CloudRecordingEnableO
0x501DTheftModeNotificationEnableO
0x501CTheftModeEnableO
0x501BScheduledSleepTimePeriodO
0x5019AIDetectionBoxEnableO
0x501AScheduledSleepEnableO
0x5018PrivacyMaskRegionsO
0x5017PowerFrequencyO
0x5014WhiteLightOnOffO
0x5016WhiteLightBrightnessO
0x5013CameraEventImportanceLevelO
0x5012CameraAdvancedEventNotificationEnableO
0x5010CameraNotificationSchedulePeriodsO
0x5011CameraFilterUnimportantNotificationsO
0x500FCameraNotificationScheduleEnableO
0x500ECameraNotificationTypeO
0x516DAlexaDetectionEventsO
0x4FFCLensObstructionRecordEnableO
0x4FFDLensObstructionIntervalO
0x4FFBLensObstructionSensitivityO
0x4FC5AIModelSilenceOTAEnableO
0x4FC6SetDetectionModeO
0x4FC3AIVideoSummaryEnableO
0x4FC2AIVideoSearchEnableO
0x4FC1SupportLocalVideoDownloadO
0x4FBFLightingTimePeriodO
0x4FC0RelatedEventRecordEnableO
0x4FBELightUpWhenEventDetectedO
0x4FB0LogoWatermarkEnableO
0x4F91CameraRTSPEnableO
0x4F90CameraRTSPURLO
0x517CLiveChannelO
0x517DPlaybackChannelO
0x4E44P2PCaptureStatusO
0x80C0VolumeO
0x80A2CameraActiveStatusO

CloudRecordingMode Trait(云端录像模式)​

指示云端录像类型。值 0 表示事件触发录像(仅在事件发生时),1 表示连续录像(24/7)。

Trait IDCode
0x5001CloudRecordingMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCloudRecordingModeEnum80RVWO
0x0006Supported Valuelist[CloudRecordingModeEnum8]RO
0x0007Default Valueuint80RWO

HdrEnable Trait(HDR使能)​

启用或禁用 HDR(High Dynamic Range,高动态范围)功能。启用后,设备在逆光或高对比度场景中改善画质,保留亮部和暗部细节,画面更清晰自然。

Trait IDCode
0x5000HdrEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CloudTimelapseInfo Trait(云端延时摄影信息)​

提供云端延时摄影任务信息,包括任务数量、任务 ID、激活状态、每日重复标志、起止日期、起止时间(绝对时间或相对日出/日落)及拍摄间隔。

Trait IDCode
0x4FFFCloudTimelapseInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCloudTimelapseInfoTraitPresentValueStructureRVWO

P2PCaptureEnabled Trait(是否支持P2P抓图)​

指示摄像头是否启用 P2P(peer-to-peer)抓拍功能。

Trait IDCode
0x4E3EP2PCaptureEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVO
0x0007Default Valueboolean1RWO

P2PVideoEnable Trait(P2P视频使能)​

启用或禁用摄像机的 P2P 视频传输能力。启用后可通过点对点链路建立视频连接。

Trait IDCode
0x50D8P2PVideoEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CameraAdvancedEventNotificationSettings Trait(摄像机高级事件通知设置)​

配置摄像机发送通知的高级事件集。该值是一个由事件类型编号组成的字符串,由垂直条(|)分隔,例如"39 | 40 | 111 | 108"。每个数字对应于以下列出的特定事件类型。只有数字包含在字符串中的事件才会触发通知。Value Event Description (英文) 1 运动检测 2 人形 3 有猫或狗在场 4 人类游荡 5 按下门铃 6 篡改警报 7 家庭成员认可 8 陌生人认出 9 异常哭泣 10 哭泣 11 咳嗽 12 报警声音 13 狗叫声 14 镜头被挡住 15 检测到包裹 16个 包裹消失 17 车辆存在 32 婴儿床 33 婴儿推车 38 玩具车 39 面罩/口罩 40 口鼻遮盖 46 拿着手机 48 人fallen 50 人攀岩 53 人吸烟 56 戴帽子 58 狗 59 猫 60 饮用水 61 进食 62 使用马桶 63 动物 64 宠物 65 鸟 66 熊 67 棕熊 68 松鼠 69 兔子 70 鹿 71 驯鹿

Trait IDCode
0x4FC9CameraAdvancedEventNotificationSettings
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

CloudClipRecordingType Trait(云端小视频录制类型)​

指示触发的云端短视频(片段)录像类型。值 0 = 默认(未指定),1 = 录像(一般事件),22 = 关联事件(由其他传感器/设备触发),27 = 安防关联事件(例如看家报警)。该特征可被设备读取、写入并主动上报。

Trait IDCode
0x4FE9CloudClipRecordingType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCloudClipRecordingTypeEnum80RVWO
0x0006Supported Valuelist[CloudClipRecordingTypeEnum8]RO
0x0007Default Valueuint80RWO

ZoomRatio Trait(变焦倍率设置)​

控制摄像头的变焦倍率。数值越大,拍摄主体越近。

Trait IDCode
0x4FE8ZoomRatio
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVWO
0x0002Maximum Valuefloat9.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat1RWO

ImageEncryptionKey Trait(图片加密密钥)​

提供用于在推送至云端或客户端之前加密图像(快照)的加密密钥。

Trait IDCode
0x4FE6ImageEncryptionKey
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

LensObstructionPushEnable Trait(镜头遮挡推送使能)​

启用或禁用镜头遮挡事件的推送通知。启用后,镜头被遮挡时用户将收到告警。

Trait IDCode
0x4FE0LensObstructionPushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

LensObstructionTimePeriod Trait(镜头遮挡侦测时段)​

定义镜头遮挡检测生效的时间段。计划配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式字符串(24 小时制),范围 "00:00" 至 "23:59",定义生效时段的起止时间。若两者相等,则全天有效。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日 starttime 开始至次日 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次为周日、周一、周二、周三、周四、周五、周六。值为 1 表示该星期几生效,0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FDFLensObstructionTimePeriod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLensObstructionTimePeriodTraitPresentValueStructureRVWO

LensObstructionEnable Trait(镜头遮挡使能)​

启用或禁用镜头遮挡检测功能。启用后,摄像头监测镜头是否部分或完全遮挡,并可相应触发事件、录像或通知。

Trait IDCode
0x4FDELensObstructionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

WhiteLightDuration Trait(白光灯持续时长)​

设置白光(补光灯)触发后保持点亮的持续时间。值为 0 表示持续点亮(常亮)。1 至 1800 表示自动关闭前保持的秒数。

Trait IDCode
0x4FDBWhiteLightDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVWO
0x0002Maximum Valueuint321800RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint3230RWO

CloudAISupportedAlgorithm Trait(云端支持的AI算法)​

指示云端支持的 AI 算法类型。值为枚举,表示通过云端处理可用的检测/识别能力。

Trait IDCode
0x4FDDCloudAISupportedAlgorithm
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuearrayRVO
0x0006Supported Valuelist[array]RO

EventLightingMode Trait(事件触发亮灯模式)​

定义设备检测到事件时指示灯/照明灯的行为。Steady:灯持续常亮;Blink:灯反复闪烁。

Trait IDCode
0x4FDAEventLightingMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueEventLightingModeEnum80RVWO
0x0006Supported Valuelist[EventLightingModeEnum8]RO
0x0007Default Valueuint80RWO

ActiveWakeupInterval Trait(主动唤醒间隔)​

配置在AOV (始终在线视频)智能监控模式下操作时电池供电摄像头的主动唤醒间隔。设备以此间隔(以秒为单位)定期唤醒以捕获帧以进行事件检测。例如,设置为3意味着相机每3秒唤醒一次,以检查运动或事件。

Trait IDCode
0x4FD9ActiveWakeupInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint323RVWO
0x0002Maximum Valueuint3265535RO
0x0003Minimum Valueuint321RO
0x0005Step Valueuint321RO
0x0007Default Valueuint323RWO

CameraMatterCapability Trait(摄像机Matter 能力)​

使用位掩码指示 Matter 功能支持。Bit0:设备支持原生 Matter 摄像头(无需网关桥接)。Bit1:网关支持将摄像头桥接至 Matter。Bit2:摄像头(无内置网关)可通过独立网关桥接至 Matter。预定义组合值:0(位 000)、2(位 010)、4(位 100)、5(位 101)。

Trait IDCode
0x4FD7CameraMatterCapability
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

CamWorkMode Trait(摄像机工作模式)​

定义摄像头在功耗与功能方面的工作模式。PowerSaving:降低性能以延长电池续航;SuperPowerSaving:最大省电,功能受限;MainsPower:常供电(AC/DC)下全性能运行;AOV:Always-On Video 低功耗智能监控模式。

Trait IDCode
0x4FD8CamWorkMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCamWorkModeEnum80RVWO
0x0006Supported Valuelist[CamWorkModeEnum8]RO
0x0007Default Valueuint80RWO

AOVRecordingEnable Trait(AOV录像使能)​

启用或禁用 AOV(Always-On Video)录像功能。启用后,设备持续录像以确保不遗漏关键时刻。

Trait IDCode
0x4FD6AOVRecordingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

RecordingMode Trait(录像模式)​

配置设备的录制行为。结构包含两个字段:模式( uint8 ,值: 0 =关闭, 1 =连续录制, 2 =事件触发录制)和覆盖( uint8 ,值: 1 =存储已满时的循环覆盖)。这两个字段都是必填字段。

Trait IDCode
0x4FD2RecordingMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRecordingModeTraitPresentValueStructureRVWO
0x0007Default ValueRecordingModeTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":2,"1":1}RWO

RangeTestMode Trait(进入测距测试模式)​

启用摄像头检测距离配置的测距测试模式。该模式下,检测到目标时设备发出提示(如白光灯闪三次),指示当前距离设置的有效范围。

Trait IDCode
0x4FD3RangeTestMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

RecordingMuteEnable Trait(无声录制使能)​

确定录像时是否同时录制音频。设置为 1(静音)时,录像文件不保存音频;为 0 时包含音频。

Trait IDCode
0x4FD1RecordingMuteEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

VideoCorrectionEnable Trait(视频矫正使能)​

开启/关闭镜头畸变校正。启用时,设备应用变形校正以拉直广角镜头造成的弯曲边缘(改善图像几何形状但可能裁切视场)。

Trait IDCode
0x4FD0VideoCorrectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

OSDTimeFormatSetting Trait(时间水印格式设置)​

指定 OSD 水印中显示日期和时间的格式字符串。采用与 strftime 兼容的格式说明符(例如 %Y 表示年,%m 表示月,%d 表示日,%H 表示时,%M 表示分,%S 表示秒)。

Trait IDCode
0x4FCEOSDTimeFormatSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

ImageFlipMode Trait(画面翻转)​

控制视频画面是否垂直翻转(180 deg 旋转)。设置为 Flip (1) 时,画面上下颠倒,适用于吊顶或倒装场景;设置为 Normal (0) 时,画面方向为标准方向。

Trait IDCode
0x4FCFImageFlipMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueImageFlipModeEnum80RVWO
0x0006Supported Valuelist[ImageFlipModeEnum8]RO
0x0007Default Valueuint80RWO

OSDWatermarkEnable Trait(OSD时间水印使能)​

控制是否在实时预览和录像中叠加时间戳。启用后,当前日期和时间将显示在视频画面的指定位置,便于查看者准确识别事件发生时间。

Trait IDCode
0x4FCBOSDWatermarkEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

InfraredNightVisionSetting Trait(夜视设置)​

设置摄像头夜视模式。AlwaysOff:IR cut 和照明器关闭;AlwaysOn:IR cut 开启(黑白)且 IR LED 开启;Auto:根据光照切换;WarmColorFullColor:使用暖白光实现全彩夜视。

Trait IDCode
0x4FCAInfraredNightVisionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueInfraredNightVisionSettingEnum82RVWO
0x0006Supported Valuelist[InfraredNightVisionSettingEnum8]RO
0x0007Default Valueuint82RWO

TimelapseTimePeriod Trait(延时摄影时段)​

定义延时摄影录像生效时段的定时计划。 定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FC8TimelapseTimePeriod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimelapseTimePeriodTraitPresentValueStructureRVWO

TimelapseEnable Trait(延时摄影使能)​

启用或禁用延时摄影功能。启用后,设备按固定间隔(单独配置)拍摄图像序列并合成为视频。

Trait IDCode
0x4FC7TimelapseEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

DynamicCoverRefreshEnable Trait(动态刷新封面使能)​

启用或禁用 App 首页设备封面图的动态刷新。

Trait IDCode
0x5027DynamicCoverRefreshEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

PeriodicSnapshotUploadEnable Trait(定时上传图片使能)​

启用或禁用定期快照上传至云端。实现 PeriodicSnapshotInterval 时,抓拍间隔由该 Trait 配置;未实现时保持每 10 分钟上传一帧的行为。

Trait IDCode
0x5028PeriodicSnapshotUploadEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CloudRecordingEnable Trait(录制云端视频总使能)​

启用或禁用事件云端录像的总开关。

Trait IDCode
0x5026CloudRecordingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

TheftModeNotificationEnable Trait(丢失模式推送使能)​

启用或禁用防盗模式事件的推送通知。

Trait IDCode
0x501DTheftModeNotificationEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

TheftModeEnable Trait(丢失模式使能)​

启用或禁用防盗/丢失模式。

Trait IDCode
0x501CTheftModeEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ScheduledSleepTimePeriod Trait(定时休眠时段)​

定义设备应进入睡眠模式的时段定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x501BScheduledSleepTimePeriod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueScheduledSleepTimePeriodTraitPresentValueStructureRVWO

AIDetectionBoxEnable Trait(显示识别框使能)​

启用或禁用在实时预览中绘制 AI 检测边界框(如人、宠物)。

Trait IDCode
0x5019AIDetectionBoxEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ScheduledSleepEnable Trait(定时休眠使能)​

启用或禁用计划睡眠模式。

Trait IDCode
0x501AScheduledSleepEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

PrivacyMaskRegions Trait(隐私遮挡区域)​

定义视频帧中用于保护隐私的遮罩区域。其值为包含 visible 和 regions 两个字段的结构体。visible 为布尔值或整数(0 或 1),表示是否在实时预览中显示遮罩区域轮廓(用于调试或确认,不影响实际遮罩效果)。regions 为最多 4 个遮罩对象的数组。每个遮罩对象包含 color 和 rect。color 为整数(十进制),表示遮罩块的 RGB 颜色(例如 0xRRGGBB 的十进制形式,高字节为红、中字节为绿、低字节为蓝)。rect 为四个整数组成的数组,指定边界矩形:左坐标、上坐标、宽度、高度。坐标原点在图像左上角,X 轴向右递增,Y 轴向下递增。该配置同时适用于实时视频和录像流,遮罩在设备端执行,以确保隐私敏感内容不被还原。

Trait IDCode
0x5018PrivacyMaskRegions
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePrivacyMaskRegionsTraitPresentValueStructureRVWO

PowerFrequency Trait(电源频率)​

设置电源线频率以避免闪烁(50Hz 或 60Hz)。

Trait IDCode
0x5017PowerFrequency
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePowerFrequencyEnum80RVWO
0x0006Supported Valuelist[PowerFrequencyEnum8]RO
0x0007Default Valueuint80RWO

WhiteLightOnOff Trait(白光补光灯开关)​

控制白色补光灯的总开关。切换可改变当前状态。

Trait IDCode
0x5014WhiteLightOnOff
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

WhiteLightBrightness Trait(白光灯设置亮度)​

设置白光亮度等级,范围 1% 至 100%。

Trait IDCode
0x5016WhiteLightBrightness
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat1RWO

CameraEventImportanceLevel Trait(摄像机事件重要等级级别)​

设置事件通知的最低重要级别。仅 level >= 该值的事件触发通知。

Trait IDCode
0x5013CameraEventImportanceLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint82RVWO
0x0002Maximum Valueuint85RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO
0x0007Default Valueuint82RWO

CameraAdvancedEventNotificationEnable Trait(摄像机高级事件通知使能)​

启用或禁用高级事件通知(如详细 AI 事件告警)。

Trait IDCode
0x5012CameraAdvancedEventNotificationEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CameraNotificationSchedulePeriods Trait(摄像机通知计划-时段)​

定义允许通知时段的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x5010CameraNotificationSchedulePeriods
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCameraNotificationSchedulePeriodsTraitPresentValueStructureRVWO

CameraFilterUnimportantNotifications Trait(摄像机过滤不重要的通知使能)​

启用或禁用不重要通知过滤,以减少干扰。

Trait IDCode
0x5011CameraFilterUnimportantNotifications
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CameraNotificationScheduleEnable Trait(摄像机通知计划使能)​

启用或禁用通知计划功能。

Trait IDCode
0x500FCameraNotificationScheduleEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CameraNotificationType Trait(摄像机通知类型)​

指定要接收的通知类型:事件通知或 AI 视频摘要通知。

Trait IDCode
0x500ECameraNotificationType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCameraNotificationTypeEnum81RVWO
0x0006Supported Valuelist[CameraNotificationTypeEnum8]RO
0x0007Default ValueCameraNotificationTypeEnum81RWO

AlexaDetectionEvents Trait(Alexa支持的侦测事件)​

表示用户通过 Alexa 平台配置的、需要设备支持的侦测事件类型列表。

Trait IDCode
0x516DAlexaDetectionEvents
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[AlexaDetectionEventsEnum8]RVWO

LensObstructionRecordEnable Trait(镜头遮挡录像使能)​

启用或禁用检测到镜头遮挡时的本地录像。

Trait IDCode
0x4FFCLensObstructionRecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

LensObstructionInterval Trait(镜头遮挡侦测间隔)​

连续镜头遮挡检测触发之间的时间间隔(秒)。

Trait IDCode
0x4FFDLensObstructionInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16180RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16180RWO

LensObstructionSensitivity Trait(镜头遮挡侦测灵敏度)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FFBLensObstructionSensitivity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLensObstructionSensitivityEnum81RVWO
0x0006Supported Valuelist[LensObstructionSensitivityEnum8]RO
0x0007Default Valueuint81RWO

AIModelSilenceOTAEnable Trait(AI算法模型静默升级使能)​

启用或禁用无需用户干预的 AI 模型静默 OTA 升级。启用后,AI 模型在后台自动更新。

Trait IDCode
0x4FC5AIModelSilenceOTAEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SetDetectionMode Trait(侦测类型)​

设置摄像头的主要检测模式。该模式决定事件生成和录像优先使用的 AI 算法。

Trait IDCode
0x4FC6SetDetectionMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSetDetectionModeEnum80RVWO
0x0006Supported Valuelist[SetDetectionModeEnum8]RO
0x0007Default Valueuint80RWO

AIVideoSummaryEnable Trait(AI视频摘要使能)​

启用或禁用 AI 视频摘要生成。AI 提取关键时刻(事件)并合成为短视频摘要。

Trait IDCode
0x4FC3AIVideoSummaryEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AIVideoSearchEnable Trait(AI视频搜索使能)​

启用或禁用 AI 视频搜索功能。启用后,用户可按对象类型(如人、车辆、包裹)搜索录像。

Trait IDCode
0x4FC2AIVideoSearchEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SupportLocalVideoDownload Trait(是否支持本地录像下载)​

指示设备是否支持通过 App 从 SD 卡下载本地视频。

Trait IDCode
0x4FC1SupportLocalVideoDownload
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

LightingTimePeriod Trait(亮灯时段)​

定义事件触发照明功能生效时段的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FBFLightingTimePeriod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLightingTimePeriodTraitPresentValueStructureRVWO
0x0007Default ValueLightingTimePeriodTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

RelatedEventRecordEnable Trait(关联事件录像使能)​

启用或禁用关联事件(如来自其他 Zigbee/Thread 传感器)发生时的本地录像。允许由门窗传感器等外部设备触发录像。

Trait IDCode
0x4FC0RelatedEventRecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

LightUpWhenEventDetected Trait(侦测到事件时亮灯)​

在计划时段内检测到事件(如移动、人形检测)时,启用白光灯亮 20 秒。用作视觉威慑或照明。

Trait IDCode
0x4FBELightUpWhenEventDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean0RWO

LogoWatermarkEnable Trait(Logo水印使能)​

启用或禁用视频品牌 Logo 水印叠加。启用后,设备将在视频文件中嵌入固定 Logo 图像。

Trait IDCode
0x4FB0LogoWatermarkEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

CameraRTSPEnable Trait(摄像机RTSP使能)​

指示摄像头 RTSP(Real Time Streaming Protocol)启用开关配置。启用时允许通过 RTSP 协议访问实时视频流;禁用时禁止 RTSP 访问。

Trait IDCode
0x4F91CameraRTSPEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CameraRTSPURL Trait(摄像头RTSP地址)​

指示摄像头的 RTSP(Real Time Streaming Protocol)URL,用于通过 RTSP 协议访问实时视频流。该属性返回 JSON 对象,键为分辨率标识(如 "360p"、"720p"、"1080p"、"4mp"),值为对应完整 RTSP URL 字符串。示例格式如下:{"360p": "rtsp://192.168.1.109:8554/360p","720p": "rtsp://192.168.1.109:8554/720p","1080p": "rtsp://192.168.1.109:8554/1080p","4mp": "rtsp://192.168.1.109:8554/4mp"}

Trait IDCode
0x4F90CameraRTSPURL
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

LiveChannel Trait(实时视频通道)​

实时视频通道。表示实时视频使用的码流通道。0 = 主码流,1 = 次码流,2 = 第三码流,3 = 其他。

Trait IDCode
0x517CLiveChannel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLiveChannelEnum80RVWO
0x0006Supported Valuelist[LiveChannelEnum8]RO
0x0007Default Valueuint80RWO

PlaybackChannel Trait(回放视频通道)​

回放视频通道。表示回放视频使用的码流通道。0 = 主码流,1 = 次码流,2 = 第三码流,3 = 其它。

Trait IDCode
0x517DPlaybackChannel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePlaybackChannelEnum80RVWO
0x0006Supported Valuelist[PlaybackChannelEnum8]RO
0x0007Default Valueuint80RWO

P2PCaptureStatus Trait(P2P动态取图状态)​

P2P动态趣图状态开关

Trait IDCode
0x4E44P2PCaptureStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanRVWO
0x0007Default Valueboolean0RWO

Volume Trait(音量)​

指示或设置摄像头设备扬声器音量(如双向语音)。值通常为百分比(0 至 100)或设备定义的数值范围。

Trait IDCode
0x80C0Volume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

CameraActiveStatus Trait(摄像头休眠状态)​

该 Trait 用于「摄像头休眠状态」相关数据的访问与上报。

Trait IDCode
0x80A2CameraActiveStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

Command 定义​

Command IDNameConformance
0x9DADThirdPartySnapshotTriggerO
0x9D3EWhiteLightToggleO
0x9D3DSnapshotUploadCommandO
0x9D3BFormatSDCardCommandO
0x9D3ACameraActiveToggleO

ThirdPartySnapshotTrigger Command​

该 Command 由第三方生态平台(如 Alexa)调用,触发设备执行抓图操作。该命令包含触发来源参数,用于标识调用方。

参数​

ThirdPartySnapshotTrigger Command Structure

WhiteLightToggle Command​

该 Command 用于执行「白光灯状态切换控制」操作。

参数​

WhiteLightToggle Command Structure

SnapshotUploadCommand Command​

该 Command 用于执行「拍照并上传」操作。

参数​

SnapshotUploadCommand Command Structure

FormatSDCardCommand Command​

该 Command 用于执行「格式化存储卡」操作。

参数​

FormatSDCardCommand Command Structure

CameraActiveToggle Command​

该 Command 用于执行「摄像机休眠切换命令」操作。

参数​

CameraActiveToggle Command Structure

WindowCovering(窗帘功能)​

简介​

本 Function 提供窗帘、卷帘、百叶帘等窗饰设备的开合控制、倾斜控制、目标位置管理与运行状态反馈能力。

除标准开合/倾斜控制外,本 Function 还包含 Aqara 扩展能力:场景管理(内置/自定义场景的启动、读取、预览、增删改)、手动校准、远程配对、远程行程记录、电机映射交换与增强模式状态。

客户端应结合 TravelConfigured、MotorControllability、MotorOperationStatus、EnhanceMode 等 Trait 判断设备当前可控性与操作阶段,避免在不满足条件时下发无效命令。

Function 标识​

Function IDCode名称
0x0089WindowCovering窗帘功能

Trait​

Trait IDCode名称Conformance
0x80A5WindowCoveringOpenOrientation窗帘开合方向M
0x5199TravelCalibrationReminderEnable行程校准提醒使能M
0x504ETravelCalibrationCustomDays行程校准自定义时长M
0x504DTravelCalibrationReminder行程校准提醒M
0x4F8AEffectInfo调光场景信息M
0x50C0LastCalibrationDate上次校准时间M
0x5062EffectOperationState场景运行状态O
0x5051SafetyStatus安全状态O
0x4F33ChildEndpointList子节点列表O
0x504CAutoCalibration自动校准O
0x504AMotorMappingExchanged电机映射交换O
0x5049StepResolution步进精度O
0x5048ManualPullStrength手拉启停强度O
0x5047MotorStrength电机强度O
0x5046EnhanceMode高阶模式O
0x4EADLimitPointSetting设置行程限位点O
0x4F9CMaxEffectNameLength最大场景名称长度O
0x4F9BUserDefinedEffects用户自定义场景O
0x4F89MaxUserDefinedEffects最大自定义场景数O
0x4F88CurrentEffectID当前场景IDO
0x4F87BuiltInEffects内置场景O
0x4FABSupportedActionTypes支持动作类型O
0x4F05TargetPositionRotationPercentage目标倾斜旋转位置百分比O
0x4F04CurrentPositionRotationPercentage当前倾斜旋转位置百分比O
0x51F0TiltLimitRange翻转电机限位点O
0x8158CurrentRotationAngle窗帘的当前旋转角度O
0x80A4TargetPositionPercentage目标位置百分比O
0x4EDEObstacleLimitMarkingBlockTime遇阻打点功能的屏蔽时长O
0x4EDDLimitPointCount电机限位点数量O
0x4EDCObstacleLimitSensitivity遇阻灵敏度设置O
0x4EDBObstacleLimitAutoReboundEnable遇阻反弹使能配置O
0x4EDAObstacleLimitMarkingEnable遇阻打点功能使能配置O
0x4ED9MotorSpeedPercentage电机速度百分比设置O
0x4ED8MotorSpeedSetting电机速度档位设置O
0x4ED7ManualPullStartStopEnabled手拉启动停止使能O
0x4EAEManualPullStartEnabled手拉启动使能O
0x4EAFManualPullStopEnabled手拉停止使能O
0x4E3FMotorOperationStatus电机运行状态O
0x8157WindowCoveringMotorsBinding窗帘电机绑定为统一总控O
0x4EB1ManualPullEvent手拉事件上报O
0x4EB0ManualPullAdaptiveSpeedEnabled手拉速度自适应使能O
0x4E26UnconfiguredTravelControlPermission行程未配控制许可O
0x4E43MotorControllability电机是否可控制O
0x80AEWindowCoveringType窗帘细分类型O
0x4E42WindowCoveringCategory窗帘大类别O
0x4E41MotorDirectionReversed电机方向反转O
0x4E40TravelConfigured是否已配置行程O
0x8159TargetRotationAngle窗帘的目标旋转角度O
0x80F9TripTime行程时间O
0x80A3CurrentPositionPercentage当前位置百分比O
0x51EFLiftLimitRange升降电机限位点O

Command​

Command IDCode名称Conformance
0x9D63RemoveUserDefinedEffects批量删除自定义场景O
0x9D44EnterRemoteControlPairing进入远程控制配对O
0x9D43CommitManualCalibration完成手动校准O
0x9D42ManualCalibrationOperation手动校准操作O
0x9D41EnterManualCalibration进入手动校准O
0x9D30StopPreview停止预览O
0x9D2FPreviewEffect预览场景O
0x9D2ERemoveUserDefinedEffect删除自定义场景O
0x9D2DUpdateUserDefinedEffect更新自定义场景O
0x9D2CAddUserDefinedEffect新增自定义场景O
0x9D2BGetEffectData获取场景数据O
0x9D2AStartEffect启动场景O
0x9C74GoToPositionRotationPercentage至倾斜旋转百分比O
0x88C4RotationControl窗帘电机旋转角度控制O
0x8100StepPosition开合增量调节O
0x80AAGoToPositionPercentage至指定开合比O
0x80A9AutoControl自动控制O
0x80A8StopMotion停止O
0x80A7GoToMinPositionPercentage至最小O
0x80A6GoToMaxPositionPercentage至最大O

数据类型​

LiftLimitRangeTraitPresentValueStructure Type​

该结构体定义 LiftLimitRange Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0MinfloatM开合位置最小实际值,单位为 %。
1MaxfloatM开合位置最大实际值,单位为 %。
TiltLimitRangeTraitPresentValueStructure Type​

该结构体定义 TiltLimitRange Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0MinfloatM俯仰/旋转位置最小实际值,单位为 %。
1MaxfloatM俯仰/旋转位置最大实际值,单位为 %。
WindowCoveringOpenOrientationEnum8 Type​

该枚举定义 WindowCoveringOpenOrientation Trait 的 Present Value 有效取值。

ValueNameDescription
0x00LeftRight左右双开
0x01LeftToRight从左向右
0x02RightToLeft从右向左
0x03Up从下向上
0x04Horizontal左右开合
0x05Vertical上下开合
TravelCalibrationReminderEnum8 Type​

该枚举定义 TravelCalibrationReminder Trait 的 Present Value 有效取值。

ValueNameDescription
0x00TwoWeeks两周
0x01OneMonth一个月
0x02TwoMonths两个月
0x03ThreeMonths三个月
0x04SixMonths六个月
0x05Custom自定义
EffectInfoTraitPresentValueStructure Type​

该结构体定义 EffectInfo Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EffectIDuint8M场景 ID。
1EffectDatacharacterStringM场景数据。
2EffectNamecharacterStringM场景名称。
EffectOperationStateEnum8 Type​

该枚举定义 EffectOperationState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Idle空闲
0x01Executing执行中
0x02Previewing预览中
AutoCalibrationEnum8 Type​

该枚举定义 AutoCalibration Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NormalMode正常模式
0x01CalibrationMode校准模式
ManualPullStrengthEnum8 Type​

该枚举定义 ManualPullStrength Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Low低
0x01Medium中
0x02High高
MotorStrengthEnum8 Type​

该枚举定义 MotorStrength Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Strong强劲
LimitPointSettingEnum8 Type​

该枚举定义 LimitPointSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ClearLimitPoints清除限位点
0x01SetOpenLimit设置开限位点
0x02SetCloseLimit设置关限位点
UserDefinedEffectsTraitPresentValueStructure Type​

该结构体定义 UserDefinedEffects Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EffectIDuint8M用户自定义场景 ID。
1EffectNamecharacterStringM场景名称。
BuiltInEffectsTraitPresentValueStructure Type​

该结构体定义 BuiltInEffects Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EffectIDuint8M内置场景 ID。
1BuiltInEffectLabelIDenum8M内置场景标签 ID。
ObstacleLimitSensitivityEnum8 Type​

该枚举定义 ObstacleLimitSensitivity Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Low低
0x01MediumLow较低
0x02Medium中等
0x03MediumHigh较高
0x04High高
MotorSpeedSettingEnum8 Type​

该枚举定义 MotorSpeedSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00LowSpeed低速
0x01MediumSpeed中速
0x02HighSpeed高速
MotorOperationStatusEnum8 Type​

该枚举定义 MotorOperationStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Closing关闭中
0x01Opening打开中
0x02Stopped停止
0x03ObstacleStop障碍物停止
0x04ObstacleLimitAutoRebound遇阻反弹
ManualPullEventEnum32 Type​

该枚举定义 ManualPullEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x01ManualOpen手拉打开
0x02ManualClose手拉关闭
0x03ManualStop手拉停止
WindowCoveringTypeEnum8 Type​

该枚举定义 WindowCoveringType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00RollerShade卷帘
0x01VenetianBlind百叶帘
0x02ShangrilaBlind香格里拉百叶帘
0x03ZebraBlind斑马帘
0x04Curtain开合帘
0x05VerticalVenetianBlind梦幻帘
0x1FRomanShade罗马帘
0x20BalloonShade气球帘
0x21WovenWood编织木帘
0x22PleatedShade褶皱帘
0x23CellularShade蜂巢帘
0x24LayeredShade分层帘
0x25LayeredShade2D2D分层帘
0x26SheerShade透光帘
0x27TiltOnlyInteriorBlind仅倾斜室内百叶帘
0x28InteriorBlind室内百叶帘
0x29VerticalBlindStripCurtain垂直百叶帘条形窗帘
0x2AInteriorVenetianBlind室内威尼斯百叶帘
0x2BExteriorVenetianBlind室外威尼斯百叶帘
0x2CLateralLeftCurtain左侧滑动窗帘
0x2DLateralRightCurtain右侧滑动窗帘
0x2ECentralCurtain中央窗帘
0x2FRollerShutter卷帘门
0x30ExteriorVerticalScreen室外垂直遮阳帘
0x31AwningTerracePatio露台遮阳篷
0x32AwningVerticalScreen垂直遮阳篷
0x33TiltOnlyPergola仅倾斜凉亭
0x34SwingingShutter摆动百叶帘
0x35SlidingShutter滑动百叶帘
0xFFUnknown未知
WindowCoveringCategoryEnum8 Type​

该枚举定义 WindowCoveringCategory Trait 的 Present Value 有效取值。

ValueNameDescription
0x00RollerShade卷帘
0x01RollerShade2Motor双层卷帘
0x02RollerShadeExterior室外卷帘
0x03RollerShadeExterior2Motor双层室外卷帘
0x04Drapery窗帘
0x05Awning遮阳篷
0x06Shutter百叶帘
0x07TiltBlindTiltOnly仅倾斜百叶帘
0x08TiltBlindLiftAndTilt倾斜和升降百叶帘
0x09ProjectorScreen投影屏幕
0xFFUnknown未知
RemoveUserDefinedEffects Command Structure Type​

RemoveUserDefinedEffects Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDslist[Struct]M待批量删除的 EffectID 列表。每项应为已存在的 UserDefined 场景 ID;列表长度不得超过 MaxUserDefinedEffects 的 Present Value。
EnterRemoteControlPairing Command Structure Type​

EnterRemoteControlPairing Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PairingDurationuint16M远程配对持续时长(秒)。成功后设备进入配对模式并在超时后自动退出。
ManualCalibrationOperation Command Structure Type​

ManualCalibrationOperation Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Operationenum8M校准操作类型(Open/Close/Stop)。仅在手动校准模式下有效。
EnterManualCalibration Command Structure Type​

EnterManualCalibration Command 的参数结构体。

结构体成员序号字段名类型必须说明
0CalibrationTimeoutuint16M手动校准会话空闲超时时间(秒)。超时后应自动退出校准模式并丢弃临时记录。
PreviewEffect Command Structure Type​

PreviewEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectDatacharacterStringM待预览场景的原始数据。编码格式应与新增/更新用户自定义场景一致。
RemoveUserDefinedEffect Command Structure Type​

RemoveUserDefinedEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDuint8M待删除场景 ID。应为已存在且可删除的 UserDefined 场景。
UpdateUserDefinedEffect Command Structure Type​

UpdateUserDefinedEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDuint8M待更新场景 ID。应为已存在 UserDefined 场景。
1EffectDatacharacterStringM更新后的场景数据,编码格式应与 EffectData 规范一致。
AddUserDefinedEffect Command Structure Type​

AddUserDefinedEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectNamecharacterStringM新增场景名称,UTF-8 字节长度不得超过 MaxEffectNameLength。
1EffectDatacharacterStringM新增场景的原始数据,编码格式应与 EffectData 规范一致。
GetEffectData Command Structure Type​

GetEffectData Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDuint8M待读取场景数据的场景 ID,应存在于 BuiltIn 或 UserDefined 列表中。
StartEffect Command Structure Type​

StartEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDenum8M待启动场景 ID,应为设备当前支持的 BuiltIn 或 UserDefined 场景。
GoToPositionRotationPercentage Command Structure Type​

GoToPositionRotationPercentage Command 的参数结构体。

结构体成员序号字段名类型必须说明
0RotationPercentagefloatM倾斜旋转百分比。
RotationControl Command Structure Type​

RotationControl Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Directionenum8M方向。
StepPosition Command Structure Type​

StepPosition Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SizefloatM增量值。
1Timeint32O时间。
GoToPositionPercentage Command Structure Type​

GoToPositionPercentage Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PositionPercentagefloatM开合比。
1TransitionTimeuint32O时间。

Trait 定义​

Trait IDNameConformance
0x80A5WindowCoveringOpenOrientationM
0x5199TravelCalibrationReminderEnableM
0x504ETravelCalibrationCustomDaysM
0x504DTravelCalibrationReminderM
0x4F8AEffectInfoM
0x50C0LastCalibrationDateM
0x5062EffectOperationStateO
0x5051SafetyStatusO
0x4F33ChildEndpointListO
0x504CAutoCalibrationO
0x504AMotorMappingExchangedO
0x5049StepResolutionO
0x5048ManualPullStrengthO
0x5047MotorStrengthO
0x5046EnhanceModeO
0x4EADLimitPointSettingO
0x4F9CMaxEffectNameLengthO
0x4F9BUserDefinedEffectsO
0x4F89MaxUserDefinedEffectsO
0x4F88CurrentEffectIDO
0x4F87BuiltInEffectsO
0x4FABSupportedActionTypesO
0x4F05TargetPositionRotationPercentageO
0x4F04CurrentPositionRotationPercentageO
0x8158CurrentRotationAngleO
0x80A4TargetPositionPercentageO
0x4EDEObstacleLimitMarkingBlockTimeO
0x4EDDLimitPointCountO
0x4EDCObstacleLimitSensitivityO
0x4EDBObstacleLimitAutoReboundEnableO
0x4EDAObstacleLimitMarkingEnableO
0x4ED9MotorSpeedPercentageO
0x4ED8MotorSpeedSettingO
0x4ED7ManualPullStartStopEnabledO
0x4EAEManualPullStartEnabledO
0x4EAFManualPullStopEnabledO
0x4E3FMotorOperationStatusO
0x8157WindowCoveringMotorsBindingO
0x4EB1ManualPullEventO
0x4EB0ManualPullAdaptiveSpeedEnabledO
0x4E26UnconfiguredTravelControlPermissionO
0x4E43MotorControllabilityO
0x80AEWindowCoveringTypeO
0x4E42WindowCoveringCategoryO
0x4E41MotorDirectionReversedO
0x4E40TravelConfiguredO
0x8159TargetRotationAngleO
0x80F9TripTimeO
0x80A3CurrentPositionPercentageO

WindowCoveringOpenOrientation Trait(窗帘开合方向)​

标识自动控制的实际窗饰开启方向。

Trait IDCode
0x80A5WindowCoveringOpenOrientation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWindowCoveringOpenOrientationEnum80RVWM
0x0006Supported Valuelist[WindowCoveringOpenOrientationEnum8]RO
0x0007Default ValueWindowCoveringOpenOrientationEnum80RWO

TravelCalibrationReminderEnable Trait(行程校准提醒使能)​

该 Trait 用于启用或禁用行程校准提醒。

Present Value 为 true 时,设备应按 TravelCalibrationReminder 及 TravelCalibrationCustomDays 的配置周期触发行程校准提醒;为 false 时,设备不触发行程校准提醒。

Trait IDCode
0x5199TravelCalibrationReminderEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWM
0x0007Default Valueboolean0RWO

TravelCalibrationCustomDays Trait(行程校准自定义时长)​

该 Trait 用于配置行程校准提醒的自定义周期天数。

当 TravelCalibrationReminder 取值为 Custom 时,设备应采用本 Trait 的 Present Value 作为提醒周期。

Trait IDCode
0x504ETravelCalibrationCustomDays
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVWM
0x0002Maximum Valueuint16999RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO
0x0007Default Valueuint161RWO

TravelCalibrationReminder Trait(行程校准提醒)​

该 Trait 用于配置行程校准提醒周期。

设备可按固定档位(两周/一月/两月/三月/六月)或自定义天数触发提醒;当取值为 Custom 时应结合 TravelCalibrationCustomDays 使用。

Trait IDCode
0x504DTravelCalibrationReminder
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTravelCalibrationReminderEnum80RVWM
0x0006Supported Valuelist[TravelCalibrationReminderEnum8]RO
0x0007Default ValueTravelCalibrationReminderEnum80RWO

EffectInfo Trait(调光场景信息)​

该 Trait 提供场景信息列表,每项包含 EffectID、EffectData 与 EffectName,用于维护、展示与同步场景详情。

EffectData 的编码应与场景写入/预览命令保持一致,以便客户端在读取后可直接展示、备份或复用。

Trait IDCode
0x4F8AEffectInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[EffectInfoTraitPresentValueStructure]RVM

LastCalibrationDate Trait(上次校准时间)​

应指示上次校准日期。Total = Year << 12 | Month << 8 | Day

Trait IDCode
0x50C0LastCalibrationDate
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVM
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO

EffectOperationState Trait(场景运行状态)​

指示窗饰设备当前场景运行状态(如空闲、执行中、预览中)。

Trait IDCode
0x5062EffectOperationState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueEffectOperationStateEnum80RVO
0x0006Supported Valuelist[EffectOperationStateEnum8]RO

SafetyStatus Trait(安全状态)​

该 Trait 用于上报设备安全状态位集合(如障碍、过载或其他保护状态)。

客户端可据此判断设备是否处于受限运行状态,并决定是否提示用户或限制继续控制。

Trait IDCode
0x5051SafetyStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

ChildEndpointList Trait(子节点列表)​

该属性应上报窗饰设备已配置分区中当前分配的子端点。

Trait IDCode
0x4F33ChildEndpointList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

AutoCalibration Trait(自动校准)​

该 Trait 指示设备当前自动校准模式状态。

NormalMode 表示正常控制状态;CalibrationMode 表示处于校准流程。处于校准相关模式时,部分常规控制行为可能受限。

Trait IDCode
0x504CAutoCalibration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAutoCalibrationEnum80RVWO
0x0006Supported Valuelist[AutoCalibrationEnum8]RO
0x0007Default Valueuint80RWO

MotorMappingExchanged Trait(电机映射交换)​

该 Trait 指示主/副电机逻辑映射是否交换。

当取值为 true 时,设备应交换主副电机映射,用于修正安装接线方向不一致场景,而无需重新布线。

Trait IDCode
0x504AMotorMappingExchanged
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

StepResolution Trait(步进精度)​

该 Trait 定义位置控制可接受的最小分辨率步长。

设备处理位置目标或步进请求时,应按该分辨率进行对齐(可四舍五入到最近支持值,或按设备策略拒绝不满足精度要求的请求)。

Trait IDCode
0x5049StepResolution
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16100RVO
0x0002Maximum Valueuint1610000RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16100RWO

ManualPullStrength Trait(手拉启停强度)​

该 Trait 用于配置手拉触发阈值强度。

阈值越高,触发手拉动作所需外力通常越大。

Trait IDCode
0x5048ManualPullStrength
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueManualPullStrengthEnum80RVWO
0x0006Supported Valuelist[ManualPullStrengthEnum8]RO
0x0007Default ValueManualPullStrengthEnum80RWO

MotorStrength Trait(电机强度)​

该 Trait 用于配置电机输出强度模式。

Normal 适用于常规工况,Strong 适用于需要更大驱动力的负载场景。

Trait IDCode
0x5047MotorStrength
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMotorStrengthEnum80RVWO
0x0006Supported Valuelist[MotorStrengthEnum8]RO
0x0007Default ValueMotorStrengthEnum80RWO

EnhanceMode Trait(高阶模式)​

该 Trait 表示设备增强模式位图状态。

在手动校准能力模型下,关键位包括:手动校准模式(bit0)、开/关校准记录已配置(bit1/bit2);其余位保留(bit3-bit7)。

ManualCalibration 与 RemoteTravelRecord 特性互斥,设备实现两者之一时,应保持位图语义一致且不混用。

远程配对状态不通过 EnhanceMode 位图表达,客户端不应使用 bit7 推断远程配对状态,应以命令应答和设备配对窗口行为为准。

Trait IDCode
0x5046EnhanceMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

LimitPointSetting Trait(设置行程限位点)​

用于配置窗帘电机限位点,具体设置全开或全关限位位置。

Trait IDCode
0x4EADLimitPointSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLimitPointSettingEnum80RVWO
0x0006Supported Valuelist[LimitPointSettingEnum8]RO
0x0007Default ValueLimitPointSettingEnum80RWO

MaxEffectNameLength Trait(最大场景名称长度)​

指示窗饰设备用户自定义场景中 EffectName 字段允许的最大字节长度。该值按设备固定,范围为 1-32。

Trait IDCode
0x4F9CMaxEffectNameLength
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint832RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO

UserDefinedEffects Trait(用户自定义场景)​

包含存储在窗饰设备上的所有用户自定义场景列表。每个条目包括 EffectID(0x80‑0xFE)和 EffectName。

Trait IDCode
0x4F9BUserDefinedEffects
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[UserDefinedEffectsTraitPresentValueStructure]RVO

MaxUserDefinedEffects Trait(最大自定义场景数)​

指示窗饰设备可支持的用户自定义场景最大数量。

Trait IDCode
0x4F89MaxUserDefinedEffects
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint832RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO

CurrentEffectID Trait(当前场景ID)​

指示窗饰设备当前激活场景的 EffectID。

Trait IDCode
0x4F88CurrentEffectID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x000DIs NullbooleanFalseRVO

BuiltInEffects Trait(内置场景)​

包含窗饰设备支持的所有内置场景列表。每个条目包括 EffectID(0x00‑0x7F)和 BuiltInEffectLabelID。

Trait IDCode
0x4F87BuiltInEffects
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[BuiltInEffectsTraitPresentValueStructure]RVO
0x000DIs NullbooleanFalseRVO

SupportedActionTypes Trait(支持动作类型)​

该 Trait 指示设备在 EffectData 中支持的动作类型集合。

客户端在发送 AddUserDefinedEffect、UpdateUserDefinedEffect、PreviewEffect 前,应依据该列表约束可选动作模式。

Trait IDCode
0x4FABSupportedActionTypes
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

TargetPositionRotationPercentage Trait(目标倾斜旋转位置百分比)​

TargetPositionRotationPercentage 特征的当前值以百分比表示窗饰设备俯仰将要到达或正在移动的目标位置(单位 1%)。

Trait IDCode
0x4F05TargetPositionRotationPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

CurrentPositionRotationPercentage Trait(当前倾斜旋转位置百分比)​

CurrentPositionRotationPercentage 特征的当前值以百分比表示实际俯仰/旋转位置,范围为 0% 至 100%,默认步进为 1%。

Trait IDCode
0x4F04CurrentPositionRotationPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

TiltLimitRange Trait(翻转电机限位点)​

该扩展 Trait 用于上报俯仰/旋转限位范围。

Trait IDCode
0x51F0TiltLimitRange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTiltLimitRangeTraitPresentValueStructureRVO

CurrentRotationAngle Trait(窗帘的当前旋转角度)​

当前值指示窗饰设备当前的旋转角度,范围为 -90 度至 90 度。

Trait IDCode
0x8158CurrentRotationAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat90.0RO
0x0003Minimum Valuefloat-90.0RO
0x0005Step Valuefloat1.0RO

TargetPositionPercentage Trait(目标位置百分比)​

该 Trait 指示当前或即将执行的目标开合位置百分比。

设备接收开合位置控制命令后,应将目标值写入本 Trait,并在运动完成或中断后与 CurrentPositionPercentage 保持一致性。

Trait IDCode
0x80A4TargetPositionPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

ObstacleLimitMarkingBlockTime Trait(遇阻打点功能的屏蔽时长)​

障碍物限位标记功能被禁用的时长(秒)。

Trait IDCode
0x4EDEObstacleLimitMarkingBlockTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint8255RVWO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint810RO
0x0005Step Valueuint321RO
0x0007Default Valueuint8255RWO

LimitPointCount Trait(电机限位点数量)​

表示为窗帘类电机配置的限位点(或行程限位)数量。

Trait IDCode
0x4EDDLimitPointCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint82RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO
0x0007Default Valueuint80RWO

ObstacleLimitSensitivity Trait(遇阻灵敏度设置)​

指窗帘电机遇到障碍物时的灵敏度设置。

Trait IDCode
0x4EDCObstacleLimitSensitivity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueObstacleLimitSensitivityEnum82RVWO
0x0006Supported Valuelist[ObstacleLimitSensitivityEnum8]RO
0x0007Default Valueuint82RWO

ObstacleLimitAutoReboundEnable Trait(遇阻反弹使能配置)​

启用后,窗帘电机遇障碍物时反转方向,防止损坏。

Trait IDCode
0x4EDBObstacleLimitAutoReboundEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

ObstacleLimitMarkingEnable Trait(遇阻打点功能使能配置)​

启用或禁用电机遇阻时标记限位点(开或关)的功能。

Trait IDCode
0x4EDAObstacleLimitMarkingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

MotorSpeedPercentage Trait(电机速度百分比设置)​

定义电机运行速度百分比,范围为 1(最低速)至 100(最高速)。

Trait IDCode
0x4ED9MotorSpeedPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

MotorSpeedSetting Trait(电机速度档位设置)​

定义电机运行速度档位,范围为 1(最低速)至 2(最高速)。

Trait IDCode
0x4ED8MotorSpeedSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMotorSpeedSettingEnum81RVWO
0x0006Supported Valuelist[MotorSpeedSettingEnum8]RO
0x0007Default Valueuint81RWO

ManualPullStartStopEnabled Trait(手拉启动停止使能)​

启用允许用户通过拉动手动启停窗帘/窗饰移动的功能。

Trait IDCode
0x4ED7ManualPullStartStopEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

ManualPullStartEnabled Trait(手拉启动使能)​

启用允许用户通过拉动手动启动窗帘/窗饰移动的功能。

Trait IDCode
0x4EAEManualPullStartEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

ManualPullStopEnabled Trait(手拉停止使能)​

启用允许用户通过拉动手动停止窗帘/窗饰移动的功能。

Trait IDCode
0x4EAFManualPullStopEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

MotorOperationStatus Trait(电机运行状态)​

指示电机当前运行状态。

Trait IDCode
0x4E3FMotorOperationStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMotorOperationStatusEnum82RVO
0x0006Supported Valuelist[MotorOperationStatusEnum8]RO
0x0007Default Valueuint82RWO

WindowCoveringMotorsBinding Trait(窗帘电机绑定为统一总控)​

指示窗帘类设备的多个电机是否逻辑绑定以实现统一控制。值:false = 独立控制,true = 统一主控。

Trait IDCode
0x8157WindowCoveringMotorsBinding
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ManualPullEvent Trait(手拉事件上报)​

跟踪或发出由窗饰设备手动拉动交互触发的事件。

Trait IDCode
0x4EB1ManualPullEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueManualPullEventEnum321VO
0x0006Supported Valuelist[ManualPullEventEnum32]RO

ManualPullAdaptiveSpeedEnabled Trait(手拉速度自适应使能)​

允许在手动拉力操作期间进行自适应速度调整,提供基于拉力的可变速度响应。

Trait IDCode
0x4EB0ManualPullAdaptiveSpeedEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

UnconfiguredTravelControlPermission Trait(行程未配控制许可)​

用于指示窗帘电机设备未配置行程时是否允许控制。

Trait IDCode
0x4E26UnconfiguredTravelControlPermission
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVO
0x0007Default Valueboolean1RWO

MotorControllability Trait(电机是否可控制)​

指示电机当前是否可控。

Trait IDCode
0x4E43MotorControllability
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

WindowCoveringType Trait(窗帘细分类型)​

标识窗饰产品类型(如卷帘、百叶窗、窗帘等)。值为支持值列表中定义的枚举(0 = Roller Shade,1 = Venetian Blind,... 255 = Unknown)。

Trait IDCode
0x80AEWindowCoveringType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWindowCoveringTypeEnum80RVWO
0x0006Supported Valuelist[WindowCoveringTypeEnum8]RO
0x0007Default Valueuint80RWO

WindowCoveringCategory Trait(窗帘大类别)​

由窗帘类设备上报,用于将窗饰设备划分为大类。

Trait IDCode
0x4E42WindowCoveringCategory
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWindowCoveringCategoryEnum80RVO
0x0006Supported Valuelist[WindowCoveringCategoryEnum8]RO
0x0007Default Valueuint80RWO

MotorDirectionReversed Trait(电机方向反转)​

指定电机运行方向是否反转,影响窗饰设备的开合方式。

Trait IDCode
0x4E41MotorDirectionReversed
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

TravelConfigured Trait(是否已配置行程)​

指示窗帘电机行程(运动范围)是否已配置。

Trait IDCode
0x4E40TravelConfigured
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO
0x0007Default Valueboolean0RWO

TargetRotationAngle Trait(窗帘的目标旋转角度)​

当前值指定窗饰设备的目标旋转角度,范围为 -90 度至 90 度。

Trait IDCode
0x8159TargetRotationAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat90.0RO
0x0003Minimum Valuefloat-90.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

TripTime Trait(行程时间)​

指示电机行程时间,即从完全打开到完全关闭(或相反)所需的时间(秒)。取值范围为 1 至 300 秒,默认 1 秒。

Trait IDCode
0x80F9TripTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVO
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO

CurrentPositionPercentage Trait(当前位置百分比)​

以 0% 至 100% 的百分比标识实际位置,默认步进 1%。

Trait IDCode
0x80A3CurrentPositionPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

LiftLimitRange Trait(升降电机限位点)​

该扩展 Trait 用于上报升降限位范围。

Trait IDCode
0x51EFLiftLimitRange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLiftLimitRangeTraitPresentValueStructureRVO

Command 定义​

Command IDNameConformance
0x9D63RemoveUserDefinedEffectsO
0x9D44EnterRemoteControlPairingO
0x9D43CommitManualCalibrationO
0x9D42ManualCalibrationOperationO
0x9D41EnterManualCalibrationO
0x9D30StopPreviewO
0x9D2FPreviewEffectO
0x9D2ERemoveUserDefinedEffectO
0x9D2DUpdateUserDefinedEffectO
0x9D2CAddUserDefinedEffectO
0x9D2BGetEffectDataO
0x9D2AStartEffectO
0x9C74GoToPositionRotationPercentageO
0x88C4RotationControlO
0x8100StepPositionO
0x80AAGoToPositionPercentageO
0x80A9AutoControlO
0x80A8StopMotionO
0x80A7GoToMinPositionPercentageO
0x80A6GoToMaxPositionPercentageO

RemoveUserDefinedEffects Command​

该命令应请求设备批量移除用户自定义场景;仅 UserDefined 类型场景可移除。

设备可逐项返回每个 EffectID 的处理结果,或按实现定义返回整体错误。

接收后行为(Effect on Receipt)​

设备接收命令后应逐项校验 EffectIDs:

  • EffectIDs 列表长度不得超过 MaxUserDefinedEffects Trait 的 Present Value。
  • 目标 ID 不存在时,应返回未找到语义错误。
  • 目标 ID 对应 BuiltIn 场景时,应返回"不可删除"语义错误。
  • 目标 ID 对应 UserDefined 场景时,应执行删除并返回成功。

设备可采用"逐项结果返回"或"整体失败返回"策略,但应保证最终存储状态与返回语义一致。

参数​

RemoveUserDefinedEffects Command Structure

EnterRemoteControlPairing Command​

该命令应请求设备进入远程配对模式,并在 PairingDuration 指定时长内保持可配对状态。

该命令状态不依赖 EnhanceMode 位图;设备应通过配对窗口状态管理该流程。

接收后行为(Effect on Receipt)​

设备接收该命令后,应校验 PairingDuration 是否在设备支持范围内。

  • 校验通过时:设备应进入远程配对模式并启动配对计时。
  • 若当前已处于远程配对模式:设备可按实现选择重置计时,或保持现有计时策略。
  • 配对时长到期时:设备应自动退出远程配对模式。
参数​

EnterRemoteControlPairing Command Structure

CommitManualCalibration Command​

该命令应请求设备提交当前手动校准临时记录并退出手动校准模式。

若开/关关键校准记录不完整,命令应失败且不应持久化临时记录。

接收后行为(Effect on Receipt)​

设备仅应在手动校准模式下处理该命令。

  • 若设备不在手动校准模式:应返回"未处于手动校准模式"语义错误。
  • 若处于手动校准模式且开/关临时记录完整:设备应持久化校准记录,退出手动校准模式,并更新 EnhanceMode(清除 bit0,置位 bit1/bit2)。
  • 若临时记录不完整:设备应返回"缺少校准记录"语义错误,且不应持久化临时记录;应退出手动校准模式并清除 bit0,确保状态可预测。

该 Command 无参数。

ManualCalibrationOperation Command​

该命令应在手动校准模式下执行开/关/停动作,用于校准过程中的位置调整。

若设备不在手动校准模式,命令应返回对应错误。

接收后行为(Effect on Receipt)​

设备仅应在手动校准模式下处理该命令。

  • 当 Operation = Open:设备应朝打开方向移动。
  • 当 Operation = Close:设备应朝关闭方向移动。
  • 当 Operation = Stop:设备应立即停止当前运动。

命令执行成功后,设备应重置手动校准空闲计时;若设备不在手动校准模式,应返回对应错误。

参数​

ManualCalibrationOperation Command Structure

EnterManualCalibration Command​

该命令应请求设备进入手动校准模式,并按 CalibrationTimeout 启动空闲超时计时。

超时且未收到有效校准动作时,设备应自动退出校准模式并清理临时记录。

接收后行为(Effect on Receipt)​

设备接收该命令后,应校验 CalibrationTimeout 是否满足设备支持范围。

  • 校验通过时:设备应进入手动校准模式,置位 EnhanceMode 的 bit0,并按该参数启动空闲计时。
  • 进入手动校准模式时:设备不应清除已保存的开/关校准记录,且不应改变 EnhanceMode 的 bit1/bit2。
  • 在校准会话中,每次成功处理校准动作类命令后,设备应重置空闲计时。
  • 计时到期后:设备应退出手动校准模式,清除 bit0,并丢弃本会话未提交的临时校准记录;未提交记录不应被持久化。
参数​

EnterManualCalibration Command Structure

StopPreview Command​

该命令应请求设备停止当前运行的场景预览并恢复正常窗饰运行。

接收后行为(Effect on Receipt)​

设备接收该命令后,应停止当前预览场景并恢复至常规控制状态。

  • 若当前存在预览场景:应终止预览并将 EffectOperationState 切回空闲或设备定义的稳定状态。
  • 若当前无预览场景:设备可返回"无活动预览"语义状态,或按实现返回成功空操作。

该 Command 无参数。

PreviewEffect Command​

该命令应请求设备使用提供的 EffectData 预览场景而不保存。用户可在添加或更新用户自定义场景前预览该场景。

接收后行为(Effect on Receipt)​

设备接收该命令后,应校验 EffectData 编码合法性与动作类型支持情况。

  • 校验通过时:设备应进入预览状态并执行对应场景效果,且不应写入持久化存储。
  • 校验失败时:设备应返回参数或数据格式错误语义状态。

预览过程中,EffectOperationState 应反映为 Previewing,结束后应恢复为空闲或实现定义状态。

参数​

PreviewEffect Command Structure

RemoveUserDefinedEffect Command​

该命令应请求设备移除现有的用户自定义场景。仅 UserDefined 类型场景可移除,BuiltIn 场景不可移除。

接收后行为(Effect on Receipt)​

设备接收该命令后,应校验 EffectID 是否存在且属于 UserDefined 范围。

  • 校验通过时:设备应删除该场景记录,并更新 UserDefinedEffects 列表。
  • 若 EffectID 不存在:应返回"场景不存在"语义错误。
  • 若目标为 BuiltIn 场景:应返回"非用户自定义场景不可删除"语义错误。
参数​

RemoveUserDefinedEffect Command Structure

UpdateUserDefinedEffect Command​

该命令应请求设备更新现有的用户自定义场景。仅 UserDefined 类型场景可更新。

接收后行为(Effect on Receipt)​

设备接收该命令后,应先校验 EffectID 与数据内容合法性。

  • 校验通过时:设备应更新对应场景数据,并保持场景 ID 不变。
  • 若 EffectID 不存在:应返回"场景不存在"语义错误。
  • 若目标为 BuiltIn 场景:应返回"非用户自定义场景不可更新"语义错误。
参数​

UpdateUserDefinedEffect Command Structure

AddUserDefinedEffect Command​

该命令应请求设备添加新的用户自定义场景。新场景类型为 UserDefined。

接收后行为(Effect on Receipt)​

设备接收该命令后,应校验 EffectName 长度与 EffectData 格式。

  • 校验通过且容量未满时:设备应分配新的 UserDefined EffectID,写入场景并更新 UserDefinedEffects。
  • 若当前数量达到 MaxUserDefinedEffects:应返回"场景数量已达上限"语义错误。
  • 若名称或数据不合法:应返回参数错误语义状态。
参数​

AddUserDefinedEffect Command Structure

GetEffectData Command​

该命令应请求设备返回指定 EffectID 的场景数据。客户端可用于读取已存储的场景数据(如显示、备份或编辑)。

接收后行为(Effect on Receipt)​

设备接收该命令后,应校验 EffectID 是否存在于 BuiltIn 或 UserDefined 列表。

  • 校验通过时:设备应返回对应 EffectData。
  • 校验失败时:应返回"无效场景 ID"或"场景不存在"语义错误。
参数​

GetEffectData Command Structure

StartEffect Command​

该命令应请求设备启动指定窗饰场景。

目标 EffectID 应存在于 BuiltInEffects 或 UserDefinedEffects 列表中。

接收后行为(Effect on Receipt)​

设备接收该命令后,应校验目标 EffectID 的存在性与可执行性。

  • 校验通过时:设备应启动对应场景,将 CurrentEffectID 更新为目标 ID,并更新 EffectOperationState 为执行中。
  • 校验失败时:应返回"场景不存在"或"场景无效"语义错误。
参数​

StartEffect Command Structure

GoToPositionRotationPercentage Command​

GoToPositionRotationPercentage 命令用于将窗饰设备的目标俯仰位置设置为命令中指定的百分比值。TargetPositionRotationPercentage 应设置为 RotationPercentage;完成后,CurrentPositionRotationPercentage 将设置为命令中指定的百分比值。

接收后行为(Effect on Receipt)​

设备接收该命令后,应将 RotationPercentage 约束在设备支持范围内,并写入 TargetPositionRotationPercentage。

设备应驱动执行俯仰移动;到达目标后应更新 CurrentPositionRotationPercentage。若受机械边界限制无法完全到达,应在可达边界停止并上报实际位置。

参数​

GoToPositionRotationPercentage Command Structure

RotationControl Command​

该命令应请求设备按指定方向执行旋转控制。

设备应结合当前角度边界、分辨率与机械约束执行旋转,必要时在边界处停止。

参数​

RotationControl Command Structure

StepPosition Command​

该命令应请求设备执行相对位置步进。

步进方向由 Size 的符号决定;设备应在可控范围内裁剪目标值并按可用分辨率执行。

接收后行为(Effect on Receipt)​

设备接收该命令后,应按 Size 计算相对目标位置。

  • 当 Size > 0:按打开方向步进。
  • 当 Size < 0:按关闭方向步进。
  • 当 Size = 0:设备可按实现返回无动作成功,或返回参数无效语义错误。

若提供 Time,设备应按该时长执行过渡;若未提供则按设备默认策略执行。计算结果超出边界时,应裁剪到最小/最大可达位置。

参数​

StepPosition Command Structure

GoToPositionPercentage Command​

该命令应请求设备移动到指定开合百分比位置。

当 TransitionTime 提供时,设备应尽量按指定时长完成过渡;否则按设备默认策略执行。

接收后行为(Effect on Receipt)​

设备接收该命令后,应校验并规范化 PositionPercentage,将其写入 TargetPositionPercentage。

设备应驱动位置过渡,并在运动过程中更新 MotorOperationStatus;达到目标后应更新 CurrentPositionPercentage。

当 TransitionTime 不可满足或设备不支持定时过渡时,设备可按实现能力采用最近可行策略,但不应超出位置边界。

参数​

GoToPositionPercentage Command Structure

AutoControl Command​

该命令应请求设备执行产品定义的自动控制动作(如在预设目标间切换)。

具体策略由设备实现定义,客户端可结合当前状态与配置进行触发。

该 Command 无参数。

StopMotion Command​

该命令应请求设备立即停止当前运动。

执行成功后,设备应保持当前位置并更新相关运行状态。

该 Command 无参数。

GoToMinPositionPercentage Command​

该命令应请求设备移动到最小开合百分比位置(通常对应完全关闭或设备定义的最小端点)。

该 Command 无参数。

GoToMaxPositionPercentage Command​

该命令应请求设备移动到最大开合百分比位置(通常对应完全打开或设备定义的最大端点)。

该 Command 无参数。

Lifter(升降机功能)​

简介​

提供升降类设备的行程控制,支持设定目标位置、停止及状态查询。

Function 标识​

Function IDCode名称
0x008ALifter升降机功能

Trait​

Trait IDCode名称Conformance
0x80A4TargetPositionPercentage目标位置百分比M
0x80A3CurrentPositionPercentage当前位置百分比M
0x80F9TripTime行程时间O

Command​

Command IDCode名称Conformance
0x80AAGoToPositionPercentage至指定开合比M
0x80A8StopMotion停止M
0x80A7GoToMinPositionPercentage至最小M
0x80A6GoToMaxPositionPercentage至最大M
0x80A9AutoControl自动控制O

数据类型​

GoToPositionPercentage Command Structure Type​

GoToPositionPercentage Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PositionPercentagefloatM开合比。
1TransitionTimeuint32O时间。

Trait 定义​

Trait IDNameConformance
0x80A4TargetPositionPercentageM
0x80A3CurrentPositionPercentageM
0x80F9TripTimeO

TargetPositionPercentage Trait(目标位置百分比)​

该 Trait 用于「目标位置百分比」相关数据的访问与上报。

Trait IDCode
0x80A4TargetPositionPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

CurrentPositionPercentage Trait(当前位置百分比)​

以 0% 至 100% 的百分比标识实际位置,默认步进 1%。

Trait IDCode
0x80A3CurrentPositionPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

TripTime Trait(行程时间)​

指示电机行程时间,即从完全打开到完全关闭(或相反)所需的时间(秒)。取值范围为 1 至 300 秒,默认 1 秒。

Trait IDCode
0x80F9TripTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVO
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO

Command 定义​

Command IDNameConformance
0x80AAGoToPositionPercentageM
0x80A8StopMotionM
0x80A7GoToMinPositionPercentageM
0x80A6GoToMaxPositionPercentageM
0x80A9AutoControlO

GoToPositionPercentage Command​

该 Command 用于执行「至指定开合比」操作。

参数​

GoToPositionPercentage Command Structure

StopMotion Command​

该 Command 用于执行「停止」操作。

该 Command 无参数。

GoToMinPositionPercentage Command​

该 Command 用于执行「至最小」操作。

该 Command 无参数。

GoToMaxPositionPercentage Command​

该 Command 用于执行「至最大」操作。

该 Command 无参数。

AutoControl Command​

该 Command 用于执行「自动控制」操作。

该 Command 无参数。

IRControl(红外控制)​

简介​

提供红外发射控制能力,用于控制空调、电视等传统红外家电。

Function 标识​

Function IDCode名称
0x008BIRControl红外控制

Trait​

Trait IDCode名称Conformance
0x80CCIRKey红外指令M
0x80ACIRType红外类型M
0x5089IRRemoteId红外遥控码 IDO
0x5088IRBrandId红外品牌 IDO
0x506FIRCodeMatchStatus红外码匹配状态O
0x508AIRLearnResult红外学习结果O

Command​

Command IDCode名称Conformance
0x9D60SetIRDeviceInfo配置红外设备信息O
0x80ADSendIRCode发送红外指令O
0x9D71SendIrKey发送红外按键O

数据类型​

IRKeyEnum32 Type​

该枚举定义 IRKey Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ReservedReserved
0x01PowerPower
0x02ModeMode
0x03Temp+Temp+
0x04Temp-Temp-
0x05WindSpeedWindSpeed
0x25A5P_KEYP_KEY
IRTypeEnum8 Type​

该枚举定义 IRType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00AirConditionerAirConditioner
0x01TVTV
0x02FanFan
0x03TVBoxTVBox
0x04ProjectorProjector
0x05SettopBoxSettopBox
0x06DVDDVD
0x07HeaterHeater
0x08AirPurifierAirPurifier
0x09SpeakerSpeaker
0x0ALightingLighting
0x0BCameraCamera
0x0CCustomizeCustomize
IRCodeMatchStatusEnum8 Type​

该枚举定义 IRCodeMatchStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Default默认
0x01MatchSuccess匹配成功
0x02MatchFailure匹配失败
0x03Redownload重新下载固件
0x04DownloadSuccess码库下载成功
IRLearnResultTraitPresentValueStructure Type​

该结构体定义 IRLearnResult Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0didcharacterStringM执行红外学习的网关 Device ID。
1ircodecharacterStringM学习到的红外码(Base64 或 Hex 编码)。
2keycharacterStringM学习过程中生成的 Key ID。
3lenuint32M红外码长度(比特数或字节数)。
4successuint32M状态码:0 表示成功,非 0 表示失败。
SetIRDeviceInfo Command Structure Type​

SetIRDeviceInfo Command 的参数结构体。

结构体成员序号字段名类型必须说明
0BrandIduint32M品牌ID;默认值为 0。
1RemoteIduint32M遥控器ID;默认值为 0。
2ACModeuint32OAC模式;默认值为 0。
3ACTypeuint32OAC类型;默认值为 0。
SendIRCode Command Structure Type​

SendIRCode Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Modeenum8M模式。
1BrandIduint32M品牌DI。
2RemoteIduint32M遥控器ID。
3IRCodecharacterStringO红外压缩码。
4IRCodeLengthuint16O红外原始数据长度。
5ACKeycharacterStringO空调状态数据。
6Frequencyuint32M红外发射频率。
SendIrKey Command Structure Type​

SendIrKey Command 的参数结构体。

结构体成员序号字段名类型必须说明
0IRKeyuint32O红外按键。

Trait 定义​

Trait IDNameConformance
0x80CCIRKeyM
0x80ACIRTypeM
0x5089IRRemoteIdO
0x5088IRBrandIdO
0x506FIRCodeMatchStatusO
0x508AIRLearnResultO

IRKey Trait(红外指令)​

该 Trait 用于「红外指令」相关数据的访问与上报。

Trait IDCode
0x80CCIRKey
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueIRKeyEnum320WM
0x0006Supported Valuelist[IRKeyEnum32]RO
0x0007Default ValueIRKeyEnum320RWO

IRType Trait(红外类型)​

定义 IR 遥控器的设备类型。

Trait IDCode
0x80ACIRType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueIRTypeEnum80RVWM
0x0006Supported Valuelist[IRTypeEnum8]RO
0x0007Default ValueIRTypeEnum80RWO

IRRemoteId Trait(红外遥控码 ID)​

指示红外设备的遥控器标识符(码库 ID)。

Trait IDCode
0x5089IRRemoteId
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32O0RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint32O0RWO

IRBrandId Trait(红外品牌 ID)​

指示红外设备(如空调、电视)的品牌标识。

Trait IDCode
0x5088IRBrandId
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32O0RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint32O0RWO

IRCodeMatchStatus Trait(红外码匹配状态)​

指示红外码匹配或码库下载状态。值 0 = 默认(空闲),1 = 匹配成功,2 = 匹配失败,3 = 需要重新下载文件,4 = 码库下载成功。

Trait IDCode
0x506FIRCodeMatchStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueIRCodeMatchStatusEnum8O0RVO
0x0006Supported Valuelist[IRCodeMatchStatusEnum8]RO
0x0007Default Valueuint8O0RWO

IRLearnResult Trait(红外学习结果)​

上报红外码学习操作的结果。设备完成 IR 码学习时发布该结果。值为结构体,包含:

did(characterString):执行学习的网关 Device ID。

ircode(characterString):已学习的红外码(base64 或 hex 编码)。

key(characterString):学习过程中生成的 Key ID。

len(uint32):已学习 IR 码的长度(位数或字节数)。

success(uint32):状态码,0 表示成功,1 表示失败(或其他非零值表示特定错误)。

Trait IDCode
0x508AIRLearnResult
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueIRLearnResultTraitPresentValueStructureRVO

Command 定义​

Command IDNameConformance
0x9D60SetIRDeviceInfoO
0x80ADSendIRCodeO
0x9D71SendIrKeyO

SetIRDeviceInfo Command​

该命令配置红外设备信息,包括品牌 ID、遥控器 ID、空调模式及空调类型。收到该命令后,设备下载对应的遥控码库。所有字段置 0 可将设备恢复为出厂未配置状态。

参数​

SetIRDeviceInfo Command Structure

SendIRCode Command​

该 Command 用于执行「发送红外指令」操作。

参数​

SendIRCode Command Structure

SendIrKey Command​

该命令发送红外按键以控制目标设备(如空调、电视)。

参数​

SendIrKey Command Structure

EnergyManagement(电量管理)​

简介​

能量管理(EnergyManagement)用于描述设备的能量测量与管理能力,包括电压、电流、功率、电能及并网状态等数据。

缩写与单位​

本节及相关能源 Function 使用以下缩写和单位。首次阅读能源数据定义时,可先参考本表。

缩写/单位英文全称中文说明
PCCPoint of Common Coupling并网点;用户能源系统与公用电网连接的计量边界。
PCSPower Conversion System储能变流器;在电池直流侧与交流系统之间进行电能变换的设备。
BMSBattery Management System电池管理系统;监测和管理电池状态与运行边界。
SOCState of Charge荷电状态;电池当前可用荷电量的百分比。
SOHState of Health健康状态;描述电池相对于初始状态的性能/容量健康程度。
ACAlternating Current交流电。
DCDirect Current直流电。
Wwatt瓦,功率单位。
kWkilowatt千瓦,功率单位;1 kW = 1000 W。
W·hwatt-hour瓦时,电能单位。
kWhkilowatt-hour千瓦时,电能单位;1 kWh = 1000 W·h。
UTCCoordinated Universal Time协调世界时;本规范时间戳以 UTC Unix epoch 毫秒表示。
Unix epochUnix epoch timeUnix 时间纪元;自 1970-01-01T00:00:00Z 起累计的时间。

能源数据模型使用指南​

本节说明能源数据中常见概念及其边界,帮助实现者根据设备实际计量位置选择 Function 和 Trait。能源数据是否可比较,首先取决于测量边界、方向约定和统计周期是否一致;仅有相同单位并不意味着数据具有相同含义。

基本概念​

概念含义常见单位说明
功率(Power)某一时刻能源传输或消耗的速率W、kW瞬时测量值;功率随时间积分后得到电能。
电能(Energy)一段时间内传输或消耗的能量W·h、kWh累计电能通常是非负计数器,进口和出口应分别累计,不应互相抵消。
进口/购电(Import)电能从电网流向用户侧W、W·h并网点的进口功率/电量,用于表示从电网购入的电力。
出口/送电(Export)电能从用户侧流向电网W、W·h并网点的出口功率/电量,用于表示向电网反送的电力。
发电(Generation)发电设备输出的电能W、W·h光伏总发电量包含现场自用和并网输出,不等于并网反送电量。
充电/放电(Charge/Discharge)电能分别流入/流出储能电池W、W·h应按电池侧边界分别计量;充电和放电使用独立的非负值。
SOC电池当前可用荷电状态的百分比%由电池管理系统估算或测量;不等同于备用电池的剩余电量属性。
需量(Demand)指定积分周期内的平均功率W、kW最大需量是计费周期内各需量区间平均功率的最大值,不是瞬时功率峰值。

储能当前可用电量估算​

EnergyStorage/StoredEnergy 优先使用设备直接报告的有效值。消费者仅在同一电池的 EnergyStorage/StateOfCharge 为可信、有效且时效足够的值,并且 EnergyStorage/UsableEnergyCapacity 为当前有效值时,才可估算当前可用电量:

当前可用电量 = UsableEnergyCapacity × StateOfCharge / 100

此处 SOC 的 0% 和 100% 分别对应 BMS 配置的可用放电下限和充电上限,因此不应再次按可选的 SOC 下限/上限参数对 SOC 进行归一化。额定容量、SOH、功率限值或缺失的参数均不能替代可信 SOC 或可用容量;任一输入缺失、无效、过期或语义不明时,不得计算或将结果伪报为 0。RatedEnergyCapacity、UsableEnergyCapacity、SOC 允许范围、最大充放电功率和 SOH 默认均为可选信息。

测量边界与方向​

在 PCC 上,进口表示电能从电网进入用户侧,出口表示电能从用户侧送往电网。CurrentForwardTotalActiveEnergy 和 CurrentReverseTotalActiveEnergy 在电表/并网点场景中分别表示进口累计电量和出口累计电量;二者均为非负累计值。

设备侧数据必须使用该设备的物理边界进行解释:

  • 光伏发电量表示逆变器交流输出侧的总发电量;并网点出口电量只表示送入电网的部分,不能代替总发电量。
  • 储能充放电量和功率以电池直流端为边界;电表的进口/出口电量以电网交流并网点为边界。两种边界之间存在 PCS 的转换损耗,不能直接当作相等。
  • 对储能设备,EnergyStorage 中的充电功率/电量为能量流入电池,放电功率/电量为能量流出电池。分项功率和电量均为非负值。
  • ElectricityMetering/GridActivePower 使用带符号值:正值表示从上游电源流向用户侧(PCC 上即购电),负值表示反向流动(PCC 上即送电)。

无符号的进口、出口、发电、充电和放电累计量分别计数,避免净额计算丢失方向信息。对累计值进行跨设备比较或求和前,必须确认测量边界、倍率、单位、计数器复位/回卷处理和统计时间范围一致。

累计量与计数器代际​

累计量表示自计量起点以来的非负总量。同一设备端点、Function、Trait、计量边界及计数器字段构成一个计数器身份。实现必须保证逻辑累计值单调不减;设备重启、网络重连或软件升级不得导致读数回退。能保证逻辑累计值连续的实现可以不提供计数器代际。

当实现无法保证逻辑累计值连续,且要求消费者精确计算差值时,必须在对应累计量 Trait 上提供 Counter Generation Parameter(Parameter ID 0x0010,Uint32);该 Parameter 与 Present Value、Minimum Value、Maximum Value 等 Trait Parameter 同级,默认不要求实现。初始代际为 0;计数器清零、无法连续补偿的回卷或更换底层计量器导致累计读数重新起算时,设备必须先递增代际,再发布新读数。代际必须持久保存、不得回退;达到 4294967295 前必须建立新的设备端点/计数器身份,不能回绕。读数与代际必须来自同一一致性快照。若设备能够在底层计量器更换或计数器回卷后无损维持逻辑累计值,则可继续使用同一代际或不提供代际。

Maximum Value 表示 Trait 数值范围上限,不自动表示硬件回卷模数。设备应优先补偿可识别的硬件回卷以维持逻辑累计值;不能无损补偿且要求精确差值时,递增代际并按下述规则重新建立基线。

消费者仅在计数器身份相同、且新读数不小于旧读数时计算差值:delta = newValue - oldValue。若提供代际,还必须确认新旧代际相同;代际改变时,该采样间隔的差值未知,消费者应以新读数建立基线,不得把它当作该间隔的消耗量。代际未变但读数下降属于无效/不一致数据,不得按回零或回卷静默修正。未提供代际且读数下降时,消费者无法判定是重置、回卷还是异常,应标记差值不可用并以新读数建立基线。首次读数只建立基线,除非另有可靠的计量起点。

当累计量是结构体列表中的成员时,每个独立计数器可在对应数据项中携带 CounterGeneration;计数器身份还包括稳定的列表键(例如回路号、费率寄存器号)及累计方向。只有当实现无法保证逻辑累计值连续且要求精确差值时,该字段才是必需的。来源协议未提供代际时,适配器只有在能可靠识别重置/换表事件时才能生成代际;仅凭读数下降无法区分重置、回卷和异常值。无法识别时必须标记差值不可用并重新建立基线,不得伪造精确增量。

Function 选择指南​

设备/用途推荐 Function主要数据不应混淆的概念
通用电气参数或用电设备EnergyManagement电压、电流、功率、累计耗电量该 Function 中的 CumulativeEnergyConsumption 表示耗电,不代表发电。
光伏逆变器/发电设备EnergyManagementGeneratedActivePower、CumulativeGeneratedActiveEnergy总发电量不同于并网点出口电量;自用电量不会计入出口寄存器。
电池储能系统EnergyManagement + EnergyStorage并网/设备电气参数,以及 SOC、容量、充放电、SOHPowerSource/BatPercentRemaining 是设备供电电池剩余量,不是储能系统 SOC。
电能表/并网点计量设备EnergyManagement + ElectricityMetering进口/出口电量、带方向的并网功率、需量、分时寄存器电表测量位置和时间/费率配置决定数据含义;不等同于光伏发电计量。

常见能源流示例​

在住宅光伏储能系统中,并网点电表报告从电网购入的进口电量和向电网送出的出口电量;光伏逆变器报告光伏总发电量;电池管理系统报告电池侧 SOC、累计充电量和累计放电量。用户侧负载耗电量可由专用负载电表报告,或在测量边界、时间同步和转换损耗均明确时由其他计量值推算。不同设备的数据不能仅凭数值相减/相加来推导未测量的量。

Function 标识​

Function IDCode名称
0x008CEnergyManagement电量管理

Trait​

Trait IDCodeConformance
0x8141PowerModeO
0x4EABConfiguredLoadVoltageO
0x80B1CurrentPowerO
0x80B0CurrentVoltageO
0x4E80ConfiguredLoadPowerO
0x4E3DCircuitCurrentO
0x80B2CumulativeEnergyConsumptionO
0x51B0PhaseAVoltageO
0x51B1PhaseBVoltageO
0x51B2PhaseCVoltageO
0x51B3CurrentForwardTotalActiveEnergyO
0x51B4CurrentReverseTotalActiveEnergyO
0x51B5PhaseACurrentO
0x51B6PhaseBCurrentO
0x51B7PhaseCCurrentO
0x51B8FrequencyO
0x51B9TotalActivePowerO
0x51BATotalReactivePowerO
0x51BBTotalApparentPowerO
0x51BCPowerFactorO
0x51F7CumulativeGeneratedActiveEnergyO
0x51F8GeneratedActivePowerO
0x5232SystemInterconnectionStatusO

Command​

本 Function 不包含 Command。

数据类型​

PowerModeEnum8 Type​

该枚举定义 PowerMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01Mains市电
0x02Battery电池
0x03DCSource直流电源
0x04ACSource交流电源
SystemInterconnectionStatusEnum8 Type​

该枚举表示能源设备与电网的连系状态。目前定义自立运行取值;其他取值应在语义和互操作规则明确后追加。

ValueNameDescription
0x00Independent自立运行

Trait 定义​

Trait IDNameConformance
0x8141PowerModeO
0x4EABConfiguredLoadVoltageO
0x80B1CurrentPowerO
0x80B0CurrentVoltageO
0x4E80ConfiguredLoadPowerO
0x4E3DCircuitCurrentO
0x80B2CumulativeEnergyConsumptionO
0x51B0PhaseAVoltageO
0x51B1PhaseBVoltageO
0x51B2PhaseCVoltageO
0x51B3CurrentForwardTotalActiveEnergyO
0x51B4CurrentReverseTotalActiveEnergyO
0x51B5PhaseACurrentO
0x51B6PhaseBCurrentO
0x51B7PhaseCCurrentO
0x51B8FrequencyO
0x51B9TotalActivePowerO
0x51BATotalReactivePowerO
0x51BBTotalApparentPowerO
0x51BCPowerFactorO
0x51F7CumulativeGeneratedActiveEnergyO
0x51F8GeneratedActivePowerO
0x5232SystemInterconnectionStatusO

PowerMode Trait​

指示设备的供电模式。

Trait IDCode
0x8141PowerMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePowerModeEnum80RVO
0x0006Supported Valuelist[PowerModeEnum8]RO

ConfiguredLoadVoltage Trait​

为设备运行配置的负载电压值(单位:伏特),初始化后覆盖内部测量值。

Trait IDCode
0x4EABConfiguredLoadVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat500.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

CurrentPower Trait​

指示当前实时功耗。单位:瓦特(W)。

Trait IDCode
0x80B1CurrentPower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat5000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO

CurrentVoltage Trait​

指示当前测得的电源电压值。单位:伏特(V)。

Trait IDCode
0x80B0CurrentVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat500.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO

ConfiguredLoadPower Trait​

外部配置的有功功率值(瓦),设备在初始设置后应将其作为负载功率使用。单位:W。

Trait IDCode
0x4E80ConfiguredLoadPower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat5000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

CircuitCurrent Trait​

流经特定电路或电路部分的电流,通常用于测量电流负载。单位:A。

Trait IDCode
0x4E3DCircuitCurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default Valuefloat0RWO

CumulativeEnergyConsumption Trait​

该 Trait 用于「累计耗电量」相关数据的访问与上报。单位:W·h。

Trait IDCode
0x80B2CumulativeEnergyConsumption
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat1.0E8RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO

CumulativeGeneratedActiveEnergy Trait​

累计发电量表示当前计数器代际内发电设备输出的累计有功电能。对于光伏设备,计量边界为逆变器交流输出侧,包含现场自用、储能充电和并网输出的发电量;它不是并网点出口电量。该值为非负累计计数器,单位 W·h。设备重启不得清零读数或代际;计数器复位、无法补偿的回卷或计量器更换导致计数重新起算时,须递增 Counter Generation。

Trait IDCode
0x51F7CumulativeGeneratedActiveEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

GeneratedActivePower Trait​

发电功率表示发电设备当前输出的有功功率。对于光伏设备,计量边界为逆变器交流输出侧;该值不包含并网点净功率方向,单位 W。无发电或设备待机时报告 0。

Trait IDCode
0x51F8GeneratedActivePower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-5000000 W0RVO
0x0002Maximum Valuefloat5000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

PhaseAVoltage Trait​

表示三相供电系统中 A 相回路的实时电压值,用于判断该相供电是否稳定,以及是否存在欠压、过压或相间不平衡问题。单位:V。

Trait IDCode
0x51B0PhaseAVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat220RVO
0x0002Maximum Valuefloat500.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat220RWO

PhaseBVoltage Trait​

表示三相供电系统中 B 相回路的实时电压值,用于判断该相供电稳定性及电压异常情况。单位:V。

Trait IDCode
0x51B1PhaseBVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat220RVO
0x0002Maximum Valuefloat500.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat220RWO

PhaseCVoltage Trait​

表示三相供电系统中 C 相回路的实时电压值,用于判断该相供电稳定性及电压异常情况。单位:V。

Trait IDCode
0x51B2PhaseCVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat220RVO
0x0002Maximum Valuefloat500.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat220RWO

CurrentForwardTotalActiveEnergy Trait​

表示设备从电网正向获取的累计有功电能,常用于统计实际用电量、能耗分析和计费结算。单位:W·h。

在并网点电表场景中,正向规定为从电网流向用户侧(进口/购电),该值为非负累计值。其他测量边界必须在对应设备/Function 的定义中明确正向含义,不得仅凭 Forward 名称推断为发电或储能充电。

Trait IDCode
0x51B3CurrentForwardTotalActiveEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat100000000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

CurrentReverseTotalActiveEnergy Trait​

表示设备向电网反送的累计有功电能,常用于分析回馈电能、并网运行和能量回收情况。单位:W·h。

在并网点电表场景中,反向规定为从用户侧流向电网(出口/送电),该值为非负累计值。该值不等于发电设备的总发电量;其他测量边界必须在对应设备/Function 的定义中明确反向含义。

Trait IDCode
0x51B4CurrentReverseTotalActiveEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat100000000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

PhaseACurrent Trait​

表示三相供电系统中 A 相回路的实时电流值,可用于判断该相负载大小、运行电流状态以及是否存在过载风险。

Trait IDCode
0x51B5PhaseACurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default Valuefloat0RWO

PhaseBCurrent Trait​

表示三相供电系统中 B 相回路的实时电流值,可用于判断该相负载大小以及三相是否存在偏载。单位:A。

Trait IDCode
0x51B6PhaseBCurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default Valuefloat0RWO

PhaseCCurrent Trait​

表示三相供电系统中 C 相回路的实时电流值,可用于判断该相负载大小以及三相是否存在偏载。单位:A。

Trait IDCode
0x51B7PhaseCCurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default Valuefloat0RWO

Frequency Trait​

表示交流供电系统的实时频率,用于判断电网运行是否稳定,以及是否存在频率波动或供电异常。单位:Hz。

Trait IDCode
0x51B8Frequency
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat50RWO

TotalActivePower Trait​

表示设备当前实际做功的总功率,是反映真实负载水平、能耗状态和运行强度的重要指标。单位:W。

Trait IDCode
0x51B9TotalActivePower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat5000000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

TotalReactivePower Trait​

表示设备当前的总无功功率,可用于评估无功补偿需求、电能质量水平和供配电运行状态。单位:kvar。

Trait IDCode
0x51BATotalReactivePower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat5000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

TotalApparentPower Trait​

表示设备当前的总视在功率,即电压与电流形成的综合功率量,用于配合有功功率和功率因数分析负载特性。单位:kVA。

Trait IDCode
0x51BBTotalApparentPower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat5000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

PowerFactor Trait​

表示交流回路中有功功率与视在功率的比值,用于衡量电能被有效利用的程度。数值越接近 1,说明无功损耗越小,常用于配电监测、能效评估和运行分析。

Trait IDCode
0x51BCPowerFactor
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVO
0x0002Maximum Valuefloat1.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat1RWO

SystemInterconnectionStatus Trait​

系统连系状态表示能源设备当前的电网连接运行方式;目前定义自立运行状态,其他状态待语义和互操作规则明确后追加。

Trait IDCode
0x5232SystemInterconnectionStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSystemInterconnectionStatusEnum80无固定默认值RVO

Command 定义​

本 Function 不包含 Command。

HeaterCooler(冷暖控制功能)​

简介​

提供制冷/制热控制能力,包括目标温度、运行模式、风速等暖通参数。

Function 标识​

Function IDCode名称
0x008DHeaterCooler冷暖控制功能

Trait​

Trait IDCode名称Conformance
0x80B3HeaterCoolerMode制热制冷模式M
0x80B8CurrentTemperature温度O
0x5050TRVValvePosition阀门开合O
0x504FSummerMode夏日制冷模式O
0x5045Schedules智能日程O
0x5044ActiveScheduleHandle当前日程句柄O
0x5043NumberOfScheduleTransitionPerDay每日日程变更次数O
0x5042NumberOfScheduleTransitions日程变更次数O
0x5041NumberOfSchedules日程数量O
0x5040ScheduleTypes日程类型O
0x4EF2Preset预设O
0x4EF1ActivePresetHandle主动预设句柄O
0x4EF0NumberOfPresets预设数量O
0x4EEFPresetTypes预设类型O
0x4EC4AntiFreezeTemperature防冻温度O
0x4E82HeaterCoolerPolarity温控器极性设置O
0x4E81HeaterCoolerButtonEvent温控按键事件O
0x4E6CSetBack温度浮动O
0x4E37TemperatureUIDisplayMode温度用户界面显示模式O
0x8144MinHeatCoolDeadBand制冷制热温度最小死区O
0x80B9CurrentHumidity湿度O
0x80B5CoolingTemperature制冷温度O
0x80B4HeatingTemperature制热温度O
0x4E5BSetTemperature设置温度O
0x5154AcPreheatStatus空调预热状态O
0x5156FilterCleanRequired滤网是否需清洗O
0x5157AcPumpStatus空调水泵状态O
0x5158HvacCommStatus暖通设备通讯状态O
0x5159AntifreezeModeEnable防冻模式使能O
0x515AFloorHeatingBrand地暖品牌O
0x515BQuickCoolEnable空调开机速冷开关O
0x515FThermostatBaseType温控器底座类型O
0x5160AcSelfCleaningEnable空调自清洁开关O
0x5161AcErrorCode空调故障码O
0x5164AcBrand空调品牌O
0x5165DefrostStatus除霜状态O
0x5167FloorHeatingErrorCode地暖故障码O
0x5168AntifreezeStatus防冻保护状态O
0x518EOpenWindowAlarm开窗告警O
0x518FEnableOpenWindowDetection开窗检测使能O
0x5190OpenWindowTemperatureControlPauseDuration检测开窗后暂停控温时长O

Command​

Command IDCode名称Conformance
0x9D65SetHvac控制暖通空调O
0x9D40SetActiveSchedule设置当前日程O
0x9C72ClearActivePreset清除主动预设O
0x9C71SetActivePreset设置主动预设O
0x9DB1ClearOpenWindowAlarm清除开窗告警O

数据类型​

HeaterCoolerModeEnum8 Type​

该枚举定义 HeaterCoolerMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Cool制冷
0x01Heat制热
0x02Auto自动
0x03Fan送风
0x04Dry除湿
0x05Sleep睡眠
0x06FreshAir新风
0x07FloorHeat地暖
0x08HeatandFloorHeat强热
0x09FloorHeatandFreshAir地暖+新风
0x0AEmergencyHeat速热
0x0BPrecooling预冷
0x0COff关闭
0x0DManual手动
0x0EAntiFreeze防冻
SchedulesTraitPresentValueStructure Type​

该结构体定义 Schedules Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0ScheduleHandlecharacterStringO日程句柄;新建日程时为 null。
1SystemModeenum8M系统模式。
2Transitionslist[Struct]M日程转换列表(ScheduleTransitionStruct)。
3BuiltInbooleanM是否为内置日程。
ScheduleTypesTraitPresentValueStructure Type​

该结构体定义 ScheduleTypes Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0SystemModeenum8M系统模式(与 HeaterCoolerMode 枚举一致)。
1NumberOfSchedulesuint8M该模式下支持的日程数量。
2ScheduleTypeFeaturesuint8M日程类型特性位图。
PresetTraitPresentValueStructure Type​

该结构体定义 Preset Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0PresetHandlecharacterStringM预设句柄。
1PresetScenarioenum8M预设场景:1=Occupied,2=Unoccupied,3=Sleep,4=Wake,5=Vacation,6=GoingToSleep;7-254=Reserved。
2NamecharacterStringO预设名称;若为 null 则省略该字段。
3CoolingSetpointfloatO制冷设定温度,默认 26。
4HeatingSetpointfloatO制热设定温度,默认 20。
5BuiltInbooleanM是否为内置预设,默认 false。
HeaterCoolerPolarityEnum8 Type​

该枚举定义 HeaterCoolerPolarity Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Forward正向(制热)
0x01Reverse反向(制冷)
0x02Bidirectional双向
HeaterCoolerButtonEventEnum8 Type​

该枚举定义 HeaterCoolerButtonEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x00PowerShortPress电源短按
0x01FanSpeedShortPress风速短按
0x02TempUpShortPress温度+短按
0x03TempDownShortPress温度-短按
0x04ModeShortPress模式短按
0x10PowerMidPress电源中按
0x11FanSpeedMidPress风速中按
0x12TempUpMidPress温度+中按
0x13TempDownMidPress温度-中按
0x14ModeMidPress模式中按
0x30PowerLongPress电源长按
0x31FanSpeedLongPress风速长按
0x32TempUpLongPress温度+长按
0x33TempDownLongPress温度-长按
0x34ModeLongPress模式长按
TemperatureUIDisplayModeEnum8 Type​

该枚举定义 TemperatureUIDisplayMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Celsius摄氏度
0x01Fahrenheit华氏度
AcPumpStatusEnum8 Type​

该枚举定义 AcPumpStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off关闭
0x01On开启
HvacCommStatusEnum8 Type​

该枚举定义 HvacCommStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Abnormal通讯异常
0x01Normal通讯正常
ThermostatBaseTypeEnum8 Type​

该枚举定义 ThermostatBaseType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01Freon氟机版
0x02Water水机版
DefrostStatusEnum8 Type​

该枚举定义 DefrostStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00No否
0x01Yes正在除霜中
AntifreezeStatusEnum8 Type​

该枚举定义 AntifreezeStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Inactive未处于防冻保护
0x01Active处于防冻保护中
OpenWindowAlarmEnum8 Type​

该枚举定义 OpenWindowAlarm Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NoAlarm无开窗告警
0x01InternalOpenWindowAlarm内置探头检测到开窗告警
0x02ExternalOpenWindowAlarm外部传感器检测到开窗告警
SetHvac Command Structure Type​

SetHvac Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Powerenum8O开关;默认值为 0。
1Modeenum8O模式;默认值为 0。
2TemperaturefloatO设定温度;默认值为 26。
3FanSpeedenum8O风速;默认值为 0。
4SwingDirectionenum8O风向;默认值为 0。
5LightSwitchenum8O灯光开关;默认值为 0。
SetActiveSchedule Command Structure Type​

SetActiveSchedule Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ScheduleHandlecharacterStringM日程句柄。
SetActivePreset Command Structure Type​

SetActivePreset Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PresetHandlecharacterStringM预设操作。

Trait 定义​

Trait IDNameConformance
0x80B3HeaterCoolerModeM
0x80B8CurrentTemperatureO
0x5050TRVValvePositionO
0x504FSummerModeO
0x5045SchedulesO
0x5044ActiveScheduleHandleO
0x5043NumberOfScheduleTransitionPerDayO
0x5042NumberOfScheduleTransitionsO
0x5041NumberOfSchedulesO
0x5040ScheduleTypesO
0x4EF2PresetO
0x4EF1ActivePresetHandleO
0x4EF0NumberOfPresetsO
0x4EEFPresetTypesO
0x4EC4AntiFreezeTemperatureO
0x4E82HeaterCoolerPolarityO
0x4E81HeaterCoolerButtonEventO
0x4E6CSetBackO
0x4E37TemperatureUIDisplayModeO
0x8144MinHeatCoolDeadBandO
0x80B9CurrentHumidityO
0x80B5CoolingTemperatureO
0x80B4HeatingTemperatureO
0x4E5BSetTemperatureO
0x5154AcPreheatStatusO
0x5156FilterCleanRequiredO
0x5157AcPumpStatusO
0x5158HvacCommStatusO
0x5159AntifreezeModeEnableO
0x515AFloorHeatingBrandO
0x515BQuickCoolEnableO
0x515FThermostatBaseTypeO
0x5160AcSelfCleaningEnableO
0x5161AcErrorCodeO
0x5164AcBrandO
0x5165DefrostStatusO
0x5167FloorHeatingErrorCodeO
0x5168AntifreezeStatusO
0x518EOpenWindowAlarmO
0x518FEnableOpenWindowDetectionO
0x5190OpenWindowTemperatureControlPauseDurationO

HeaterCoolerMode Trait(制热制冷模式)​

该 Trait 用于「制热制冷模式」相关数据的访问与上报。

Trait IDCode
0x80B3HeaterCoolerMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHeaterCoolerModeEnum80RVWM
0x0006Supported Valuelist[HeaterCoolerModeEnum8]RO
0x0007Default ValueHeaterCoolerModeEnum80RWO

CurrentTemperature Trait(温度)​

指示当前温度。单位:deg C。

Trait IDCode
0x80B8CurrentTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat26RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat26RWO

TRVValvePosition Trait(阀门开合)​

该 Trait 用于「阀门开合」相关数据的访问与上报。单位:%。

Trait IDCode
0x5050TRVValvePosition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

SummerMode Trait(夏日制冷模式)​

该 Trait 用于「夏日制冷模式」相关数据的访问与上报。

Trait IDCode
0x504FSummerMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Schedules Trait(智能日程)​

该 Trait 用于「智能日程」相关数据的访问与上报。

Trait IDCode
0x5045Schedules
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[SchedulesTraitPresentValueStructure]RVWO

ActiveScheduleHandle Trait(当前日程句柄)​

该 Trait 用于「当前日程句柄」相关数据的访问与上报。

Trait IDCode
0x5044ActiveScheduleHandle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

NumberOfScheduleTransitionPerDay Trait(每日日程变更次数)​

该 Trait 用于「每日日程变更次数」相关数据的访问与上报。

Trait IDCode
0x5043NumberOfScheduleTransitionPerDay
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO

NumberOfScheduleTransitions Trait(日程变更次数)​

该 Trait 用于「日程变更次数」相关数据的访问与上报。

Trait IDCode
0x5042NumberOfScheduleTransitions
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO

NumberOfSchedules Trait(日程数量)​

该 Trait 用于「日程数量」相关数据的访问与上报。

Trait IDCode
0x5041NumberOfSchedules
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO

ScheduleTypes Trait(日程类型)​

该 Trait 用于「日程类型」相关数据的访问与上报。

Trait IDCode
0x5040ScheduleTypes
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[ScheduleTypesTraitPresentValueStructure]RVO

Preset Trait(预设)​

该 Trait 用于「预设」相关数据的访问与上报。

Trait IDCode
0x4EF2Preset
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[PresetTraitPresentValueStructure]RVWO

ActivePresetHandle Trait(主动预设句柄)​

该 Trait 用于「主动预设句柄」相关数据的访问与上报。

Trait IDCode
0x4EF1ActivePresetHandle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringnullRVWO
0x0007Default ValuecharacterStringnullRWO

NumberOfPresets Trait(预设数量)​

该 Trait 用于「预设数量」相关数据的访问与上报。

Trait IDCode
0x4EF0NumberOfPresets
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVWO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0007Default Valueuint80RWO

PresetTypes Trait(预设类型)​

该 Trait 用于「预设类型」相关数据的访问与上报。

Trait IDCode
0x4EEFPresetTypes
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVWO

AntiFreezeTemperature Trait(防冻温度)​

防冻保护温度设置通常指触发防冻机制的阈值(例如 5 degC)。

Trait IDCode
0x4EC4AntiFreezeTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat5RVWO
0x0002Maximum Valuefloat15.0RO
0x0003Minimum Valuefloat5.0RO
0x0005Step Valuefloat0.5RO
0x0007Default Valuefloat5RWO

HeaterCoolerPolarity Trait(温控器极性设置)​

指定极性配置,用于确定系统控制制冷还是制热。

Trait IDCode
0x4E82HeaterCoolerPolarity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHeaterCoolerPolarityEnum82RVWO
0x0006Supported Valuelist[HeaterCoolerPolarityEnum8]RO
0x0007Default Valueuint82RWO

HeaterCoolerButtonEvent Trait(温控按键事件)​

温控器或气候控制设备上按钮交互触发的事件。

Trait IDCode
0x4E81HeaterCoolerButtonEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHeaterCoolerButtonEventEnum80RVO
0x0006Supported Valuelist[HeaterCoolerButtonEventEnum8]RO

SetBack Trait(温度浮动)​

表示温控器温度浮动范围,单位:deg C。

Trait IDCode
0x4E6CSetBack
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat25.5RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

TemperatureUIDisplayMode Trait(温度用户界面显示模式)​

该特征应指定温控器内置屏幕显示温度的单位。

Trait IDCode
0x4E37TemperatureUIDisplayMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTemperatureUIDisplayModeEnum80RVWO
0x0006Supported Valuelist[TemperatureUIDisplayModeEnum8]RO
0x0007Default Valueuint80RWO

MinHeatCoolDeadBand Trait(制冷制热温度最小死区)​

指示自动模式下制热与制冷温度之间的最小差值。单位:deg C。

Trait IDCode
0x8144MinHeatCoolDeadBand
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat2RVWO
0x0002Maximum Valuefloat2.5RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat2RWO

CurrentHumidity Trait(湿度)​

该 Trait 用于「湿度」相关数据的访问与上报。单位:%。

Trait IDCode
0x80B9CurrentHumidity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

CoolingTemperature Trait(制冷温度)​

指示制冷温度。单位:deg C。

Trait IDCode
0x80B5CoolingTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat26RVWO
0x0002Maximum Valuefloat32.0RO
0x0003Minimum Valuefloat16.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat26RWO

HeatingTemperature Trait(制热温度)​

指示加热温度。单位:deg C。

Trait IDCode
0x80B4HeatingTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat18RVWO
0x0002Maximum Valuefloat30.0RO
0x0003Minimum Valuefloat5.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat18RWO

SetTemperature Trait(设置温度)​

SetTemperature 允许用户指定和调整设备或系统的目标温度。单位:deg C。

Trait IDCode
0x4E5BSetTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat20RVWO
0x0002Maximum Valuefloat32RO
0x0003Minimum Valuefloat5RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat20RWO

AcPreheatStatus Trait(空调预热状态)​

表示空调当前是否处于预热状态。取值为 0 表示否(未预热),1 表示是(正在预热)。

Trait IDCode
0x5154AcPreheatStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO
0x0007Default Valueboolean0RWO

FilterCleanRequired Trait(滤网是否需清洗)​

表示空调滤网是否需要清洗。取值为 0 表示不需要清洗,1 表示需要清洗。

Trait IDCode
0x5156FilterCleanRequired
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO
0x0007Default Valueboolean0RWO

AcPumpStatus Trait(空调水泵状态)​

表示空调水泵当前的运行状态。取值为 1 表示水泵开启(工作中),0 表示水泵关闭(停止)。

Trait IDCode
0x5157AcPumpStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAcPumpStatusEnum80RVO
0x0006Supported Valuelist[AcPumpStatusEnum8]RO
0x0007Default ValueAcPumpStatusEnum80RWO

HvacCommStatus Trait(暖通设备通讯状态)​

表示暖通设备(如空调、新风系统)与控制器(温控器或网关)之间的通讯链路是否正常。取值为 0 表示通讯异常,此时无法执行控制操作;取值为 1 表示通讯正常,可正常下发控制指令。

Trait IDCode
0x5158HvacCommStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHvacCommStatusEnum81RVO
0x0006Supported Valuelist[HvacCommStatusEnum8]RO
0x0007Default ValueHvacCommStatusEnum81RWO

AntifreezeModeEnable Trait(防冻模式使能)​

用于启用或禁用设备的防冻模式。开启后,设备将启动防冻保护机制(如保持最低温度或循环水路),以防止管路或部件因低温冻结损坏。

Trait IDCode
0x5159AntifreezeModeEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

FloorHeatingBrand Trait(地暖品牌)​

表示当前温控器所连接的地暖系统的品牌名称。该值为可读文本字符串。

Trait IDCode
0x515AFloorHeatingBrand
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

QuickCoolEnable Trait(空调开机速冷开关)​

用于开启或停止空调的速冷(快速制冷)功能。开启(取值1)后,空调将以最大制冷能力运行,快速降低房间温度。停止(取值0)后,速冷功能退出,设备返回正常制冷模式。该 Trait 既可用于下发控制指令(写入),也可用于上报当前速冷状态(上报)。

Trait IDCode
0x515BQuickCoolEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ThermostatBaseType Trait(温控器底座类型)​

表示温控器底座的类型。取值 0 表示未知,1 表示氟机版(制冷剂系统),2 表示水机版(水系统)。

Trait IDCode
0x515FThermostatBaseType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueThermostatBaseTypeEnum80RVO
0x0006Supported Valuelist[ThermostatBaseTypeEnum8]RO

AcSelfCleaningEnable Trait(空调自清洁开关)​

用于开启或关闭空调的自清洁功能。该功能仅在空调处于关机状态且设备支持自清洁时才能启用。开启(取值1)后,空调执行自清洁流程(如干燥、杀菌),以保持内部洁净。

Trait IDCode
0x5160AcSelfCleaningEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AcErrorCode Trait(空调故障码)​

表示空调设备的故障代码,用于诊断运行异常。该值为可读文本字符串。

Trait IDCode
0x5161AcErrorCode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

AcBrand Trait(空调品牌)​

表示温控器所连接的空调设备的品牌名称。该值为可读文本字符串。

Trait IDCode
0x5164AcBrand
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

DefrostStatus Trait(除霜状态)​

表示设备当前是否正在执行除霜操作。取值为 0 表示未在除霜,1 表示正在除霜中。

Trait IDCode
0x5165DefrostStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDefrostStatusEnum80RVO
0x0006Supported Valuelist[DefrostStatusEnum8]RO

FloorHeatingErrorCode Trait(地暖故障码)​

表示地暖设备的故障代码,用于诊断运行异常。该值为可读文本字符串。

Trait IDCode
0x5167FloorHeatingErrorCode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

AntifreezeStatus Trait(防冻保护状态)​

表示温控器当前是否处于防冻保护状态。当处于防冻保护中时,设备会采取相应措施以防止冻坏。

Trait IDCode
0x5168AntifreezeStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAntifreezeStatusEnum80RVO
0x0006Supported Valuelist[AntifreezeStatusEnum8]RO
0x0007Default ValueAntifreezeStatusEnum80RWO

OpenWindowAlarm Trait(开窗告警)​

指示温控器当前的开窗告警状态。

当启用开窗检测(EnableOpenWindowDetection 为 true)且检测到开窗时,温控器将该 Trait 设置为内部探头告警(Internal open window alarm)或外部传感器告警(External open window alarm),并暂停控温。若支持 OpenWindowTemperatureControlPauseDuration,温控器将暂停控温指定时长,除非提前清除告警;若不支持,暂停时长由设备具体实现决定。

当开窗条件解除或通过 ClearOpenWindowAlarmReq 成功清除告警时,温控器将该 Trait 置为无告警(No alarm)并立即恢复控温。当禁用开窗检测(EnableOpenWindowDetection 为 false)时,温控器可将该 Trait 置为无告警并立即恢复控温。

Trait IDCode
0x518EOpenWindowAlarm
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOpenWindowAlarmEnum80RVO
0x0007Default ValueOpenWindowAlarmEnum80RWO

EnableOpenWindowDetection Trait(开窗检测使能)​

指示温控器是否启用开窗检测功能。

设为 true 时,温控器可通过温度快速变化、外部传感器输入或产品特定逻辑检测开窗并相应调整本地控温行为。设为 false 时,温控器不应用特定于开窗检测的控温行为,并将 OpenWindowAlarm 重置为无告警,立即恢复控温。

Trait IDCode
0x518FEnableOpenWindowDetection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

OpenWindowTemperatureControlPauseDuration Trait(检测开窗后暂停控温时长)​

指定触发开窗告警后温控器暂停控温的时长,单位为分钟。

取值范围由最小值(OpenWindowTemperatureControlPauseDurationMin,默认为 1 分钟)和最大值(OpenWindowTemperatureControlPauseDurationMax,默认为 1440 分钟/24 小时)约束。当检测到开窗告警时,温控器将暂停控温该时长,除非通过清除告警命令提前恢复。

Trait IDCode
0x5190OpenWindowTemperatureControlPauseDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1630RVWO
0x0002Maximum Valueuint161440RO
0x0003Minimum Valueuint161RO
0x0007Default Valueuint1630RWO

Command 定义​

Command IDNameConformance
0x9D65SetHvacO
0x9D40SetActiveScheduleO
0x9C72ClearActivePresetO
0x9C71SetActivePresetO
0x9DB1ClearOpenWindowAlarmO

SetHvac Command​

该命令配置空调,可选参数包括:电源、运行模式、目标温度、风速、摆风方向及显示灯。

参数​

SetHvac Command Structure

SetActiveSchedule Command​

该 Command 用于执行「设置当前日程」操作。

参数​

SetActiveSchedule Command Structure

ClearActivePreset Command​

该 Command 用于执行「清除主动预设」操作。

该 Command 无参数。

SetActivePreset Command​

该 Command 用于执行「设置主动预设」操作。

参数​

SetActivePreset Command Structure

ClearOpenWindowAlarm Command​

请求温控器清除当前处于激活状态的开窗告警。

执行成功后,温控器将 OpenWindowAlarm 置为无告警(No alarm),并立即恢复控温。

该 Command 无参数。

FanControl(风扇控制)​

简介​

提供风扇转速与模式控制,支持档位调节及运行状态读取。

Function 标识​

Function IDCode名称
0x008EFanControl风扇控制

Trait​

Trait IDCode名称Conformance
0x80B6FanMode风扇模式M
0x80B7RockSetting扫风O
0x0008FanSpeed风速O
0x0007AirflowDirection风向O
0x0006WindSetting风类型O

Command​

本 Function 不包含 Command。

数据类型​

FanModeEnum8 Type​

该枚举定义 FanMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off关闭
0x01LowSpeed低速
0x02MediumSpeed中速
0x03HighSpeed高速
0x04Auto自动
0x05Smart智能
RockSettingEnum8 Type​

该枚举定义 RockSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off关闭
0x01RockLeftRight左右
0x02RockUpDown上下
0x03RockRound循环
0x04Swing扫风
0x05FixedDirection固定
0x15Fixed固定风向
AirflowDirectionEnum8 Type​

该枚举定义 AirflowDirection Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ForwardForward
0x01ReverseReverse
WindSettingEnum8 Type​

该枚举定义 WindSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Sleep睡眠
0x02Natural自然

Trait 定义​

Trait IDNameConformance
0x80B6FanModeM
0x80B7RockSettingO
0x0008FanSpeedO
0x0007AirflowDirectionO
0x0006WindSettingO

FanMode Trait(风扇模式)​

FanMode 定义了风扇的模式.

Trait IDCode
0x80B6FanMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFanModeEnum80RVWM
0x0006Supported Valuelist[FanModeEnum8]RO
0x0007Default ValueFanModeEnum80RWO

RockSetting Trait(扫风)​

定义摆风/摇头模式。

Trait IDCode
0x80B7RockSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRockSettingEnum80RVWO
0x0006Supported Valuelist[RockSettingEnum8]RO
0x0007Default Valueuint80RWO

FanSpeed Trait(风速)​

anSpeed表示风速百分比。

Trait IDCode
0x0008FanSpeed
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVWO
0x0002Maximum Valueuint8100RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO
0x0007Default Valueuint80RWO

AirflowDirection Trait(风向)​

irflowDirection 定义了风向.

Trait IDCode
0x0007AirflowDirection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAirflowDirectionEnum80RVWO
0x0006Supported Valuelist[AirflowDirectionEnum8]RO
0x0007Default Valueuint80RWO

WindSetting Trait(风类型)​

WindSetting 定义了风的类型.

Trait IDCode
0x0006WindSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWindSettingEnum80RVWO
0x0006Supported Valuelist[WindSettingEnum8]RO
0x0007Default Valueuint80RWO

Command 定义​

本 Function 不包含 Command。

Temperature(温度)​

简介​

测量并上报环境温度,提供当前温度值及有效量程等属性。

Function 标识​

Function IDCode名称
0x008FTemperature温度

Trait​

Trait IDCodeConformance
0x80B8CurrentTemperatureM
0x502FCentiCelsiusTemperatureO
0x5173TemperatureSourceO
0x51BFInletTemperatureO
0x51C0OutletTemperatureO
0x523DOutdoorTemperatureO

Command​

本 Function 不包含 Command。

数据类型​

TemperatureSourceTraitPresentValueStructure Type​

该结构体定义 TemperatureSource Trait 的列表项字段布局。

结构体成员序号字段名类型必须说明
0DeviceDidcharacterStringM温度源设备的唯一标识符(Device DID)。若为本机,填入本机 DID。
1PointPathcharacterStringO温度数据点访问路径,格式为 {Endpoint ID}.{Function ID}.{Trait ID}.{Parameter ID},例如 2.143.32952.1。若为空,则表示采用参数0的设备 ID 所指定设备的默认温度数据点。

Trait 定义​

Trait IDNameConformance
0x80B8CurrentTemperatureM
0x502FCentiCelsiusTemperatureO
0x5173TemperatureSourceO
0x51BFInletTemperatureO
0x51C0OutletTemperatureO
0x523DOutdoorTemperatureO

CurrentTemperature Trait​

指示当前温度。单位:deg C。

Trait IDCode
0x80B8CurrentTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat26RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat26RWO

CentiCelsiusTemperature Trait​

以摄氏度为单位的温度数字表示,其中每个单位等于摄氏度的百分之一( 0.01 degC )。此格式使用整数值来表示高精度温度读数,例如,值2500对应于25.00 degC。

Trait IDCode
0x502FCentiCelsiusTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint320RVO
0x0002Maximum Valueint3210000RO
0x0003Minimum Valueint32-5000RO
0x0005Step Valueuint321RO

TemperatureSource Trait​

表示当前温度数据使用的温度来源配置。该 Trait 为一个列表,每个列表项包含设备 ID(必选)和温度数据点访问路径(可选),用于指定温控器采集的温度来源于本机传感器还是关联的外部传感器。若 point_path 为空,则表示采用该设备 ID 所指定设备的默认温度数据点。当列表中存在多个数据源时,表示数据来源不只一处,可以按照某种约定的规则优先选择某个数据源作为当前温度。

Trait IDCode
0x5173TemperatureSource
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[TemperatureSourceTraitPresentValueStructure]RVWO

InletTemperature Trait​

表示进入流量计所在管段的介质温度,用于结合流量等数据分析运行工况。单位: degC。

Trait IDCode
0x51BFInletTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVO
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

OutletTemperature Trait​

表示离开流量计所在管段的介质温度,用于结合流量等数据分析运行工况。单位: degC。

Trait IDCode
0x51C0OutletTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVO
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

OutdoorTemperature Trait​

室外温度表示设备测量到的室外环境温度,单位 deg C;它与空调室内的 CurrentTemperature 分别报告。

Trait IDCode
0x523DOutdoorTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat-50-100 deg C无固定默认值;报告当前值RVO
0x0002Maximum Valuefloat100RO
0x0003Minimum Valuefloat-50RO
0x0005Step Valuefloat0.1RO

Command 定义​

本 Function 不包含 Command。

RelativeHumidity(湿度)​

简介​

测量并上报环境相对湿度,提供当前湿度值及有效量程等属性。

Function 标识​

Function IDCode名称
0x0090RelativeHumidity湿度

Trait​

Trait IDCode名称Conformance
0x80B9CurrentHumidity湿度M
0x5030CentiPercentHumidity厘百分比湿度O
0x5174HumiditySource湿度源O

Command​

本 Function 不包含 Command。

数据类型​

HumiditySourceTraitPresentValueStructure Type​

该结构体定义 HumiditySource Trait 的列表项字段布局。

结构体成员序号字段名类型必须说明
0DeviceDidcharacterStringM湿度源设备的唯一标识符(Device DID)。若为本机,填入本机 DID。
1PointPathcharacterStringO湿度数据点访问路径,格式:{Endpoint ID}.{Function ID}.{Trait ID}.{Parameter ID},例如 2.144.32953.1。若为空,则表示采用参数 0 的该设备 ID 所指定设备的默认湿度数据点。

Trait 定义​

Trait IDNameConformance
0x80B9CurrentHumidityM
0x5030CentiPercentHumidityO
0x5174HumiditySourceO

CurrentHumidity Trait(湿度)​

该 Trait 用于「湿度」相关数据的访问与上报。单位:%。

Trait IDCode
0x80B9CurrentHumidity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

CentiPercentHumidity Trait(厘百分比湿度)​

湿度值以整数表示,每个单位等于 0.01% 相对湿度(例如值 5000 表示 50.00% RH)。

Trait IDCode
0x5030CentiPercentHumidity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1610000RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO

HumiditySource Trait(湿度源)​

表示当前湿度数据使用的湿度来源配置。该 Trait 为一个列表,每个列表项包含设备 ID(必选)和湿度数据点访问路径(可选),用于指定温控器采集的湿度来源于本机传感器还是关联的外部传感器。若 PointPath 为空,则表示采用参数 0 的该设备 ID 所指定设备的默认湿度数据点。当列表中存在多个数据源时,表示数据来源不只一处,可以按照某种约定的规则优先选择某个数据源作为当前湿度。

Trait IDCode
0x5174HumiditySource
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[HumiditySourceTraitPresentValueStructure]RVWO

Command 定义​

本 Function 不包含 Command。

MediaPlayback(媒体播放)​

简介​

提供媒体播放控制能力,包括播放、暂停、切歌、音量及播放状态管理。

Function 标识​

Function IDCode名称
0x0091MediaPlayback媒体播放

Trait​

Trait IDCode名称Conformance
0x80BACurrentPlaybackState播放状态M
0x80FDTargetPlaybackState目标播放状态M
0x816ASelectedMediaOutputSource当前播放输出源O
0x8169PlaybackSampledPosition当前媒体播放位置O
0x80F7LoginState登录状态O
0x80BFSelectedSource播放源O
0x80BEMediaInformation媒体信息O
0x80BDPlaybackMode播放模式O
0x80BCSampledPosition播放进度O
0x80BBPlaybackDuration时长O
0x5150Playlists播放列表O
0x5151FavoritePlaylists收藏播放列表O

Command​

Command IDCode名称Conformance
0x80C5Stop停止M
0x80C4Pause暂停M
0x80C3Play播放M
0x9C52PlaySpecificList播放列表O
0x9C51Rewind回退O
0x9C50FastForward快进O
0x9C41MediaPlaybackCommand媒体播放命令O
0x9DA6SearchAndPlay搜索并播放歌曲O
0x9DA9PlayPlaylist播放歌单O
0x9DACPlayFavorite播放收藏列表O
0x9DB6PlayMediaURL按链接播放媒体O
0x811AOff关闭O
0x8119On打开O
0x80C8Next下一个O
0x80C7Previous上一个O
0x80C6StartOver重播O

数据类型​

CurrentPlaybackStateEnum8 Type​

该枚举定义 CurrentPlaybackState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Playing播放中
0x01Paused暂停
0x02Stopped停止
0x03Buffering缓冲
0x04FastForwarding快进
0x05Rewinding快退
TargetPlaybackStateEnum8 Type​

该枚举定义 TargetPlaybackState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Play播放
0x01Pause暂停
0x02Stop停止
0x03StartOver重播
0x04FastForward快进
0x05Rewind快退
0x06Previous上一首
0x07Next下一首
0x08PlaySpecificList播放指定歌单
SelectedMediaOutputSourceEnum8 Type​

该枚举定义 SelectedMediaOutputSource Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Internal内置
0x01Bluetooth蓝牙
0x02Aux辅助
0x03SPDIFSPDIF
0x04Coaxial同轴
0x05Audio1音频1
0x06Audio2音频2
0x07Audio3音频3
0x08AV1AV1
0x09AV2AV2
0x0AAV3AV3
0x0BHDMI1HDMI1
0x0CHDMI2HDMI2
0x0DHDMI3HDMI3
0x0EOther其他
SelectedSourceEnum8 Type​

该枚举定义 SelectedSource Trait 的 Present Value 有效取值。

ValueNameDescription
0x00InternalInternal
0x01BluetoothBluetooth
0x02ExternalExternal
PlaybackModeEnum8 Type​

该枚举定义 PlaybackMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ShuffleShuffle
0x01OrderOrder
0x02SingleCycleSingleCycle
0x03AllCycleAllCycle
MediaPlaybackLoadActionEnum8 Type​

该枚举定义播放列表/收藏加载动作的有效取值。

ValueNameDescription
0x00APPEND追加到当前队列末尾。
0x01REPLACE清空当前队列并替换为新内容。
0x02INSERT_NEXT插入到当前播放项之后。
MediaPlaybackCommand Command Structure Type​

MediaPlaybackCommand Command 的参数结构体。

结构体成员序号字段名类型必须说明
0MediaTypeenum8M媒体类型;默认值为 0;媒体类型:0: Music (音乐) 1: Video (视频)2: Radio (电台)。
1CommandcharacterStringO命令内容,比如"我要听周杰伦的歌"。
2TitlecharacterStringO媒体名称,比如"七里香"。
SearchAndPlay Command Structure Type​

SearchAndPlay Command 的参数结构体。

结构体成员序号字段名类型必须说明
0KeywordcharacterStringO搜索关键词,例如歌曲名、歌手名或其他检索条件。
1ArtistcharacterStringO歌手名,用于精确筛选。
2TrackcharacterStringO歌曲名,用于精确筛选。
PlayMediaURL Command Structure Type​

PlayMediaURL Command 的参数结构体。

结构体成员序号字段名类型必须说明
0MediaURLcharacterStringM指向可直接播放音频资源的 URL。设备应将其作为播放目标,不得将其解释为搜索关键词;普通网页或搜索结果页面 URL 不属于可直接播放资源。
1TitlecharacterStringO媒体标题,仅用于显示或媒体信息;不改变 MediaURL 指定的播放目标。

Playlists Trait​

该 Trait 用于返回当前音乐服务账户中用户已创建的播放列表,支持可读可上报。

PlaylistsTraitPresentValueStructure Type​

Playlists Trait 单个播放列表结构体。

结构体成员序号字段名类型必须说明
0IdcharacterStringM播放列表 ID。
1NamecharacterStringM播放列表名称。
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[PlaylistsTraitPresentValueStructure]RVO
FavoritePlaylistsTraitPresentValueStructure Type​

FavoritePlaylists Trait 单个收藏播放列表结构体。

结构体成员序号字段名类型必须说明
0IdcharacterStringM收藏项 ID。
1NamecharacterStringM收藏项名称。

FavoritePlaylists Trait​

该 Trait 用于返回当前音乐服务账户中用户已收藏的播放列表,支持可读可上报。

Trait IDCode名称Conformance
0x5151FavoritePlaylists收藏播放列表O
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[FavoritePlaylistsTraitPresentValueStructure]RVO
PlayPlaylist Command Structure Type​

PlayPlaylist Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PlaylistIdcharacterStringM播放列表 ID。
PlayFavorite Command Structure Type​

PlayFavorite Command 的参数结构体。

结构体成员序号字段名类型必须说明
0FavoriteIdcharacterStringM收藏项 ID。

Trait 定义​

Trait IDNameConformance
0x80BACurrentPlaybackStateM
0x80FDTargetPlaybackStateM
0x816ASelectedMediaOutputSourceO
0x8169PlaybackSampledPositionO
0x80F7LoginStateO
0x80BFSelectedSourceO
0x80BEMediaInformationO
0x80BDPlaybackModeO
0x80BCSampledPositionO
0x80BBPlaybackDurationO

CurrentPlaybackState Trait(播放状态)​

描述当前播放状态。

Trait IDCode
0x80BACurrentPlaybackState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCurrentPlaybackStateEnum80RVM
0x0006Supported Valuelist[CurrentPlaybackStateEnum8]RO

TargetPlaybackState Trait(目标播放状态)​

该 Trait 用于「目标播放状态」相关数据的访问与上报。

Trait IDCode
0x80FDTargetPlaybackState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTargetPlaybackStateEnum80RVWM
0x0006Supported Valuelist[TargetPlaybackStateEnum8]RO
0x0007Default ValueTargetPlaybackStateEnum80RWO

SelectedMediaOutputSource Trait(当前播放输出源)​

描述所选媒体输出源。

Trait IDCode
0x816ASelectedMediaOutputSource
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSelectedMediaOutputSourceEnum80RVWO
0x0006Supported Valuelist[SelectedMediaOutputSourceEnum8]RO
0x0007Default ValueSelectedMediaOutputSourceEnum80RWO

PlaybackSampledPosition Trait(当前媒体播放位置)​

设置并查询当前播放位置。单位:ms。

Trait IDCode
0x8169PlaybackSampledPosition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVWO
0x0002Maximum Valueuint644294967295RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint321RO
0x0007Default Valueuint640RWO

LoginState Trait(登录状态)​

描述媒体服务的登录状态。

Trait IDCode
0x80F7LoginState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

SelectedSource Trait(播放源)​

指示或设置当前所选媒体输出源(如内置扬声器、Bluetooth、AUX、HDMI 等)。取值:0 = Internal,1 = Bluetooth,2 = Aux,3 = SPDIF,4 = Coaxial,5-7 = Audio 1-3,8-10 = AV1-3,11-13 = HDMI1-3,14 = Other。

Trait IDCode
0x80BFSelectedSource
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSelectedSourceEnum80RVWO
0x0006Supported Valuelist[SelectedSourceEnum8]RO
0x0007Default ValueSelectedSourceEnum80RWO

MediaInformation Trait(媒体信息)​

描述媒体信息(标题、艺术家等)。

Trait IDCode
0x80BEMediaInformation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

PlaybackMode Trait(播放模式)​

描述当前播放模式。

Trait IDCode
0x80BDPlaybackMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePlaybackModeEnum80RVWO
0x0006Supported Valuelist[PlaybackModeEnum8]RO
0x0007Default ValuePlaybackModeEnum80RWO

SampledPosition Trait(播放进度)​

指示或设置媒体当前播放位置。值为毫秒(ms)时间偏移,范围 0 至总播放时长。写入时,设备跳转至该位置。

Trait IDCode
0x80BCSampledPosition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat7200000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO

PlaybackDuration Trait(时长)​

指示播放时长,单位为 ms。

Trait IDCode
0x80BBPlaybackDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat7200000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO

Command 定义​

Command IDNameConformance
0x80C5StopM
0x80C4PauseM
0x80C3PlayM
0x9C52PlaySpecificListO
0x9C51RewindO
0x9C50FastForwardO
0x9C41MediaPlaybackCommandO
0x9DA6SearchAndPlayO
0x9DA9PlayPlaylistO
0x9DACPlayFavoriteO
0x9DB6PlayMediaURLO
0x811AOffO
0x8119OnO
0x80C8NextO
0x80C7PreviousO
0x80C6StartOverO

Stop Command​

该命令应请求设备停止当前操作。

该 Command 无参数。

Pause Command​

该 Command 用于执行「暂停」操作。

该 Command 无参数。

Play Command​

该 Command 用于执行「播放」操作。

该 Command 无参数。

PlaySpecificList Command​

该 Command 用于执行「播放列表」操作。

该 Command 无参数。

Rewind Command​

该 Command 用于执行「回退」操作。

该 Command 无参数。

FastForward Command​

该 Command 用于执行「快进」操作。

该 Command 无参数。

MediaPlaybackCommand Command​

MediaPlaybackCommand表示媒体播放命令,适用于多种类型的媒体(音乐、视频、有声书、电台等)播放操作

参数​

MediaPlaybackCommand Command Structure

SearchAndPlay Command​

根据关键词、歌手、歌曲名等条件搜索音乐内容,并播放搜索结果。支持控制队列数量、播放顺序(正序/乱序)。该命令适用于用户主动点播歌曲的场景。

参数​

SearchAndPlay Command Structure

PlayMediaURL Command​

直接播放 MediaURL 指定的音频资源。该命令用于播放客户端已知的直链,不执行歌曲搜索;需要按歌曲名、歌手或关键词查找内容时,应使用 SearchAndPlay。命令执行后,设备应以该 URL 作为当前播放项并开始加载、播放;URL 所指资源不可访问、格式或协议不受设备支持时,设备不得将其报告为正在播放,并应按命令执行机制报告失败。支持的 URL 协议、音频格式及访问条件由设备能力决定,设备实现应明确其支持范围。需要鉴权的资源仅在设备具备相应访问凭据或授权机制时可播放。

Title 为可选展示信息,不作为资源定位或搜索条件。命令被接受或开始加载不代表音频已成功播放;播放过程和当前状态应通过本 Function 的播放状态相关 Trait 反映。

参数​

PlayMediaURL Command Structure

PlayPlaylist Command​

通过播放列表 ID 将指定歌单加载并播放。加载动作控制新内容如何影响当前队列,支持自动播放及乱序、循环、淡入淡出等播放模式。

参数​

PlayPlaylist Command Structure

PlayFavorite Command​

通过收藏项 ID 将指定收藏内容加载并播放。支持控制加载动作、是否自动播放及乱序、循环、淡入淡出等播放模式。

参数​

PlayFavorite Command Structure

Off Command​

该 Command 用于执行「关闭」操作。

该 Command 无参数。

On Command​

该 Command 用于执行「打开」操作。

该 Command 无参数。

Next Command​

该 Command 用于执行「下一个」操作。

该 Command 无参数。

Previous Command​

该 Command 用于执行「上一个」操作。

该 Command 无参数。

StartOver Command​

该 Command 用于执行「重播」操作。

该 Command 无参数。

Speaker(喇叭)​

简介​

描述设备扬声器输出能力,包括文本转语音播报、音量控制及静音等音频输出功能。

Function 标识​

Function IDCode名称
0x0092Speaker喇叭

Trait​

Trait IDCode名称Conformance
0x80C0Volume音量O
0x80C1Mute静音O
0x80C2StepValue步长O

Command​

Command IDCodeConformance
0x9DB5PlayTTSO

数据类型​

PlayTTS Command Structure Type​

PlayTTS Command 的参数结构体。

结构体成员序号字段名类型必须说明
0TextstringM需要转换为语音并播放的文本内容,最长 200 字节。

Trait 定义​

Trait IDNameConformance
0x80C0VolumeO
0x80C1MuteO
0x80C2StepValueO

Volume Trait(音量)​

指示或设置摄像头设备扬声器音量(如双向语音)。值通常为百分比(0 至 100)或设备定义的数值范围。

Trait IDCode
0x80C0Volume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

Mute Trait(静音)​

指示扬声器静音状态。

Trait IDCode
0x80C1Mute
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

StepValue Trait(步长)​

指示或设置步进增量(如音量调节)。在本扬声器应用中,单位为百分比(%);具体取值范围因设备而异。

Trait IDCode
0x80C2StepValue
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat10.0RO
0x0007Default Valuefloat1RWO

Command 定义​

Command IDNameConformance
0x9DB5PlayTTSO

PlayTTS Command​

控制设备将指定文本转换为语音并通过扬声器播放。Text 为必填字符串,内容最长为 200 字节。

参数​

PlayTTS Command Structure

PowerSource(电源)​

简介​

描述设备供电来源与电池状态,包括电量、充电状态、电池数量、可更换性,以及面向用户的电池更换规格描述等信息。

Function 标识​

Function IDCode名称
0x0093PowerSource电源

Trait​

Trait IDCode名称Conformance
0x80B0CurrentVoltage电压值O
0x8141PowerMode供电方式O
0x5175PowerDetectionMode电源功率检测模式O
0x5176PowerDetectionResult电源功率检测结果上报O
0x4E3CRechargeable是否可充电O
0x4E3BBatQuantity电池数量O
0x4E3ABatReplacementDescription电池更换描述O
0x4E39BatReplaceability电池可更换性O
0x4E38BatReplacementNeeded是否需要更换电池O
0x815BWiredPresent电源连接状态O
0x80CDBatPercentRemaining电量百分比O
0x80C9StateOfLowBat低电状态O
0x80CEBatChargeState充电状态O

Command​

本 Function 不包含 Command。

数据类型​

PowerModeEnum8 Type​

该枚举定义 PowerMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01Mains市电
0x02Battery电池
0x03DCSource直流电源
0x04ACSource交流电源
PowerDetectionResultEnum8 Type​

该枚举定义 PowerDetectionResult Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01Pass通过
BatReplaceabilityEnum8 Type​

该枚举定义 BatReplaceability Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unspecified未指定
0x01NotReplaceable不可更换
0x02UserReplaceable用户可更换
0x03FactoryReplaceable工厂可更换
StateOfLowBatEnum8 Type​

该枚举定义 StateOfLowBat Trait 的 Present Value 有效取值。

ValueNameDescription
0x00False电量充足
0x01True低电量
0x02Critical电量耗尽
BatChargeStateEnum8 Type​

该枚举定义 BatChargeState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01TheBatteryIsCharging正在充电
0x02TheBatteryIsAtFullCharge已充满电
0x03TheBatteryIsNotCharging未在充电
0x04TheBatteryIsNotChargeable不可充电

Trait 定义​

Trait IDNameConformance
0x80B0CurrentVoltageO
0x8141PowerModeO
0x5175PowerDetectionModeO
0x5176PowerDetectionResultO
0x4E3CRechargeableO
0x4E3BBatQuantityO
0x4E3ABatReplacementDescriptionO
0x4E39BatReplaceabilityO
0x4E38BatReplacementNeededO
0x815BWiredPresentO
0x80CDBatPercentRemainingO
0x80C9StateOfLowBatO
0x80CEBatChargeStateO

CurrentVoltage Trait(电压值)​

指示当前测得的电源电压值。单位:伏特(V)。

Trait IDCode
0x80B0CurrentVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat500.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO

PowerMode Trait(供电方式)​

指示设备的供电模式。0:未知,1:市电,2:电池,3:直流电源。

Trait IDCode
0x8141PowerMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePowerModeEnum80RVO
0x0006Supported Valuelist[PowerModeEnum8]RO

PowerDetectionMode Trait(电源功率检测模式)​

电源功率检测模式。用于标识设备是否进入电源功率检测模式。常供电门铃设备(如 G400)若接入的电源功率不足,可能无法正常使用(如自动重启),因此需要提前检测。写入 1 进入检测模式,写入 0 退出检测模式。

Trait IDCode
0x5175PowerDetectionMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

PowerDetectionResult Trait(电源功率检测结果上报)​

电源功率检测结果。表示设备返回电源功率检测是否通过。检测通过时设备会返回 1;不通过时设备会重启,无法返回结果,此时 APP 通过超时来判定检测不通过。

Trait IDCode
0x5176PowerDetectionResult
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePowerDetectionResultEnum80RVO
0x0006Supported Valuelist[PowerDetectionResultEnum8]RO

Rechargeable Trait(是否可充电)​

该特征应指示电池是否可充电。

Trait IDCode
0x4E3CRechargeable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

BatQuantity Trait(电池数量)​

该特征应指示电池源中可由用户或工厂维护的独立电池单元或电池组数量。

Trait IDCode
0x4E3BBatQuantity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

BatReplacementDescription Trait(电池更换描述)​

该特征必须提供面向用户的电池描述,用于说明更换电池时使用的电池规格。

本 Trait 在 PowerSource Function 中为可选;实现本 Trait 时,必须提供 Present Value 参数,支持读取和上报,不支持写入。Present Value 为最长 32 的字符串,默认值为 null,表示尚未提供电池描述;Unspecified 是有效的字符串值,与 null 不同。

Trait IDCode
0x4E3ABatReplacementDescription
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuestring32最长 32;允许 nullnullRVM
0x0006Supported Valuelist[string32]元素为支持的电池描述字符串,每个字符串最长 32RO
支持的字符串值​

本 Trait 至少支持以下字符串值。字符串的拼写和大小写必须与下表一致;允许扩展其他电池描述字符串,不将取值限定为封闭枚举。

ValueDescription
Unspecified未指定电池规格
AAAA 电池
AAAAAA 电池
CR2450CR2450 电池
CR1632CR1632 电池
CR2032CR2032 电池
CR123ACR123A 电池
CR17450CR17450 电池

Supported Value 参数提供设备支持的电池描述字符串列表;实现该参数时,列表中包含上述字符串值。

BatReplaceability Trait(电池可更换性)​

该特征应指示电池是否可更换以及适用的更换方式:未指定或未知、不可更换、用户可更换,或由工厂授权人员更换。

Trait IDCode
0x4E39BatReplaceability
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBatReplaceabilityEnum80RVO
0x0006Supported Valuelist[BatReplaceabilityEnum8]RO

BatReplacementNeeded Trait(是否需要更换电池)​

该特征应指示电池是否需要更换。

Trait IDCode
0x4E38BatReplacementNeeded
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO
0x0007Default Valueboolean0RWO

WiredPresent Trait(电源连接状态)​

指示是否检测到有线电源(电源适配器)。

Trait IDCode
0x815BWiredPresent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

BatPercentRemaining Trait(电量百分比)​

指示剩余电池电量百分比。当前电量值正在获取中、暂不可用时,Present Value 使用 255 作为状态标识;该值表示"电量获取中",不是实际电量百分比,不受 0-100 的百分比范围约束。

Trait IDCode
0x80CDBatPercentRemaining
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat50RWO

StateOfLowBat Trait(低电状态)​

指示电池是否处于低电量状态。0:正常,1:低电量,2:严重不足。

Trait IDCode
0x80C9StateOfLowBat
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStateOfLowBatEnum80RVO
0x0006Supported Valuelist[StateOfLowBatEnum8]RO

BatChargeState Trait(充电状态)​

指示电池充电状态。0:Unknown,1:Charging,2:Full charge,3:Not charging,4:Not chargeable。

Trait IDCode
0x80CEBatChargeState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBatChargeStateEnum83RVO
0x0006Supported Valuelist[BatChargeStateEnum8]RO

Command 定义​

本 Function 不包含 Command。

DoorLock(门锁)​

简介​

提供智能门锁核心能力,包括锁状态、用户/凭证管理、开锁/上锁及告警事件。

Function 标识​

Function IDCode名称
0x0094DoorLock门锁

Trait​

Trait IDCode名称Conformance
0x80CALockState锁状态M
0x50B4FingerprintEnrollProgress指纹录入过程O
0x50B3LockErrorLogReport锁错误日志上报O
0x50B2LockLogReport锁日志上报O
0x50B1DoorLogReport门日志上报O
0x50B0AqaraUserError添加Aqara凭证超时O
0x50AFAqaraUserChangeAqara用户变更O
0x51F1GetAqaraUserResponse获取Aqara用户响应O
0x50ACWiFiConfigStatusWifi配置状态O
0x50ABWifiModeWifi模式O
0x50A9WiFiStatusWiFi连接状态O
0x50A8FirmwareDowngradeEnabled开启固件降级O
0x50A7VoiceOTAStatus语音固件升级O
0x50A6OTASilentUpgradeOTA静默升级O
0x50A5OTAProgressOTA进度O
0x50A4UWBApproachDirectionUWB接近方向O
0x50A2SupportedNfcCardTypes支持NFC卡类型O
0x50A1VoicePackageInfo语音包信息O
0x518ADetectionDistance侦测距离O
0x518BDetectionThreshold侦测灵敏度阈值O
0x509CRemoteUnlockRelockDelay远程解锁重新上锁时间O
0x509BLocalCredentialLockoutDuration本地凭证锁定时间O
0x509AAutoUnlock自动开锁O
0x5098AwayModeArming离家模式布防O
0x5097LockQuietMode静音开锁模式O
0x5096NormalModeSpeed正常模式电机转速O
0x5095DoorbellLightEnabled开启门铃灯O
0x5094DeviceOrientation门方向O
0x5047MotorStrength电机强度O
0x5092PullSpringPullSpring弹舌配置O
0x5090FrontLockConnectionStatus前锁连接状态O
0x508FDoorHandleDirection门把手方向O
0x508ELocalSetting开启本地设置O
0x508DDualVerification双重验证O
0x508CLockWorkMode门锁工作模式O
0x5060LocalMenuEntryMethod设置进入本地菜单方式O
0x505FDoorLockAlarmStatus门锁告警状态O
0x505ETamperAlarmEnabled撬锁报警开关设置O
0x505DHardInfo硬件信息O
0x505CDoorAjarConfig门虚掩告警设置O
0x505BDoorNotLockedConfig门未锁告警设置O
0x505ADoorNotClosedConfig门未关告警设置O
0x5059AlarmVolume报警音量O
0x5058LockJammedVolume锁舌卡住提示音量O
0x5057AwayModePromptVolume布/撤防提示音量O
0x5056DemoVoiceVolume演示固件语料音量O
0x5055AbnormalVibrationAlarmVolume异常震动告警音量O
0x5054VoiceVolume语音音量O
0x5053DoorbellVolume门铃音量O
0x5052UnlockVolume开锁音量O
0x4F5DEnableElectronicLockoutMode开启电子反锁模式O
0x4F5BEnableAwayMode开启离家模式O
0x514BAqaraLockStateExtension锁状态扩展O
0x514CAqaraDoorStateExtension门状态扩展O
0x514DDoorLockStateChangeTimestamp锁状态变更时间戳O
0x4EF3VoiceLanguage语音播报语言O
0x4F09OTAStateOTA状态O
0x5080ChildLock童锁O
0x5169ButtonLockUnlockEnabled单击按键上解锁使能O
0x509DAlwaysOpenMode常开模式O
0x514EAuxRotationEnabled辅助旋转使能O
0x514FSpeedFollowEnabled速度跟随使能O
0x5149DoorbellEnabled门铃使能O
0x514ADoorbellSensitivity门铃感应灵敏度O
0x513FUWBEnabledUWB 功能使能O
0x5140UWBDoubleDoorModeUWB 双层门模式使能O
0x5141UWBMinUnlockDistanceUWB 最小开锁距离O
0x5142UWBFastStartModeUWB 快速启动模式O
0x5143UWBRangingTimeoutUWB 感应时间O
0x5144UWBSignalLostTimeoutUWB 信号搜索时间O
0x5145UWBMultiEntrancesModeUWB 多入口模式使能O
0x513CCloseDoorAutoRelockEnabled关门自动上锁使能O
0x513DCloseDoorAutoRelockTime关门自动上锁时间O
0x513ERemoteUnlockAutoRelockEnabled远程开锁后自动上锁使能O
0x5185MagneticEncoderCalibrationStatus磁编码校准状态O
0x518DBoltTravelConfigured锁舌行程配置O
0x507AEnableDeadbolt开启反锁O
0x5031ConfigOperation门锁配置操作O
0x80C9StateOfLowBat低电状态O
0x4E71GetCredentialStatusResponse获取凭证状态回复O
0x4E70SetCredentialResponse设置凭证回复O
0x4E6FGetUserResponse获取用户回复O
0x4E6DGetWeekDayScheduleResponse获取周日程回复O
0x4E6EGetYearDayScheduleResponse获取年日程回复O
0x4E6BNumberOfCredentialsSupportedPerUser每用户可支持凭证数O
0x4E6ANumberOfYearDaySchedulesSupportedPerUser每用户可支持年日程数O
0x4E69NumberOfWeekDaySchedulesSupportedPerUser每用户可支持周日程数O
0x4E68NumberOfRFIDUsersSupportedRFID用户量O
0x4E67NumberOfPINUsersSupportedPIN用户量O
0x4E66NumberOfTotalUsersSupported门锁总用户量O
0x4E2ANetworkInterfaces网络接口信息O
0x8171LockOperationError门锁操作(事件)错误上报O
0x9C40RemoteControlWithAuthCode远程控制(带授权码)-绿米私有O
0x8173LockUserChange门锁用户变更上报O
0x8172DoorLockAlarm门锁报警(事件)上报O
0x8170LockOperation门锁操作(事件)上报O
0x8125RemoteUnlock远程解锁--绿米私有O
0x8102SupportedRemoteFeatures支持的远程特性O
0x8101EnableRemoteControl远程控制使能O
0x80CBDoorState门状态O
0x8133ActuatorEnabled执行器启用O
0x8130AlarmMask报警掩码O
0x812ACredentialRulesSupport凭证规则支持O
0x812FExpiringUserTimeout用户超时过期O
0x8126MaxPINCodeLength最大PINCode长度O
0x8128MaxRFIDCodeLength最大RFID长度O
0x8127MinPINCodeLength最小PINCode长度O
0x8129MinRFIDCodeLength最小RFID长度O
0x812BOperatingMode操作模式O
0x812ERequirePINForRemoteOperation是否需要PIN码进行远程操作O
0x812DSendPINOverTheAir通过空中发送PIN码O
0x812CUserCodeTemporaryDisableTime用户代码临时禁用时间O
0x8131SupportsTapToUnlock支持轻触解锁O
0x8132SupportsTapToLock支持轻触上锁O

Command​

Command IDCode名称Conformance
0x9C61GetUser获取用户O
0x9C65ClearCredential清除凭证O
0x9C64GetCredentialStatus获取凭证状态O
0x9C63SetCredential设置凭证O
0x9C62ClearUser清除用户O
0x9C60SetUser设置用户O
0x9C5FUnboltDoor开门O
0x9C5DGetYearDaySchedule获取年日程O
0x9C5EClearYearDaySchedule清除年日程O
0x9C5CSetYearDaySchedule设置年日程O
0x9C5BClearWeekDaySchedule清除周日程O
0x9C5AGetWeekDaySchedule获取周日程O
0x9C59SetWeekDaySchedule设置周日程O
0x88CDQuietUnlockDoor静音开锁O
0x88CCQuietLockDoor静音上锁O
0x88C3UnlockDoor解锁O
0x88C2LockDoor上锁O
0x9DAEMagneticEncoderCalibration磁编码校准命令O
0x9D6FGetLog获取日志O
0x9D6EExitAddAqaraCredential退出新增Aqara凭证O
0x9D6DGetAqaraCredential获取Aqara凭证O
0x9D6CDeleteAqaraCredential删除Aqara凭证O
0x9D6BModifyAqaraCredential修改Aqara凭证O
0x9D6AAddAqaraCredential新增Aqara凭证O
0x9D69GetAqaraUser获取Aqara用户O
0x9D68DeleteAqaraUser删除Aqara用户O
0x9D67ModifyAqaraUser修改Aqara用户O
0x9D66AddAqaraUser新增Aqara用户O
0x9CB1SetTravelCalibration设置行程校准O

数据类型​

GetUserResponseCredentialStructure Type​

该结构体定义 GetUserResponse 内 Credential 字段布局。

结构体成员序号字段名类型必须说明
0CredentialTypeenum8M凭证类型:0=ProgrammingPIN,1=PIN,2=RFID,3=Fingerprint,4=FingerVein,5=Face,6=AliroCredentialIssuerKey,7=AliroEvictableEndpointKey,8=AliroNonEvictableEndpointKey。
1CredentialIndexuint16O凭证索引。
LockStateEnum8 Type​

该枚举定义 LockState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NotFullyLocked锁舌异常
0x01Locked已上锁
0x02Unlocked未上锁
FingerprintEnrollProgressTraitPresentValueStructure Type​

该结构体定义 FingerprintEnrollProgress Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0CurrentAttemptuint8M当前录入尝试序号,从 1 开始。
1TotalAttemptsuint8M完整注册会话所需尝试次数(当前为 8)。
2EnrollmentProgressuint8M录入进度百分比,范围 0 至 100。
3EnrollmentStatusenum8M本次尝试的录入状态。
LockErrorLogReportTraitPresentValueStructure Type​

该结构体定义 LockErrorLogReport Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0LockErrorCodeenum8M外部或内部异常,取值见 LockErrorCodeEnum Type。
1LogIndexuint16M日志索引。
2TimestampUtcuint32M事件发生 UTC 时间戳(Epoch Time in Seconds)。
LockLogReportTraitPresentValueStructure Type​

该结构体定义 LockLogReport Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0LockOperationTypeenum8M执行的门锁操作类型。
1OperationSourceenum8M门锁操作来源。
2UserSourceenum8OUserId 与 CredentialId 的来源。省略时默认 Lock Local。
3UserIduint32O用户唯一标识。
4CredentialIduint32O凭证唯一标识。
5MatterVendorIduint16O当 OperationSource 为 Remote(Matter Ecosystem) 时表示 Matter Vendor ID。
6LockPositionenum8O门锁操作位置。
7LogIndexuint16M日志索引。
8TimestampUtcuint32M事件发生 UTC 时间戳(Epoch Time in Seconds)。
DoorLogReportTraitPresentValueStructure Type​

该结构体定义 DoorLogReport Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0DoorStateenum8M门状态事件类型。
1LogIndexuint16M日志索引。
2TimestampUtcuint32M事件发生 UTC 时间戳(Epoch Time in Seconds)。
LockDataTypeEnum8 Type​

该枚举标识 AqaraUserChange 事件中发生变更的数据类别。

ValueNameDescription
0x00User用户记录
0x01Credential通用凭证记录
0x02Schedule用户有效期日程
0x03NFCNFC 卡凭证
0x04Fingerprint指纹凭证
0x05Face人脸凭证
0x06FingerVein指静脉凭证
0x07Password数字或字母数字密码凭证
0x08UWB超宽带凭证
0x09Palm掌纹凭证
DataOperationTypeEnum8 Type​

该枚举标识 AqaraUserChange 事件对用户或凭证数据库条目执行的操作类型。

ValueNameDescription
0x00Add新增数据库条目
0x01Delete删除已有数据库条目
0x02Modify修改已有数据库条目
AqaraUserErrorTraitPresentValueStructure Type​

该结构体定义 AqaraUserError Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
1UserIduint16M用户 ID。
2CredentialAttributeuint8M凭证属性。
3CredentialTypeuint8M凭证类型。
AqaraUserChangeTraitPresentValueStructure Type​

该结构体定义 AqaraUserChange Trait 的 Present Value 字段布局。该 Trait 仅在用户或凭证数据库成功变更后上报相关状态;凭证变更时,Credential 可携带完整的 AqaraCredentialItemStruct(包括凭证类型及其内容)。Extension 事件中的 CheckNumber 仅供网关内部使用,不属于 Trait,不得上报至 App 或云端。

结构体成员序号字段名类型必须说明
0LockDataTypeLockDataTypeEnum8M被变更的数据类别。
1DataOperationTypeDataOperationTypeEnum8M对数据执行的操作类型。
2UserIduint16M变更涉及的用户 ID。
3UserTypeAqaraUserTypeEnum8M变更后用户的类型及访问权限等级。
4UserNamecharacterStringO变更后用户名,UTF-8 编码,最大 20 字节;未设置时可为 null。
5CredentialAqaraCredentialItemStructO变更涉及的完整凭证信息,包含凭证属性、类型、ID、索引、名称、有效期及类型对应的凭证内容;无相关凭证、删除凭证或设备未提供敏感凭证内容时可省略或为 null。
WiFiConfigStatusEnum8 Type​

该枚举定义 WiFiConfigStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ConfigFailed配置失败
0x01Configuring配置中
0x02ConfigSucceeded配置成功
WifiModeEnum8 Type​

该枚举定义 WifiMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01KeepAlive持续在线
0x02Silence静默休眠
0x03TempAlive临时在线
WiFiStatusEnum8 Type​

该枚举定义 WiFiStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Undefined未定义
0x01APConnectedAP已连接
0x02APConnectFailedAP连接失败
0x03CloudConnected连接上云
0x04CloudConnectFailed云连接失败
0x05APConnectingAP连接中
0x06PowerOff掉电状态
VoiceOTAStatusTraitPresentValueStructure Type​

该结构体定义 VoiceOTAStatus Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Statusenum8M语音固件 OTA 升级状态。
1Progressuint8O升级进度百分比,范围 1 至 100。
OTASilentUpgradeTraitPresentValueStructure Type​

该结构体定义 OTASilentUpgrade Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EnabledbooleanM是否启用静默 OTA 升级。
1ValidStartUtcuint32O静默升级生效 UTC 起始时间;与 ValidEndUtc 均为 0 表示始终生效。
2ValidEndUtcuint32O静默升级生效 UTC 结束时间。
VoicePackageInfoTraitPresentValueStructure Type​

该结构体定义 VoicePackageInfo Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0PackageIduint32M语音包 ID。
1PackageNamecharacterStringM语音包名称。
2LanguagecharacterStringM语音包语言标识。
3VersioncharacterStringM语音包版本。
CloseDoorAutoRelockTimeTraitPresentValueStructure Type​

该结构体定义 CloseDoorAutoRelockTime Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0AutoLockTimeuint32M自动上锁延迟秒数;值为 0 禁用自动上锁。
1ValidStartUtcuint32M自动上锁生效 UTC 起始时间;与 ValidEndUtc 均为 0 表示始终生效。
2ValidEndUtcuint32M自动上锁生效 UTC 结束时间。
LockQuietModeTraitPresentValueStructure Type​

该结构体定义 LockQuietMode Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0QuietModeEnabledbooleanM静音模式是否激活。
1QuietModeSpeedenum8M静音窗口内电机速度,取值见 MotorSpeedEnum Type。
2ValidStartUtcuint32M静音模式生效 UTC 起始时间;与 ValidEndUtc 均为 0 表示计划未激活。
3ValidEndUtcuint32M静音模式生效 UTC 结束时间。
NormalModeSpeedEnum8 Type​

该枚举定义 NormalModeSpeed Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Performance极快
0x01Standard标准
0x02Quiet安静
0x03Silent静音
DeviceOrientationTraitPresentValueStructure Type​

该结构体定义 DeviceOrientation Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0DoorOpenDirectionenum8M门开启方向,取值见 DoorOpenDirectionEnum Type。
1InstallationOrientationenum8M锁体安装轴向,取值见 InstallationOrientationEnum Type。
MotorStrengthTraitPresentValueStructure Type​

该结构体定义 MotorStrength Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0MotorStrengthuint8M电机强度。
PullSpringTraitPresentValueStructure Type​

该结构体定义 PullSpring Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EnabledbooleanM拉簧是否激活。
1LatchRetractTimeuint16M锁舌缩回时间(毫秒)。
DoorHandleDirectionEnum8 Type​

该枚举定义 DoorHandleDirection Trait 的 Present Value 有效取值。

ValueNameDescription
0x00RightOpen右开
0x01LeftOpen左开
LockWorkModeEnum8 Type​

该枚举定义 LockWorkMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01InstallationInspection安装检查
0x02Demo演示
DoorLockAlarmStatusTraitPresentValueStructure Type​

该结构体定义 DoorLockAlarmStatus Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0LockStateenum8M锁状态快照。
1DoorStateenum8M门状态快照。
2TamperActivebooleanM防拆告警是否激活。
3AwayModeArmedbooleanM离家模式是否布防。
4LowBatterybooleanM是否处于低电量状态。
DoorAjarConfigTraitPresentValueStructure Type​

该结构体定义 DoorAjarConfig Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EnabledbooleanM是否启用门虚掩报警。
1Volumeenum8M报警音量。
2WaitTimeuint32M门保持虚掩后触发报警的超时秒数。
3AlarmDurationuint32O每次触发时报警持续秒数。
DoorNotLockedConfigTraitPresentValueStructure Type​

该结构体定义 DoorNotLockedConfig Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EnabledbooleanM是否启用门未锁报警。
1Volumeenum8M报警音量。
2WaitTimeuint32M门保持关闭但未上锁后触发报警的超时秒数。
3AlarmDurationuint32O每次触发时报警持续秒数。
DoorNotClosedConfigTraitPresentValueStructure Type​

该结构体定义 DoorNotClosedConfig Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EnabledbooleanM是否启用门未关报警。
1Volumeenum8M报警音量。
2WaitTimeuint32M门保持打开后触发报警的超时秒数。
3AlarmDurationuint32O每次触发时报警持续秒数。
AlarmVolumeEnum8 Type​

该枚举定义 AlarmVolume Trait 的 Present Value 有效取值。

ValueNameDescription
0x00High高
0x01Medium中
0x02Low低
0x03Mute静音
LockJammedVolumeEnum8 Type​

该枚举定义 LockJammedVolume Trait 的 Present Value 有效取值。

ValueNameDescription
0x00High高
0x01Medium中
0x02Low低
0x03Mute静音
AwayModePromptVolumeEnum8 Type​

该枚举定义 AwayModePromptVolume Trait 的 Present Value 有效取值。

ValueNameDescription
0x00High高
0x01Medium中
0x02Low低
0x03Mute静音
DemoVoiceVolumeEnum8 Type​

该枚举定义 DemoVoiceVolume Trait 的 Present Value 有效取值。

ValueNameDescription
0x00High高
0x01Medium中
0x02Low低
0x03Mute静音
AbnormalVibrationAlarmVolumeEnum8 Type​

该枚举定义 AbnormalVibrationAlarmVolume Trait 的 Present Value 有效取值。

ValueNameDescription
0x00High高
0x01Medium中
0x02Low低
0x03Mute静音
VoiceVolumeEnum8 Type​

该枚举定义 VoiceVolume Trait 的 Present Value 有效取值。

ValueNameDescription
0x00High高
0x01Medium中
0x02Low低
0x03Mute静音
DoorbellVolumeEnum8 Type​

该枚举定义 DoorbellVolume Trait 的 Present Value 有效取值。

ValueNameDescription
0x00High高
0x01Medium中
0x02Low低
0x03Mute静音
UnlockVolumeEnum8 Type​

该枚举定义 UnlockVolume Trait 的 Present Value 有效取值。

ValueNameDescription
0x00High高
0x01Medium中
0x02Low低
0x03Mute静音
ConfigOperationEnum8 Type​

该枚举定义 ConfigOperation Trait 的 Present Value 有效取值。

ValueNameDescription
0x00EnableElectronicLockoutMode开启电子反锁
0x01DisableElectronicLockoutMode关闭电子反锁
StateOfLowBatEnum8 Type​

该枚举定义 StateOfLowBat Trait 的 Present Value 有效取值。

ValueNameDescription
0x00False电量充足
0x01True低电量
0x02Critical电量耗尽
GetCredentialStatusResponseTraitPresentValueStructure Type​

该结构体定义 GetCredentialStatusResponse Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0CredentialExistsbooleanM凭证是否存在。
1UserIndexuint16M用户索引。
2CreatorFabricIndexuint16O为空时不上报。
3LastModifiedFabricIndexuint16O为空时不上报。
4NextUserIndexuint16O为空时不上报。
SetCredentialResponseTraitPresentValueStructure Type​

该结构体定义 SetCredentialResponse Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Statusenum8M响应状态。
1UserIndexuint16M用户索引。
2NextCredentialIndexuint16O下一凭证索引;为空时不上报。
AqaraUserTypeEnum8 Type​

该枚举定义 Aqara 用户类型及对应的访问权限等级。

ValueNameDescription
0x00Unknown用户类型未知或未指定。
0x01Administrator管理员,具有较高权限。
0x02RegularUser普通用户,具有标准访问权限。
0x03FrequentVisitor常客,具有受限访问权限。
0x04Owner设备所有者;每把锁最多一个 Owner,且不可删除。
AqaraCredentialAttributeEnum8 Type​

该枚举定义凭证的安全属性。

ValueNameDescription
0x00Normal普通凭证,不带特殊属性。
0x01Duress胁迫凭证;使用时触发静默报警。
0x02OneToMany一对多凭证,可关联多个用户。
AqaraCredentialTypeEnum8 Type​

该枚举定义 Aqara 凭证类型。

ValueNameDescription
0x01Fingerprint指纹凭证。
0x02Password数字或字母数字密码凭证。
0x03NFCNFC 卡凭证。
0x04ElectronicKey电子钥匙凭证。
0x06Face人脸凭证。
0x10OneTimePassword一次性密码凭证。
0x11Bluetooth蓝牙凭证。
AqaraCredentialRepeatTypeEnum8 Type​

该枚举定义凭证有效期的重复周期。

ValueNameDescription
0x00Never单次有效时间范围,不重复。
0x01Daily每日重复。
0x02Weekly每周重复。
0x03BiWeekly每两周重复。
0x04Monthly每月重复。
AqaraNFCCardTypeEnum8 Type​

该枚举定义 NFC 凭证使用的实体卡片标准。

ValueNameDescription
0x01TypeAISO 14443-A 卡。
0x02TypeBISO 14443-B 卡。
0x03TypeFJIS X 6319-4(FeliCa)卡。
AqaraCredentialValidityStruct Type​

该结构体定义凭证的有效时间及重复计划。

成员 ID字段名类型必须说明
0RepeatTypeAqaraCredentialRepeatTypeEnum8M有效期重复周期。
1StartTimeuint32M有效期开始时间,Epoch 秒;默认值为 0。
2EndTimeuint32M有效期结束时间,Epoch 秒;默认值为 0。
3EndRepeatTimeuint32M重复计划结束时间,Epoch 秒;默认值为 0xFFFFFFFF,表示不设结束时间。RepeatType 为 Never 时应为 0xFFFFFFFF。
4RepeatDaysuint32M重复日期位图;默认值为 0x00000000。Weekly 时 bit 0-6 表示周日到周六;Monthly 时 bit 0-30 表示每月 1-31 日;其他重复类型应为 0。
AqaraNFCCardInfoStruct Type​

该结构体定义 NFC 凭证的附加卡片数据。

成员 ID字段名类型必须说明
0CidoctstrO卡片 CID,最大 32 字节。
1KeyoctstrO卡片密钥,最大 64 字节。
2CardTypeAqaraNFCCardTypeEnum8ONFC 卡片标准。
AqaraCredentialContentStruct Type​

该结构体承载凭证类型对应的特定内容。由同一凭证项中的 CredentialType 选择有效字段:Password(0x02)时 PasswordData 非空且 NFCCardInfo 为空;NFC(0x03)时 NFCCardInfo 非空且 PasswordData 为空;其他凭证类型两字段均为空。

成员 ID字段名类型必须说明
0PasswordDataoctstrO密码内容,最大 255 字节;仅 Password 凭证使用。
1NFCCardInfoAqaraNFCCardInfoStructONFC 卡片附加数据;仅 NFC 凭证使用。
AqaraCredentialItemStruct Type​

该结构体定义 GetAqaraUserResponse 用户记录中的单条凭证。

成员 ID字段名类型必须说明
0CredentialAttributeAqaraCredentialAttributeEnum8M凭证安全属性。
1CredentialTypeAqaraCredentialTypeEnum8M凭证类型。
2CredentialIduint16M凭证 ID。
3CredentialIndexuint8M凭证索引。
4CredentialNamecharacterStringO凭证名称,最大 20 字节。
5ValidityAqaraCredentialValidityStructO凭证有效期计划。
6CredentialContentAqaraCredentialContentStructO由 CredentialType 决定的凭证内容。
AqaraUserRecordStruct Type​

该结构体定义 GetAqaraUserResponse 的 Users 列表中的单条用户记录,包含用户标识、用户类型、凭证及可选用户名。

成员 ID字段名类型必须说明
0UserIduint16M用户 ID。
1UserTypeAqaraUserTypeEnum8M用户类型及访问权限等级。
2Credentialslist[AqaraCredentialItemStruct]O用户凭证列表;可为 null 或省略(例如用户尚无凭证,或响应未包含凭证列表);空列表与 null 等价。
3UserNamecharacterStringO用户显示名称,UTF-8 编码,最大 20 字节;未设置时为 null。
GetAqaraUserResponseTraitPresentValueStructure Type​

该结构体定义 GetAqaraUserResponse Trait 的 Present Value。Users 是用户记录结构体列表;NextUserId 为可空分页游标。

成员 ID字段名类型必须说明
0Userslist[AqaraUserRecordStruct]O用户记录列表,最多返回请求中的 Number 条记录,并按 UserId 升序排列;空数据库时为空列表。
1NextUserIduint16M后续分页查询的起始用户 ID;null 表示遍历完成。
GetUserResponseTraitPresentValueStructure Type​

该结构体定义 GetUserResponse Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0UserIndexuint16M用户索引,范围 1 至 NumberOfTotalUsersSupported。
1UserNamecharacterStringO用户名;若为空则整个 key 不下发。
2UserUniqueIDuint32O用户唯一 ID;若为空则整个 key 不下发。
3UserStatusenum8M用户状态:0=Available,1=OccupiedEnabled,2=OccupiedDisabled。
4UserTypeenum8M用户类型:0=UnrestrictedUser,1=YearDayScheduleUser,2=WeekDayScheduleUser,3=ProgrammingUser,4=NonAccessUser,5=ForcedUser,6=DisposableUser,7=ExpiringUser,8=ScheduleRestrictedUser,9=RemoteOnlyUser。
5CredentialRuleenum8M凭证规则:0=Single,1=Dual,2=Tri。
6CredentialGetUserResponseCredentialStructureM凭证信息。
7CreatorFabricIndexuint16O创建方 Fabric 索引;若为 null 则不上报。
8LastModifiedFabricIndexuint16O最后修改方 Fabric 索引;若为 null 则不上报。
9NextUserIndexuint16O下一用户索引;若为 null 则不上报。
GetWeekDayScheduleResponseTraitPresentValueStructure Type​

该结构体定义 GetWeekDayScheduleResponse Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0WeekDayIndexuint8MWeek Day schedule 索引。
1UserIndexuint16M用户索引。
2Statusenum8M响应状态。
3DaysMaskuint16M星期掩码,bit 0..6 分别对应 Sunday..Saturday。
4StartHouruint8M开始小时,最大 23。
5StartMinuteuint8M开始分钟,最大 59。
6EndHouruint8M结束小时,最大 23。
7EndMinuteuint8M结束分钟,最大 59。
GetYearDayScheduleResponseTraitPresentValueStructure Type​

该结构体定义 GetYearDayScheduleResponse Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0YearDayIndexuint8MYear Day schedule 索引。
1UserIndexuint16M用户索引。
2Statusenum8M响应状态。
3LocalStartTimeuint32M本地开始时间,Epoch Time in Seconds。
4LocalEndTimeuint32M本地结束时间,Epoch Time in Seconds;应大于 LocalStartTime。
NetworkInterfacesTraitPresentValueStructure Type​

该结构体定义 NetworkInterfaces Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0NamecharacterStringM网络接口名称,最大长度 32 字节。
1IsOperationalbooleanM接口是否处于运行状态。
2OffPremiseServicesReachableIPv4booleanO是否可通过 IPv4 访问网外服务;为空表示未知。
3OffPremiseServicesReachableIPv6booleanO是否可通过 IPv6 访问网外服务;为空表示未知。
4HardwareAddressoctetStringM硬件 MAC 地址。
5IPv4Addresseslist[octetString]MIPv4 地址列表。
6IPv6Addresseslist[octetString]MIPv6 地址列表。
7Typeenum8M接口类型(InterfaceTypeEnum)。
LockOperationErrorTraitPresentValueStructure Type​

该结构体定义 LockOperationError Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0LockOperationTypeenum8M执行的门锁操作类型。
1OperationSourceenum8M门锁操作来源。
2OperationErrorenum8M操作失败原因。
3UserIndexuint16M执行门锁操作的用户索引。
4FabricIDuint64M执行门锁操作的 fabric ID。
5SourceNodeuint64M执行门锁操作的 node ID。
6Credentialslist[Struct]O执行门锁操作时使用的凭证列表;无凭证时可为空。
LockUserChangeTraitPresentValueStructure Type​

该结构体定义 LockUserChange Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0LockDataTypeenum8M被变更的数据类型。
1DataOperationTypeenum8M数据操作类型。
2OperationSourceenum8M执行操作的来源。
3UserIndexuint16M执行门锁操作的用户索引。
4FabricIDuint64M执行门锁操作的 fabric ID。
5SourceNodeuint64M执行门锁操作的 node ID。
6DataIndexuint16O被变更项目在 LockDataType 对应列表中的索引。
DoorLockAlarmTraitPresentValueStructure Type​

该结构体定义 DoorLockAlarm Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0AlarmCodeenum8M门锁告警类型。
LockOperationTraitPresentValueStructure Type​

该结构体定义 LockOperation Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0LockOperationTypeenum8M执行的门锁操作类型。
1OperationSourceenum8M门锁操作来源。
2UserSourceenum8OUserId 与 CredentialId 的来源。省略时默认 Lock Local。
3UserIduint32O用户唯一标识。
4CredentialIduint32O凭证唯一标识。
5MatterVendorIduint16O当 OperationSource 为 Remote(Matter Ecosystem) 时表示 Matter Vendor ID。
6LockPositionenum8O门锁操作位置。
DoorStateEnum8 Type​

该枚举定义 DoorState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00DoorOpen门未关
0x01DoorClosed门已关
0x02DoorJammed门卡住
0x03DoorForcedOpen门强制打开
0x04DoorUnspecifiedError门异常
0x05DoorAjar门虚掩
OperatingModeEnum8 Type​

该枚举定义 OperatingMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NormalNormal
0x01VacationVacation
0x02PrivacyPrivacy
0x03NoRemoteLockUnlockNoRemoteLockUnlock
0x04PassagePassage
ClearCredential Command Structure Type​

ClearCredential Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ClearCredentialstructM清除凭证。
GetCredentialStatus Command Structure Type​

GetCredentialStatus Command 的参数结构体。

结构体成员序号字段名类型必须说明
0CredentialstructM凭证。
SetCredential Command Structure Type​

SetCredential Command 的参数结构体。

结构体成员序号字段名类型必须说明
0OperationTypeuint16M操作类型。
1CredentialstructM凭证。
2CredentialDatacharacterStringM凭证数据。
3UserIndexuint16M用户索引。
4UserStatusuint32M用户状态;默认值为 OccupiedEnabled。
5UserTypeuint32M用户类型;默认值为 UnrestrictedUser。
GetUser Command Structure Type​

GetUser Command 的参数结构体。

结构体成员序号字段名类型必须说明
0UserIndexuint16M要查询的用户索引。
ClearUser Command Structure Type​

ClearUser Command 的参数结构体。

结构体成员序号字段名类型必须说明
0UserIndexuint16M用户索引。
SetUser Command Structure Type​

SetUser Command 的参数结构体。

结构体成员序号字段名类型必须说明
0OperationTypeuint16M操作类型。
1UserIndexuint16M用户索引。
2UserNamecharacterStringM用户名。
3UserUniqueIDuint32M用户唯一ID;默认值为 0xFFFFFFFF。
4UserStatusuint16M用户状态;默认值为 OccupiedEnabled。
5UserTypeint64M用户类型;默认值为 UnrestrictedUser。
6CredentialRuleuint16M凭证规则;默认值为 Single。
UnboltDoor Command Structure Type​

UnboltDoor Command 的参数结构体。

结构体成员序号字段名类型必须说明
0CodecharacterStringO编码。
GetYearDaySchedule Command Structure Type​

GetYearDaySchedule Command 的参数结构体。

结构体成员序号字段名类型必须说明
0YearDayIndexuint8M年日序号;默认值为 1。
1UserIndexuint16M用户索引;默认值为 1。
ClearYearDaySchedule Command Structure Type​

ClearYearDaySchedule Command 的参数结构体。

结构体成员序号字段名类型必须说明
0YearDayIndexuint8M年日序号;默认值为 1。
1UserIndexuint16M用户索引;默认值为 1。
SetYearDaySchedule Command Structure Type​

SetYearDaySchedule Command 的参数结构体。

结构体成员序号字段名类型必须说明
0YearDayIndexuint8M年日序号;默认值为 1。
1UserIndexuint16M用户索引;默认值为 1。
2LocalStartTimeuint64M本地开始时间。
3LocalEndTimeuint64M本地结束时间。
ClearWeekDaySchedule Command Structure Type​

ClearWeekDaySchedule Command 的参数结构体。

结构体成员序号字段名类型必须说明
0WeekDayIndexuint8M工作日索引;默认值为 1。
1UserIndexuint16M用户索引;默认值为 1。
GetWeekDaySchedule Command Structure Type​

GetWeekDaySchedule Command 的参数结构体。

结构体成员序号字段名类型必须说明
0WeekDayIndexuint8M工作日索引;默认值为 1。
1UserIndexuint16M用户索引;默认值为 1。
SetWeekDaySchedule Command Structure Type​

SetWeekDaySchedule Command 的参数结构体。

结构体成员序号字段名类型必须说明
0WeekDayIndexuint8M工作日索引;默认值为 1。
1UserIndexuint16M用户索引;默认值为 1。
2DaysMaskenum8M日期掩码。
3StartHouruint8M开始小时;默认值为 0。
4StartMinuteuint8M开始分钟;默认值为 0。
5EndHouruint8M结束小时;默认值为 0。
6EndMinuteuint8M结束分钟;默认值为 0。
UnlockDoor Command Structure Type​

UnlockDoor Command 的参数结构体。

结构体成员序号字段名类型必须说明
0CodecharacterStringO解锁密钥。
LockDoor Command Structure Type​

LockDoor Command 的参数结构体。

结构体成员序号字段名类型必须说明
0CodecharacterStringO
GetLog Command Structure Type​

GetLog Command 的参数结构体。

结构体成员序号字段名类型必须说明
0StartIndexuint16M起始索引。
1EndIndexuint16M结束索引。
ExitAddAqaraCredential Command Structure Type​

ExitAddAqaraCredential Command 的参数结构体。

结构体成员序号字段名类型必须说明
1UserIduint16M用户ID。
2CredentialAttributeenum8M凭证属性。
3CredentialTypeenum8M凭证类型。
GetAqaraCredential Command Structure Type​

GetAqaraCredential Command 的参数结构体。

结构体成员序号字段名类型必须说明
1UserIduint16M用户ID。
2CredentialIduint16M凭证ID。
DeleteAqaraCredential Command Structure Type​

DeleteAqaraCredential Command 的参数结构体。

结构体成员序号字段名类型必须说明
1CredentialIduint16M凭证ID。
ModifyAqaraCredential Command Structure Type​

ModifyAqaraCredential Command 的参数结构体。

结构体成员序号字段名类型必须说明
1CredentialIduint16M凭证ID。
2CredentialAttributeenum8O凭证属性。
3CredentialTypeenum8O凭证类型。
4CredentialContentstructO凭证内容。
5ValiditystructO有效性。
6CredentialNamecharacterStringO凭证名称。
AddAqaraCredential Command Structure Type​

AddAqaraCredential Command 的参数结构体。

结构体成员序号字段名类型必须说明
1UserIduint16M用户ID。
2CredentialAttributeenum8M凭证属性。
3CredentialTypeenum8M凭证类型。
4CredentialContentstructO凭证内容。
5ValiditystructO有效性。
6CredentialNamecharacterStringO凭证名称。
DeleteAqaraUser Command Structure Type​

DeleteAqaraUser Command 的参数结构体。

结构体成员序号字段名类型必须说明
1UserIduint16M用户ID。
ModifyAqaraUser Command Structure Type​

ModifyAqaraUser Command 的参数结构体。

结构体成员序号字段名类型必须说明
1UserIduint16M用户ID。
2UserTypeenum8O用户类型。
3UserNamecharacterStringO用户名。
AddAqaraUser Command Structure Type​

AddAqaraUser Command 的参数结构体。

结构体成员序号字段名类型必须说明
1UserTypeenum8M用户类型。
2UserNamecharacterStringM用户名。
GetAqaraUser Command Structure Type​

GetAqaraUser Command 的参数结构体。

结构体成员序号字段名类型必须说明
1UserIduint16M要查询的起始用户ID;用户ID从 1 开始。
2Numberuint8M单次请求返回的最大用户记录数,最小值为 1。
SetTravelCalibration Command Structure Type​

SetTravelCalibration Command 的参数结构体。

结构体成员序号字段名类型必须说明
0TravelCalibrationCmdenum8M行程校准命令。

Trait 定义​

Trait IDNameConformance
0x80CALockStateM
0x50B4FingerprintEnrollProgressO
0x50B3LockErrorLogReportO
0x50B2LockLogReportO
0x50B1DoorLogReportO
0x50B0AqaraUserErrorO
0x50AFAqaraUserChangeO
0x51F1GetAqaraUserResponseO
0x50ACWiFiConfigStatusO
0x50ABWifiModeO
0x50A9WiFiStatusO
0x50A8FirmwareDowngradeEnabledO
0x50A7VoiceOTAStatusO
0x50A6OTASilentUpgradeO
0x50A5OTAProgressO
0x50A4UWBApproachDirectionO
0x50A2SupportedNfcCardTypesO
0x50A1VoicePackageInfoO
0x518ADetectionDistanceO
0x518BDetectionThresholdO
0x509CRemoteUnlockRelockDelayO
0x509BLocalCredentialLockoutDurationO
0x509AAutoUnlockO
0x5098AwayModeArmingO
0x5097LockQuietModeO
0x5096NormalModeSpeedO
0x5095DoorbellLightEnabledO
0x5094DeviceOrientationO
0x5047MotorStrengthO
0x5092PullSpringO
0x5090FrontLockConnectionStatusO
0x508FDoorHandleDirectionO
0x508ELocalSettingO
0x508DDualVerificationO
0x508CLockWorkModeO
0x5060LocalMenuEntryMethodO
0x505FDoorLockAlarmStatusO
0x505ETamperAlarmEnabledO
0x505DHardInfoO
0x505CDoorAjarConfigO
0x505BDoorNotLockedConfigO
0x505ADoorNotClosedConfigO
0x5059AlarmVolumeO
0x5058LockJammedVolumeO
0x5057AwayModePromptVolumeO
0x5056DemoVoiceVolumeO
0x5055AbnormalVibrationAlarmVolumeO
0x5054VoiceVolumeO
0x5053DoorbellVolumeO
0x5052UnlockVolumeO
0x4F5DEnableElectronicLockoutModeO
0x4F5BEnableAwayModeO
0x514BAqaraLockStateExtensionO
0x514CAqaraDoorStateExtensionO
0x514DDoorLockStateChangeTimestampO
0x4EF3VoiceLanguageO
0x4F09OTAStateO
0x5080ChildLockO
0x5169ButtonLockUnlockEnabledO
0x509DAlwaysOpenModeO
0x514EAuxRotationEnabledO
0x514FSpeedFollowEnabledO
0x5149DoorbellEnabledO
0x514ADoorbellSensitivityO
0x513FUWBEnabledO
0x5140UWBDoubleDoorModeO
0x5141UWBMinUnlockDistanceO
0x5142UWBFastStartModeO
0x5143UWBRangingTimeoutO
0x5144UWBSignalLostTimeoutO
0x5145UWBMultiEntrancesModeO
0x513CCloseDoorAutoRelockEnabledO
0x513DCloseDoorAutoRelockTimeO
0x513ERemoteUnlockAutoRelockEnabledO
0x5185MagneticEncoderCalibrationStatusO
0x518DBoltTravelConfiguredO
0x507AEnableDeadboltO
0x5031ConfigOperationO
0x80C9StateOfLowBatO
0x4E71GetCredentialStatusResponseO
0x4E70SetCredentialResponseO
0x4E6FGetUserResponseO
0x4E6DGetWeekDayScheduleResponseO
0x4E6EGetYearDayScheduleResponseO
0x4E6BNumberOfCredentialsSupportedPerUserO
0x4E6ANumberOfYearDaySchedulesSupportedPerUserO
0x4E69NumberOfWeekDaySchedulesSupportedPerUserO
0x4E68NumberOfRFIDUsersSupportedO
0x4E67NumberOfPINUsersSupportedO
0x4E66NumberOfTotalUsersSupportedO
0x4E2ANetworkInterfacesO
0x8171LockOperationErrorO
0x9C40RemoteControlWithAuthCodeO
0x8173LockUserChangeO
0x8172DoorLockAlarmO
0x8170LockOperationO
0x8125RemoteUnlockO
0x8102SupportedRemoteFeaturesO
0x8101EnableRemoteControlO
0x80CBDoorStateO
0x8133ActuatorEnabledO
0x8130AlarmMaskO
0x812ACredentialRulesSupportO
0x812FExpiringUserTimeoutO
0x8126MaxPINCodeLengthO
0x8128MaxRFIDCodeLengthO
0x8127MinPINCodeLengthO
0x8129MinRFIDCodeLengthO
0x812BOperatingModeO
0x812ERequirePINForRemoteOperationO
0x812DSendPINOverTheAirO
0x812CUserCodeTemporaryDisableTimeO
0x8131SupportsTapToUnlockO
0x8132SupportsTapToLockO

LockState Trait(锁状态)​

该 Trait 用于「锁状态」相关数据的访问与上报。

Trait IDCode
0x80CALockState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockStateEnum80RVM
0x0006Supported Valuelist[LockStateEnum8]RO

FingerprintEnrollProgress Trait(指纹录入过程)​

在注册会话期间,设备在每次指纹录入尝试后发送 FingerprintEnrollProgress 事件。完整注册会话包含多次尝试(当前为 8 次);设备应在每次尝试后发出该事件。

Trait IDCode
0x50B4FingerprintEnrollProgress
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFingerprintEnrollProgressTraitPresentValueStructureVO

LockErrorLogReport Trait(锁错误日志上报)​

设备每次记录 LockErrorCodeEnum Type 定义的外部或内部异常时发出。

Trait IDCode
0x50B3LockErrorLogReport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockErrorLogReportTraitPresentValueStructureVO

LockLogReport Trait(锁日志上报)​

设备每次记录上锁或解锁操作时发出。

Trait IDCode
0x50B2LockLogReport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockLogReportTraitPresentValueStructureVO

DoorLogReport Trait(门日志上报)​

设备每次记录门状态事件时发出。

Trait IDCode
0x50B1DoorLogReport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorLogReportTraitPresentValueStructureVO

AqaraUserError Trait(添加Aqara凭证超时)​

该 Trait 用于上报 Aqara 用户或凭证管理操作失败的错误信息。

Trait IDCode
0x50B0AqaraUserError
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAqaraUserErrorTraitPresentValueStructureVO

AqaraUserChange Trait(Aqara用户变更)​

应将结果状态广播给所有订阅者,无论变更源自何处(远程命令、本地触控面板、恢复出厂设置等)。

Trait IDCode
0x50AFAqaraUserChange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAqaraUserChangeTraitPresentValueStructureVO

WiFiConfigStatus Trait(Wifi配置状态)​

应指示设备当前 Wi-Fi 配网/配置阶段,编码为 WiFiConfigStatusEnum Type。

Trait IDCode
0x50ACWiFiConfigStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWiFiConfigStatusEnum80RVO
0x0006Supported Valuelist[WiFiConfigStatusEnum8]RO

WifiMode Trait(Wifi模式)​

应配置设备的 Wi-Fi 运行时功耗/行为模式,编码为 WifiModeEnum Type。

Trait IDCode
0x50ABWifiMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWifiModeEnum80RVWO
0x0006Supported Valuelist[WifiModeEnum8]RO
0x0007Default ValueWifiModeEnum80RWO

WiFiStatus Trait(WiFi连接状态)​

应指示设备当前 Wi-Fi 连接状态,编码为 WiFiStatusEnum Type。

Trait IDCode
0x50A9WiFiStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWiFiStatusEnum80RVO
0x0006Supported Valuelist[WiFiStatusEnum8]RO

FirmwareDowngradeEnabled Trait(开启固件降级)​

应控制是否允许设备固件版本降级。false(0)应禁止降级;true(1)应允许降级。

Trait IDCode
0x50A8FirmwareDowngradeEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0WO
0x0007Default Valueboolean0RWO

VoiceOTAStatus Trait(语音固件升级)​

应指示当前语音固件 OTA 升级状态。

Trait IDCode
0x50A7VoiceOTAStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVoiceOTAStatusTraitPresentValueStructureRVO

OTASilentUpgrade Trait(OTA静默升级)​

应配置静默 OTA 固件升级功能。

Trait IDCode
0x50A6OTASilentUpgrade
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOTASilentUpgradeTraitPresentValueStructureRVWO

OTAProgress Trait(OTA进度)​

应指示当前 OTA 固件进度,上报 1 至 100 范围内的升级完成百分比

Trait IDCode
0x50A5OTAProgress
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81RVO
0x0002Maximum Valueuint8100RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO

UWBApproachDirection Trait(UWB接近方向)​

应配置 UWB 接近方向区域。每个位启用特定侧向区域的检测

Trait IDCode
0x50A4UWBApproachDirection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVWO

SupportedNfcCardTypes Trait(支持NFC卡类型)​

应指示门锁上启用凭据识别的 NFC 卡类型集合,编码为 SupportedNfcCardTypesBitmap Type。

Trait IDCode
0x50A2SupportedNfcCardTypes
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVWO

VoicePackageInfo Trait(语音包信息)​

应配置门锁语音包元数据。列表中每项编码为 VoicePackageInfoItemStruct Type。

Trait IDCode
0x50A1VoicePackageInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[VoicePackageInfoTraitPresentValueStructure]RVWO

DetectionDistance Trait(侦测距离)​

该 Trait 指示门锁雷达的有效检测距离,单位为厘米。

Trait IDCode
0x518ADetectionDistance
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16RVWO
0x0002Maximum Valueuint16600RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint16300RWO

DetectionThreshold Trait(侦测灵敏度阈值)​

该 Trait 指示用于区分有效检测事件与噪声的雷达检测灵敏度阈值。

Trait IDCode
0x518BDetectionThreshold
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16RVWO
0x0002Maximum Valueuint1612RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint161RWO

RemoteUnlockRelockDelay Trait(远程解锁重新上锁时间)​

应配置远程解锁后门锁自动重新上锁前的延迟秒数。单位为秒。

Trait IDCode
0x509CRemoteUnlockRelockDelay
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1630RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint1630RWO

CloseDoorAutoRelockEnabled Trait(关门自动上锁使能)​

该 Trait 用于启用或禁用门锁关门后的自动重新上锁功能。启用后,重新上锁延迟由 CloseDoorAutoRelockTime 配置。

Trait IDCode
0x513CCloseDoorAutoRelockEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AqaraLockStateExtension Trait(锁状态扩展)​

该 Trait 用于上报标准 LockState 无法表达的 Aqara 门锁异常锁状态。锁体暂时无法获知锁机构状态时,该值可以为 NULL。

Trait IDCode
0x514BAqaraLockStateExtension
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint8254RVO

AqaraDoorStateExtension Trait(门状态扩展)​

该 Trait 用于上报标准 DoorState 无法表达的 Aqara 门锁异常门状态。锁体暂时无法获知门状态时,该值可以为 NULL。

Trait IDCode
0x514CAqaraDoorStateExtension
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint8254RVO

DoorLockStateChangeTimestamp Trait(锁状态变更时间戳)​

该 Trait 指示上报的门锁状态最近一次发生变化的时间戳,使用 Unix 时间戳(毫秒,ms)。设备尚未上报状态变化时,该值可以为 NULL。

Trait IDCode
0x514DDoorLockStateChangeTimestamp
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVO
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO

VoiceLanguage Trait(语音播报语言)​

该 Trait 指示当前语音播报语言。

Trait IDCode
0x4EF3VoiceLanguage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint8RVWO
0x0006Supported Valuelist[uint8]RO
0x0007Default Valueuint81RWO

OTAState Trait(OTA状态)​

该 Trait 指示设备当前 OTA 固件升级状态。

Trait IDCode
0x4F09OTAState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81RVO

ButtonLockUnlockEnabled Trait(单击按键上解锁使能)​

该 Trait 用于启用或禁用单击按键上锁/解锁功能。值为 true 时,用户可通过单击按键上锁或解锁;值为 false 时禁用该功能。

Trait IDCode
0x5169ButtonLockUnlockEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AlwaysOpenMode Trait(常开模式)​

该 Trait 用于启用或禁用常开模式。值为 true 时启用常开模式,值为 false 时禁用常开模式。

Trait IDCode
0x509DAlwaysOpenMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AuxRotationEnabled Trait(辅助旋转使能)​

该 Trait 用于控制门锁辅助旋转功能是否启用。

Trait IDCode
0x514EAuxRotationEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SpeedFollowEnabled Trait(速度跟随使能)​

该 Trait 用于控制门锁速度跟随功能是否启用。

Trait IDCode
0x514FSpeedFollowEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

DoorbellEnabled Trait(门铃使能)​

该 Trait 用于启用或禁用门铃功能。

Trait IDCode
0x5149DoorbellEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

DoorbellSensitivity Trait(门铃感应灵敏度)​

该 Trait 指示门铃感应灵敏度等级。

Trait IDCode
0x514ADoorbellSensitivity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81RVWO
0x0007Default Valueuint81RWO

UWBMinUnlockDistance Trait(UWB 最小开锁距离)​

该 Trait 指示门锁的 UWB 最小开锁距离,单位为 mm。

UWBEnabled Trait(UWB 功能使能)​

该 Trait 用于启用或禁用 UWB 功能。

Trait IDCode
0x513FUWBEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

UWBDoubleDoorMode Trait(UWB 双层门模式使能)​

该 Trait 用于启用或禁用 UWB 双门模式。

Trait IDCode
0x5140UWBDoubleDoorMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

UWBFastStartMode Trait(UWB 快速启动模式)​

该 Trait 用于启用或禁用 UWB 快速启动模式。

Trait IDCode
0x5142UWBFastStartMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

UWBMultiEntrancesMode Trait(UWB 多入口模式使能)​

该 Trait 用于启用或禁用 UWB 多入口模式。

Trait IDCode
0x5145UWBMultiEntrancesMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueuint160RWO
Trait IDCode
0x5141UWBMinUnlockDistance
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161000RVWO

UWBRangingTimeout Trait(UWB 感应时间)​

该 Trait 指示门锁 UWB 测距会话超时时间,单位为毫秒。

Trait IDCode
0x5143UWBRangingTimeout
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1610RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint1610RWO

UWBSignalLostTimeout Trait(UWB 信号搜索时间)​

该 Trait 指示门锁在 UWB 信号丢失后等待后续动作的超时时间,单位为毫秒。

Trait IDCode
0x5144UWBSignalLostTimeout
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1630RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint1630RWO

CloseDoorAutoRelockTime Trait(关门自动上锁时间)​

该 Trait 指示门锁当前的关门自动重新上锁参数。AutoLockTime 表示重新上锁前的延迟秒数。

Trait IDCode
0x513DCloseDoorAutoRelockTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCloseDoorAutoRelockTimeTraitPresentValueStructureRVWO

MagneticEncoderCalibrationStatus Trait(磁编码校准状态)​

该 Trait 指示门锁磁编码校准状态。

Trait IDCode
0x5185MagneticEncoderCalibrationStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO

BoltTravelConfigured Trait(锁舌行程配置)​

该 Trait 指示门锁锁舌行程配置状态。

Trait IDCode
0x518DBoltTravelConfigured
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

RemoteUnlockAutoRelockEnabled Trait(远程开锁后自动上锁使能)​

该 Trait 用于启用或禁用远程开锁后的自动重新上锁功能。启用后,重新上锁延迟由 RemoteUnlockAutoRelockTime 配置。

Trait IDCode
0x513ERemoteUnlockAutoRelockEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

LocalCredentialLockoutDuration Trait(本地凭证锁定时间)​

应指示本地凭据输入(例如设备键盘密码、指纹传感器、NFC 读卡器、人脸/掌静脉)在过多验证失败后应用的剩余锁定秒数。该属性非空且非零时,设备应拒绝本地凭据尝试并随时间递减该值。

Trait IDCode
0x509BLocalCredentialLockoutDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint3290RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint3290RWO

AutoUnlock Trait(自动开锁)​

应配置 Aqara 专用自动解锁行为,编码为 32 位无符号整数,单位为秒。该值应指定自动解锁前的延迟;值为 0 应禁用自动解锁。

Trait IDCode
0x509AAutoUnlock
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

AwayModeArming Trait(离家模式布防)​

指示离家模式布防/撤防状态:false(0)撤防,true(1)布防。

Trait IDCode
0x5098AwayModeArming
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanRVWO
0x0007Default Valueboolean0RWO

LockQuietMode Trait(静音开锁模式)​

应配置上锁/解锁操作的静音电机速度模式。QuietModeEnabled 控制静音模式是否激活。QuietModeSpeed 使用 MotorSpeedEnum Type 设置静音窗口内的电机速度。ValidStartUtc 和 ValidEndUtc 指定静音模式生效的 UTC 时间范围;两者均设为 0 表示计划未激活。

Trait IDCode
0x5097LockQuietMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockQuietModeTraitPresentValueStructureRVWO

NormalModeSpeed Trait(正常模式电机转速)​

应配置正常(日常)运行模式下使用的电机速度档位,即静音模式未激活时。该值应为 MotorSpeedEnum Type 条目以选择速度档位。

Trait IDCode
0x5096NormalModeSpeed
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNormalModeSpeedEnum80RVWO
0x0006Supported Valuelist[NormalModeSpeedEnum8]RO
0x0007Default ValueNormalModeSpeedEnum80RWO

DoorbellLightEnabled Trait(开启门铃灯)​

应启用或禁用门铃指示灯。

Trait IDCode
0x5095DoorbellLightEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

DeviceOrientation Trait(门方向)​

应配置门锁物理朝向。DoorOpenDirection 使用 DoorOpenDirectionEnum Type 指定门向外开或向内开。 InstallationOrientation 使用 InstallationOrientationEnum Type 指定锁体安装轴向。

Trait IDCode
0x5094DeviceOrientation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDeviceOrientationTraitPresentValueStructureRVWO

MotorStrength Trait(电机强度)​

该 Trait 指示门锁电机强度。

Trait IDCode
0x5047MotorStrength
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint8RVWO
0x0007Default Valueuint80RWO

PullSpring Trait(PullSpring弹舌配置)​

应配置拉簧机构。Enabled 控制拉簧是否激活。LatchRetractTime 指定锁舌缩回时间(毫秒)。

Trait IDCode
0x5092PullSpring
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePullSpringTraitPresentValueStructureRVWO

FrontLockConnectionStatus Trait(前锁连接状态)​

应指示前后锁体之间的连接状态。false(0x00)表示未连接;true(0x01)表示已连接

Trait IDCode
0x5090FrontLockConnectionStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

DoorHandleDirection Trait(门把手方向)​

应配置门把手开启方向。RightOpen 表示门向右开;LeftOpen 表示门向左开。

Trait IDCode
0x508FDoorHandleDirection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorHandleDirectionEnum80RVWO
0x0006Supported Valuelist[DoorHandleDirectionEnum8]RO
0x0007Default ValueDoorHandleDirectionEnum80RWO

LocalSetting Trait(开启本地设置)​

应启用或禁用门锁本地设置功能。设为 true 时允许设备本地配置变更;设为 false 时锁定本地配置。

Trait IDCode
0x508ELocalSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

DualVerification Trait(双重验证)​

应启用或禁用门锁双重验证模式。启用后,门锁需两次独立凭据验证方可授予访问。

Trait IDCode
0x508DDualVerification
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

LockWorkMode Trait(门锁工作模式)​

应配置门锁运行模式。Normal(0)选择标准运行。InstallationInspection(1)激活现场安装功能检测模式用于现场测试。Demo(2)激活演示模式用于产品展示。

Trait IDCode
0x508CLockWorkMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockWorkModeEnum80RVWO
0x0006Supported Valuelist[LockWorkModeEnum8]RO
0x0007Default Valueuint80RWO

LocalMenuEntryMethod Trait(设置进入本地菜单方式)​

应配置允许进入设备本地菜单的认证方式。

Trait IDCode
0x5060LocalMenuEntryMethod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVWO

DoorLockAlarmStatus Trait(门锁告警状态)​

应上报门锁设备当前组合状态作为只读快照。设备尚未上报状态时,该属性应为 null。

Trait IDCode
0x505FDoorLockAlarmStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorLockAlarmStatusTraitPresentValueStructureRVO

TamperAlarmEnabled Trait(撬锁报警开关设置)​

应启用或禁用防拆报警。设为 true 时,检测到篡改事件门锁应触发报警。

Trait IDCode
0x505ETamperAlarmEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

HardInfo Trait(硬件信息)​

应提供只读字符串,编码门锁设备及其后盖模块的版本和身份信息。该字符串应为 UTF-8 编码,最大长度 256 字节。

Trait IDCode
0x505DHardInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

DoorAjarConfig Trait(门虚掩告警设置)​

应配置门虚掩报警行为。Enabled 字段启用或禁用报警。Volume 字段设置报警音量。WaitTime 字段定义门保持虚掩(未完全锁舌入位)后触发报警的超时秒数。可选 AlarmDuration 字段(如存在)指定每次触发时报警应持续的秒数。

Trait IDCode
0x505CDoorAjarConfig
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorAjarConfigTraitPresentValueStructureRVWO

DoorNotLockedConfig Trait(门未锁告警设置)​

应配置门未锁报警行为。Enabled 字段启用或禁用报警。Volume 字段设置报警音量。WaitTime 字段定义门保持关闭但未上锁后触发报警的超时秒数。可选 AlarmDuration 字段(如存在)指定每次触发时报警应持续的秒数。

Trait IDCode
0x505BDoorNotLockedConfig
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorNotLockedConfigTraitPresentValueStructureRVWO

DoorNotClosedConfig Trait(门未关告警设置)​

应配置门未关报警行为。Enabled 字段启用或禁用报警。Volume 字段设置报警音量。WaitTime 字段定义门保持打开后触发报警的超时秒数。可选 AlarmDuration 字段(如存在)指定每次触发时报警应持续的秒数。

Trait IDCode
0x505ADoorNotClosedConfig
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorNotClosedConfigTraitPresentValueStructureRVWO

AlarmVolume Trait(报警音量)​

应配置通用报警音量等级。

Trait IDCode
0x5059AlarmVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAlarmVolumeEnum80RVWO
0x0006Supported Valuelist[AlarmVolumeEnum8]RO
0x0007Default ValueAlarmVolumeEnum80RWO

LockJammedVolume Trait(锁舌卡住提示音量)​

应配置锁机构卡死时触发报警的音量等级。

Trait IDCode
0x5058LockJammedVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockJammedVolumeEnum80RVWO
0x0006Supported Valuelist[LockJammedVolumeEnum8]RO
0x0007Default ValueLockJammedVolumeEnum80RWO

AwayModePromptVolume Trait(布/撤防提示音量)​

应配置离家模式布防/撤防提示音量等级。

Trait IDCode
0x5057AwayModePromptVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAwayModePromptVolumeEnum80RVWO
0x0006Supported Valuelist[AwayModePromptVolumeEnum8]RO
0x0007Default ValueAwayModePromptVolumeEnum80RWO

DemoVoiceVolume Trait(演示固件语料音量)​

应配置演示固件语音音量等级,用于展厅演示。

Trait IDCode
0x5056DemoVoiceVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDemoVoiceVolumeEnum80RVWO
0x0006Supported Valuelist[DemoVoiceVolumeEnum8]RO
0x0007Default ValueDemoVoiceVolumeEnum80RWO

AbnormalVibrationAlarmVolume Trait(异常震动告警音量)​

应配置异常振动报警音量等级,用于保险箱功能。

Trait IDCode
0x5055AbnormalVibrationAlarmVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAbnormalVibrationAlarmVolumeEnum80RVWO
0x0006Supported Valuelist[AbnormalVibrationAlarmVolumeEnum8]RO
0x0007Default ValueAbnormalVibrationAlarmVolumeEnum80RWO

VoiceVolume Trait(语音音量)​

应配置语音提示音量等级。

Trait IDCode
0x5054VoiceVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVoiceVolumeEnum80RVWO
0x0006Supported Valuelist[VoiceVolumeEnum8]RO
0x0007Default ValueVoiceVolumeEnum80RWO

DoorbellVolume Trait(门铃音量)​

应配置门铃音量等级。

Trait IDCode
0x5053DoorbellVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorbellVolumeEnum80RVWO
0x0006Supported Valuelist[DoorbellVolumeEnum8]RO
0x0007Default ValueDoorbellVolumeEnum80RWO

UnlockVolume Trait(开锁音量)​

应配置解锁提示音音量等级。

Trait IDCode
0x5052UnlockVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueUnlockVolumeEnum80RVWO
0x0006Supported Valuelist[UnlockVolumeEnum8]RO
0x0007Default ValueUnlockVolumeEnum80RWO

EnableElectronicLockoutMode Trait(开启电子反锁模式)​

应启用/禁用电子锁定模式(童锁)。启用后,触控面板和键盘被锁定以防止误操作。

Trait IDCode
0x4F5DEnableElectronicLockoutMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableAwayMode Trait(开启离家模式)​

启用/禁用离家模式。

Trait IDCode
0x4F5BEnableAwayMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableDeadbolt Trait(开启反锁)​

该 Trait 用于「开启反锁」相关数据的访问与上报。

Trait IDCode
0x507AEnableDeadbolt
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ConfigOperation Trait(门锁配置操作)​

该 Trait 用于「门锁配置操作」相关数据的访问与上报。

Trait IDCode
0x5031ConfigOperation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueConfigOperationEnum80RVO
0x0006Supported Valuelist[ConfigOperationEnum8]RO

StateOfLowBat Trait(低电状态)​

指示电池是否处于低电量状态。0:正常,1:低电量,2:严重不足。

Trait IDCode
0x80C9StateOfLowBat
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStateOfLowBatEnum80RVO
0x0006Supported Valuelist[StateOfLowBatEnum8]RO

GetCredentialStatusResponse Trait(获取凭证状态回复)​

该 Trait 用于「获取凭证状态回复」相关数据的访问与上报。

Trait IDCode
0x4E71GetCredentialStatusResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueGetCredentialStatusResponseTraitPresentValueStructureRVO

SetCredentialResponse Trait(设置凭证回复)​

该 Trait 用于「设置凭证回复」相关数据的访问与上报。

Trait IDCode
0x4E70SetCredentialResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSetCredentialResponseTraitPresentValueStructureRVO

GetUserResponse Trait(获取用户回复)​

该 Trait 用于「获取用户回复」相关数据的访问与上报。

Trait IDCode
0x4E6FGetUserResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[GetUserResponseTraitPresentValueStructure]RVO

GetAqaraUserResponse Trait(获取Aqara用户响应)​

该 Trait 用于承载 GetAqaraUserResponse 返回的用户记录列表。

Trait IDCode
0x51F1GetAqaraUserResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueGetAqaraUserResponseTraitPresentValueStructureRVO

GetWeekDayScheduleResponse Trait(获取周日程回复)​

该 Trait 用于「获取周日程回复」相关数据的访问与上报。

Trait IDCode
0x4E6DGetWeekDayScheduleResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueGetWeekDayScheduleResponseTraitPresentValueStructureRVO

GetYearDayScheduleResponse Trait(获取年日程回复)​

该 Trait 用于「获取年日程回复」相关数据的访问与上报。

Trait IDCode
0x4E6EGetYearDayScheduleResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueGetYearDayScheduleResponseTraitPresentValueStructureRVO

NumberOfCredentialsSupportedPerUser Trait(每用户可支持凭证数)​

该 Trait 用于「每用户可支持凭证数」相关数据的访问与上报。

Trait IDCode
0x4E6BNumberOfCredentialsSupportedPerUser
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0007Default Valueuint80RWO

NumberOfYearDaySchedulesSupportedPerUser Trait(每用户可支持年日程数)​

该 Trait 用于「每用户可支持年日程数」相关数据的访问与上报。

Trait IDCode
0x4E6ANumberOfYearDaySchedulesSupportedPerUser
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0007Default Valueuint80RWO

NumberOfWeekDaySchedulesSupportedPerUser Trait(每用户可支持周日程数)​

该 Trait 用于「每用户可支持周日程数」相关数据的访问与上报。

Trait IDCode
0x4E69NumberOfWeekDaySchedulesSupportedPerUser
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0007Default Valueuint80RWO

NumberOfRFIDUsersSupported Trait(RFID用户量)​

该 Trait 用于「RFID用户量」相关数据的访问与上报。

Trait IDCode
0x4E68NumberOfRFIDUsersSupported
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint160RWO

NumberOfPINUsersSupported Trait(PIN用户量)​

该 Trait 用于「PIN用户量」相关数据的访问与上报。

Trait IDCode
0x4E67NumberOfPINUsersSupported
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint160RWO

NumberOfTotalUsersSupported Trait(门锁总用户量)​

该 Trait 用于「门锁总用户量」相关数据的访问与上报。

Trait IDCode
0x4E66NumberOfTotalUsersSupported
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint160RWO

NetworkInterfaces Trait(网络接口信息)​

该特征描述设备支持的网络接口。

Trait IDCode
0x4E2ANetworkInterfaces
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[NetworkInterfacesTraitPresentValueStructure]RVO

LockOperationError Trait(门锁操作(事件)错误上报)​

门锁操作因各种原因失败时,门锁将发出 LockOperationError 事件。

Trait IDCode
0x8171LockOperationError
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockOperationErrorTraitPresentValueStructureVO

RemoteControlWithAuthCode Trait(远程控制(带授权码)-绿米私有)​

该 Trait 用于「远程控制(带授权码)-绿米私有」相关数据的访问与上报。

Trait IDCode
0x9C40RemoteControlWithAuthCode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringWO

LockUserChange Trait(门锁用户变更上报)​

门锁用户、日程或凭证发生变更时,门锁将发出 LockUserChange 事件。

Trait IDCode
0x8173LockUserChange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockUserChangeTraitPresentValueStructureVO

DoorLockAlarm Trait(门锁报警(事件)上报)​

门锁在出现关键状态时可发送多种告警。

Trait IDCode
0x8172DoorLockAlarm
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorLockAlarmTraitPresentValueStructureVO
0x0006Extended Supported Valueslist[enum8]RO

LockOperation Trait(门锁操作(事件)上报)​

当设备通过任何支持的方式成功解锁/上锁时,记录并上报锁操作事件。提供解锁/上锁操作的详细上下文,包括来源(例如 Matter 生态系统或本地方式)、用户身份及使用的具体凭据。

Trait IDCode
0x8170LockOperation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockOperationTraitPresentValueStructureVO
0x0006Extended Supported Valueslist[enum8]RO

RemoteUnlock Trait(远程解锁--绿米私有)​

该 Trait 用于「远程解锁--绿米私有」相关数据的访问与上报。

Trait IDCode
0x8125RemoteUnlock
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SupportedRemoteFeatures Trait(支持的远程特性)​

该 Trait 用于「支持的远程特性」相关数据的访问与上报。

Trait IDCode
0x8102SupportedRemoteFeatures
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRO

EnableRemoteControl Trait(远程控制使能)​

该 Trait 用于「远程控制使能」相关数据的访问与上报。

Trait IDCode
0x8101EnableRemoteControl
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

DoorState Trait(门状态)​

该 Trait 用于「门状态」相关数据的访问与上报。

Trait IDCode
0x80CBDoorState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorStateEnum80RVO
0x0006Supported Valuelist[DoorStateEnum8]RO

ActuatorEnabled Trait(执行器启用)​

该 Trait 用于「执行器启用」相关数据的访问与上报。

Trait IDCode
0x8133ActuatorEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

AlarmMask Trait(报警掩码)​

该 Trait 用于「报警掩码」相关数据的访问与上报。

Trait IDCode
0x8130AlarmMask
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO
0x0007Default Valueuint161RWO

CredentialRulesSupport Trait(凭证规则支持)​

该 Trait 用于「凭证规则支持」相关数据的访问与上报。

Trait IDCode
0x812ACredentialRulesSupport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

ExpiringUserTimeout Trait(用户超时过期)​

该 Trait 用于「用户超时过期」相关数据的访问与上报。单位:S。

Trait IDCode
0x812FExpiringUserTimeout
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVWO
0x0002Maximum Valuefloat2880.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat1RWO

MaxPINCodeLength Trait(最大PINCode长度)​

该 Trait 用于「最大PINCode长度」相关数据的访问与上报。

Trait IDCode
0x8126MaxPINCodeLength
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

MaxRFIDCodeLength Trait(最大RFID长度)​

该 Trait 用于「最大RFID长度」相关数据的访问与上报。

Trait IDCode
0x8128MaxRFIDCodeLength
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

MinPINCodeLength Trait(最小PINCode长度)​

该 Trait 用于「最小PINCode长度」相关数据的访问与上报。

Trait IDCode
0x8127MinPINCodeLength
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

MinRFIDCodeLength Trait(最小RFID长度)​

该 Trait 用于「最小RFID长度」相关数据的访问与上报。

Trait IDCode
0x8129MinRFIDCodeLength
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

OperatingMode Trait(操作模式)​

该 Trait 用于「操作模式」相关数据的访问与上报。

Trait IDCode
0x812BOperatingMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOperatingModeEnum8RVWO
0x0006Supported Valuelist[OperatingModeEnum8]RO
0x0007Default ValueOperatingModeEnum80RWO

RequirePINForRemoteOperation Trait(是否需要PIN码进行远程操作)​

该 Trait 用于「是否需要PIN码进行远程操作」相关数据的访问与上报。

Trait IDCode
0x812ERequirePINForRemoteOperation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

SendPINOverTheAir Trait(通过空中发送PIN码)​

该 Trait 用于「通过空中发送PIN码」相关数据的访问与上报。

Trait IDCode
0x812DSendPINOverTheAir
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

UserCodeTemporaryDisableTime Trait(用户代码临时禁用时间)​

该 Trait 用于「用户代码临时禁用时间」相关数据的访问与上报。单位:S。

Trait IDCode
0x812CUserCodeTemporaryDisableTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVWO
0x0002Maximum Valuefloat255.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat1RWO

SupportsTapToUnlock Trait(支持轻触解锁)​

该 Trait 用于「支持轻触解锁」相关数据的访问与上报。

Trait IDCode
0x8131SupportsTapToUnlock
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

SupportsTapToLock Trait(支持轻触上锁)​

该 Trait 用于「支持轻触上锁」相关数据的访问与上报。

Trait IDCode
0x8132SupportsTapToLock
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

SetTravelCalibrationResponse Command​

该命令用于响应 SetTravelCalibration,上报行程校准会话的执行结果。

参数序号字段名类型必须说明
0ErrorCodeenum8M行程校准结果;0x00 表示成功,非零值表示失败原因。

AddAqaraUserResponse Command​

该命令用于响应 AddAqaraUser,上报用户创建结果,并返回设备分配的 UserId。

参数序号字段名类型必须说明
0ErrorCodeenum8M用户创建结果。
2UserIduint16M成功时为设备分配的新用户 ID。

ModifyAqaraUserResponse Command​

该命令用于响应 ModifyAqaraUser,上报用户修改结果。

参数序号字段名类型必须说明
0ErrorCodeenum8M用户修改结果。
2UserIduint16M被修改的用户 ID。

DeleteAqaraUserResponse Command​

该命令用于响应 DeleteAqaraUser,上报用户删除结果。

参数序号字段名类型必须说明
0ErrorCodeenum8M用户删除结果。
2UserIduint16M被删除的用户 ID。

GetAqaraUserResponse 响应数据格式​

设备以该响应返回用户记录及分页游标。下表仅列出 Aqara Spec 用户数据模型使用的字段;Trait 仅保存 Users,不包含 ErrorCode。字段 ID 沿用 Extension 定义。

参数序号字段名类型必须说明
2Userslist[AqaraUserRecordStruct]O用户记录列表,最多返回请求中的 Number 条记录,并按 UserId 升序排列;空数据库时为空列表。
3NextUserIduint16M后续分页查询的起始用户 ID;null 表示遍历完成。

AddAqaraCredentialResponse Command​

该命令用于响应 AddAqaraCredential,上报凭证添加结果,并在成功时返回 CredentialId。

参数序号字段名类型必须说明
0ErrorCodeenum8M凭证添加结果。
2UserIduint16M凭证所属用户 ID。
3CredentialIduint16O成功时为设备分配的凭证 ID。

ModifyAqaraCredentialResponse Command​

该命令用于响应 ModifyAqaraCredential,上报凭证修改结果。

参数序号字段名类型必须说明
0ErrorCodeenum8M凭证修改结果。
2CredentialIduint16M被修改的凭证 ID。

DeleteAqaraCredentialResponse Command​

该命令用于响应 DeleteAqaraCredential,上报凭证删除结果。

参数序号字段名类型必须说明
0ErrorCodeenum8M凭证删除结果。
2CredentialIduint16M被删除的凭证 ID。

GetAqaraCredentialResponse Command​

该命令用于响应 GetAqaraCredential,返回凭证查询结果和凭证记录。

参数序号字段名类型必须说明
0ErrorCodeenum8M凭证查询结果。
2UserIduint16O凭证所属用户 ID。
3CredentialStructO凭证记录。

ExitAddAqaraCredentialResponse Command​

该命令用于响应 ExitAddAqaraCredential,上报退出凭证录入会话的结果。

参数序号字段名类型必须说明
0ErrorCodeenum8M退出会话结果。
2UserIduint16M退出会话所属用户 ID。

Command 定义​

Command IDNameConformance
0x9C61GetUserO
0x9C65ClearCredentialO
0x9C64GetCredentialStatusO
0x9C63SetCredentialO
0x9C62ClearUserO
0x9C60SetUserO
0x9C5FUnboltDoorO
0x9C5DGetYearDayScheduleO
0x9C5EClearYearDayScheduleO
0x9C5CSetYearDayScheduleO
0x9C5BClearWeekDayScheduleO
0x9C5AGetWeekDayScheduleO
0x9C59SetWeekDayScheduleO
0x88CDQuietUnlockDoorO
0x88CCQuietLockDoorO
0x88C3UnlockDoorO
0x88C2LockDoorO
0x9DAEMagneticEncoderCalibrationO
0x9D6FGetLogO
0x9D6EExitAddAqaraCredentialO
0x9D6DGetAqaraCredentialO
0x9D6CDeleteAqaraCredentialO
0x9D6BModifyAqaraCredentialO
0x9D6AAddAqaraCredentialO
0x9D69GetAqaraUserO
0x9D68DeleteAqaraUserO
0x9D67ModifyAqaraUserO
0x9D66AddAqaraUserO
0x9CB1SetTravelCalibrationO

GetUser Command​

该 Command 用于执行「获取用户」操作。

参数​

GetUser Command Structure

ClearCredential Command​

该 Command 用于执行「清除凭证」操作。

参数​

ClearCredential Command Structure

GetCredentialStatus Command​

该 Command 用于执行「获取凭证状态」操作。

参数​

GetCredentialStatus Command Structure

SetCredential Command​

该 Command 用于执行「设置凭证」操作。

参数​

SetCredential Command Structure

ClearUser Command​

ClearUser(清除用户)

参数​

ClearUser Command Structure

SetUser Command​

该 Command 用于执行「设置用户」操作。

参数​

SetUser Command Structure

UnboltDoor Command​

开门--收起方舌和斜舌

参数​

UnboltDoor Command Structure

GetYearDaySchedule Command​

该 Command 用于执行「获取年日程」操作。

参数​

GetYearDaySchedule Command Structure

ClearYearDaySchedule Command​

该 Command 用于执行「清除年日程」操作。

参数​

ClearYearDaySchedule Command Structure

SetYearDaySchedule Command​

该 Command 用于执行「设置年日程」操作。

参数​

SetYearDaySchedule Command Structure

ClearWeekDaySchedule Command​

该 Command 用于执行「清除周日程」操作。

参数​

ClearWeekDaySchedule Command Structure

GetWeekDaySchedule Command​

该 Command 用于执行「获取周日程」操作。

参数​

GetWeekDaySchedule Command Structure

SetWeekDaySchedule Command​

该 Command 用于执行「设置周日程」操作。

参数​

SetWeekDaySchedule Command Structure

QuietUnlockDoor Command​

该 Command 用于执行「静音开锁」操作。

该 Command 无参数。

QuietLockDoor Command​

该 Command 用于执行「静音上锁」操作。

该 Command 无参数。

UnlockDoor Command​

该 Command 用于执行「解锁」操作。

参数​

UnlockDoor Command Structure

LockDoor Command​

该 Command 用于执行「上锁」操作。

参数​

LockDoor Command Structure

MagneticEncoderCalibration Command​

该命令用于启动门锁磁编码校准。该命令无参数。

GetLog Command​

该命令应请求门锁返回一段日志条目。设备应以 GetLogResponse 命令响应。

参数​

GetLog Command Structure

ExitAddAqaraCredential Command​

该命令应退出指定凭证类型和属性的添加凭证会话。客户端发送该命令以取消或完成凭证录入流程而不提交新凭证。UserId 字段标识正在退出凭证录入会话的用户。

参数​

ExitAddAqaraCredential Command Structure

GetAqaraCredential Command​

该命令应请求门锁返回指定凭证的完整凭证记录。设备应以 GetAqaraCredentialResponse 命令响应。

参数​

GetAqaraCredential Command Structure

DeleteAqaraCredential Command​

该命令应从门锁凭证数据库中删除 CredentialId 标识的凭证。

参数​

DeleteAqaraCredential Command Structure

ModifyAqaraCredential Command​

该命令应更新 CredentialId 标识凭证的一个或多个属性。 每个可更新字段均可独立省略:字段省略时,设备上凭证的现有值应保持不变。至少应提供 CredentialAttribute、CredentialType、CredentialContent、Validity 或 CredentialName 之一;若五项均省略,设备应以 DoorLockErrorCodeEnum 类型 InvalidParameter(0x07)响应且不得修改任何凭证数据。

参数​

ModifyAqaraCredential Command Structure

AddAqaraCredential Command​

该命令应添加新凭证并将其与 UserId 标识的现有用户关联。CredentialContent 字段以结构化值承载类型特定的凭证载荷;CredentialName 为带隐式长度前缀的可变长度字符串。可选 Validity 字段在存在时以 CredentialValidityStruct 类型编码凭证的周期性有效日程;不存在时,凭证除设备默认限制外无时间边界限制。

参数​

AddAqaraCredential Command Structure

GetAqaraUser Command​

该命令应请求门锁返回一条或多条用户记录(每条携带用户属性及关联凭证)。设备应以 GetAqaraUserResponse 响应,从 UserId 起最多返回 Number 条记录。该命令也是遍历完整用户数据库的基本操作--客户端通过链式连续调用并消费每次响应的 NextUserId 字段直至其为 null 来遍历数据库。

参数​

GetAqaraUser Command Structure

DeleteAqaraUser Command​

该命令应从门锁用户数据库中删除 UserId 标识的用户。

参数​

DeleteAqaraUser Command Structure

ModifyAqaraUser Command​

该命令应更新门锁设备上 UserId 标识用户的一个或多个属性。每个可更新字段均可独立省略:字段为 null 或省略时,设备上用户的现有值应保持不变。UserType 或 UserName 至少一项应提供非 null 值;若两项均为 null 或省略,设备应以 DoorLockErrorCodeEnum 类型 InvalidParameter(0x07)响应且不得修改任何用户数据。

参数​

ModifyAqaraUser Command Structure

AddAqaraUser Command​

该命令应在门锁用户数据库中创建新用户条目。设备应为新用户分配未使用的 UserId,并在对应的 AddAqaraUserResponse 中返回该标识符。新创建的用户尚未关联任何凭证;后续可通过 AddAqaraCredential 附加凭证。

参数​

AddAqaraUser Command Structure

SetTravelCalibration Command​

该命令应控制门锁的手动行程校准会话。客户端发送该命令驱动锁体完成全行程运动并记录开锁与关锁端点位置。

参数​

SetTravelCalibration Command Structure

Sweeper(扫地)​

简介​

提供扫地机器人基础控制,包括启动清扫、暂停、回充等操作与状态反馈。

Function 标识​

Function IDCode名称
0x0095Sweeper扫地

Trait​

Trait IDCode名称Conformance
0x80CFSweeperState扫地状态M

Command​

Command IDCode名称Conformance
0x80D0ContinueCleaning继续清扫M
0x80D3PauseCleaning暂停清扫O
0x80D2StartCleaning开始清扫O
0x80D1StopCleaning停止清扫O

数据类型​

SweeperStateEnum8 Type​

该枚举定义 SweeperState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Cleaning清扫中
0x01Paused暂停
0x02NotCleaning未清扫

Trait 定义​

Trait IDNameConformance
0x80CFSweeperStateM

SweeperState Trait(扫地状态)​

该 Trait 用于「扫地状态」相关数据的访问与上报。

Trait IDCode
0x80CFSweeperState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSweeperStateEnum80RVM
0x0006Supported Valuelist[SweeperStateEnum8]RO

Command 定义​

Command IDNameConformance
0x80D0ContinueCleaningM
0x80D3PauseCleaningO
0x80D2StartCleaningO
0x80D1StopCleaningO

ContinueCleaning Command​

该 Command 用于执行「继续清扫」操作。

该 Command 无参数。

PauseCleaning Command​

该 Command 用于执行「暂停清扫」操作。

该 Command 无参数。

StartCleaning Command​

该 Command 用于执行「开始清扫」操作。

该 Command 无参数。

StopCleaning Command​

该 Command 用于执行「停止清扫」操作。

该 Command 无参数。

AirQuality(空气质量)​

简介​

监测并上报空气质量指标,如 AQI 或综合空气质量等级。

Function 标识​

Function IDCode名称
0x0096AirQuality空气质量

Trait​

Trait IDCode名称Conformance
0x80D5VOCQualityVOC等级M
0x80D4VOCDensityVOC浓度M
0x0009AirQuality空气质量等级O
0x51A9NMHCDensity非甲烷总烃浓度O
0x51ADNegativeOxygenIons负氧离子O

Command​

本 Function 不包含 Command。

数据类型​

VOCQualityEnum8 Type​

该枚举定义 VOCQuality Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01Excellent优
0x02Good良好
0x03Fair一般
0x04Inferior差
0x05Poor极差
AirQualityEnum8 Type​

该枚举定义 AirQuality Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01Excellent优
0x02Good良
0x03Fair中
0x04Inferior差
0x05Poor极差

Trait 定义​

Trait IDNameConformance
0x80D5VOCQualityM
0x80D4VOCDensityM
0x0009AirQualityO
0x51A9NMHCDensityO
0x51ADNegativeOxygenIonsO

VOCQuality Trait(VOC等级)​

指示挥发性有机化合物(VOC)空气质量等级。值:0 = 未知,1 = 优,2 = 良,3 = 中,4 = 较差,5 = 差。

Trait IDCode
0x80D5VOCQuality
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVOCQualityEnum80RVM
0x0006Supported Valuelist[VOCQualityEnum8]RO

VOCDensity Trait(VOC浓度)​

该 Trait 用于「VOC浓度」相关数据的访问与上报。单位:ppb。

Trait IDCode
0x80D4VOCDensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVM
0x0002Maximum Valuefloat9999.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat1RWO

AirQuality Trait(空气质量等级)​

AirQuality表示空气质量等级.

Trait IDCode
0x0009AirQuality
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAirQualityEnum80RVO
0x0006Supported Valuelist[AirQualityEnum8]RO
0x0007Default Valueuint80RWO

NMHCDensity Trait(非甲烷总烃浓度)​

表示空气中非甲烷总烃浓度,可用于评估挥发性有机污染总体水平。单位:ug/m^3。

Trait IDCode
0x51A9NMHCDensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat9999.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

NegativeOxygenIons Trait(负氧离子)​

表示空气中负氧离子水平,常用于描述空气清新度或特定环境特征。单位:ions/cm^3。

Trait IDCode
0x51ADNegativeOxygenIons
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat1000000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

Pressure(压力)​

简介​

测量并上报大气压力或系统压力值。

Function 标识​

Function IDCode名称
0x0097Pressure压力

Trait​

Trait IDCode名称Conformance
0x80D6CurrentPressure压力M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x80D6CurrentPressureM

CurrentPressure Trait(压力)​

该 Trait 用于「压力」相关数据的访问与上报。单位:kPa。

Trait IDCode
0x80D6CurrentPressure
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat101RVM
0x0002Maximum Valuefloat200000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat101RWO

Command 定义​

本 Function 不包含 Command。

ParticulateMatter(颗粒物)​

简介​

监测并上报颗粒物浓度(如 PM2.5、PM10)。

Function 标识​

Function IDCode名称
0x0098ParticulateMatter颗粒物

Trait​

Trait IDCode名称Conformance
0x80D7PM2.5DensityPM2.5浓度M
0x80D8PM2.5LevelPM2.5等级M
0x80D9PM1.0DensityPM1.0浓度M
0x80DAPM10DensityPM10浓度M
0x519EPM100DensityPM100浓度O
0x51AATSPDensityTSP浓度O

Command​

本 Function 不包含 Command。

数据类型​

PM2.5LevelEnum8 Type​

该枚举定义 PM2.5Level Trait 的 Present Value 有效取值。

ValueNameDescription
0x00UnknownUnknown
0x01Excellent优
0x02Good良好
0x03Fair一般
0x04Inferior差
0x05Poor极差

Trait 定义​

Trait IDNameConformance
0x80D7PM2.5DensityM
0x80D8PM2.5LevelM
0x80D9PM1.0DensityM
0x80DAPM10DensityM
0x519EPM100DensityO
0x51AATSPDensityO

PM2.5Density Trait(PM2.5浓度)​

该 Trait 用于「PM2.5浓度」相关数据的访问与上报。单位:ug/m^3。

Trait IDCode
0x80D7PM2.5Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat1000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

PM2.5Level Trait(PM2.5等级)​

该 Trait 用于「PM2.5等级」相关数据的访问与上报。

Trait IDCode
0x80D8PM2.5Level
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePM2.5LevelEnum80RVM
0x0006Supported Valuelist[PM2.5LevelEnum8]RO

PM1.0Density Trait(PM1.0浓度)​

该 Trait 用于「PM1.0浓度」相关数据的访问与上报。单位:ug/m^3。

Trait IDCode
0x80D9PM1.0Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat65535.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

PM10Density Trait(PM10浓度)​

该 Trait 用于「PM10浓度」相关数据的访问与上报。单位:ug/m^3。

Trait IDCode
0x80DAPM10Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat65535.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

PM100Density Trait(PM100浓度)​

表示空气中较大颗粒物的质量浓度,可用于评估悬浮颗粒污染水平以及环境洁净度变化。单位:ug/m^3。

Trait IDCode
0x519EPM100Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

TSPDensity Trait(TSP浓度)​

表示空气中总悬浮颗粒物浓度,可用于评估整体颗粒污染水平和环境洁净度。单位:ug/m^3。

Trait IDCode
0x51AATSPDensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

CO2(二氧化碳)​

简介​

测量并上报环境中二氧化碳浓度。

Function 标识​

Function IDCode名称
0x0099CO2二氧化碳

Trait​

Trait IDCode名称Conformance
0x80DCCO2LevelCO2等级M
0x80DBCO2DensityCO2浓度M

Command​

本 Function 不包含 Command。

数据类型​

CO2LevelEnum8 Type​

该枚举定义 CO2Level Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Excellent优
0x01LightPollution轻度污染
0x02HeavyPollution重度污染

Trait 定义​

Trait IDNameConformance
0x80DCCO2LevelM
0x80DBCO2DensityM

CO2Level Trait(CO2等级)​

以定性指数指示二氧化碳浓度水平。取值:0 = Excellent(正常/低 CO2),1 = Light Pollution(CO2 轻度升高),2 = Heavy Pollution(CO2 浓度高)。

Trait IDCode
0x80DCCO2Level
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCO2LevelEnum80RVM
0x0006Supported Valuelist[CO2LevelEnum8]RO

CO2Density Trait(CO2浓度)​

该 Trait 用于「CO2浓度」相关数据的访问与上报。单位:ppm。

Trait IDCode
0x80DBCO2Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat9999.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

Illuminance(光照度)​

简介​

测量并上报环境光照度(lux)。

Function 标识​

Function IDCode名称
0x009AIlluminance光照度

Trait​

Trait IDCode名称Conformance
0x80DDCurrentIlluminance光照度M
0x4E99SamplingInterval采样时间间隔设置O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x80DDCurrentIlluminanceM
0x4E99SamplingIntervalO

CurrentIlluminance Trait(光照度)​

该 Trait 用于「光照度」相关数据的访问与上报。单位:lux。

Trait IDCode
0x80DDCurrentIlluminance
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVM
0x0002Maximum Valuefloat100000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

SamplingInterval Trait(采样时间间隔设置)​

定义数据采样时间间隔。单位:S。

Trait IDCode
0x4E99SamplingInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat5RVWO
0x0002Maximum Valuefloat3600.0RO
0x0003Minimum Valuefloat0.5RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat5RWO

Command 定义​

本 Function 不包含 Command。

Contact(接触)​

简介​

检测接触/门磁类二元状态,上报打开或关闭状态及可选角度信息。

Function 标识​

Function IDCode名称
0x009BContact接触

Trait​

Trait IDCode名称Conformance
0x80DEContactSensorState接触状态M
0x4E74OpenAngle开合角度O
0x5061CalibrationNotification校准结果O

Command​

Command IDCode名称Conformance
0x9C75CalibrateReq远程校准O

数据类型​

CalibrationNotificationEnum8 Type​

该枚举定义 CalibrationNotification Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Success成功
0x01Failure失败

Trait 定义​

Trait IDNameConformance
0x80DEContactSensorStateM
0x4E74OpenAngleO
0x5061CalibrationNotificationO

ContactSensorState Trait(接触状态)​

该 Trait 用于「接触状态」相关数据的访问与上报。

Trait IDCode
0x80DEContactSensorState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM

OpenAngle Trait(开合角度)​

门窗开合角度

Trait IDCode
0x4E74OpenAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat360.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

CalibrationNotification Trait(校准结果)​

该 Trait 用于「校准结果」相关数据的访问与上报。

Trait IDCode
0x5061CalibrationNotification
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCalibrationNotificationEnum80RVO
0x0006Supported Valuelist[CalibrationNotificationEnum8]RO

Command 定义​

Command IDNameConformance
0x9C75CalibrateReqO

CalibrateReq Command​

该 Command 用于执行「远程校准」操作。

该 Command 无参数。

Smoke(烟雾)​

简介​

检测烟雾并上报报警事件,支持灵敏度、自检提醒及静音等相关配置。

Function 标识​

Function IDCode名称
0x009CSmoke烟雾

Trait​

Trait IDCode名称Conformance
0x80E0SmokeDetected烟雾检测状态M
0x4F86SmokeChamberContamination烟室污染状态O
0x4F47AlarmError报警错误O
0x4F11SmokeState烟雾等级O
0x519BSelfTestReminder自检提醒O
0x4F10EnableHeartbeatIndicator心跳指示灯控制O
0x4F0FFireProductIdentification消防识别码O
0x4F0BAlarmsEnabled报警使能O
0x4E88SelfCheck报警器自检O
0x0005ExpressedState报警器状态O
0x80F0SmokeDensitydB烟雾浓度dBO
0x80DFSmokeDensity烟雾浓度O
0x80C1Mute静音O
0x503CInterconnectSmokeAlarm烟雾联动报警O

Command​

Command IDCode名称Conformance
0x9C76TriggerWarning触发报警O
0x9C42SelfTestRequest自检O

数据类型​

SmokeChamberContaminationEnum8 Type​

该枚举定义 SmokeChamberContamination Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal监测正常
0x01Contaminated烟室污染
AlarmErrorEnum8 Type​

该枚举定义 AlarmError Trait 的 Present Value 有效取值。

ValueNameDescription
0x00SUCCESS成功
0x01FAILURE失败
0x02NOT_ALLOWED不允许
SmokeStateEnum8 Type​

该枚举定义 SmokeState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Warning警告
0x02Critical严重
ExpressedStateEnum8 Type​

该枚举定义 ExpressedState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01SmokeAlarm烟雾泄漏
0x02COAlarmCO泄漏
0x03BatteryAlert电池警告
0x04Testing测试中
0x05HardwareFault硬件错误
0x06EndOfService服务终止
0x07InterconnectSmoke互联烟雾报警
0x08InterconnectCO互联CO报警
InterconnectSmokeAlarmEnum8 Type​

该枚举定义 InterconnectSmokeAlarm Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Warning告警
0x02Critical严重告警
SelfTestReminderEnum8 Type​

该枚举定义 SelfTestReminder Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NoReminder当前不需要执行自检
0x01SelfTestRequired设备需要执行自检
TriggerWarning Command Structure Type​

TriggerWarning Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Warningenum8M警告。

Trait 定义​

Trait IDNameConformance
0x80E0SmokeDetectedM
0x4F86SmokeChamberContaminationO
0x4F47AlarmErrorO
0x4F11SmokeStateO
0x519BSelfTestReminderO
0x4F10EnableHeartbeatIndicatorO
0x4F0FFireProductIdentificationO
0x4F0BAlarmsEnabledO
0x4E88SelfCheckO
0x0005ExpressedStateO
0x80F0SmokeDensitydBO
0x80DFSmokeDensityO
0x80C1MuteO
0x503CInterconnectSmokeAlarmO

SmokeDetected Trait(烟雾检测状态)​

该 Trait 用于「烟雾检测状态」相关数据的访问与上报。

Trait IDCode
0x80E0SmokeDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM

SmokeChamberContamination Trait(烟室污染状态)​

指示烟腔污染状态。该 Trait 使用枚举表示灰尘或颗粒物积聚遮挡光路造成的不同污染等级。非零值表示需要维护,值越高可能表示污染越严重。

Trait IDCode
0x4F86SmokeChamberContamination
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSmokeChamberContaminationEnum80RVO
0x0006Supported Valuelist[SmokeChamberContaminationEnum8]RO
0x0007Default Valueuint80RWO

AlarmError Trait(报警错误)​

该 Trait 用于「报警错误」相关数据的访问与上报。

Trait IDCode
0x4F47AlarmError
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAlarmErrorEnum80RVWO
0x0006Supported Valuelist[AlarmErrorEnum8]RO
0x0007Default ValueAlarmErrorEnum80RWO

SmokeState Trait(烟雾等级)​

该 Trait 用于「烟雾状态」相关数据的访问与上报。

Trait IDCode
0x4F11SmokeState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSmokeStateEnum80RVO
0x0006Supported Valuelist[SmokeStateEnum8]RO

EnableHeartbeatIndicator Trait(心跳指示灯控制)​

该 Trait 用于「心跳指示灯控制」相关数据的访问与上报。

Trait IDCode
0x4F10EnableHeartbeatIndicator
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

FireProductIdentification Trait(消防识别码)​

该 Trait 用于「消防识别码」相关数据的访问与上报。

Trait IDCode
0x4F0FFireProductIdentification
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

SelfTestReminder Trait(自检提醒)​

该 Trait 为只读属性,用于指示设备当前是否需要执行自检。设备检测到需要自检时,应将该 Trait 设置为 SelfTestRequired;不需要自检时,应设置为 NoReminder。

Trait IDCode
0x519BSelfTestReminder
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSelfTestReminderEnum80RVO

AlarmsEnabled Trait(报警使能)​

该 Trait 用于「报警使能」相关数据的访问与上报。

Trait IDCode
0x4F0BAlarmsEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SelfCheck Trait(报警器自检)​

便于执行自检以验证设备功能是否正常。

Trait IDCode
0x4E88SelfCheck
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ExpressedState Trait(报警器状态)​

ExpressedState 定义了报警器的状态.

Trait IDCode
0x0005ExpressedState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueExpressedStateEnum80RVO
0x0006Supported Valuelist[ExpressedStateEnum8]RO
0x0007Default Valueuint80RWO

SmokeDensitydB Trait(烟雾浓度dB)​

该 Trait 用于「烟雾浓度dB」相关数据的访问与上报。单位:dB/m。

Trait IDCode
0x80F0SmokeDensitydB
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat10.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default Valuefloat0RWO

SmokeDensity Trait(烟雾浓度)​

该 Trait 用于「烟雾浓度」相关数据的访问与上报。单位:OBS%/FT。

Trait IDCode
0x80DFSmokeDensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat5.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default Valuefloat0RWO

Mute Trait(静音)​

指示扬声器静音状态。

Trait IDCode
0x80C1Mute
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

InterconnectSmokeAlarm Trait(烟雾联动报警)​

该 Trait 用于「烟雾联动报警」相关数据的访问与上报。

Trait IDCode
0x503CInterconnectSmokeAlarm
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueInterconnectSmokeAlarmEnum80RVO
0x0006Supported Valuelist[InterconnectSmokeAlarmEnum8]RO

Command 定义​

Command IDNameConformance
0x9C76TriggerWarningO
0x9C42SelfTestRequestO

TriggerWarning Command​

该 Command 用于执行「触发报警」操作。

参数​

TriggerWarning Command Structure

SelfTestRequest Command​

SelfTestRequest表示报警器自检。

该 Command 无参数。

Gas(气体)​

简介​

检测可燃气体或有害气体泄漏并上报告警事件。

Function 标识​

Function IDCode名称
0x009DGas气体

Trait​

Trait IDCode名称Conformance
0x80E2GasDetected气体检测状态M
0x80E1GasDensity气体浓度M
0x4E88SelfCheck报警器自检O
0x80C1Mute静音O
0x813BCurrentSensitivityLevel当前灵敏度等级O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x80E2GasDetectedM
0x80E1GasDensityM
0x4E88SelfCheckO
0x80C1MuteO
0x813BCurrentSensitivityLevelO

GasDetected Trait(气体检测状态)​

该 Trait 用于「气体检测状态」相关数据的访问与上报。

Trait IDCode
0x80E2GasDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM

GasDensity Trait(气体浓度)​

该 Trait 用于「气体浓度」相关数据的访问与上报。单位:%LEL。

Trait IDCode
0x80E1GasDensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

SelfCheck Trait(报警器自检)​

便于执行自检以验证设备功能是否正常。

Trait IDCode
0x4E88SelfCheck
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Mute Trait(静音)​

指示扬声器静音状态。

Trait IDCode
0x80C1Mute
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CurrentSensitivityLevel Trait(当前灵敏度等级)​

指示当前所选通用配置灵敏度等级。

Trait IDCode
0x813BCurrentSensitivityLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint8RVWO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO
0x0007Default Valueuint80RWO

Command 定义​

本 Function 不包含 Command。

Sleep(睡眠)​

简介​

监测睡眠相关状态,上报睡眠阶段、时长或质量等指标。

Function 标识​

Function IDCode名称
0x009ESleep睡眠

Trait​

Trait IDCode名称Conformance
0x80E3SleepState睡眠状态M
0x80E4SleepQuality睡眠质量M
0x80E5OnBed在床状态M
0x80E6SleepStage睡眠阶段O

Command​

本 Function 不包含 Command。

数据类型​

SleepStateEnum8 Type​

该枚举定义 SleepState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01Awake清醒
0x02Sleep入睡
SleepStageEnum8 Type​

该枚举定义 SleepStage Trait 的 Present Value 有效取值。

ValueNameDescription
0x00LightSleepLightSleep
0x01DeepSleepDeepSleep
0x02REMREM

Trait 定义​

Trait IDNameConformance
0x80E3SleepStateM
0x80E4SleepQualityM
0x80E5OnBedM
0x80E6SleepStageO

SleepState Trait(睡眠状态)​

该 Trait 用于「睡眠状态」相关数据的访问与上报。

Trait IDCode
0x80E3SleepState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSleepStateEnum80RVM
0x0006Supported Valuelist[SleepStateEnum8]RO

SleepQuality Trait(睡眠质量)​

定义睡眠质量,取值范围 0 至 100。

Trait IDCode
0x80E4SleepQuality
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

OnBed Trait(在床状态)​

定义在床状态。

Trait IDCode
0x80E5OnBed
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM

SleepStage Trait(睡眠阶段)​

定义睡眠阶段。

Trait IDCode
0x80E6SleepStage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSleepStageEnum80RVO
0x0006Supported Valuelist[SleepStageEnum8]RO

Command 定义​

本 Function 不包含 Command。

WaterLeak(水浸)​

简介​

检测水浸事件,在检测到漏水时及时上报告警。

Function 标识​

Function IDCode名称
0x009FWaterLeak水浸

Trait​

Trait IDCode名称Conformance
0x80E7LeakState泄漏状态M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x80E7LeakStateM

LeakState Trait(泄漏状态)​

该 Trait 用于「泄漏状态」相关数据的访问与上报。

Trait IDCode
0x80E7LeakState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM

Command 定义​

本 Function 不包含 Command。

OccupancySensing(存在)​

简介​

检测空间内是否有人存在,上报占用/空闲状态及保持时间等参数。

Function 标识​

Function IDCode名称
0x00A0OccupancySensing存在

Trait​

Trait IDCode名称Conformance
0x80E9OccupancySensorType存在传感类型M
0x80E8Occupancy存在状态M
0x5029OccupancySensingEnable人体感应使能O
0x502DRegionDimension区域尺寸O
0x4FCCBitmaskRegionSetting侦测区域设置O
0x4FB6RecordEnable录像使能O
0x4FB5PushEnable推送使能O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x4FB3TimePeriodSetting时段设置O
0x4E72HoldTime无人判定延时O
0x8115DurationOccupiedWithinOneWeek当周占用时长O
0x8114DurationOccupiedWithinOneDay当日占用时长O
0x4FE2OccupancyStayTime人体感应逗留时长O
0x8134OccupiedToUnoccupiedDelay变为非占用延时O
0x8135UnoccupiedToOccupiedDelay变为占用延时O

Command​

本 Function 不包含 Command。

数据类型​

OccupancySensorTypeEnum8 Type​

该枚举定义 OccupancySensorType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00PIR被动红外
0x01Ultrasonic超声波
0x02PIRAndUltrasonic红外和超声波
0x03PhysicalContact物理接触
0x04Radar雷达
0x05Vision视觉
RegionDimensionTraitPresentValueStructure Type​

该结构体定义 RegionDimension Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0unitenum8M宽度和高度的单位,例如 GRID 或 PIXEL。
1widthuint32M指定单位下的区域总宽度。
2heightuint32M指定单位下的区域总高度。
BitmaskRegionSettingTraitPresentValueStructure Type​

该结构体定义 BitmaskRegionSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0detect_regioncharacterStringM十六进制字符串形式的位掩码,每一位对应一个网格单元。
1effective_bitsint32M位掩码中的有效 bit 数,超过该数量的 bit 应被忽略。
SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高
TimePeriodSettingTraitPresentValueStructure Type​

该结构体定义 TimePeriodSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。

Trait 定义​

Trait IDNameConformance
0x80E9OccupancySensorTypeM
0x80E8OccupancyM
0x5029OccupancySensingEnableO
0x502DRegionDimensionO
0x4FCCBitmaskRegionSettingO
0x4FB6RecordEnableO
0x4FB5PushEnableO
0x4FB4SensitivityLevelEnumO
0x4FB3TimePeriodSettingO
0x4E72HoldTimeO
0x8115DurationOccupiedWithinOneWeekO
0x8114DurationOccupiedWithinOneDayO
0x4FE2OccupancyStayTimeO
0x8134OccupiedToUnoccupiedDelayO
0x8135UnoccupiedToOccupiedDelayO

OccupancySensorType Trait(存在传感类型)​

指定占用传感器类型(如 PIR、超声波、雷达、视觉等)。

Trait IDCode
0x80E9OccupancySensorType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOccupancySensorTypeEnum80RVM
0x0006Supported Valuelist[OccupancySensorTypeEnum8]RO

Occupancy Trait(存在状态)​

该 Trait 用于「存在状态」相关数据的访问与上报。

Trait IDCode
0x80E8Occupancy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM

OccupancySensingEnable Trait(人体感应使能)​

启用或禁用移动检测的总开关。

Trait IDCode
0x5029OccupancySensingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

RegionDimension Trait(区域尺寸)​

定义客户端(如 App)可用于区域配置(如检测区域、隐私遮罩)的完整画布尺寸。其值为包含三个字段的结构体: unit(enum8):width 和 height 的单位,例如 GRID(网格单元)、PIXEL(像素)。 width(uint32):指定单位下的区域总宽度。 height(uint32):指定单位下的区域总高度。

Trait IDCode
0x502DRegionDimension
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRegionDimensionTraitPresentValueStructureRVO

BitmaskRegionSetting Trait(侦测区域设置)​

基于网格掩码定义区域配置。包含两个字段:detect_region(十六进制字符串)和 effective_bits(整数)。十六进制字符串中的每一位对应一个网格单元(例如将画面划分为 24 个单元)。位值为 1 表示对应单元启用检测或识别功能,0 表示禁用。位的排列遵循预定义顺序(例如从左到右或从最高位到最低位)。effective_bits 字段指定十六进制字符串中实际有效的位数,使字符串可保持固定长度而仅前 N 位有意义。例如 "FF" 表示连续 8 位均为 1。若 effective_bits 为 32,则全部 32 位有效;若为 24,则仅前 24 位有效。该表示方式常用于运动检测、人形检测等需要在视频帧上灵活选择特定区域的功能。

Trait IDCode
0x4FCCBitmaskRegionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBitmaskRegionSettingTraitPresentValueStructureRVWO
0x0007Default ValueBitmaskRegionSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"ffffffffffffffffffffffffffffffffffff"}RWO

RecordEnable Trait(录像使能)​

启用或禁用人脸识别时的本地录像。

Trait IDCode
0x4FB6RecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

PushEnable Trait(推送使能)​

控制特定功能(如检测事件、识别事件)触发时是否向用户发送推送通知。值为布尔类型:true(启用)表示事件发生时发送推送通知;false(禁用)表示即使事件发生也不发送通知。

Trait IDCode
0x4FB5PushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

TimePeriodSetting Trait(时段设置)​

定义时间段和工作日的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FB3TimePeriodSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimePeriodSettingTraitPresentValueStructureRVWO
0x0007Default ValueTimePeriodSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

HoldTime Trait(无人判定延时)​

无人判定延时,单位:S。

Trait IDCode
0x4E72HoldTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0007Default Valueuint161RWO

DurationOccupiedWithinOneWeek Trait(当周占用时长)​

表示 occupancy 传感器在一周内(从周一 00:00:00 起算的自然周)检测到被占用的总时长,单位为毫秒。

Trait IDCode
0x8115DurationOccupiedWithinOneWeek
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat6.048E8RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO

DurationOccupiedWithinOneDay Trait(当日占用时长)​

表示 occupancy 传感器在一天内检测到被占用的总时长,单位为毫秒。

Trait IDCode
0x8114DurationOccupiedWithinOneDay
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat8.64E7RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO

OccupancyStayTime Trait(人体感应逗留时长)​

人员在检测区域内停留多少秒后才触发"徘徊"事件。用于过滤短暂移动。

Trait IDCode
0x4FE2OccupancyStayTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint83RVWO
0x0002Maximum Valueuint830RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO
0x0007Default Valueuint83RWO

OccupiedToUnoccupiedDelay Trait(变为非占用延时)​

该 Trait 用于「变为非占用延时」相关数据的访问与上报。单位:S。

Trait IDCode
0x8134OccupiedToUnoccupiedDelay
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat4.294967295E9RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

UnoccupiedToOccupiedDelay Trait(变为占用延时)​

该 Trait 用于「变为占用延时」相关数据的访问与上报。单位:S。

Trait IDCode
0x8135UnoccupiedToOccupiedDelay
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat4.294967295E9RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

Location(位置)​

简介​

提供设备或目标的位置信息上报与查询能力。

Function 标识​

Function IDCode名称
0x00A1Location位置

Trait​

Trait IDCode名称Conformance
0x80EAMotionDetected移动方向侦测M

Command​

本 Function 不包含 Command。

数据类型​

MotionDetectedEnum8 Type​

该枚举定义 MotionDetected Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Enter进入
0x01Left离开
0x02LeftIn左进
0x03RightOut右出
0x04RightIn右进
0x05LeftOut左出
0x06Access接近
0x07Away远离

Trait 定义​

Trait IDNameConformance
0x80EAMotionDetectedM

MotionDetected Trait(移动方向侦测)​

该 Trait 用于「移动侦测」相关数据的访问与上报。

Trait IDCode
0x80EAMotionDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMotionDetectedEnum80VM
0x0006Supported Valuelist[MotionDetectedEnum8]RO

Command 定义​

本 Function 不包含 Command。

Knob(旋钮)​

简介​

描述旋钮类输入设备的旋转角度、按压及组合动作事件。

Function 标识​

Function IDCode名称
0x00A2Knob旋钮

Trait​

Trait IDCode名称Conformance
0x80EBRotationAngle旋转角度M
0x80EDRotationEvent旋转事件O
0x4E28InvertedRotationAngle倒置旋转角度O
0x4E25HoldRotationInterval按住旋转间隔时长O
0x4E24RotationInterval旋转间隔时长O
0x8167HoldRotationAngle按住旋转角度O
0x80ECRotationDirection旋转方向O
0x50B6RotationSamplingInterval旋转采样间隔O

Command​

本 Function 不包含 Command。

数据类型​

RotationEventEnum8 Type​

该枚举定义 RotationEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Rotate旋转
0x01HoldToRotate按住旋转
0x02InvertedRotate反面旋转
RotationDirectionEnum8 Type​

该枚举定义 RotationDirection Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ClockwiseClockwise
0x01CounterClockwiseCounterClockwise

Trait 定义​

Trait IDNameConformance
0x80EBRotationAngleM
0x80EDRotationEventO
0x4E28InvertedRotationAngleO
0x4E25HoldRotationIntervalO
0x4E24RotationIntervalO
0x8167HoldRotationAngleO
0x80ECRotationDirectionO
0x50B6RotationSamplingIntervalO

RotationAngle Trait(旋转角度)​

该 Trait 用于「旋转角度」相关数据的访问与上报。

Trait IDCode
0x80EBRotationAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0VM
0x0002Maximum Valuefloat3600.0RO
0x0003Minimum Valuefloat-3600.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

RotationEvent Trait(旋转事件)​

描述旋钮事件类型:Rotate、Hold to rotate 或 Inverted rotate。取值:0 = Rotate,1 = Hold to rotate,2 = Inverted Rotate。

Trait IDCode
0x80EDRotationEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRotationEventEnum80VO
0x0006Supported Valuelist[RotationEventEnum8]RO

InvertedRotationAngle Trait(倒置旋转角度)​

倒置旋转的角度

Trait IDCode
0x4E28InvertedRotationAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0VO
0x0002Maximum Valuefloat3600.0RO
0x0003Minimum Valuefloat-3600.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

HoldRotationInterval Trait(按住旋转间隔时长)​

某个按住旋转事件对应的旋转所用时长,即旋转间隔时长,单位:ms。

Trait IDCode
0x4E25HoldRotationInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161VO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO

RotationInterval Trait(旋转间隔时长)​

某个旋转事件对应的旋转所用时长,即旋转间隔时长,单位:ms。

Trait IDCode
0x4E24RotationInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161VO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO

HoldRotationAngle Trait(按住旋转角度)​

该 Trait 用于「按住旋转角度」相关数据的访问与上报。

Trait IDCode
0x8167HoldRotationAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0VO
0x0002Maximum Valuefloat3600.0RO
0x0003Minimum Valuefloat-3600.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

RotationDirection Trait(旋转方向)​

描述旋转方向。取值:0 = Clockwise(顺时针),1 = Counterclockwise(逆时针)。

Trait IDCode
0x80ECRotationDirection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRotationDirectionEnum80VO
0x0006Supported Valuelist[RotationDirectionEnum8]RO

RotationSamplingInterval Trait(旋转采样间隔)​

应指示采样角度变化所需的最短时间。单位为毫秒。

Trait IDCode
0x50B6RotationSamplingInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16100RVO
0x0002Maximum Valueuint16500RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO

Command 定义​

本 Function 不包含 Command。

Cube(魔方)​

简介​

描述魔方控制器的手势识别,包括翻转、旋转、摇一摇等动作及面识别。

Function 标识​

Function IDCode名称
0x00A3Cube魔方

Trait​

Trait IDCode名称Conformance
0x80EECubeEvent魔方事件M
0x4F0DCubeWorkModeSetting魔方工作模式设置O
0x4EC5TopFace当前的顶面O
0x4EC6TopFaceChanged顶面翻转O
0x50BBStationaryDuration静止时长O
0x50B9TapCount敲击次数O

Command​

本 Function 不包含 Command。

数据类型​

CubeEventEnum8 Type​

该枚举定义 CubeEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Flip90翻转90 deg
0x01Flip180翻转180 deg
0x02Push轻推
0x03TapTwice拿起敲两下
0x04Shake摇一摇
0x05Swing甩一下
0x06Rotate旋转
0x07TriggeredAfter1Minute静止后触动
0x0APickUpHold拿起保持
CubeWorkModeSettingEnum8 Type​

该枚举定义 CubeWorkModeSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Action Mode动作模式
0x01Scene Mode场景模式
TopFaceEnum8 Type​

该枚举定义 TopFace Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Face 1 Up第1面朝上
0x01Face 2 Up第2面朝上
0x02Face 3 Up第3面朝上
0x03Face 4 Up第4面朝上
0x04Face 5 Up第5面朝上
0x05Face 6 Up第6面朝上
TopFaceChangedEnum8 Type​

该枚举定义 TopFaceChanged Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Face 1 Up第1面朝上
0x01Face 2 Up第2面朝上
0x02Face 3 Up第3面朝上
0x03Face 4 Up第4面朝上
0x04Face 5 Up第5面朝上
0x05Face 6 Up第6面朝上

Trait 定义​

Trait IDNameConformance
0x80EECubeEventM
0x4F0DCubeWorkModeSettingO
0x4EC5TopFaceO
0x4EC6TopFaceChangedO
0x50BBStationaryDurationO
0x50B9TapCountO

CubeEvent Trait(魔方事件)​

该 Trait 用于「魔方事件」相关数据的访问与上报。

Trait IDCode
0x80EECubeEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCubeEventEnum80VM
0x0006Supported Valuelist[CubeEventEnum8]RO

CubeWorkModeSetting Trait(魔方工作模式设置)​

启用 Magic Cube 设备多种操作模式设置,增强体验与交互。

Trait IDCode
0x4F0DCubeWorkModeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCubeWorkModeSettingEnum80RVWO
0x0006Supported Valuelist[CubeWorkModeSettingEnum8]RO
0x0007Default Valueuint80RWO

TopFace Trait(当前的顶面)​

指示魔方控制器当前朝上的面,用于定义设备状态。

Trait IDCode
0x4EC5TopFace
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTopFaceEnum80RVO
0x0006Supported Valuelist[TopFaceEnum8]RO

TopFaceChanged Trait(顶面翻转)​

表示设备"朝上面"已变更。用户翻转设备(如魔方控制器)时触发。

Trait IDCode
0x4EC6TopFaceChanged
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTopFaceChangedEnum80VO
0x0006Supported Valuelist[TopFaceChangedEnum8]RO

StationaryDuration Trait(静止时长)​

应指示检测到移动之前所达到的静止时长阈值,单位为分钟。

Trait IDCode
0x50BBStationaryDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81VO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint81RO

TapCount Trait(敲击次数)​

应指示点击次数

Trait IDCode
0x50B9TapCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint83VO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO

Command 定义​

本 Function 不包含 Command。

Vibration(动静)​

简介​

检测振动或动静变化,上报移动、倾斜、跌落等事件。

Function 标识​

Function IDCode名称
0x00A4Vibration动静

Trait​

Trait IDCode名称Conformance
0x80EFVibrationEvent动静贴事件M
0x4F99ObjectOrientationEnable对象姿态检测使能O
0x4F98ObjectOrientationState对象姿态方向状态O
0x4F97EventReportInterval事件上报间隔O
0x4F96ObjectMotionDetectionEnable物品移动检测使能O
0x4F95StationaryTiltAngle静止倾斜角度O
0x4F94PeakTiltAngle峰值倾斜角度O
0x4F93TiltAngleDeviation倾斜偏移角度O
0x4F92InitialTiltAngle倾斜初始角度O
0x4F8CStationaryState静止状态监测O
0x503BVibrationDuration震动持续时长O
0x503AVibrationDurThreshold震动持续监测时长阈值O
0x5039ObjectMotionDuration物品移动持续时长O
0x5038ObjectMotionDurThreshold物品移动持续监测时长阈值O
0x5194FreeFallEnable跌落检测使能O
0x5195VibrationEnable震动检测使能O
0x5197ThreeKnocksEnable敲三下检测使能O

Command​

本 Function 不包含 Command。

数据类型​

VibrationEventEnum8 Type​

该枚举定义 VibrationEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ThreeKnocks三击
0x01Move移动
0x02Vibrate震动
0x03Tilt倾斜
0x04FreeFall跌落
ObjectOrientationStateEnum8 Type​

该枚举定义 ObjectOrientationState Trait 的 Present Value 有效取值。

ValueNameDescription
0x01HorizontalUp水平朝上
0x02HorizontalDown水平朝下
0x03Vertical垂直
0x04Tilted倾斜
StationaryStateEnum8 Type​

该枚举定义 StationaryState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00InMotion运动中
0x01Stationary静止

Trait 定义​

Trait IDNameConformance
0x80EFVibrationEventM
0x4F99ObjectOrientationEnableO
0x4F98ObjectOrientationStateO
0x4F97EventReportIntervalO
0x4F96ObjectMotionDetectionEnableO
0x4F95StationaryTiltAngleO
0x4F94PeakTiltAngleO
0x4F93TiltAngleDeviationO
0x4F92InitialTiltAngleO
0x4F8CStationaryStateO
0x503BVibrationDurationO
0x503AVibrationDurThresholdO
0x5039ObjectMotionDurationO
0x5038ObjectMotionDurThresholdO
0x5194FreeFallEnableO
0x5195VibrationEnableO
0x5197ThreeKnocksEnableO

VibrationEvent Trait(动静贴事件)​

该 Trait 用于「动静贴事件」相关数据的访问与上报。

Trait IDCode
0x80EFVibrationEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVibrationEventEnum80VM
0x0006Supported Valuelist[VibrationEventEnum8]RO

FreeFallEnable Trait(跌落检测使能)​

启用或禁用跌落检测功能。设为 True 时,设备检测并上报跌落事件;设为 False 时禁用跌落检测。

Trait IDCode
0x5194FreeFallEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

VibrationEnable Trait(震动检测使能)​

启用或禁用震动检测功能。设为 True 时,设备检测并上报震动事件;设为 False 时禁用震动检测。

Trait IDCode
0x5195VibrationEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ThreeKnocksEnable Trait(敲三下检测使能)​

启用或禁用敲三下检测功能。设为 True 时,设备检测并上报三击事件;设为 False 时禁用敲三下检测。

Trait IDCode
0x5197ThreeKnocksEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ObjectOrientationEnable Trait(对象姿态检测使能)​

启用或禁用物体朝向监测功能。设为 True 时,设备主动监测并上报物体朝向变化;设为 False 时禁用朝向监测。

Trait IDCode
0x4F99ObjectOrientationEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

ObjectOrientationState Trait(对象姿态方向状态)​

指示设备检测到的物体当前空间朝向。值为枚举,表示物体相对参考平面的姿态,可能状态如下: 1 - Horizontal Up(物体朝上,如平放在桌面正面朝上) 2 - Horizontal Down(物体朝下,如平放在桌面正面朝下) 3 - Vertical(物体竖直,如垂直于地面) 4 - Tilted(物体倾斜,不属于水平或竖直分类)

Trait IDCode
0x4F98ObjectOrientationState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueObjectOrientationStateEnum81RVO
0x0006Supported Valuelist[ObjectOrientationStateEnum8]RO

EventReportInterval Trait(事件上报间隔)​

指示设备连续事件上报之间的时间间隔,单位为秒。例如,值为 60 表示设备每 60 秒上报一次事件。该间隔决定设备向网关或云端发送事件数据的频率。

Trait IDCode
0x4F97EventReportInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint3260RVWO
0x0002Maximum Valueuint32300RO
0x0003Minimum Valueuint325RO
0x0005Step Valueuint321RO
0x0007Default Valueuint3260RWO

ObjectMotionDetectionEnable Trait(物品移动检测使能)​

启用或禁用物体移动检测功能。True 表示启用(将检测物体移动),False 表示禁用。

Trait IDCode
0x4F96ObjectMotionDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

StationaryTiltAngle Trait(静止倾斜角度)​

指示物体运动后静止时的倾斜角。单位: deg。

Trait IDCode
0x4F95StationaryTiltAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat180.0RO
0x0003Minimum Valuefloat-180.0RO
0x0005Step Valuefloat0.01RO

PeakTiltAngle Trait(峰值倾斜角度)​

指示从唤醒到静止期间记录的最大倾斜角。单位: deg。

Trait IDCode
0x4F94PeakTiltAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat180.0RO
0x0003Minimum Valuefloat-180.0RO
0x0005Step Valuefloat0.01RO

TiltAngleDeviation Trait(倾斜偏移角度)​

指示当前运动期间 Tilt 角度的实际变化量(偏移)。

Trait IDCode
0x4F93TiltAngleDeviation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat180.0RO
0x0003Minimum Valuefloat-180.0RO
0x0005Step Valuefloat0.01RO

InitialTiltAngle Trait(倾斜初始角度)​

指示设备校准期间建立的初始倾斜角,表示校准方向(例如朝上)与最近轴正方向之间的夹角。单位: deg。

Trait IDCode
0x4F92InitialTiltAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat180.0RO
0x0003Minimum Valuefloat-180.0RO
0x0005Step Valuefloat0.01RO

StationaryState Trait(静止状态监测)​

该特征的当前值应以枚举形式指示目标当前是否静止。取值 0 表示目标处于运动状态,取值 1 表示目标静止。

Trait IDCode
0x4F8CStationaryState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStationaryStateEnum81RVO
0x0006Supported Valuelist[StationaryStateEnum8]RO
0x0007Default Valueuint81RWO

VibrationDuration Trait(震动持续时长)​

上报设备检测到的振动实际持续时间(秒)。上报逻辑如下:当振动持续时间达到配置的"Vibration Duration"阈值时,立即上报等于该阈值的持续时间。若振动在超过阈值后仍持续,则不再发送持续时间上报,直至振动停止并上报"stationary event"(通常为持续时间 0 或单独状态)。新的振动事件开始时计时器重置并重新计数,达到阈值时再次上报。

Trait IDCode
0x503BVibrationDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint160RWO

VibrationDurThreshold Trait(震动持续监测时长阈值)​

设置设备持续监测振动事件的时长阈值(秒)。振动持续时间达到该设定值时,设备触发"Vibration Duration"事件上报。当前取值范围 0 至 3600 秒,默认 3600 秒。未来可能扩展至 18 小时。

Trait IDCode
0x503AVibrationDurThreshold
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint163600RVWO
0x0002Maximum Valueuint163600RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint163600RWO

ObjectMotionDuration Trait(物品移动持续时长)​

上报设备检测到的移动实际持续时间(秒)。上报逻辑与振动类似:当移动持续时间达到配置的"Object Motion Duration"阈值时,立即上报等于该阈值的持续时间。若移动在超过阈值后仍持续,则不再发送持续时间上报,直至移动停止并上报"stationary event"。新的移动事件开始时计时器重置并重新计数,达到阈值时再次上报。

Trait IDCode
0x5039ObjectMotionDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint160RWO

ObjectMotionDurThreshold Trait(物品移动持续监测时长阈值)​

设置设备持续监测移动事件的时长阈值(秒)。移动持续时间达到该设定值时,设备触发"Motion Duration"事件上报。当前取值范围 0 至 3600 秒,默认 3600 秒。未来可能扩展至 18 小时。

Trait IDCode
0x5038ObjectMotionDurThreshold
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint163600RVWO
0x0002Maximum Valueuint163600RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint163600RWO

Command 定义​

本 Function 不包含 Command。

Modes(模式)​

简介​

提供设备多模式管理能力,支持切换和读取当前运行模式。

Function 标识​

Function IDCode名称
0x00A5Modes模式

Trait​

Trait IDCode名称Conformance
0x8168ModeCount模式数量M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x8168ModeCountM

ModeCount Trait(模式数量)​

描述设备支持的模式数量。格式:int。

Trait IDCode
0x8168ModeCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint320RVM
0x0002Maximum Valueint322147483647RO
0x0003Minimum Valueint320RO
0x0005Step Valueuint321RO

Command 定义​

本 Function 不包含 Command。

PetFeeder(宠物喂食)​

简介​

提供宠物喂食控制能力,包括出粮份数、喂食计划及余量状态。

Function 标识​

Function IDCode名称
0x00A6PetFeeder宠物喂食

Trait​

Trait IDCode名称Conformance
0x80F6Feed喂食M

Command​

本 Function 不包含 Command。

数据类型​

FeedEnum8 Type​

该枚举定义 Feed Trait 的 Present Value 有效取值。

ValueNameDescription
0x01RemoteFeeding喂养

Trait 定义​

Trait IDNameConformance
0x80F6FeedM

Feed Trait(喂食)​

该 Trait 用于「喂食」相关数据的访问与上报。

Trait IDCode
0x80F6Feed
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFeedEnum81RVM
0x0006Supported Valuelist[FeedEnum8]RO

Command 定义​

本 Function 不包含 Command。

BridgeConfiguration(桥配置)​

简介​

管理网关桥接配置,描述子设备接入、桥接能力及网络拓扑相关信息。

Function 标识​

Function IDCode名称
0x00A7BridgeConfiguration桥配置

Trait​

Trait IDCode名称Conformance
0x80FABridgedNodeList桥节点列表M
0x4F55SupportedHubCapability支持的中枢网关能力集M
0x516BMatterBridgeCapabilityMatter 桥接能力O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x80FABridgedNodeListM
0x4F55SupportedHubCapabilityM
0x516BMatterBridgeCapabilityO

BridgedNodeList Trait(桥节点列表)​

表示添加到此 Bridge Node 的桥接节点 Device ID 列表。字符串数组。

Trait IDCode
0x80FABridgedNodeList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

SupportedHubCapability Trait(支持的中枢网关能力集)​

该属性以位掩码形式上报网关作为智能家居中枢所具备的核心功能特性。每一位代表一项特定能力(如本地自动化、数据存储、AI 支持)。上层应用据此发现并适配设备高级功能,实现差异化体验。 bit 0:支持网关基础功能(支持创建网关集群等) bit 1:具备本地自动化模块 ha_driven bit 2:支持网关本地数据存储功能 NAS bit 3:支持 SAAS bit 4:支持本地 AI bit 5:支持局域网 APP 控制 bit 6:支持运行 Aqara Studio bit 7:支持桥接摄像头设备 bit 8:支持 Aqara Studio 逻辑功能块 bit 9 至 31:保留

Trait IDCode
0x4F55SupportedHubCapability
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVM
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

MatterBridgeCapability Trait(Matter 桥接能力)​

该 Trait 用于标识设备在 Matter 桥接场景下的能力角色。采用位掩码(Bitmap)形式,每个 Bit 表示一种特定的桥接或可桥接能力。

Trait IDCode
0x516BMatterBridgeCapability
位定义​
位 (Bit)名称含义描述 (中文)
0BridgeSubDevices支持将子设备桥接到 Matter 网络(作为通用 Bridge)。
1BridgeCameraDevices支持将具备 Camera 功能的子设备桥接到 Matter 网络。
2CameraBridgeable设备自身具备 Camera 功能,并且可被具有 Bit1 能力的设备桥接。
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

Command 定义​

本 Function 不包含 Command。

AttitudeDetection(姿态检测)​

简介​

检测设备姿态或倾斜角度变化,上报姿态异常或角度信息。

Function 标识​

Function IDCode名称
0x00A8AttitudeDetection姿态检测

Trait​

Trait IDCode名称Conformance
0x80FBAttitudeDetected姿态检测M

Command​

本 Function 不包含 Command。

数据类型​

AttitudeDetectedEnum8 Type​

该枚举定义 AttitudeDetected Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01FallDown跌倒
0x02SuspectedFall疑似跌倒

Trait 定义​

Trait IDNameConformance
0x80FBAttitudeDetectedM

AttitudeDetected Trait(姿态检测)​

该 Trait 用于「姿态检测」相关数据的访问与上报。

Trait IDCode
0x80FBAttitudeDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAttitudeDetectedEnum80RVM
0x0006Supported Valuelist[AttitudeDetectedEnum8]RO

Command 定义​

本 Function 不包含 Command。

Group(组配置)​

简介​

管理设备分组配置,维护组内节点列表及组级控制能力。

Function 标识​

Function IDCode名称
0x00A9Group组配置

Trait​

Trait IDCode名称Conformance
0x80FCNodeList节点列表M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x80FCNodeListM

NodeList Trait(节点列表)​

该 Trait 用于「节点列表」相关数据的访问与上报。

Trait IDCode
0x80FCNodeList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

Command 定义​

本 Function 不包含 Command。

Doorbell(门铃)​

简介​

提供门铃相关能力,包括呼叫事件上报及与室内铃铛/中继的联动。

Function 标识​

Function IDCode名称
0x00AADoorbell门铃

Trait​

Trait IDCode名称Conformance
0x80A0ButtonEvent按钮事件M
0x80C0Volume音量O
0x50E1DoorbellRepeaterConnectionStatus门铃中继器连接状态O
0x517FDoorbellCallRecvEnable接收门铃呼叫使能O
0x5184DoorbellRingCount门铃铃声响铃次数O
0x518COutdoorBellVolume室外门铃音量O

Command​

Command IDCode名称Conformance
0x9D75TriggerDoorbellWake唤醒门铃M

数据类型​

ButtonEventEnum8 Type​

该枚举定义 ButtonEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x00SinglePress单击
0x01DoublePress双击
0x02LongPress长按
0x03LongPressRelease长按释放
DoorbellRepeaterConnectionStatusEnum8 Type​

该枚举定义 DoorbellRepeaterConnectionStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Disconnected断连
0x01Connected正常
DoorbellRingCountEnum8 Type​

该枚举定义 DoorbellRingCount Trait 的 Present Value 有效取值。

ValueNameDescription
0x01RingOnce1 次
0x02RingTwice2 次
TriggerDoorbellWake Command Structure Type​

TriggerDoorbellWake Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Wakeuint32M唤醒;默认值为 1。

Trait 定义​

Trait IDNameConformance
0x80A0ButtonEventM
0x80C0VolumeO
0x50E1DoorbellRepeaterConnectionStatusO
0x517FDoorbellCallRecvEnableO
0x5184DoorbellRingCountO
0x518COutdoorBellVolumeO

ButtonEvent Trait(按钮事件)​

该 Trait 用于「按钮事件」相关数据的访问与上报。

Trait IDCode
0x80A0ButtonEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueButtonEventEnum80VM
0x0006Supported Valuelist[ButtonEventEnum8]RO

Volume Trait(音量)​

指示或设置摄像头设备扬声器音量(如双向语音)。值通常为百分比(0 至 100)或设备定义的数值范围。

Trait IDCode
0x80C0Volume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

DoorbellRepeaterConnectionStatus Trait(门铃中继器连接状态)​

表示门铃与中继器(如室内叮咚)之间的连接状态。

Trait IDCode
0x50E1DoorbellRepeaterConnectionStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorbellRepeaterConnectionStatusEnum80RVO
0x0006Supported Valuelist[DoorbellRepeaterConnectionStatusEnum8]RO
0x0007Default Valueuint80RWO

DoorbellCallRecvEnable Trait(接收门铃呼叫使能)​

接收门铃呼叫使能。开启后,当有人按门铃时,App 会显示通话页面。0 = 关闭,1 = 打开。

Trait IDCode
0x517FDoorbellCallRecvEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

DoorbellRingCount Trait(门铃铃声响铃次数)​

门铃铃声响铃次数。1 = 1 次,2 = 2 次。

Trait IDCode
0x5184DoorbellRingCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDoorbellRingCountEnum82RVWO
0x0002Maximum ValueDoorbellRingCountEnum82RO
0x0003Minimum ValueDoorbellRingCountEnum81RO
0x0006Supported Valuelist[DoorbellRingCountEnum8]RO
0x0007Default Valueuint82RWO

OutdoorBellVolume Trait(室外门铃音量)​

室外门铃音量。表示室外门铃的音量大小,取值范围为 0-100(百分比)。该 Trait 可读、可写、可上报,用于调节和获取室外门铃的当前音量。

Trait IDCode
0x518COutdoorBellVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

Command 定义​

Command IDNameConformance
0x9D75TriggerDoorbellWakeM

TriggerDoorbellWake Command​

该命令唤醒门铃设备以提高流媒体或响应速度。应向该命令写入值 1 以唤醒设备。

参数​

TriggerDoorbellWake Command Structure

NetworkCommissioning(网络配网)​

简介​

提供网络配网能力,支持 Wi-Fi、Thread、Zigbee、Ethernet、BLE Endpoint 与 Wi-Fi Endpoint 的扫描、连接与配置。Magic Pair 入网流程见 ref_MagicPairNetworkCommissioning。

Function 标识​

Function IDCode名称
0x00ABNetworkCommissioning网络配网

Trait​

Trait IDCodeConformance
0x8103SupportedNetworkM
0x4F54MagicPairKeychainO
0x4ECDSlaveAddressO
0x4ECCAuthenticationStatusO
0x4E97WiFiRSSIO
0x4E96WiFiChannelO
0x4E95ZigbeeAuthRandcodeResponseO
0x4E94ZigbeeAuthRandcodeO
0x4E73HomeStationCredentialsO
0x8106ZigbeeDiagnosticsO
0x8105ThreadDiagnosticsO
0x8104WiFiDiagnosticsO
0x811FEthernetDiagnosticsO
0x8121ZigbeeDeviceInformationO
0x8122LANStatusO
0x8145RegistrationInformationO
0x815ATimeSynchronizationO
0x8174LocalizationConfigurationO
0x4FA6ChildDeviceProvisioningStateO

Command​

Command IDCodeConformance
0x9DB3TriggerWifiRssiUpdateO
0x9D21TriggerZigbeeNetworkInfoUploadO
0x9C67ConnectToHomeStationResponseO
0x9C66ConnectToHomeStationO
0x9C54ConfigStaticIPAddrO
0x9D96ConfigureWiFiNetworkO
0x810EAddOrUpdateZigbeeNetworkResponseO
0x810DAddOrUpdateZigbeeNetworkO
0x810CAddOrUpdateThreadNetworkResponseO
0x810BAddOrUpdateThreadNetworkO
0x810AAddOrUpdateWiFiNetworkResponseO
0x8109AddOrUpdateWiFiNetworkO
0x8108ScanWiFiNetworksResponseO
0x8107ScanWiFiNetworksO
0x88BAVerifyDeviceAuthenticityO
0x88BBVerifyDeviceAuthenticityResponseO
0x9D72SetZigbeeChannelO
0x9D73SetThreadChannelO

数据类型​

AuthenticationStatusEnum8 Type​

该枚举定义 AuthenticationStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NotAuthenticated未认证
0x01CertifiedAndValid已认证且合法
0x02NoCertificate没证书
0x03CertificateInvalid有证书但不合法
HomeStationCredentialsTraitPresentValueStructure Type​

该结构体定义 HomeStationCredentials Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0SSIDcharacterStringM家庭基站 SSID。
1CredentialscharacterStringM家庭基站连接凭证。
ZigbeeDiagnosticsTraitPresentValueStructure Type​

该结构体定义 ZigbeeDiagnostics Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Channeluint8MZigbee radio channel。
1ExtendedPANIDuint64MZigbee extended PAN identifier。
2NetworkKeyoctetStringMZigbee network key。
3NetworkNamecharacterStringMZigbee network name。
4PANIDuint16MZigbee PAN identifier。
5RSSIint8ORSSI for the Zigbee network client in dBm。
6LQIuint8OLink quality indicator。
ThreadDiagnosticsTraitPresentValueStructure Type​

该结构体定义 ThreadDiagnostics Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Channeluint8MThe Thread network radio channel。
1ExtendedPANIDuint64MThe Thread network extended PAN identifier。
2NetworkKeyoctetStringMThe Thread network key。
3NetworkNamecharacterStringMThe Thread network name。
4PANIDuint16MThe Thread network PAN identifier。
5PSKcoctetStringMThe Thread network pre-shared key for the Commissioner。
6ActiveTimeStampuint64MActive timestamp。
7SecurityPolicycharacterStringOSecurity policy。
8OperationalDatasetoctetStringMThread Network Parameters dataset。
9RSSIint8ORSSI for the Thread network client in dBm。
10LQIuint8OLink quality indicator。
11BorderAgentIDoctetStringMIdentifier of an active Thread network Border Agent。
12MeshLocalPrefixcharacterStringOPrefix of all interfaces reachable within the same Thread network。
13CommissionerCredentialcharacterStringOUTF-8 Commissioner Credential, 6 to 255 characters。
14VersioncharacterStringOOpenThread Version。
15Roleuint8OThread Role bit mask。
16BorderExtAgentIDcharacterStringMThread Border Agent ID。
WiFiDiagnosticsTraitPresentValueStructure Type​

该结构体定义 WiFiDiagnostics Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0BSSIDcharacterStringMThe Wi-Fi BSSID。
1Encryptionuint8O0: No Encryption;1: WEP;2: WPA;3: WPA/WPA2;4: WPA2;5: WPA3。
2Versionuint8OThe Wi-Fi Version:0:a,1:b,2:g,3:n,4:ac,5:ax。
3Channeluint8MThe Wi-Fi network Channel。
4RSSIint8MRSSI for the WiFi network client in dBm。
5NetworkNamecharacterStringMThe Wi-Fi network name。
6IPV4AddresscharacterStringOIPV4 Address。
7IPV6AddresscharacterStringOIPV6 Address。
8SubnetMaskcharacterStringOSubnet mask。
9GatewaycharacterStringOGateway address。
10DNScharacterStringODNS server。
11AlternateDNScharacterStringOBackup DNS server。
EthernetDiagnosticsTraitPresentValueStructure Type​
结构体成员序号字段名类型必须说明
0IsReadybooleanM网线是否已插入
ZigbeeDeviceInformationTraitPresentValueStructure Type​
结构体成员序号字段名类型必须说明
0Macuint64M设备的64位Zigbee IEEE MAC地址
1InstallCodecharacterStringOInstall Code(安装码);Magic Pair 阶段必选,其他场景可选
2FirmwareVersionuint32O设备固件版本号
3HardwareVersionuint32O设备硬件版本号
4ManufacturerCodeuint16OZigbee 厂商编码
5ModelcharacterStringO设备型号
6ShortAddruint16O设备在Zigbee网络的短地址
7ZigbeeVersionuint8OZigbee 协议版本
8DeviceTypeuint8OZigbee 设备类型
9ExtendedXCodeuint16O扩展 X 码;具体含义依产品 Profile 定义
10LastResetTypeuint8O0 无效;1 恢复出厂设置;2 网络重置
RegistrationInformationTraitPresentValueStructure Type​
结构体成员序号字段名类型必须说明
0EncryptionTypeuint8M0 Tuple;1 Certificate
1ProtocolPrefixuint8MCloud ID 前缀枚举,见 Trait 定义
2UniqueIdoctetStringM64-bit Unique ID
3MacoctetStringCTuple 模式必须
4TokenoctetStringCCertificate 模式
5CloudIdcharacterStringO
6LastResetTypeuint8O
TimeSynchronizationTraitPresentValueStructure Type​
结构体成员序号字段名类型必须说明
0UTCTimeuint32MUnix Epoch 秒
1TimeZoneOffsetint32M相对 UTC 的秒偏移
2TimeZoneNamecharacterStringOIANA 时区名
LocalizationConfigurationTraitPresentValueStructure Type​
结构体成员序号字段名类型必须说明
0VoiceLanguagecharacterStringOBCP 47
1ScreenLanguagecharacterStringOBCP 47
2TemperatureUnituint8O0 摄氏;1 华氏
3CountryCodecharacterStringOISO 3166-1 alpha-2
ScanWiFiNetworksResponse Command Structure Type​
结构体成员序号字段名类型必须说明
0SSIDcharacterStringM
1RSSIint8M
2Encryptionuint8M
3BSSIDcharacterStringO
4Channeluint16O
5WiFiBanduint8O0 2.4 GHz;1 3.6 GHz;2 5 GHz;3 6 GHz;4 60 GHz
ChildDeviceProvisioningStateEnum8 Type​

该枚举定义 ChildDeviceProvisioningState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NotProvisioning未处于配网状态
0x01Provisioning处于配网状态
TriggerWifiRssiUpdateActionEnum8 Type​

该枚举定义 TriggerWifiRssiUpdate Command 的 Action 字段有效取值。

ValueNameDescription
0x01Update更新
TriggerWifiRssiUpdate Command Structure Type​

TriggerWifiRssiUpdate Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ActionTriggerWifiRssiUpdateActionEnum8M执行动作,取值为 0x01(Update),表示立即更新并上报当前 Wi-Fi RSSI。
TriggerZigbeeNetworkInfoUpload Command Structure Type​

TriggerZigbeeNetworkInfoUpload Command 的参数结构体。

结构体成员序号字段名类型必须说明
0InstallCodecharacterStringM安装代码。
1MACcharacterStringMMAC地址。
ConnectToHomeStationResponse Command Structure Type​

ConnectToHomeStationResponse Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ConnectToHomeStationResponseenum8M连接家庭基站反馈。
ConnectToHomeStation Command Structure Type​

ConnectToHomeStation Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SSIDcharacterStringMSSID。
1CredentialscharacterStringM凭证。
2Typeuint8M0 全功能 Home Station;1 受限功能 Home Station
3RelayKeycharacterStringMHome Station 生成的中继凭证,最大 64 字节
4RelayPortuint16M中继端口,取值由 Home Station 提供
5CloudIdOfStationcharacterStringMHome Station 的 Cloud ID
6AlivePortuint16O保活端口
7CountryDomaincharacterStringO最大 64 字节
8BindkeycharacterStringO最大 64 字节
9TimeZonecharacterStringO最大 32 字节
10CountryCodecharacterStringOISO 3166-1 alpha-2
ConfigStaticIPAddr Command Structure Type​

ConfigStaticIPAddr Command 的参数结构体。

结构体成员序号字段名类型必须说明
0IPAddresscharacterStringOIP 地址,字符串(最大长度 32)。示例:192.168.1.100。
1SubnetMaskcharacterStringO子网掩码,字符串(最大长度 32)。示例:255.255.255.0。
2DefaultGatewaycharacterStringO默认网关,字符串(最大长度 32)。示例:192.168.1.1。
3PrimaryDNScharacterStringO首选 DNS,字符串(最大长度 32)。示例:8.8.8.8。
4SecondaryDNScharacterStringO备选 DNS,字符串(最大长度 32)。示例:8.8.4.4。
5InterfaceNamecharacterStringO接口名称,字符串(最大长度 32)。示例:eth0。为空时表示应用于所有网络接口。
6AddressingModeenum8O地址分配模式。0 表示切换为 DHCP 获取 IP(此时 IPAddress、SubnetMask、PrimaryDNS、DefaultGateway、SecondaryDNS 参数会被忽略);1 表示静态 IP 模式(可配置上述网络参数)。若该字段不存在,默认按静态 IP 模式处理。
ConfigureWiFiNetwork Command Structure Type​

ConfigureWiFiNetwork Command 的参数结构体。

结构体成员序号字段名类型必须说明
0InterfaceNamecharacterStringM网络接口名称,用于指定在哪个网络接口上执行配网(应与设备系统内接口标识一致)。示例:wlan0(2.4G Wi-Fi STA)、wlan1(5G Wi-Fi STA)。
1SSIDcharacterStringM目标 Wi-Fi 网络名称(区分大小写,建议与 AP 实际广播名称完全一致)。示例:Home_2.4G、Office-WiFi。
2CredentialscharacterStringM目标 Wi-Fi 网络接入密码(明文传输内容应满足设备安全策略)。示例:Home@2026!、MyHome#12345。
AddOrUpdateZigbeeNetworkResponse Command Structure Type​

AddOrUpdateZigbeeNetworkResponse Command 的参数结构体。

结构体成员序号字段名类型必须说明
0StatusCodesuint8M
AddOrUpdateZigbeeNetwork Command Structure Type​

AddOrUpdateZigbeeNetwork Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Channeluint8M
1ExtendedPANIDoctetStringM
2NetworkKeyoctetStringM
3NetworkNamecharacterStringO
4PANIDuint16M
5NetworkKeySequenceNumberuint8MZigbee Network Key Sequence Number
6TrustCenterAddresscharacterStringMTrust Center 地址
AddOrUpdateThreadNetworkResponse Command Structure Type​

AddOrUpdateThreadNetworkResponse Command 的参数结构体。

结构体成员序号字段名类型必须说明
0StatusCodesuint8M
AddOrUpdateThreadNetwork Command Structure Type​

AddOrUpdateThreadNetwork Command 的参数结构体。

结构体成员序号字段名类型必须说明
0OperationalDatasetoctetStringO完整 Thread Operational Dataset。省略或 Null 表示由设备创建新网络
AddOrUpdateWiFiNetworkResponse Command Structure Type​

AddOrUpdateWiFiNetworkResponse Command 的参数结构体。

结构体成员序号字段名类型必须说明
0StatusCodesuint8M
AddOrUpdateWiFiNetwork Command Structure Type​

AddOrUpdateWiFiNetwork Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SSIDcharacterStringO
1CredentialscharacterStringO
2Encryptionuint8O
3CountryDomaincharacterStringO
4BindkeycharacterStringO
5TimeZonecharacterStringO
6CountryCodecharacterStringOISO 3166-1 alpha-2
7Ecosystemuint8O0 Aqara AIoT;1 Aqara Studio
8ServerPortuint16O云端监听端口
VerifyDeviceAuthenticity Command Structure Type​

VerifyDeviceAuthenticity Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Cmduint8M0 SendRandomCode;1 GetCertificateFile;2 ValidationPassed;3 ValidationFailed;4 WriteCloudId;5 Registered;6 RegisterFailed;7 SendSelfSignedCertificate;8 RefreshToken;9 WriteUserId;10 SendRandomCodeOfCertificate
1ParamscharacterStringO随 Cmd 变化:随机数、证书、Cloud ID、Token 或 UserID;不得当作固定 schema
VerifyDeviceAuthenticityResponse Command Structure Type​

VerifyDeviceAuthenticityResponse Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Cmduint8M
1ParamscharacterStringO
SetZigbeeChannel Command Structure Type​

SetZigbeeChannel Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Channeluint8M信道;默认值为 11。
SetThreadChannel Command Structure Type​

SetThreadChannel Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Channeluint8M信道;默认值为 11。

Trait 定义​

Trait IDNameConformance
0x8103SupportedNetworkM
0x4F54MagicPairKeychainO
0x4ECDSlaveAddressO
0x4ECCAuthenticationStatusO
0x4E97WiFiRSSIO
0x4E96WiFiChannelO
0x4E95ZigbeeAuthRandcodeResponseO
0x4E94ZigbeeAuthRandcodeO
0x4E73HomeStationCredentialsO
0x8106ZigbeeDiagnosticsO
0x8105ThreadDiagnosticsO
0x8104WiFiDiagnosticsO
0x811FEthernetDiagnosticsO
0x8121ZigbeeDeviceInformationO
0x8122LANStatusO
0x8145RegistrationInformationO
0x815ATimeSynchronizationO
0x8174LocalizationConfigurationO
0x4FA6ChildDeviceProvisioningStateO

SupportedNetwork Trait​

指示设备入网(MagicPair)所支持的网络协议。值为位掩码:bit0=Wi‑Fi,bit1=Thread,bit2=Ethernet,bit3=Zigbee,bit4=BLE,bit5=BLE Endpoint,bit6=Wi‑Fi Endpoint,bit7=Limited Home Station 的 Wi‑Fi Endpoint,bit8=Aqara RS485。不包含用于配对的 BLE。

Trait IDCode
0x8103SupportedNetwork
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RM
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

MagicPairKeychain Trait​

用于 MagicPair 网络配网密钥链。

Trait IDCode
0x4F54MagicPairKeychain
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

SlaveAddress Trait​

总线上为设备作为从机分配的地址,用于主从通信寻址。

Trait IDCode
0x4ECDSlaveAddress
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint8O255RVWO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO
0x0007Default Valueuint8O255RWO

AuthenticationStatus Trait​

指示设备认证状态,反映是否已通过认证及证书是否有效。

Trait IDCode
0x4ECCAuthenticationStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAuthenticationStatusEnum8O0RVO
0x0006Supported Valuelist[AuthenticationStatusEnum8]RO
0x0007Default Valueuint8O0RWO

WiFiRSSI Trait​

测量Wi-Fi连接信号强度的指标,以dBm为单位,范围从-100 dBm (非常弱)到0 dBm (最强)。

Trait IDCode
0x4E97WiFiRSSI
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint80RVO
0x0002Maximum Valueint80RO
0x0003Minimum Valueint8-100RO
0x0005Step Valueuint321RO

WiFiChannel Trait​

Wi-Fi 信道,如 2.4GHz 频段信道 1-14 或 5GHz 频段信道 149、153、157、161、165 等。

Trait IDCode
0x4E96WiFiChannel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVO
0x0002Maximum Valueuint16165RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO

ZigbeeAuthRandcodeResponse Trait​

Zigbee 3.0 设备与云端认证时返回的 Confirm 结果。

Trait IDCode
0x4E95ZigbeeAuthRandcodeResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringVO

ZigbeeAuthRandcode Trait​

Zigbee 3.0 设备连接云端进行认证时,由云端下发的随机数。

Trait IDCode
0x4E94ZigbeeAuthRandcode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringWO

HomeStationCredentials Trait​

Home Station Credentials信息

Trait IDCode
0x4E73HomeStationCredentials
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHomeStationCredentialsTraitPresentValueStructureRVO

ZigbeeDiagnostics Trait​

提供 Zigbee 网络的诊断信息。包括无线电信道、extended PAN ID、network name、PAN ID、RSSI(如可用)及 LQI。NetworkKey 属于 commissioning-secret:Magic Pair 安全会话中 MAY 用于入网;CoIP 普通 Read/Report SHALL NOT 回读该字段,见 ref_MagicPairModelMapping。

Trait IDCode
0x8106ZigbeeDiagnostics
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueZigbeeDiagnosticsTraitPresentValueStructureRVO

ThreadDiagnostics Trait​

提供 Thread 网络的诊断信息。包括信道、extended PAN ID、network name、PAN ID、active timestamp、security policy、RSSI、LQI、border agent ID、mesh local prefix、OpenThread 版本及角色。NetworkKey、PSKc、OperationalDataset 与 commissioner credential 属于 commissioning-secret:Magic Pair 安全会话中 MAY 用于入网;CoIP 普通 Read/Report SHALL NOT 回读这些字段。

Trait IDCode
0x8105ThreadDiagnostics
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueThreadDiagnosticsTraitPresentValueStructureRVO

WiFiDiagnostics Trait​

提供 Wi‑Fi 网络的诊断信息。包括 BSSID、加密类型、Wi‑Fi 版本、信道、RSSI、网络名称、IPv4 地址、IPv6 地址、子网掩码、网关、DNS 及备用 DNS(字段因可用性而异)。

Trait IDCode
0x8104WiFiDiagnostics
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWiFiDiagnosticsTraitPresentValueStructureRVO

EthernetDiagnostics Trait​

以太网口是否已插入网线。

Trait IDCode
0x811FEthernetDiagnostics
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueEthernetDiagnosticsTraitPresentValueStructureRVO

ZigbeeDeviceInformation Trait​

Zigbee 设备身份与安装信息。InstallCode 属于 commissioning-secret,SHALL NOT 经普通诊断接口回读。

Trait IDCode
0x8121ZigbeeDeviceInformation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueZigbeeDeviceInformationTraitPresentValueStructureRVO

LANStatus Trait​

设备局域网连接状态。0 未连接;1 已连接。

Trait IDCode
0x8122LANStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO

RegistrationInformation Trait​

Magic Pair Version 20 起用于云端注册。ProtocolPrefix:0 lumi;1 lumi1;2 lumi2;3 O;4 aqara;5 matt;6 lumi3;7 lumi4。

Trait IDCode
0x8145RegistrationInformation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRegistrationInformationTraitPresentValueStructureRVO

TimeSynchronization Trait​

App 在入网前段向设备写入 UTC 时间与时区,供证书有效期校验。

Trait IDCode
0x815ATimeSynchronization
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimeSynchronizationTraitPresentValueStructureRWO

LocalizationConfiguration Trait​

语音/界面语言、温度单位与国家码。国家码可用于无线合规限制。

Trait IDCode
0x8174LocalizationConfiguration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLocalizationConfigurationTraitPresentValueStructureRWO

ChildDeviceProvisioningState Trait​

供网关上报子设备(如 Zigbee 设备、Matter 设备等)配网窗口状态。网关为某类子设备开放网络时上报"进入配网状态";关闭该类子设备配网窗口时上报"退出配网状态"。上层应用据此实时感知网关是否处于允许添加某类子设备的状态,以引导用户操作或显示配网进度。

Trait IDCode
0x4FA6ChildDeviceProvisioningState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueChildDeviceProvisioningStateEnum8O0RVO
0x0006Supported Valuelist[ChildDeviceProvisioningStateEnum8]RO
0x0007Default Valueuint8O0RWO

Command 定义​

Command IDNameConformance
0x9DB3TriggerWifiRssiUpdateO
0x9D21TriggerZigbeeNetworkInfoUploadO
0x9C67ConnectToHomeStationResponseO
0x9C66ConnectToHomeStationO
0x9C54ConfigStaticIPAddrO
0x9D96ConfigureWiFiNetworkO
0x810EAddOrUpdateZigbeeNetworkResponseO
0x810DAddOrUpdateZigbeeNetworkO
0x810CAddOrUpdateThreadNetworkResponseO
0x810BAddOrUpdateThreadNetworkO
0x810AAddOrUpdateWiFiNetworkResponseO
0x8109AddOrUpdateWiFiNetworkO
0x8108ScanWiFiNetworksResponseO
0x8107ScanWiFiNetworksO
0x88BAVerifyDeviceAuthenticityO
0x88BBVerifyDeviceAuthenticityResponseO
0x9D72SetZigbeeChannelO
0x9D73SetThreadChannelO

TriggerWifiRssiUpdate Command​

触发 Wi-Fi 信号强度更新。设备收到该命令且 Action 为 0x01(Update)时,应立即更新当前 Wi-Fi 信号强度(RSSI),并通过 WiFiRSSI Trait 的 Present Value 上报最新值,单位为 dBm。

在设备安装引导的信号测试页中,客户端或 App 可每隔几秒发送一次该命令,触发设备上报最新的 Wi-Fi RSSI,以便及时判断当前位置的信号是否良好。周期性发送由客户端或 App 控制,每次命令触发一次更新与上报。

参数​

TriggerWifiRssiUpdate Command Structure

TriggerZigbeeNetworkInfoUpload Command​

触发网关上报 Zigbee 网络信息以供后续操作,例如基于 Zigbee 网络信息启用 Zigbee 设备快速配对。

参数​

TriggerZigbeeNetworkInfoUpload Command Structure

ConnectToHomeStationResponse Command​

连接家庭基站反馈

参数​

ConnectToHomeStationResponse Command Structure

ConnectToHomeStation Command​

表示 WiFi Endpoint 连接到 Home Station 命令。

参数​

ConnectToHomeStation Command Structure

ConfigStaticIPAddr Command​

ConfigStaticIPAddr Command 表示配置设备网络地址信息。可选参数 AddressingMode:当取值为 0 时切换为 DHCP 获取 IP(忽略 IPAddress、SubnetMask、PrimaryDNS、DefaultGateway、SecondaryDNS);当取值为 1 时切换为静态 IP 模式并应用上述参数;若该字段不存在,默认采用静态 IP 模式。可选参数 InterfaceName(示例:eth0)用于指定目标接口;未传该参数时表示应用于所有网络接口。

参数​

ConfigStaticIPAddr Command Structure

ConfigureWiFiNetwork Command​

该命令用于在指定网络接口上配置并连接 Wi-Fi 网络。

参数​

ConfigureWiFiNetwork Command Structure

AddOrUpdateZigbeeNetworkResponse Command​

该 Command 用于执行「加入或者更新Zigbee网络反馈」操作。

参数​

AddOrUpdateZigbeeNetworkResponse Command Structure

AddOrUpdateZigbeeNetwork Command​

该 Command 用于执行「加入或者更新Zigbee网络命令」操作。

参数​

AddOrUpdateZigbeeNetwork Command Structure

AddOrUpdateThreadNetworkResponse Command​

该 Command 用于执行「加入或者更新Thread网络命令反馈」操作。

参数​

AddOrUpdateThreadNetworkResponse Command Structure

AddOrUpdateThreadNetwork Command​

该 Command 用于执行「加入或者更新Thread网络命令」操作。OperationalDataset 省略或为 Null 时,设备 SHALL 创建新 Thread 网络。

参数​

AddOrUpdateThreadNetwork Command Structure

AddOrUpdateWiFiNetworkResponse Command​

该 Command 用于执行「加入或者更新WiFi网络命令反馈」操作。

参数​

AddOrUpdateWiFiNetworkResponse Command Structure

AddOrUpdateWiFiNetwork Command​

该 Command 用于执行「加入或者更新WiFi网络命令」操作。

参数​

AddOrUpdateWiFiNetwork Command Structure

ScanWiFiNetworksResponse Command​

该 Command 用于返回附近 Wi-Fi 热点列表。payload 为 ScanWiFiNetworksResponse Command Structure 数组。

参数​

ScanWiFiNetworksResponse Command Structure

ScanWiFiNetworks Command​

该 Command 用于执行「扫描WiFi网络命令」操作。

该 Command 无参数。

VerifyDeviceAuthenticity Command​

该 Command 用于执行「校验设备合法性」操作。Cmd 取值:0 SendRandomCode;1 GetCertificateFile;2 ValidationPassed;3 ValidationFailed;4 WriteCloudId;5 Registered;6 RegisterFailed;7 SendSelfSignedCertificate;8 RefreshToken;9 WriteUserId;10 SendRandomCodeOfCertificate。流程见 ref_MagicPairNetworkCommissioning。

参数​

VerifyDeviceAuthenticity Command Structure

VerifyDeviceAuthenticityResponse Command​

该 Command 用于执行「校验设备合法性响应」操作。

参数​

VerifyDeviceAuthenticityResponse Command Structure

SetZigbeeChannel Command​

该命令更改设备(如网关或协调器)上的 Zigbee 通信信道。信道值通常为 11 至 26(2.4 GHz 频段)。执行后,设备可能需要重启 Zigbee 协议栈或进行网络重配置。

参数​

SetZigbeeChannel Command Structure

SetThreadChannel Command​

该命令更改设备上的 Thread 通信信道。信道值通常为 11 至 26(2.4 GHz 频段)。执行后,设备可能需要重启 Thread 协议栈或进行网络重配置。

参数​

SetThreadChannel Command Structure

EcosystemInformation(生态平台信息)​

简介​

描述设备所接入的生态平台信息,如 HomeKit、Matter Fabric 等绑定状态。

Function 标识​

Function IDCode名称
0x00ACEcosystemInformation生态平台信息

Trait​

Trait IDCode名称Conformance
0x810FSupportedEcosystem支持的生态系统M
0x8113MatterPayloadMatter配对码数据O
0x8112HomeKitPayloadHomeKit配对码数据O
0x8111MagicPairPayloadMagicPair配对码数据O
0x8110BoundEcosystem已绑定的生态系统O
0x50C4StudioStatusSyncStudio状态同步O

Command​

Command IDCode名称Conformance
0x88B8SysControl执行系统指令O
0x9D5EEnterHomeKitPairingMode进入HomeKit入网模式O

数据类型​

MatterPayloadTraitPresentValueStructure Type​

该结构体定义 MatterPayload Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0QRCodecharacterStringM配对二维码原始字符串数据。
1DigitalPairingCodecharacterStringM11 或 21 位数字配对码。
HomeKitPayloadTraitPresentValueStructure Type​

该结构体定义 HomeKitPayload Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0QRCodecharacterStringM配对二维码原始字符串数据。
1DigitalPairingCodecharacterStringM8 位数字配对码。
MagicPairPayloadTraitPresentValueStructure Type​

该结构体定义 MagicPairPayload Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0QRCodecharacterStringM配对二维码原始字符串数据。
1DigitalPairingCodecharacterStringM8 位数字配对码。
StudioStatusSyncTraitPresentValueStructure Type​

该结构体定义 StudioStatusSync Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Statusenum8MStudio 当前关键状态枚举值,用于标识同步事件(如首次登录)。
SysControl Command Structure Type​

SysControl Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Cmduint8MCmd。
1ParamscharacterStringOParams。
EnterHomeKitPairingMode Command Structure Type​

EnterHomeKitPairingMode Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Actionenum8M动作;默认值为 1。

Trait 定义​

Trait IDNameConformance
0x810FSupportedEcosystemM
0x8113MatterPayloadO
0x8112HomeKitPayloadO
0x8111MagicPairPayloadO
0x8110BoundEcosystemO
0x50C4StudioStatusSyncO

SupportedEcosystem Trait(支持的生态系统)​

指示设备支持的生态(如 Aqara Hub M3 支持 Aqara Home、Apple HomeKit 和 Matter)。值为位掩码:bit0 = Aqara Home,bit1 = Apple HomeKit,bit2 = Matter,bit3 = Aqara Studio,bit4-7 保留。

Trait IDCode
0x810FSupportedEcosystem
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RM
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

MatterPayload Trait(Matter配对码数据)​

提供 Matter 配网所需的配对信息。值为结构体,包含:QRCode(配对二维码原始字符串)和 DigitalPairingCode(11 位或 21 位数字配对码)。设备未绑定时,读取该载荷可能激活 Matter 配网窗口一段时间(默认 10 分钟)。

Trait IDCode
0x8113MatterPayload
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMatterPayloadTraitPresentValueStructureRVO

HomeKitPayload Trait(HomeKit配对码数据)​

提供 HomeKit 配网所需的配对信息。值为结构体,包含:QRCode(配对二维码原始字符串)和 DigitalPairingCode(8 位数字配对码)。设备未绑定时,读取该载荷可能激活 HomeKit 配网窗口一段时间(默认 10 分钟)。

Trait IDCode
0x8112HomeKitPayload
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHomeKitPayloadTraitPresentValueStructureRVO

MagicPairPayload Trait(MagicPair配对码数据)​

提供 MagicPair 入网所需的配对信息。值为结构体,包含:QRCode(配对二维码原始字符串)和 DigitalPairingCode(8 位数字配对码)。设备未绑定时,读取该载荷可能激活 MagicPair 配网窗口一段时间(默认 10 分钟)。

Trait IDCode
0x8111MagicPairPayload
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMagicPairPayloadTraitPresentValueStructureRVO

BoundEcosystem Trait(已绑定的生态系统)​

指示设备已绑定的生态。值为位掩码:bit0 = Aqara Home,bit1 = Apple HomeKit,bit2 = Matter,bit3 = Aqara Studio,bit4-7 保留(应为 0)。例如值 0x03 表示同时绑定 Aqara Home 和 HomeKit。

Trait IDCode
0x8110BoundEcosystem
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

StudioStatusSync Trait(Studio状态同步)​

Studio 向其他端点(网关、设备、云端等)通知其当前关键状态。该结构体包含单一状态枚举值,用于标识特定同步事件(如首次登录)。

Trait IDCode
0x50C4StudioStatusSync
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStudioStatusSyncTraitPresentValueStructureRVWO

Command 定义​

Command IDNameConformance
0x88B8SysControlO
0x9D5EEnterHomeKitPairingModeO

SysControl Command​

该 Command 用于执行系统控制操作。Cmd 取值:

Cmd名称说明
0FactoryReset擦除所有本地用户与网络数据
1Reset不删除数据的软重置
2Restart重启
3RemoveHomeKitPairing移除 HomeKit 绑定并上报更新后的 BoundEcosystem
4RemoveMatterPairing移除全部 Matter Fabric
5OpenHomeKitCommissioningWindow打开 HomeKit 窗口,默认 10 分钟
6OpenMatterCommissioningWindow打开 Matter 窗口,默认 10 分钟
7RemoveSelectedMatterPairing移除 Params 中指定 Vendor ID 的 Fabric
8WriteAqaraUserId写入 Aqara 账户 User ID;Params 为字符串,最长 128 字节。BLE Endpoint 入网写入 UserID 使用 VerifyDeviceAuthenticity Cmd 9,不是本 Cmd

Params 仅在 Cmd 需要附加数据时出现,不得收窄为与 Cmd 无关的固定字符串。恢复出厂、解绑与协议切换的密钥清除规则见 ref_MagicPairSecurity 与 ref_MagicPairStateMachine。

参数​

SysControl Command Structure

EnterHomeKitPairingMode Command​

该命令指示设备进入 HomeKit 配对模式,以便被发现并与 Apple HomeKit 配对。action 设为 ENTER 时,设备开始作为 HomeKit 配件广播并响应配对请求。命令包含 action 枚举字段:NO_ACTION(0)无操作,ENTER(1)触发设备进入 HomeKit 配对模式。

参数​

EnterHomeKitPairingMode Command Structure

MatterCommissioning(Matter入网)​

简介​

提供 Matter 入网与 Fabric 管理能力,包括配网窗口、Fabric 列表及节点标识。二码合一设备的 Discriminator、Passcode 与 Vendor ID SHALL 与本 Function 及 Matter QR 保持一致;Product ID 在单固件二码合一设备上相同,在双固件二码合一设备上不同,见 ref_MatterMagicPairUnifiedTypes。打开窗口的默认超时为 10 分钟,也可由 SysControl Cmd 6 触发。

Function 标识​

Function IDCode名称
0x00ADMatterCommissioningMatter入网

Trait​

Trait IDCode名称Conformance
0x8142MatterNodeIdMatter节点IDM
0x8124MatterCommissioningWindowStatusMatter配对窗口状态M
0x8123ConnectedMatterFabrics已连接的Matter生态M
0x4FA0MatterFabricsOperationMatter生态操作M

Command​

Command IDCode名称Conformance
0x88BCRemoveMatterFabric将Matter设备从指定Fabric移除M
0x88B9OpenMatterCommissioningWindow开启Matter设备配网窗口M

数据类型​

ConnectedMatterFabricsTraitPresentValueStructure Type​

该结构体定义 ConnectedMatterFabrics Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0VendorIDuint16MMatter Vendor ID。
1FabricIDuint64MFabric ID。
2ManufacturerLabelcharacterStringOManufacturer Label。
3NodeIDuint64MNode ID。
MatterFabricsOperationTraitPresentValueStructure Type​

该结构体定义 MatterFabricsOperation Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Fabric IDuint32MFabric ID。
1Vendor IDuint32MVendor ID。
RemoveMatterFabric Command Structure Type​

RemoveMatterFabric Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Fabric IDuint32M域ID。
1Vendor IDuint32M厂商ID。
OpenMatterCommissioningWindow Command Structure Type​

OpenMatterCommissioningWindow Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Commissioning Timeoutuint16M配对时间。
1PAKE Passcode VerifiercharacterStringM密码校验器。
2Discriminatoruint16M区分标志性。
3Iterationsuint32M迭代。
4SaltcharacterStringM盐值。

Trait 定义​

Trait IDNameConformance
0x8142MatterNodeIdM
0x8124MatterCommissioningWindowStatusM
0x8123ConnectedMatterFabricsM
0x4FA0MatterFabricsOperationM

MatterNodeId Trait(Matter节点ID)​

表示 Matter 设备 ID。格式:Uint64。

Trait IDCode
0x8142MatterNodeId
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVM
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint321RO

MatterCommissioningWindowStatus Trait(Matter配对窗口状态)​

表示 Matter 设备配网窗口的当前状态。值:0 = WindowNotOpen,1 = EnhancedWindowOpen,2 = BasicWindowOpen。

Trait IDCode
0x8124MatterCommissioningWindowStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVM
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

ConnectedMatterFabrics Trait(已连接的Matter生态)​

表示已连接的 Matter 生态系统列表。每个 fabric 包含 Vendor ID、Fabric ID、Manufacturer Label、Node ID。

Trait IDCode
0x8123ConnectedMatterFabrics
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[ConnectedMatterFabricsTraitPresentValueStructure]RVM

MatterFabricsOperation Trait(Matter生态操作)​

该 Trait 用于「Matter生态操作」相关数据的访问与上报。

Trait IDCode
0x4FA0MatterFabricsOperation
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[MatterFabricsOperationTraitPresentValueStructure]RVM

Command 定义​

Command IDNameConformance
0x88BCRemoveMatterFabricM
0x88B9OpenMatterCommissioningWindowM

RemoveMatterFabric Command​

该 Command 用于执行「将Matter设备从指定Fabric移除」操作。

参数​

RemoveMatterFabric Command Structure

OpenMatterCommissioningWindow Command​

该 Command 用于执行「开启Matter设备配网窗口」操作。

参数​

OpenMatterCommissioningWindow Command Structure

IndicationLight(指示灯)​

简介​

管理设备指示灯行为,包括状态指示、亮度、颜色及闪烁模式等。

Function 标识​

Function IDCode名称
0x00AEIndicationLight指示灯

Trait​

Trait IDCode名称Conformance
0x4F33ChildEndpointList子节点列表O
0x4EA0EnableInvertIndicationLight指示灯反转使能配置O
0x511BEnableMotionDetectionIndicatorLight移动侦测指示灯使能配置O
0x8139DNDTimePeriod勿扰时间段O
0x8138EnableDNDMode勿扰模式使能O
0x8137IndicationLightSetting指示灯触发设置O

Command​

Command IDCode名称Conformance
0x9D87EnableQuietMode打开勿扰模式O
0x9D88DisableQuietMode关闭勿扰模式O

数据类型​

DNDTimePeriodTraitPresentValueStructure Type​

该结构体定义 DNDTimePeriod Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0BeginTimecharacterStringM免打扰模式开始时间,crontab 格式,默认值为 0 21 *。
1EndTimecharacterStringM免打扰模式结束时间,crontab 格式,默认值为 0 9 *;若早于 BeginTime,表示次日时间。
IndicationLightSettingEnum8 Type​

该枚举定义 IndicationLightSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NeverUse从不使用
0x01Use使用

Trait 定义​

Trait IDNameConformance
0x4F33ChildEndpointListO
0x4EA0EnableInvertIndicationLightO
0x511BEnableMotionDetectionIndicatorLightO
0x8139DNDTimePeriodO
0x8138EnableDNDModeO
0x8137IndicationLightSettingO

ChildEndpointList Trait(子节点列表)​

该属性应上报设备已配置分区中当前分配的子端点。

Trait IDCode
0x4F33ChildEndpointList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

EnableInvertIndicationLight Trait(指示灯反转使能配置)​

该配置启用或禁用指示灯状态的反转功能,对应 Aqara Indicator Light Configuration Cluster 的 EnableIndicationLightInversion 属性。

Trait IDCode
0x4EA0EnableInvertIndicationLight
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableMotionDetectionIndicatorLight Trait(移动侦测指示灯使能配置)​

写入时开启或关闭运动检测指示灯显示。读取表示当前开关状态。取值:false = 关闭,true = 开启。

Trait IDCode
0x511BEnableMotionDetectionIndicatorLight
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

DNDTimePeriod Trait(勿扰时间段)​

定义免打扰时段。其值为包含两个可选字段 begin_time 和 end_time 的结构体,均以 crontab 格式表示。crontab 格式遵循"分 时 日 月 星期"模式(例如 "0 22 * * *" 表示每天 22:00)。

Trait IDCode
0x8139DNDTimePeriod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDNDTimePeriodTraitPresentValueStructureRVWO

EnableDNDMode Trait(勿扰模式使能)​

写入时启用或禁用指示灯勿扰(DND)模式。DND 模式下,指示灯在特定时段可能不闪烁或保持熄灭以避免打扰。取值:false = 关闭 DND(正常运行),true = 开启 DND。

Trait IDCode
0x8138EnableDNDMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

IndicationLightSetting Trait(指示灯触发设置)​

配置指示灯的使用方式。值: 0 =从不使用(指示灯从不激活) , 1 =使用(指示灯正常激活) , 2 =切换(每次写入此值时,切换当前状态,例如从打开到关闭或关闭到打开)。读取返回当前设置模式。

Trait IDCode
0x8137IndicationLightSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueIndicationLightSettingEnum81RVWO
0x0006Supported Valuelist[IndicationLightSettingEnum8]RO
0x0007Default Valueuint81RWO

Command 定义​

Command IDNameConformance
0x9D87EnableQuietModeO
0x9D88DisableQuietModeO

EnableQuietMode Command​

该 Command 用于执行「启用静默模式」操作。

该 Command 无参数。

DisableQuietMode Command​

该 Command 用于执行「禁用静默模式」操作。

该 Command 无参数。

SwitchConfiguration(开关配置)​

简介​

提供墙壁开关配置能力,包括接线方式、按键模式、防闪烁、强控开关与线路端子配置。

Function 标识​

Function IDCode名称
0x011ASwitchConfiguration开关配置

Trait​

Trait IDCode名称Conformance
0x4F33ChildEndpointList子节点列表O
0x510DEnableRelayLock继电器锁定O
0x510EWireConfiguration接线配置O
0x510FButtonMode开关模式O
0x5198DeviceAssociationTarget设备关联目标O
0x5172QuickDoubleControlDevice快捷双控目标设备O
0x5110EnableAntiFlicker开启防闪烁O
0x5111EnableSwitchForcedControl开关强制控制O
0x5114LineTerminal接线终端O

Command​

本 Function 不包含 Command。

数据类型​

WireConfigurationEnum8 Type​

该枚举定义 WireConfiguration Trait 的 Present Value 有效取值。

ValueNameDescription
0x00WithNeutral带零线
0x01WithoutNeutral无零线
ButtonModeEnum8 Type​

该枚举定义 ButtonMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unspecified未配置任何按键模式。
0x01DualMode按下物理按键时,同时控制继电器与 执行无线开关触发的自动化。
0x02StandardMode按下物理按键时,仅控制继电器。
0x03WirelessMode按下物理按键时,仅执行 无线开关触发的自动化。
0x04DeviceAssociationMode按下物理按键时,控制已关联设备。
0x05SceneAssociationMode按下物理按键时,触发关联场景执行。
0x06QuickDoubleControlMode按下物理按键时,切换关联开关继电器。
0x07MarsTechMode按下物理按键时,按火星技术方式控制负载设备。
LineTerminalEnum8 Type​

该枚举定义 LineTerminal Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unspecified未指定
0x01L1L1
0x02L2L2
0x03L3L3
QuickDoubleControlDeviceTraitPresentValueStructure Type​

该结构体定义 QuickDoubleControlDevice Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0DeviceIdcharacterStringM目标设备 DID。
1PointPathcharacterStringM数据点访问路径,包含 Endpoint ID、Function ID、Trait ID、Parameter ID,用 . 分隔,例如 2.132.32920.1。
2SubscribeRecordIduint32M设备已保存的快捷双控功能所需的数据订阅记录 ID。
DeviceAssociationTargetTraitPresentValueStructure Type​

该结构体定义 DeviceAssociationTarget Trait 的 Present Value 列表中单个关联目标设备的字段布局。

结构体成员序号字段名类型必须说明
0DeviceIdcharacterStringM目标设备 DID。
1PointPathcharacterStringM目标设备的数据点访问路径,包含 Endpoint ID、Function ID、Trait ID、Parameter ID,用 . 分隔。
2SubscribeRecordIduint32M目标设备关联的数据订阅记录 ID。
3GroupIduint16M用于群组控制的群组 ID;非零时可向该群组发送开关命令。

Trait 定义​

Trait IDNameConformance
0x4F33ChildEndpointListO
0x510DEnableRelayLockO
0x510EWireConfigurationO
0x510FButtonModeO
0x5198DeviceAssociationTargetO
0x5172QuickDoubleControlDeviceO
0x5110EnableAntiFlickerO
0x5111EnableSwitchForcedControlO
0x5114LineTerminalO

ChildEndpointList Trait(子节点列表)​

该属性应上报设备已配置分区中当前分配的子端点。

Trait IDCode
0x4F33ChildEndpointList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

EnableRelayLock Trait(继电器锁定)​

该 Trait 用于「继电器锁定」相关数据的访问与上报。

Trait IDCode
0x510DEnableRelayLock
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanRVWO
0x0007Default Valueboolean0RWO

WireConfiguration Trait(接线配置)​

该 Trait 用于「接线方式」相关数据的访问与上报。

Trait IDCode
0x510EWireConfiguration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWireConfigurationEnum80RVWO

ButtonMode Trait(开关模式)​

该 Trait 用于「按键模式」相关数据的访问与上报。

Trait IDCode
0x510FButtonMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueButtonModeEnum8RVWO
0x0006Supported Valuelist[ButtonModeEnum8]RO
0x0007Default ValueButtonModeEnum80RWO

DeviceAssociationTarget Trait(设备关联目标)​

该 Trait 用于配置当 ButtonMode 为 DeviceAssociationMode 时由物理按键控制的关联目标设备。按下物理按键时,应控制本 Trait 列表中的关联设备。

客户端应通过写入目标设备条目列表来配置本 Trait。

Trait IDCode
0x5198DeviceAssociationTarget
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[DeviceAssociationTargetTraitPresentValueStructure]RVWO

QuickDoubleControlDevice Trait(快捷双控目标设备)​

该 Trait 表示当本开关的 ButtonMode 设置为 QuickDoubleControl 时所使用的相关目标开关设备及其数据点。当 ButtonMode 设置为 QuickDoubleControl 时,本 Trait 有效。在此模式下,按下物理按钮应切换本 Trait 所标识设备的关联开关继电器。

客户端应通过写入目标设备条目来配置本 Trait。

Trait IDCode
0x5172QuickDoubleControlDevice
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueQuickDoubleControlDeviceTraitPresentValueStructureRVWO

EnableAntiFlicker Trait(开启防闪烁)​

该 Trait 用于「防闪烁开关」相关数据的访问与上报。

Trait IDCode
0x5110EnableAntiFlicker
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanRVWO
0x0007Default Valueboolean0RWO

EnableSwitchForcedControl Trait(开关强制控制)​

该 Trait 用于「强制控制开关」相关数据的访问与上报。

Trait IDCode
0x5111EnableSwitchForcedControl
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanRVWO
0x0007Default Valueboolean0RWO

LineTerminal Trait(接线终端)​

该 Trait 用于「线路端子」相关数据的访问与上报。

Trait IDCode
0x5114LineTerminal
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLineTerminalEnum80RVWO
0x0006Supported Valuelist[LineTerminalEnum8]RO
0x0007Default ValueLineTerminalEnum80RWO

Command 定义​

本 Function 不包含 Command。

GeneralConfiguration(通用配置)​

简介​

提供通用设备配置项,如灵敏度、延时、默认参数等设备级设置。

Function 标识​

Function IDCode名称
0x00AFGeneralConfiguration通用配置

Trait​

Trait IDCode名称Conformance
0x5080ChildLock童锁O
0x5009WiFiBandsWi-Fi 频段设置O
0x5002UsbDataCommunicationEnableUSB 数据通信使能O
0x4FF6LightSourceCategory光源类别O
0x4FECAiAgreement是否同意AI协议O
0x502ESoftSensorAlgorithm软传感器算法类型O
0x4FAFSoftSensorSourceConfig软传感器数据源配置O
0x4F9ADetectionModeSetting检测模式设置O
0x4F60BeepEnable提示音使能O
0x5163BuzzerVolume蜂鸣器音量O
0x4F5FEnergySavingEnable节能模式使能O
0x4F5ENightLightMode夜灯模式O
0x4F51HubArkTechEnable方舟技术使能(网关)O
0x4F49TimeZone时区O
0x4F0AActivityDetectionModeSetting活动监测模式设置O
0x4EF3VoiceLanguage语音播报语言O
0x4E85OutputInterlockFlag开关互锁使能配置标记O
0x4EAAResetMode恢复出厂重置方式O
0x5134LightingLinkageEnable灯光联动使能O
0x516CPublicCapObjReason公共能力对象存在原因M
0x5133DeviceControlFlags设备控制标志M
0x4E9APollingTime轮询时长O
0x519CKeepAliveInterval保活间隔O
0x4E98TransmissionPowerSetting设备发射功率设置O
0x4E83LightingModeSetting灯照明模式设置O
0x4E7EInstallationOrientationConfiguration安装方向配置O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x813BCurrentSensitivityLevel当前灵敏度等级O
0x813ANumberOfSensitivityLevelIsSupported支持的灵敏度级别数量O
0x5027DynamicCoverRefreshEnable动态刷新封面使能O
0x4E3EP2PCaptureEnabled是否支持P2P抓图O
0x5248P2PCaptureInterval首页卡片抓图时间间隔O
0x4E44P2PCaptureStatusP2P动态取图状态O
0x51EDVibrationIntensity震感强度O

Command​

Command IDCode名称Conformance
0x9D7CWakeupDevice唤醒设备O

数据类型​

P2PCaptureIntervalEnum8 Type​

该枚举定义 P2PCaptureInterval Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Auto自动
0x01Seconds1010 秒
0x02Seconds2020 秒
0x03Seconds3030 秒
0x04Minutes11 分钟
0x05Minutes22 分钟
0x06Minutes55 分钟
0x07Minutes1010 分钟
0x08Minutes3030 分钟
0x09Hours11 小时

SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高

WakeupDeviceActionEnum8 Type​

该枚举定义 WakeupDevice Command 的 action 字段有效取值。

ValueNameDescription
0x01Wakeup唤醒设备

WakeupDeviceSourceEnum8 Type​

该枚举定义 WakeupDevice Command 的 source 字段有效取值。

ValueNameDescription
0x00PPCS通过 PPCS 拉流唤醒
0x01WebRTC通过 WebRTC 拉流唤醒
0x02NetworkWrite通过写点值进行网络唤醒
0x03Recording录像唤醒

WakeupDevice Command Structure Type​

WakeupDevice Command 的参数结构体。Server 下发该 Command,用于将设备从睡眠或待机模式唤醒,适用于摄像机、传感器、门锁、控制面板等低功耗设备。Action 固定为 1,表示执行唤醒操作;Source 标识唤醒触发来源,便于设备进行统计、日志记录或差异化行为处理。

结构体成员序号字段名类型必须说明
0ActionWakeupDeviceActionEnum8M唤醒动作,固定为 0x01(Wakeup)。
1SourceWakeupDeviceSourceEnum8M唤醒来源:0x00 = PPCS,0x01 = WebRTC,0x02 = NetworkWrite,0x03 = Recording。

ChildLockEnum8 Type​

该枚举定义 ChildLock Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off关闭
0x01On打开

WiFiBandsEnum8 Type​

该枚举定义 WiFiBands Trait 的 Present Value 有效取值。

ValueNameDescription
0x002G42.4G
0x013G653.65G
0x025G5G
0x036G6G
0x0460G60G
0x051G1G
0xFFAuto自动

LightSourceCategoryEnum8 Type​

该枚举定义 LightSourceCategory Trait 的 Present Value 有效取值。

ValueNameDescription
0x00SoftFilmHardLightBoard软膜硬光源板
0x03RGBCWLightSourceRGBCW光源
0x04LightColorFourColorSource淡彩四色光源

SoftSensorAlgorithmEnum16 Type​

该枚举定义 SoftSensorAlgorithm Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Average取平均值
0x02Maximum取最大值
0x03Minimum取最小值

DetectionModeSettingEnum16 Type​

该枚举定义 DetectionModeSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unconfigured未配置
0x03DoorWindowState门窗状态检测
0x05ObjectOrientation物品姿态检测

NightLightModeEnum8 Type​

该枚举定义 NightLightMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off常关
0x01On常开
0x02Auto自动感应

BuzzerVolumeEnum8 Type​

该枚举定义 BuzzerVolume Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Mute静音
0x01Low低音量
0x02Medium中音量
0x03High高音量

ActivityDetectionModeSettingEnum32 Type​

该枚举定义 ActivityDetectionModeSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x01HumanPresence人体存在
0x03PersonnelLocation人员定位
0x05FallDetection跌倒侦测
0x08CeilingFallSingleTracking顶装跌倒和单人定位
0x09SleepMode睡眠
0x11GestureControl手势

VoiceLanguageEnum8 Type​

该枚举定义 VoiceLanguage Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Chinese中文
0x02English英文
0x03Cantonese粤语
0x04Spanish西班牙语
0x05Russian俄语
0x06Korean韩语
0x07PortugueseBR巴西语
0x08German德语
0x09French法语
0x0AItalian意大利语
0x0BJapanese日语
0x0CPolish波兰语
0x0DCzech捷克语
0x0ESlovak斯洛伐克语
0x0FTurkish土耳其语
0x10Hungarian匈牙利语
0x11Dutch荷兰语
0x12Greek希腊语
0x13Arabic阿拉伯语

ResetModeEnum8 Type​

该枚举定义 ResetMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x01FactoryReset恢复出厂
0x02NetworkReset只重置网络
0x03ConfigurationsReset只重置配置
0x04PSWReset只重置设备密码

LightingModeSettingEnum8 Type​

该枚举定义 LightingModeSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Level单色模式
0x01ColorTemp色温模式
0x02RGBRGB模式
0x03RGBW模式RGBW模式

InstallationOrientationConfigurationEnum16 Type​

该枚举定义 InstallationOrientationConfiguration Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Horizontal横向
0x01Vertical竖向

InstallationOrientationEnum8 Type​

该枚举定义 DoorLock Function 的 DeviceOrientation 结构体中 InstallationOrientation 成员的有效取值。

ValueNameDescription
0x00Horizontal横向
0x01Vertical竖向

DeviceControlFlagsBitmap32 Type​

该位图定义 DeviceControlFlags Trait 的 Present Value 各 bit 位有效含义。

ValueNameDescription
0x00000001DownloadImageDataDisabledBit0:值为 1 时禁止下载图像数据,值为 0 时允许正常下载。

PublicCapObjReasonEnum32 Type​

该枚举定义 PublicCapObjReason Trait 的 Present Value 有效取值,用于表示设备公共能力对象存在的原因。

ValueKey中文名称英文名称Description
0x00000000Unknown未知Unknown默认值,表示无特定原因或无法识别。
0x00000001BaseReplaceable底座可更换Base Replaceable设备支持底座可更换特性,需要该公共能力对象。

Trait 定义​

Trait IDNameConformance
0x5080ChildLockO
0x5009WiFiBandsO
0x5002UsbDataCommunicationEnableO
0x4FF6LightSourceCategoryO
0x4FECAiAgreementO
0x502ESoftSensorAlgorithmO
0x4FAFSoftSensorSourceConfigO
0x4F9ADetectionModeSettingO
0x4F60BeepEnableO
0x5163BuzzerVolumeO
0x4F5FEnergySavingEnableO
0x4F5ENightLightModeO
0x4F51HubArkTechEnableO
0x4F49TimeZoneO
0x4F0AActivityDetectionModeSettingO
0x4EF3VoiceLanguageO
0x4E85OutputInterlockFlagO
0x4EAAResetModeO
0x5134LightingLinkageEnableO
0x516CPublicCapObjReasonM
0x5133DeviceControlFlagsM
0x4E9APollingTimeO
0x519CKeepAliveIntervalO
0x4E98TransmissionPowerSettingO
0x4E83LightingModeSettingO
0x4E7EInstallationOrientationConfigurationO
0x4FB4SensitivityLevelEnumO
0x813BCurrentSensitivityLevelO
0x813ANumberOfSensitivityLevelIsSupportedO
0x5027DynamicCoverRefreshEnableO
0x4E3EP2PCaptureEnabledO
0x5248P2PCaptureIntervalO
0x4E44P2PCaptureStatusO
0x51EDVibrationIntensityO

P2PCaptureInterval Trait(首页卡片抓图时间间隔)​

首页卡片抓图时间间隔,由云端维护。启用 P2PCaptureEnabled 后可配置并生效。0 表示由云端自动决定抓图间隔,非零值按枚举指定的间隔执行。默认值为 0,可读、可写、可上报。

Trait IDCode
0x5248P2PCaptureInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueP2PCaptureIntervalEnum80RVWO
0x0006Supported Valuelist[P2PCaptureIntervalEnum8]RO
0x0007Default ValueP2PCaptureIntervalEnum80RWO

ChildLock Trait(童锁)​

指示设备物理按键或遥控功能是否锁定,以防止误操作。

Trait IDCode
0x5080ChildLock
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueChildLockEnum80RVWO
0x0006Supported Valuelist[ChildLockEnum8]R
0x0007Default ValueChildLockEnum80RWO

WiFiBands Trait(Wi-Fi 频段设置)​

用于设置设备通过 Wi-Fi 连接网络时使用的 Wi-Fi 频段。

Trait IDCode
0x5009WiFiBands
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWiFiBandsEnum8255RVWO
0x0006Supported Valuelist[WiFiBandsEnum8]R
0x0007Default Valueuint8255RW

UsbDataCommunicationEnable Trait(USB 数据通信使能)​

启用或禁用设备 USB 端口的数据通信功能。默认关闭,用户可开启以通过 USB 接口传输数据(如连接 PC 或外设)。

Trait IDCode
0x5002UsbDataCommunicationEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RW

LightSourceCategory Trait(光源类别)​

指示灯具内部使用的光源技术类别,如软膜硬光板、RGBCW 光源或光色四色光源。

Trait IDCode
0x4FF6LightSourceCategory
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLightSourceCategoryEnum80RVWO
0x0006Supported Valuelist[LightSourceCategoryEnum8]R
0x0007Default ValueLightSourceCategoryEnum80RWO

AiAgreement Trait(是否同意AI协议)​

是否接受 AI 协议。

Trait IDCode
0x4FECAiAgreement
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RW

SoftSensorAlgorithm Trait(软传感器算法类型)​

指定虚拟(软)传感器根据多个物理传感器测量值计算当前值所使用的聚合算法。支持三种基本算法:平均值(所有源传感器值的算术平均)、最大值(所有源传感器中的最高值)和最小值(所有源传感器中的最低值)。该配置决定软传感器当前值如何从底层多源数据计算得出,适用于需要将同类型多个传感器读数合并为代表性值的场景。

Trait IDCode
0x502ESoftSensorAlgorithm
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSoftSensorAlgorithmEnum161RVWO
0x0006Supported Valuelist[SoftSensorAlgorithmEnum16]R
0x0007Default Valueuint161RW

SoftSensorSourceConfig Trait(软传感器数据源配置)​

用于配置软传感器所依赖的物理设备及其属性列表。其值为 JSON 字符串,包含 hublist(涉及的网关列表)、temperature、humidity 等字段。每个字段列出对应网关下的子设备 DID 及其具体资源 ID(如属性的 "0.1.85")。也可包含可选 config 对象(如聚合算法 agg),但算法通常由独立的 SoftSensorAlgorithm 值定义。该配置定义软传感器的输入数据源,软传感器将基于这些源进行聚合计算。

Trait IDCode
0x4FAFSoftSensorSourceConfig
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

DetectionModeSetting Trait(检测模式设置)​

指示设备当前检测模式设置,决定设备将监测并上报的事件或状态类型。此为可配置参数,可在不同检测场景间切换。

Trait IDCode
0x4F9ADetectionModeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDetectionModeSettingEnum160RVWO
0x0006Supported Valuelist[DetectionModeSettingEnum16]R
0x0007Default Valueuint160RW

BeepEnable Trait(提示音使能)​

启用或禁用设备操作的声音反馈提示音。

Trait IDCode
0x4F60BeepEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnergySavingEnable Trait(节能模式使能)​

启用或禁用节能模式。启用后,座温、水温等维持最低水平以降低能耗。

Trait IDCode
0x4F5FEnergySavingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

NightLightMode Trait(夜灯模式)​

设置夜灯模式。Auto 模式下,设备根据环境光自动开关夜灯。

Trait IDCode
0x4F5ENightLightMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNightLightModeEnum80RVWO
0x0006Supported Valuelist[NightLightModeEnum8]R
0x0007Default ValueNightLightModeEnum80RWO

HubArkTechEnable Trait(方舟技术使能(网关))​

用于启用或禁用 Aqara Ark Technology 下代理网关的本地容灾能力。启用后,若网关故障或断电,且网关下部分 Zigbee 设备可充当代理网关,则由代理网关负责执行部分基础本地自动化、场景和设备组。

Trait IDCode
0x4F51HubArkTechEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RW

TimeZone Trait(时区)​

该属性用于设置并上报设备所在时区(如中国标准时间为 "GMT+8")。正确的时区配置确保设备系统时间、定时任务(如定时器)及日志时间戳与用户实际地理时间一致,是所有时间相关功能准确运行的基础。

Trait IDCode
0x4F49TimeZone
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

ActivityDetectionModeSetting Trait(活动监测模式设置)​

指定设备用于检测和识别特定活动或状态的当前工作模式,例如人体存在检测、跌倒检测、睡眠监测或手势识别。

Trait IDCode
0x4F0AActivityDetectionModeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueActivityDetectionModeSettingEnum321RVWO
0x0006Supported Valuelist[ActivityDetectionModeSettingEnum32]R
0x0007Default Valueuint321RW

VoiceLanguage Trait(语音播报语言)​

用于语音提示和语音反馈的语言。

Trait IDCode
0x4EF3VoiceLanguage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVoiceLanguageEnum81RVWO
0x0006Supported Valuelist[VoiceLanguageEnum8]R
0x0007Default Valueuint81RW

OutputInterlockFlag Trait(开关互锁使能配置标记)​

当两个属性的取值相同时,表示这两个属性对应的状态处于互锁关系。

Trait IDCode
0x4E85OutputInterlockFlag
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVWO
0x0002Maximum Valueuint8255R
0x0003Minimum Valueuint80R
0x0005Step Valueuint321R
0x0007Default Valueuint80RW

ResetMode Trait(恢复出厂重置方式)​

支持执行包括出厂重置、重置网络配置在内的操作。

Trait IDCode
0x4EAAResetMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueResetModeEnum81RVWO
0x0006Supported Valuelist[ResetModeEnum8]R
0x0007Default ValueResetModeEnum81RWO

LightingLinkageEnable Trait(灯光联动使能)​

灯光联动使能。用于控制主灯与副灯之间的联动行为。当使能开启(默认值)时,对主灯进行的开关、亮度、色温及颜色调节操作,将自动同步应用到所有副灯;当使能关闭时,副灯可独立调节,不受主灯控制影响。

Trait IDCode
0x5134LightingLinkageEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1R

DeviceControlFlags Trait(设备控制标志)​

使用位掩码(Bitmap)方式表达设备多个控制状态。每个 bit 位代表一种独立状态开关,上层应用可通过读取该值判断是否允许执行特定操作。

Trait IDCode
0x5133DeviceControlFlags
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDeviceControlFlagsBitmap320RVM
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

PublicCapObjReason Trait(公共能力对象存在原因)​

该 Trait 表示设备公共能力对象 DevicePublicCapabilities Object 存在的原因。用于描述设备为何需要具备某项公共能力对象。

例如: 当取值为 1 时, 表示设备因支持底座可更换特性而需要该公共能力对象。

Trait IDCode
0x516CPublicCapObjReason
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePublicCapObjReasonEnum320RVM

PollingTime Trait(轮询时长)​

设置设备与网络通信的轮询时间间隔。单位:ms。

Trait IDCode
0x4E9APollingTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVWO
0x0002Maximum Valueuint327200000R
0x0003Minimum Valueuint320R
0x0005Step Valueuint32250R
0x0007Default Valueuint320RW

KeepAliveInterval Trait(保活间隔)​

表示低功耗设备相邻两次保活指令的发送间隔。不同低功耗设备的唤醒能力不同,设备通过该 Trait 上报自身期望的保活指令发送间隔,供 APP 或云端调整保活指令的发送频率。单位:秒,取值范围 1~65535。该 Trait 为只读、可上报。默认值为 7。

Trait IDCode
0x519CKeepAliveInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint327RVO
0x0002Maximum Valueuint3265535RO
0x0003Minimum Valueuint321RO
0x0005Step Valueuint321RO
0x0007Default Valueuint327RWO

TransmissionPowerSetting Trait(设备发射功率设置)​

用于设置设备发射功率的专用特征。

Trait IDCode
0x4E98TransmissionPowerSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat10.0R
0x0003Minimum Valuefloat-32.0R
0x0005Step Valuefloat1.0R
0x0007Default Valuefloat0RWO

LightingModeSetting Trait(灯照明模式设置)​

定义灯具的工作模式。

LightingModeSetting trait 用于设置或查询照明设备的当前工作模式。该模式决定了设备所开放的控制能力范围,包括开关控制、亮度调节、色温调节以及颜色设置等功能的可用性。目前支持的模式有四种,分别为:单色模式(Level)、色温模式(ColorTemp)、RGB模式(RGB)和RGBW模式(RGBW模式)。不同模式下,设备对外提供的数据点和可执行操作有所区别。

具体来说,当灯设备处于单色模式时,其仅支持开关状态控制和亮度调节控制,不支持色温控制,也不支持任何颜色设置,这种模式适用于仅需调光功能的单色温灯具。当设备处于色温模式时,其在开关和亮度控制之外,额外支持色温调节,能够实现从暖白到冷白的平滑变化,但依旧不支持RGB或RGBW颜色设置,适用于双色温灯具。当设备切换到RGB模式时,除了开关、亮度和色温控制(色温可通过RGB通道混合模拟)之外,还支持RGB全彩颜色设置,可自由调节任意色彩,但不支持独立白光通道。当设备处于RGBW模式时,则在RGB模式的基础上进一步增加了独立的白色通道,支持RGBW四通道颜色设置,能够同时呈现鲜艳彩色和纯正白光,满足更丰富的照明场景需求。

需要特别强调的是,工作模式的设定并非软件层面的任意切换,通常需要结合灯具的物理接线方案和实际的部署情况来确定。例如,若灯具仅连接了冷暖白光LED,则不应设置为RGB模式或RGBW模式;若灯具带有RGB+W独立引脚,则可设置为RGBW模式。模式一旦修改,设备的物模型配置将同步进行动态更新--在新的工作模式下不支持的数据点会被自动隐藏,不再出现在物模型中,而新模式下支持的数据点则会按需展现。这种机制确保了客户端能够正确识别当前设备的能力范围,避免下发无效指令。因此,在修改该模式之前,必须充分确认硬件是否支持目标模式,且模式变更应慎重进行,不应随意更改,以免导致设备控制功能异常或客户端界面与实际能力不匹配。

Trait IDCode
0x4E83LightingModeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLightingModeSettingEnum80RVWO
0x0006Supported Valuelist[LightingModeSettingEnum8]R
0x0007Default Valueuint80RW

InstallationOrientationConfiguration Trait(安装方向配置)​

该 Trait 用于「安装方向配置」相关数据的访问与上报。

Trait IDCode
0x4E7EInstallationOrientationConfiguration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueInstallationOrientationConfigurationEnum160RVWO
0x0006Supported Valuelist[InstallationOrientationConfigurationEnum16]R
0x0007Default Valueuint160RW

CurrentSensitivityLevel Trait(当前灵敏度等级)​

指示当前所选通用配置灵敏度等级。

Trait IDCode
0x813BCurrentSensitivityLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVWO
0x0002Maximum Valueuint8255R
0x0003Minimum Valueuint80R
0x0005Step Valueuint321R
0x0007Default Valueuint80RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为检测、识别、感知和告警等设备功能提供统一的灵敏度等级配置。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

NumberOfSensitivityLevelIsSupported Trait(支持的灵敏度级别数量)​

该 Trait 用于「支持的灵敏度级别数量」相关数据的访问与上报。

Trait IDCode
0x813ANumberOfSensitivityLevelIsSupported
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVWO
0x0002Maximum Valueuint8255R
0x0003Minimum Valueuint80R
0x0005Step Valueuint321R
0x0007Default Valueuint80RWO

DynamicCoverRefreshEnable Trait(动态刷新封面使能)​

启用或禁用 App 首页设备封面图的动态刷新。

Trait IDCode
0x5027DynamicCoverRefreshEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RW

BuzzerVolume Trait(蜂鸣器音量)​

用于设置设备蜂鸣器的音量等级。蜂鸣器用于按键反馈、报警提示或操作通知等声音提示。该 Trait 支持读、写和主动上报。

Trait IDCode
0x5163BuzzerVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBuzzerVolumeEnum82RVWO
0x0006Supported Valuelist[BuzzerVolumeEnum8]RO
0x0007Default ValueBuzzerVolumeEnum82RWO

P2PCaptureEnabled Trait(是否支持P2P抓图)​

指示摄像头是否启用 P2P(peer-to-peer)抓拍功能。

Trait IDCode
0x4E3EP2PCaptureEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVO
0x0007Default Valueboolean1RW

P2PCaptureStatus Trait(P2P动态取图状态)​

P2P动态趣图状态开关

Trait IDCode
0x4E44P2PCaptureStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

VibrationIntensity Trait(震感强度)​

震感强度设置,用于调节线性马达的震感,控制设备触觉反馈的强弱。取值范围为 0-100%,默认值为 50%,步长为 1。

Trait IDCode
0x51EDVibrationIntensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat1RO
0x0007Default Valuefloat50RWO

Command 定义​

Command IDNameConformance
0x9D7CWakeupDeviceO

WakeupDevice Command​

Server 下发该命令,用于将设备从睡眠或待机模式唤醒。该命令适用于摄像机、传感器、门锁、控制面板等低功耗设备。Payload 包含 Action 和 Source 两个字段,其中 Action 固定为 1 表示执行唤醒操作,Source 用于标识唤醒触发来源,便于设备进行统计、日志记录或差异化行为处理。

参数​

WakeupDevice Command Structure

GeneralDiagnostics(通用诊断)​

简介​

提供通用诊断信息,包括运行时间、重启次数、网络接口及硬件故障等。

Function 标识​

Function IDCode名称
0x00B0GeneralDiagnostics通用诊断

Trait​

Trait IDCode名称Conformance
0x8149RebootReason重启原因M
0x8148RebootCount重启次数M
0x4F4BAntiDeletionNotification防误删通知O
0x4F4AAntiDeletionSetting防误删设置O
0x813DActiveHardwareFaults硬件错误O
0x4F03AntiDeletionLevelSetting防误删等级设置O
0x4EA3FreeMemory剩余可用内存大小O
0x5152TotalMemory总内存大小O
0x5147CPUUsageCPU 使用率O
0x5148CPUFrequencyCPU 运行频率O
0x4E2ANetworkInterfaces网络接口信息O
0x4E29DebugInfo调试信息O
0x4E23UpTime运行时间O
0x50AEBlockDeletion阻止删除O
0x50C3LogUploadTask日志上传O
0x513BPlatformAccessEvent平台访问事件O
0x5153SupportedRebootType支持重启类型O
0x5106CommLinkDetection链路检测O

Command​

Command IDCode名称Conformance
0x9D22Reboot重启命令O

数据类型​

RebootReasonEnum8 Type​

该枚举定义 RebootReason Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unspecified未知
0x01PowerOnReboot上电重启
0x02BrownOutReset低压复位
0x03SoftwareWatchdogReset软件看门狗复位
0x04HardwareWatchdogReset硬件看门狗复位
0x05SoftwareUpdateCompleted软件更新完成
0x06SoftwareReset软件重启(通用)
0x07ApplicationExitReboot应用正常退出后重启(例如被信号终止)
0x08DebugLogEnabledReboot云端开启调试日志后重启
0x09RemoteRPCCommandReboot通过远程 RPC 命令使设备重启
0x10ButtonLongPressReboot物理按键长按触发的重启
0x11MemoryExhaustionReboot因内存耗尽(内存不足)而触发的重启
0x12CameraHangReboot摄像头进程无响应
AntiDeletionNotificationEnum8 Type​

该枚举定义 AntiDeletionNotification Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Trigger按键触发重置
0x02FactoryResetByButton按键触发恢复出厂
AntiDeletionSettingEnum8 Type​

该枚举定义 AntiDeletionSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Disable禁用
0x01Enable启用
ActiveHardwareFaultsEnum32 Type​

该枚举定义 ActiveHardwareFaults Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unspecified未知故障
0x01Radio无线电故障
0x02Sensor传感器故障
0x03ResettableOverTemp过热保护
0x04NonResettableOverTemp过热异常
0x05PowerSource电源故障
0x06VisualDisplayFault显示故障
0x07AudioOutputFault音频输出故障
0x08UserInterfaceFault界面显示故障
0x09NonVolatileMemoryError内存故障
0x0ATamperDetected设备被拆卸/篡改
0xFFNormal无故障
AntiDeletionLevelSettingEnum8 Type​

该枚举定义 AntiDeletionLevelSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00EnableResetAndFactory启用重置网络和恢复出厂
0x01DisableFactoryOnly仅禁用恢复出厂
0x02DisableResetAndFactory禁用重置网络和恢复出厂
InterfaceTypeEnum8 Type​

该枚举定义 NetworkInterfacesTraitPresentValueStructure 中 Type 字段有效取值。

ValueNameDescription
0x00Unspecified未指定
0x01WiFiWi-Fi 接口
0x02Ethernet以太网接口
0x03Cellular蜂窝网络接口
0x04ThreadThread 接口
AddressingModeEnum8 Type​

该枚举定义 NetworkInterfacesTraitPresentValueStructure 中 AddressingMode 字段有效取值。

ValueNameDescription
0x00DHCP通过 DHCP 动态分配 IP 地址
0x01Static静态配置 IP 地址
0x02Auto自动配置(如 IPv6 SLAAC 或链路本地地址)
0xFFUnspecified未指定或未知
NetworkInterfacesTraitPresentValueStructure Type​

该结构体定义 NetworkInterfaces Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0NamecharacterStringO网络接口的人类可读或系统级标识(如 eth0、wlan0),用于在设备操作系统内唯一标识该接口并用于配置或诊断引用。
1IsOperationalbooleanM指示该网络接口当前是否可正常收发数据。通常需同时满足链路可用、已分配 IP 地址、路由可达等条件。
2OffPremiseServicesReachableIPv4booleanO指示设备是否可通过该接口使用 IPv4 访问外部(网外)服务(如云端地址);true 表示具备 IPv4 外网连通性。
3OffPremiseServicesReachableIPv6booleanO指示设备是否可通过该接口使用 IPv6 访问外部(网外)服务;true 表示具备 IPv6 外网连通性。
4HardwareAddresscharacterStringMMAC 地址字符串,最大长度 24。应为 48 位 IEEE MAC 或 64 位 IEEE MAC(EUI-64),采用大端/显示顺序(左侧为高位字节),示例:00:1A:2B:3C:4D:5E、00:1A:2B:FF:FE:3C:4D:5E。
5IPv4Addresseslist[characterString]OIPv4 地址列表,元素类型为字符串(最大长度 16),示例:192.168.2.235。
6IPv6Addresseslist[characterString]OIPv6 地址列表,元素类型为字符串(最大长度 40),示例:2001:DB8:0:0:8:800:200C:417A。
7TypeInterfaceTypeEnum8M接口类型。
8RSSIint8O接收信号强度指示值(dBm),通常为负值(如 -30)。
9AddressingModeAddressingModeEnum8O指示该接口当前 IP 地址配置模式。
10SSIDcharacterStringO当前连接 Wi-Fi 的网络名称(Service Set Identifier)。示例:Home_2.4G。
11BSSIDcharacterStringO当前连接接入点(AP)的 BSSID(MAC 地址)。示例:34:AB:37:12:CD:EF。
12RouterMACcharacterStringO当前上联网关/路由器的 MAC 地址。示例:9C:3D:CF:AA:BB:CC。
13Channeluint8O当前 Wi-Fi 工作信道(Chanel/Channel)。示例:1、6、11、149。
14SubnetMaskcharacterStringO子网掩码/前缀信息,字符串(最大长度 32)。IPv4 场景填子网掩码(示例:255.255.255.0);IPv6 场景建议填前缀长度表示(示例:64),未知或不适用可留空。
15DefaultGatewaycharacterStringO默认网关地址,字符串(最大长度 32)。可填 IPv4 或 IPv6 网关地址,示例:192.168.1.1、fe80::1。
16PrimaryDNScharacterStringO首选 DNS,字符串(最大长度 32)。可填 IPv4 或 IPv6 DNS 地址,示例:8.8.8.8、2001:4860:4860::8888。
17SecondaryDNScharacterStringO备选 DNS,字符串(最大长度 32)。可填 IPv4 或 IPv6 DNS 地址,示例:8.8.4.4、2001:4860:4860::8844。
BlockDeletionEnum8 Type​

该枚举定义 BlockDeletion Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Allow允许删除
0x01Block阻止删除
LogUploadTaskModeEnum8 Type​

该枚举定义 LogUploadTask 中 Mode 字段的有效取值。

ValueNameDescription
0x00Oneshot一次性上传当前 RAM 缓存日志
0x01Continuous持续上传模式;RAM 满时自动上传,并循环直到 ValidTime
PlatformAccessEventEnum8 Type​

该枚举定义 PlatformAccessEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x01HomeKitHomeKit 用户访问
LogUploadTaskPresentValueStructure Type​

LogUploadTask Trait 的参数结构体。

结构体成员序号字段名类型必须说明
0ModeLogUploadTaskModeEnum8M上传模式。
1ValidTimeuint32O持续上传模式有效期截止时间(UTC Epoch 秒)。仅在 Mode=Continuous 时生效;取 0 或缺省表示无截止时间。
RebootTypeEnum8 Type​

该枚举定义 Reboot Command 中 RebootType 字段的有效取值。

ValueNameDescription
0x00RebootDevice重启设备整机
0x01RebootCoordinator只重启协调器
0x7FRebootSubMCU重启子 MCU
0x80RebootStudio重启 Studio
Reboot Command Structure Type​

Reboot Command 的参数结构体。

结构体成员序号字段名类型必须说明
0RebootTypeRebootTypeEnum8M重启类型。
1Delayuint32O延迟时长,单位 s;取值范围 0 ~ 4294967295,步长 1,默认值 0。

Trait 定义​

Trait IDNameConformance
0x8149RebootReasonM
0x8148RebootCountM
0x4F4BAntiDeletionNotificationO
0x4F4AAntiDeletionSettingO
0x813DActiveHardwareFaultsO
0x4F03AntiDeletionLevelSettingO
0x4EA3FreeMemoryO
0x5152TotalMemoryO
0x5147CPUUsageO
0x5148CPUFrequencyO
0x4E2ANetworkInterfacesO
0x4E29DebugInfoO
0x4E23UpTimeO
0x50AEBlockDeletionO
0x50C3LogUploadTaskO
0x513BPlatformAccessEventO
0x5153SupportedRebootTypeO
0x5106CommLinkDetectionO

RebootReason Trait(重启原因)​

当前值应指示设备最近一次启动的原因。

Trait IDCode
0x8149RebootReason
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRebootReasonEnum80RVM
0x0006Supported Valuelist[RebootReasonEnum8]RO

RebootCount Trait(重启次数)​

当前值应尽可能准确地指示设备已重启的次数。每次设备重启时应递增。设备从低功耗或睡眠状态唤醒时不应递增。仅在设备出厂重置时应重置为 0。

Trait IDCode
0x8148RebootCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO

AntiDeletionNotification Trait(防误删通知)​

为集线器上的子设备启用AntiDeletion功能后,如果子设备执行重置/删除操作,将触发通知报告。

Trait IDCode
0x4F4BAntiDeletionNotification
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAntiDeletionNotificationEnum81VO
0x0006Supported Valuelist[AntiDeletionNotificationEnum8]RO

AntiDeletionSetting Trait(防误删设置)​

用于设置防止误删的功能。

Trait IDCode
0x4F4AAntiDeletionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAntiDeletionSettingEnum80RVWO
0x0006Supported Valuelist[AntiDeletionSettingEnum8]RO
0x0007Default Valueuint80RWO

ActiveHardwareFaults Trait(硬件错误)​

硬件错误

Trait IDCode
0x813DActiveHardwareFaults
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[ActiveHardwareFaultsEnum32]RVO
0x0006Supported Valuelist[ActiveHardwareFaultsEnum32]RO

AntiDeletionLevelSetting Trait(防误删等级设置)​

反删除级别设置控制设备运行期间复位网络和出厂复位按钮操作的权限,防止意外数据丢失。

Trait IDCode
0x4F03AntiDeletionLevelSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAntiDeletionLevelSettingEnum80RVWO
0x0006Supported Valuelist[AntiDeletionLevelSettingEnum8]RO
0x0007Default Valueuint80RWO

FreeMemory Trait(剩余可用内存大小)​

指示设备当前可用内存大小,单位为千字节(KB)。

Trait IDCode
0x4EA3FreeMemory
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

TotalMemory Trait(总内存大小)​

总内存大小。表示设备硬件配置的物理内存总容量(RAM),单位为 KB。该值为静态参数,在设备出厂时或启动时固定,用于描述设备的硬件规格。

Trait IDCode
0x5152TotalMemory
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320 ~ 4294967295(单位:KB)0RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

CPUUsage Trait(CPU 使用率)​

指示设备当前 CPU 总体使用率(CPU 使用率,单位:%),用于设备诊断和负载监控。

Trait IDCode
0x5147CPUUsage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0.0 ~ 100.0(单位:%)0RVO
0x0002Maximum Valuefloat100RO
0x0003Minimum Valuefloat0RO

CPUFrequency Trait(CPU 运行频率)​

指示设备当前 CPU 运行频率(CPU 频率,单位:MHz),用于设备诊断和负载监控。

Trait IDCode
0x5148CPUFrequency
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32>= 0(单位:MHz)1000RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

NetworkInterfaces Trait(网络接口信息)​

该特征描述设备支持的网络接口。

Trait IDCode
0x4E2ANetworkInterfaces
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[NetworkInterfacesTraitPresentValueStructure]RVO

DebugInfo Trait(调试信息)​

设备运行期间的调试信息。数据类型为字符串,最大长度为 1024 字节。

Trait IDCode
0x4E29DebugInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringVO

UpTime Trait(运行时间)​

UpTime 特征应尽可能准确地指示自节点上次重启以来经过的时间长度(秒)。

Trait IDCode
0x4E23UpTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

BlockDeletion Trait(阻止删除)​

设备请求删除(解绑)时由服务端写入。写入值 1 指示设备取消删除操作(即保持绑定)。写入值 0 或不存在该特征时,允许设备继续删除。

Trait IDCode
0x50AEBlockDeletion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBlockDeletionEnum81RVWO
0x0006Supported Valuelist[BlockDeletionEnum8]RO
0x0007Default Valueuint81RWO

LogUploadTask Trait(日志上传)​

该 Trait 用于触发设备日志上传任务。写入该 Trait 可启动/停止上传任务;读取可获取当前配置。

Trait IDCode
0x50C3LogUploadTask
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLogUploadTaskPresentValueStructureRVWO

PlatformAccessEvent Trait(平台访问事件)​

当来自外部平台(如 HomeKit、Alexa、Google Home 等)的用户访问设备时,设备上报此事件,用于生成访问日志。该 Trait 标识访问来源平台,便于安全审计和日志追踪。

Trait IDCode
0x513BPlatformAccessEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePlatformAccessEventEnum8VO

SupportedRebootType Trait(支持重启类型)​

该 Trait 用于上报设备支持的重启类型。

Trait IDCode
0x5153SupportedRebootType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[RebootTypeEnum8]RVO

CommLinkDetection Trait(链路检测)​

用于通信链路诊断,主要承载云端或运维侧链路检测相关信息。

Trait IDCode
0x5106CommLinkDetection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

Command 定义​

Command IDNameConformance
0x9D22RebootO

Reboot Command​

控制或上报设备重启状态,可用于监控或触发设备重启。

参数​

Reboot Command Structure

PanTilt(云台)​

简介​

提供云台(Pan/Tilt/Zoom)控制能力,包括预置位、校准及相对/绝对移动。

Function 标识​

Function IDCode名称
0x00B1PanTilt云台

Trait​

Trait IDCode名称Conformance
0x50D9PTZPowerOffMemory云台断电记忆O
0x50D6ViewZoomMode画面缩放方式O
0x50D5PTZHomeReturnDelay云台归位时长O
0x50D4PTZHomeMode云台归位模式O
0x50D3PTZHomePosition云台归位点O
0x50D2PTZAutoModeSetting云台智能模式O
0x50D1PTZPresets云台预置位列表O
0x50D0CurrentPTZPosition当前云台位置O
0x50C7CruiseStatus云台巡航状态O
0x50C6CruiseEnable云台巡航使能O
0x50C2PTZRange云台控制范围O
0x50C1PTZOffset云台增量偏移量O

Command​

Command IDCode名称Conformance
0x88BDPanTiltDirectionControl云台方向控制O
0x9D74PTZStop云台停止O
0x9D76PTZRelativeMove云台相对控制O
0x9D77PTZCalibration云台一键校准O
0x9D78PTZSetPosition云台控制O
0x9D79PTZMoveToPreset云台移至预置位O
0x9D7APTZSavePreset云台保存预置位O
0x9D7BPTZRemovePreset云台删除预置位O

数据类型​

PTZPowerOffMemoryEnum8 Type​

该枚举定义 PTZPowerOffMemory Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off禁用断电记忆。
0x01Hold启用断电记忆,上电后恢复断电前 PTZ 位置。

ViewZoomModeEnum8 Type​

该枚举定义 ViewZoomMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00FixedCenter固定中心缩放。
0x01FollowGesture跟随手势缩放。

PTZHomeModeEnum8 Type​

该枚举定义 PTZHomeMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00AfterTrackingOnly跟踪结束后归位。
0x01AfterTrackingOrLiveView跟踪结束或退出实时画面后归位。

PTZAutoModeSettingEnum8 Type​

该枚举定义 PTZAutoModeSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00None无。
0x01Cruise巡航。
0x02HumanTracking人形跟踪。
0x03PetTracking宠物跟踪。
0x04SoundSourceLocalization声源定位。

CruiseStatusEnum8 Type​

该枚举定义 CruiseStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00AutoStopped自动停止。
0x01ManualStopped手动停止。

PTZDirectionEnum8 Type​

该枚举定义云台旋转方向字段(PanDir/TiltDir)有效取值。

ValueNameDescription
0x01Forward正向。
0x02Reverse反向。

PTZCalibrationActionEnum8 Type​

该枚举定义 PTZCalibration Command 的 Action 字段有效取值。

ValueNameDescription
0x00Stop停止校准。
0x01Calibrate启动校准。

PTZPresetTypeEnum8 Type​

该枚举定义 PTZ 预置位类型字段(PresetType)有效取值。

ValueNameDescription
0x00Normal普通预置位。
0x01Home归位点预置位。
0x02Patrol巡航点预置位。

PTZPresetScenarioEnum8 Type​

该枚举定义 PTZ 预置位的位置语义(PresetScenario)。位置语义用于在不同设备和语言之间识别标准位置,不是预置位 ID,也不表示预置位来源或控制用途。

ValueNameDescription
0x00Unspecified未指定标准位置语义。用于兼容无法确定语义的既有预置位;新创建的用户预置位应使用 Custom。
0x01Rightmost云台朝向其有效水平行程中最右侧的标准位置。
0x02Leftmost云台朝向其有效水平行程中最左侧的标准位置。
0x03Topmost云台朝向其有效垂直行程中最上侧的标准位置。
0x04Bottommost云台朝向其有效垂直行程中最下侧的标准位置。
0x05CenterPan 和 Tilt 均处于校准后有效行程中点的标准位置。
0x06Custom不具有本枚举所定义标准位置语义的预置位。可有多个。
0x07-0xFFReserved保留供后续标准扩展。实现不得自行赋予其他含义。

Rightmost、Leftmost、Topmost 和 Bottommost 表示摄像机朝向的方向,以设备校准后的正常安装姿态和未镜像、未翻转的视频坐标为参考;不得根据客户端显示镜像改变语义。方向对应的电机正负方向由设备校准结果确定,不得假定所有设备的 Pan/Tilt 正向相同。

CurrentPTZPositionStructure Type​

该结构体定义 CurrentPTZPosition Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Panint16M水平 Pan 角度,单位度。
1Tiltint16M垂直 Tilt 角度,单位度。
2ZoomfloatO光学变焦倍率。
3PanDirPTZDirectionEnum8OPan 方向。
4TiltDirPTZDirectionEnum8OTilt 方向。

PTZOffsetStructure Type​

该结构体定义 PTZOffset Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0PanOffsetint16MPan 偏移角,单位度。
1TiltOffsetint16MTilt 偏移角,单位度。

PTZRangeStructure Type​

该结构体定义 PTZRange Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0PanMinint16MPan 最小角度,单位度。
1PanMaxint16MPan 最大角度,单位度。
2TiltMinint16MTilt 最小角度,单位度。
3TiltMaxint16MTilt 最大角度,单位度。

PTZHomePositionStructure Type​

该结构体定义 PTZHomePosition Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Modeuint8M归位模式:0=回跟踪前位置,1=回固定位置。
1Panint16O固定归位点 Pan 角度,Mode=1 时有效。
2Tiltint16O固定归位点 Tilt 角度,Mode=1 时有效。
3ZoomfloatO固定归位点 Zoom,Mode=1 时有效。

PTZPresetItemStructure Type​

该结构体定义单个 PTZ 预置位项目字段布局。

结构体成员序号字段名类型必须说明
0PresetIduint32M预置位唯一 ID。
1NamecharacterStringM预置位名称。
2PositionCurrentPTZPositionStructureM预置位对应 PTZ 位置。
3IconUrlcharacterStringO图标 URL。
4EncryptionKeyoctetStringO图片加密密钥。
5CoordinateDataoctetStringO坐标扩展数据。
6PresetTypePTZPresetTypeEnum8O预置位类型。
7SortOrderuint32O排序值。
8PresetScenarioPTZPresetScenarioEnum8O预置位的位置语义。符合本定义的新实现应提供;字段缺失表示语义未知,不得由 PresetId、Name 或列表顺序推断。
9BuiltInbooleanO是否为设备提供的内置预置位。符合本定义的新实现应提供;字段缺失表示来源未知,不得按 false 处理。
PanTiltDirectionControl Command Structure Type​

PanTiltDirectionControl Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Directionuint8M方向。
PTZRelativeMove Command Structure Type​

PTZRelativeMove Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PanDeltaint16M平移变化量。
1TiltDeltaint16M倾斜变化量。
2ZoomDeltafloatO变焦变化量。
PTZCalibration Command Structure Type​

PTZCalibration Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ActionPTZCalibrationActionEnum8M动作;默认值为 0。
PTZSetPosition Command Structure Type​

PTZSetPosition Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Panint16M平移角度。
1Tiltint16M倾斜角度。
2ZoomfloatO变焦。
3PanDirPTZDirectionEnum8O平移转动方向。
4TiltDirPTZDirectionEnum8O倾斜转动方向。
PTZMoveToPreset Command Structure Type​

PTZMoveToPreset Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PresetIduint32M预置位ID。
PTZSavePreset Command Structure Type​

PTZSavePreset Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PresetIduint32O预置位ID。
1NamecharacterStringO名称。
2PositionCurrentPTZPositionStructureO云台位置。
3IconUrlcharacterStringO图标URL。
4EncryptionKeyoctetStringO图片加密密钥。
5CoordinateDataoctetStringO坐标数据。
6PresetTypePTZPresetTypeEnum8O预置类型。
7SortOrderuint32O排序。
8PresetScenarioPTZPresetScenarioEnum8O新建用户预置位时省略表示 Custom;不允许用本命令创建或修改五个标准位置场景。
PTZRemovePreset Command Structure Type​

PTZRemovePreset Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PresetIduint32M预置位ID。

Trait 定义​

Trait IDNameConformance
0x50D9PTZPowerOffMemoryO
0x50D6ViewZoomModeO
0x50D5PTZHomeReturnDelayO
0x50D4PTZHomeModeO
0x50D3PTZHomePositionO
0x50D2PTZAutoModeSettingO
0x50D1PTZPresetsO
0x50D0CurrentPTZPositionO
0x50C7CruiseStatusO
0x50C6CruiseEnableO
0x50C2PTZRangeO
0x50C1PTZOffsetO

PTZPowerOffMemory Trait(云台断电记忆)​

用于设置或查询云台断电记忆功能。启用后,设备重启会恢复断电前 PTZ 位置;禁用后,设备重启回到默认位置。

Trait IDCode
0x50D9PTZPowerOffMemory
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePTZPowerOffMemoryEnum81RVWO
0x0006Supported Valuelist[PTZPowerOffMemoryEnum8]R
0x0007Default ValuePTZPowerOffMemoryEnum80RWO

ViewZoomMode Trait(画面缩放方式)​

用于设置或查询用户在实时画面执行双指缩放手势时的 PTZ 行为。固定中心缩放时,缩放中心保持在画面中心且 PTZ 不跟随移动;跟随手势缩放时,PTZ 会旋转对齐缩放手势中心点。

Trait IDCode
0x50D6ViewZoomMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueViewZoomModeEnum80RVWO
0x0006Supported Valuelist[ViewZoomModeEnum8]R
0x0007Default ValueViewZoomModeEnum80RWO

PTZHomeReturnDelay Trait(云台归位时长)​

用于设置或查询云台自动归位触发后等待执行的延时,单位秒。

Trait IDCode
0x50D5PTZHomeReturnDelay
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint325RVWO
0x0002Maximum Valueuint3260R
0x0003Minimum Valueuint321R
0x0005Step Valueuint321R
0x0007Default Valueuint325RWO

PTZHomeMode Trait(云台归位模式)​

用于设置或查询云台自动归位触发条件。

Trait IDCode
0x50D4PTZHomeMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePTZHomeModeEnum80RVWO
0x0006Supported Valuelist[PTZHomeModeEnum8]R
0x0007Default ValuePTZHomeModeEnum80RWO

PTZHomePosition Trait(云台归位点)​

定义云台自动归位目标配置。Mode=0 时回到跟踪前位置;Mode=1 时回到指定 Pan/Tilt/Zoom 固定位置。

Trait IDCode
0x50D3PTZHomePosition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePTZHomePositionStructure{&quot;0&quot;:0,&quot;1&quot;:999,&quot;2&quot;:999}RVWO

PTZAutoModeSetting Trait(云台智能模式)​

用于设置或查询云台智能模式,例如巡航、人形跟踪、宠物跟踪、声源定位等。

Trait IDCode
0x50D2PTZAutoModeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePTZAutoModeSettingEnum80RVWO
0x0006Supported Valuelist[PTZAutoModeSettingEnum8]R
0x0007Default ValuePTZAutoModeSettingEnum80RWO

PTZPresets Trait(云台预置位列表)​

表示设备当前可调用的云台预置位列表,包括设备内置预置位和用户保存的预置位。每项包含唯一 ID、名称、PTZ 位置及可选扩展字段。PresetId 用于标识和调用条目;PresetScenario 表示标准位置语义;BuiltIn 表示条目是否由设备提供。Name 仅供展示,不得用于判断位置语义或预置位来源。

Trait IDCode
0x50D1PTZPresets
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[PTZPresetItemStructure]RVWO
预置位列表实现要求​
  • 同一 Endpoint 当前列表中的 PresetId 必须唯一。ID 在条目存续期间必须稳定;设备重启不得改变仍存在条目的 ID。设备应避免在配置生命周期内重用已删除条目的 ID,以免延迟请求作用于不同预置位。恢复出厂设置或重新配置可能改变列表时,客户端必须重新读取本 Trait。
  • 对采用本定义的新实现,每个列表项必须提供 PresetScenario 和 BuiltIn。由于这两个结构体字段在编码层面为可选,旧实现或旧数据缺少字段时,消费者必须将其视为未知;不得将缺失的 BuiltIn 当作 false,也不得依据 ID、Name、数组索引或其他未标准化信息推断方向或来源。
  • 对新实现,五个标准场景 Rightmost、Leftmost、Topmost、Bottommost 和 Center 在一个 Endpoint 的列表中各至多出现一次。设备只应报告其实际支持、位置可确定且能够执行移动的标准预置位;不支持的标准位置应省略,不得用占位值或不可达位置伪造条目。Custom 可用于多个条目;Unspecified 仅用于兼容无法确定语义的旧条目,新创建的条目不得使用 Unspecified。
  • PresetScenario 与 PresetType 表示不同信息:前者描述位置语义,后者描述 Normal、Home 或 Patrol 等用途。不得将方向编码到 PresetType;也不得仅因某条目的场景为 Center 就推断其 PresetType 为 Home。
  • 标准位置预置位的 Name 必须使用规范英文名称:Rightmost、Leftmost、Topmost、Bottommost 或 Center,与其 PresetScenario 一致。客户端应根据 PresetScenario 本地化标准位置名称,而不是解析 Name。自定义预置位的 Name 由用户或设备提供并用于展示;不得将其作为机器可读语义。
  • 对五个标准位置,Position 必须包含可调用的完整 Pan/Tilt 位置。水平端点场景的另一轴 Tilt 使用有效垂直行程中点;垂直端点场景的另一轴 Pan 使用有效水平行程中点;Center 的 Pan 和 Tilt 均使用对应有效行程中点。行程边界应来自设备校准后的实际可用行程;若 PTZRange 未实现,设备仍必须能够可靠确定这些边界,否则不得报告相应标准场景。
  • 对中点计算,设备按 (minimum + maximum) / 2 计算;当结果不是可表示的整数角度时,向数值较小的整数角度取整,并确保目标位于有效行程内。方向端点按设备校准后与正常安装姿态下未镜像、未翻转画面方向的对应关系确定,不得假定 Pan/Tilt 的数值正负统一表示左/右或上/下。
  • 对标准位置场景,设备支持 Zoom 且 1.0 位于其有效范围内时,应使用 Zoom=1.0;否则使用设备支持的最小有效光学变焦倍率。设备不支持光学变焦时可省略 Zoom。客户端镜像、翻转或数字裁剪不得改变标准位置语义。
  • 内置条目必须报告 BuiltIn=true;用户创建的条目必须报告 BuiltIn=false。无法确定既有条目来源时,旧数据可省略该字段,消费者应将其视为未知并避免提供可能破坏预置位的编辑或删除操作。
  • 内置条目的 PresetId、PresetScenario 和标准位置语义必须保持稳定。设备校准或可用行程改变导致实际坐标变化时,设备应更新 Position 并上报列表;若该场景已无法实现,应移除该条目。客户端不得长期缓存列表并假定条目永远存在。
  • 客户端写入列表时,设备必须校验整个新列表。若存在重复 ID、重复标准场景、无效字段,或对内置条目的创建、删除、伪造、来源变更或语义变更,设备必须拒绝整个写入且不得部分应用。更新内置条目的 Position 仅允许设备因校准或硬件状态变化而执行,不允许客户端通过直接写列表修改。
  • 上述新增字段和规则不改变既有 PTZPresets Trait 的可选性。只实现旧格式的设备属于既有兼容实现;新实现应提供新增字段。消费者遇到缺失字段或未知枚举值时,应保留可读取的原始数据并使用 Name 展示,不得猜测语义。
客户端处理要求​
  • 客户端应读取设备当前 PTZPresets 列表,并按 PresetId 标识条目;不得假设某个 ID、数组下标或 SortOrder 对应某个标准位置。
  • 当 PresetScenario 为五个标准位置之一时,客户端应根据该枚举值显示本地化名称和相应的标准位置图标。Name 保留用于辅助展示,不作为判断依据。对于 Custom、Unspecified、缺失字段或客户端尚不认识的枚举值,客户端应显示设备提供的 Name,并避免显示推断出的方向语义。
  • 客户端发起移动、保存或删除时,应使用从当前列表读取的 PresetId。不得把 PresetScenario 数值当作 PresetId,也不得仅凭场景枚举构造列表中不存在的目标。
  • BuiltIn=true 条目应显示为设备内置预置位,不提供编辑或删除操作。BuiltIn 缺失或不可识别时,客户端应隐藏或禁用编辑和删除操作,直至从设备获取可确认的来源信息。
  • 列表上报或命令成功后,客户端应刷新本地列表及场景索引。若列表违反 ID 唯一性或标准场景唯一性,客户端应将数据视为无效并向用户或诊断系统报告,不得静默选取其中一项。

CurrentPTZPosition Trait(当前云台位置)​

表示当前云台机械位置(Pan/Tilt)及光学变焦倍率(Zoom),可用于状态展示和后续控制基准。

Trait IDCode
0x50D0CurrentPTZPosition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCurrentPTZPositionStructureRVWO

CruiseStatus Trait(云台巡航状态)​

用于上报当前云台巡航功能的运行状态。当巡航因达到预设条件自动停止时,上报 AutoStopped;当由用户手动停止时,上报 ManualStopped。

Trait IDCode
0x50C7CruiseStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCruiseStatusEnum80RVO
0x0006Supported Valuelist[CruiseStatusEnum8]R

CruiseEnable Trait(云台巡航使能)​

用于启用或禁用云台自动巡航功能。开启后,设备将按照预定义巡航路径自动移动;关闭后,停止自动巡航并允许手动控制。

Trait IDCode
0x50C6CruiseEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RW

PTZRange Trait(云台控制范围)​

定义云台 Pan/Tilt 的运动边界范围,通常由硬件机械限位决定,只读上报。

Trait IDCode
0x50C2PTZRange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePTZRangeStructureRVO

PTZOffset Trait(云台增量偏移量)​

存储 PTZ 相对控制的固定偏移量(Pan/Tilt),用于在增量控制中修正目标位置。

Trait IDCode
0x50C1PTZOffset
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePTZOffsetStructureRVO

Command 定义​

Command IDNameConformance
0x88BDPanTiltDirectionControlO
0x9D74PTZStopO
0x9D76PTZRelativeMoveO
0x9D77PTZCalibrationO
0x9D78PTZSetPositionO
0x9D79PTZMoveToPresetO
0x9D7APTZSavePresetO
0x9D7BPTZRemovePresetO

PanTiltDirectionControl Command​

该 Command 用于执行「云台方向控制」操作。

参数​

PanTiltDirectionControl Command Structure

PTZStop Command​

立即停止所有正在进行的 PTZ 运动(pan、tilt、zoom 等)。PTZ 将保持当前位置并进入空闲状态。

该 Command 无参数。

PTZRelativeMove Command​

按指定的 pan、tilt 或 zoom 增量值,相对于当前位置移动摄像头 PTZ 机构。支持三个轴任意组合的独立调整。 PanDelta:水平 pan 移动的增量值,单位为度。0 表示不移动;负值向左;正值向右。 TiltDelta:垂直 tilt 移动的增量值,单位为度。0 表示不移动;负值向下;正值向上。 ZoomDelta:变焦调整的百分比增量。0 表示不变;负值缩小(视野更宽);正值放大(视野更窄)。

参数​

PTZRelativeMove Command Structure

PTZCalibration Command​

触发或停止云台校准流程。写入 0 停止正在进行的校准;写入 1 触发自动校准(重新建立限位、纠正误差等)。

参数​

PTZCalibration Command Structure

PTZSetPosition Command​

将摄像头 PTZ 机构移动到指定的绝对 pan 角、tilt 角和光学变焦倍率。支持三个轴任意组合的独立设置。 Pan:目标水平 pan 角,单位为度。0 deg 为正前方;负值向左,正值向右。 Tilt:目标垂直 tilt 角,单位为度。0 deg 为水平参考;负值向下,正值向上。 Zoom:目标光学变焦倍率。1.0 为最宽视野。

参数​

PTZSetPosition Command Structure

PTZMoveToPreset Command​

将摄像头 PTZ 机构移动到指定预置位存储的位置。PresetId 必须对应设备当前 PTZPresets 列表中的条目;该字段是预置位 ID,不是 PresetScenario 枚举值。

参数​

PTZMoveToPreset Command Structure

接收后行为(Effect on Receipt)​

设备接收命令后,应查找当前列表中与 PresetId 完全匹配的条目,并移动至该条目的完整 Position。

  • 若 PresetId 不存在,设备应返回"预置位不存在"语义错误,不得移动到其他位置。
  • 若目标位置当前不可达、设备未校准或执行条件不满足,设备应返回相应失败状态,不得报告移动成功。
  • 设备成功接受移动请求不表示已到达目标位置;实际位置仍应通过 CurrentPTZPosition 等状态反馈确认。

PTZSavePreset Command​

创建新的用户预置位或更新已有用户预置位。若省略 PresetId,设备自动分配唯一 ID;若提供且存在,则更新对应用户预置位;若提供但不存在,则在未达到设备容量限制时创建该 ID 的用户预置位。新建或更新条目的 BuiltIn 必须为 false。

新建预置位时,Position 优先使用命令提供的值;若省略,则使用设备当前有效的 PTZ 位置。若两者均不可用,设备应拒绝命令,不得以零坐标代替。新建时省略 Name,设备应生成非空且可读的名称。更新时,省略的字段保持原值;省略 PresetScenario 不得将已有场景重置。新建时省略 PresetScenario 表示 Custom;若显式提供,该字段必须为 Custom。

本命令仅用于创建和更新用户预置位。调用者不得创建 Rightmost、Leftmost、Topmost、Bottommost 或 Center 标准位置预置位,也不得将用户预置位标记为内置预置位。五个标准位置(如设备支持)由设备按 PTZPresets Trait 定义提供和维护。

参数​

PTZSavePreset Command Structure

接收后行为(Effect on Receipt)​

设备应先校验命令及其对预置位列表的影响;校验成功后再一次性更新列表,并上报新的 PTZPresets 值。

  • 若指定的 PresetId 已对应 BuiltIn=true 条目,设备应返回"内置预置位不可修改"语义错误,且不得改变该条目或列表中的其他条目。
  • 若 PresetScenario 为五个标准位置之一,设备应返回"标准位置由设备维护"语义错误;不得通过本命令添加第二个相同场景或修改标准位置。
  • 若 PresetScenario 为未知或保留值、PresetId 与其他条目冲突、位置超出有效行程、名称或字段格式非法、或设备容量已满,设备应拒绝整个命令且不得部分应用。
  • 对已有用户预置位的更新,字段省略表示保留原值。设备必须保持 PresetId 不变;不得将 BuiltIn=false 改为 true。
  • 对新建用户预置位,设备应设置 BuiltIn=false。若命令省略 PresetScenario,设备应设置 Custom;若显式提供该字段,设备已按命令校验规则确认其值为 Custom。
  • 成功后,设备应返回成功状态并更新、上报列表;失败时应返回失败状态且列表保持不变。具体错误编码使用 Aqara 业务交互协议定义的等价错误,不在本 Function 中另行分配错误码。

PTZRemovePreset Command​

从 PTZPresets 列表中移除指定用户预置位。PresetId 必须对应设备当前列表中的条目。

参数​

PTZRemovePreset Command Structure

接收后行为(Effect on Receipt)​
  • 若 PresetId 不存在,设备应返回"预置位不存在"语义错误,列表保持不变。
  • 若目标条目的 BuiltIn=true,设备应返回"内置预置位不可删除"语义错误,列表保持不变。
  • 若目标条目的来源未知(例如旧列表缺少 BuiltIn),设备不得将其当作用户预置位删除;应返回来源未知或不允许删除的失败状态。
  • 若目标为用户预置位,设备应删除该条目并上报更新后的列表。删除成功后,该 ID 不再能用于移动、更新或删除命令;设备应避免在配置生命周期内将该 ID 分配给其他预置位。
  • 设备不得在失败时部分修改列表。具体错误编码使用 Aqara 业务交互协议定义的等价错误,不在本 Function 中另行分配错误码。

BridgedConfiguration(桥接配置信息)​

简介​

描述被桥接子设备的配置信息,用于 Matter/Zigbee 桥接场景。

Function 标识​

Function IDCode名称
0x00B2BridgedConfiguration桥接配置信息

Trait​

Trait IDCode名称Conformance
0x8140BridgeDeviceID桥设备IDM

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x8140BridgeDeviceIDM

BridgeDeviceID Trait(桥设备ID)​

表示此桥接节点所连接的 Bridge 设备的 DeviceID。String(32)。

Trait IDCode
0x8140BridgeDeviceID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWM

Command 定义​

本 Function 不包含 Command。

MatterNodeInformation(Matter设备信息)​

简介​

提供 Matter 节点相关信息,如首个 Endpoint ID 及节点拓扑辅助信息。

Function 标识​

Function IDCode名称
0x00B3MatterNodeInformationMatter设备信息

Trait​

Trait IDCode名称Conformance
0x8143MatteNodeFirstEndpointIdMatter设备首个节点 IDM

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x8143MatteNodeFirstEndpointIdM

MatteNodeFirstEndpointId Trait(Matter设备首个节点 ID)​

表示 Matter 设备的第一个 endpoint ID。格式:Uint16。

Trait IDCode
0x8143MatteNodeFirstEndpointId
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint160RVM
0x0002Maximum Valueint1665535RO
0x0003Minimum Valueint160RO
0x0005Step Valueuint321RO

Command 定义​

本 Function 不包含 Command。

ThreadNetworkDiagnostics(Thread网络诊断)​

简介​

提供 Thread 网络诊断指标,包括信道、PAN ID、邻居表、路由角色及收发统计。

Function 标识​

Function IDCode名称
0x00B5ThreadNetworkDiagnosticsThread网络诊断

Trait​

Trait IDCode名称Conformance
0x8152RSSI接收信号强度指示O
0x8153LQI链路质量指示O
0x814BPANID个人区域网络标识符O
0x814CExtendedPANID网络扩展标识符O
0x8151MeshLocalPrefix网状网络本地前缀O
0x4E7AThreadTopologyReportIntervalThread 拓扑上报间隔O
0x4E79ThreadTopologyDataThread 拓扑数据O
0x4E35ConnectionStatus连接状态O
0x4E34NetworkFaultChange网络故障变更O
0x4E33RxBroadcastCount报文接收广播计数O
0x4E32RxUnicastCount报文接收单播计数O
0x4E2ETxTotalCount报文发送总计数O
0x4E2FTxUnicastCount报文发送单播计数O
0x4E30TxBroadcastCount报文发送广播计数O
0x4E31RxTotalCount报文接收总计数O
0x4E2DPartitionId网络分区标识符O
0x4E2COverrunCount溢出丢包计数O
0x4E2BAverageRssi平均信号强度指示O
0x8150NeighborTable邻居表O
0x814FRoutingRole路由角色O
0x814ERouteTable路由表O
0x814DNetworkName网络名称O
0x814AChannel无线信道O
0x5003ThreadPingResultThread Ping 结果O

Command​

本 Function 不包含 Command。

数据类型​

ThreadTopologyDataTraitPresentValueStructure Type​

该结构体定义 ThreadTopologyData Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0RouterIDuint8MThread 网络中路由器的唯一 ID。
1Rloc16uint16MThread 网络中的 16-bit RLOC 地址。
2ExtAddressuint64MThread extended address。
3ThreadVersionuint64MThread Version。
4Flagsarray[uint8]M节点角色标志位。
5Linksarray[uint8]M当前路由器已建立链路的其他 RouterID 列表。
6IPv6characterStringM节点的 IPv6 地址列表。
7Childrenlist[Struct]M当前 router 下挂载的 child 设备列表。
8ThreadVersionuint64MThread Version。
9Timeoutuint32Mchild detach timeout,单位秒。
10Ageuint32M自上次成功通信以来的时间,单位秒。
11Supvnuint8MSupervision interval count。
12FullNetbooleanM节点是否已完整附着到 Thread 网络。
13QMsgCountuint8M待发送给 child 的 queued messages 数量。
14ErrRateFramefloatMFrame error rate。
15ErrRateMsgfloatMMessage error rate。
16ConnTimecharacterStringMchild 加入 parent 后的连接时长。
17CslSyncbooleanM是否已与父节点完成 CSL 同步。
18CslPerioduint16MCSL 采样间隔周期。
19CslTimeoutuint32MCSL 同步超时时间,单位秒。
20CslChanneluint16MCSL 通信使用的物理信道。
21Flagsarray[uint8]M节点角色标志位。
ConnectionStatusEnum8 Type​

该枚举定义 ConnectionStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NotConnected未连接
0x01Connected已连接
NetworkFaultChangeTraitPresentValueStructure Type​

该结构体定义 NetworkFaultChange Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Currentlist[enum8]M当前检测到的网络故障集合。
1Previouslist[enum8]M变化前检测到的网络故障集合。
ThreadPingResultTraitPresentValueStructure Type​

该结构体定义 ThreadPingResult Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0ip_addrcharacterStringM目标 IP 地址。
1status_codeenum8M执行结果状态码:0=SUCCESS,1=TIMEOUT,2=BUSY。
2avg_round_tripuint32O平均 RTT,单位 ms;仅成功时存在。
3max_round_tripuint32O最大 RTT,单位 ms;仅成功时存在。
4min_round_tripuint32O最小 RTT,单位 ms;仅成功时存在。
5loss_percentuint32O丢包率百分比;仅成功时存在。

Trait 定义​

Trait IDNameConformance
0x8152RSSIO
0x8153LQIO
0x814BPANIDO
0x814CExtendedPANIDO
0x8151MeshLocalPrefixO
0x4E7AThreadTopologyReportIntervalO
0x4E79ThreadTopologyDataO
0x4E35ConnectionStatusO
0x4E34NetworkFaultChangeO
0x4E33RxBroadcastCountO
0x4E32RxUnicastCountO
0x4E2ETxTotalCountO
0x4E2FTxUnicastCountO
0x4E30TxBroadcastCountO
0x4E31RxTotalCountO
0x4E2DPartitionIdO
0x4E2COverrunCountO
0x4E2BAverageRssiO
0x8150NeighborTableO
0x814FRoutingRoleO
0x814ERouteTableO
0x814DNetworkNameO
0x814AChannelO
0x5003ThreadPingResultO

RSSI Trait(接收信号强度指示)​

当前值应指定最近从邻近节点接收帧的 RSSI。若无已知最近接收帧,当前值应为 NULL。当前值单位为 dBm,范围为 -128 dBm 至 0 dBm。对于 Thread 网络,该属性反映 Thread 特有的 RSSI。

Trait IDCode
0x8152RSSI
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint80RVO
0x0002Maximum Valueint8127RO
0x0003Minimum Valueint8-128RO
0x0005Step Valueuint321RO

LQI Trait(链路质量指示)​

指示 Thread 网络的 Link Quality Indicator(LQI),反映 Thread 设备间 RF 链路质量。范围:0-255。

Trait IDCode
0x8153LQI
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

PANID Trait(个人区域网络标识符)​

当前值指示 Zigbee 网络 PAN ID。

Trait IDCode
0x814BPANID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665534RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO

ExtendedPANID Trait(网络扩展标识符)​

当前值为 64 位唯一标识符,用于标识 Thread 网络中的个人区域网络(PAN)。它与 PANID 配合使用以区分不同网络。每个网络具有唯一的 ExtendedPANID,所有加入该网络的节点必须使用相同的 ExtendedPANID 才能相互通信。

Trait IDCode
0x814CExtendedPANID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVO
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint321RO

MeshLocalPrefix Trait(网状网络本地前缀)​

当前值应指示设备已配置加入的 Thread 网络的 mesh-local IPv6 前缀。取值为 null 表示 Thread 接口当前未配置或未运行。

Trait IDCode
0x8151MeshLocalPrefix
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

ThreadTopologyReportInterval Trait(Thread 拓扑上报间隔)​

指定设备自动向云端上报 Thread 网络拓扑数据的时间间隔(秒)。

Trait IDCode
0x4E7AThreadTopologyReportInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint3286400RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint3286400RWO

ThreadTopologyData Trait(Thread 拓扑数据)​

描述设备观测到的当前 Thread 网络拓扑状态。

Trait IDCode
0x4E79ThreadTopologyData
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueThreadTopologyDataTraitPresentValueStructureRVO
0x000DIs NullbooleanFalseRVO

ConnectionStatus Trait(连接状态)​

设备与线程网络的连接状态已更改。

Trait IDCode
0x4E35ConnectionStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueConnectionStatusEnum80RVO
0x0006Supported Valuelist[ConnectionStatusEnum8]RO
0x0007Default Valueuint80RWO

NetworkFaultChange Trait(网络故障变更)​

设备当前检测到的网络故障集的变化。

Trait IDCode
0x4E34NetworkFaultChange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNetworkFaultChangeTraitPresentValueStructureVO

RxBroadcastCount Trait(报文接收广播计数)​

接收到的唯一广播 MAC 帧总数。

Trait IDCode
0x4E33RxBroadcastCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO

RxUnicastCount Trait(报文接收单播计数)​

接收到的唯一单播 MAC 帧总数。

Trait IDCode
0x4E32RxUnicastCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO

TxTotalCount Trait(报文发送总计数)​

唯一 MAC 帧传输请求总数。

Trait IDCode
0x4E2ETxTotalCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO

TxUnicastCount Trait(报文发送单播计数)​

唯一单播 MAC 帧传输请求总数。

Trait IDCode
0x4E2FTxUnicastCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO

TxBroadcastCount Trait(报文发送广播计数)​

唯一广播 MAC 帧传输请求总数。

Trait IDCode
0x4E30TxBroadcastCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO

RxTotalCount Trait(报文接收总计数)​

接收到的唯一 MAC 帧总数。

Trait IDCode
0x4E31RxTotalCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO

PartitionId Trait(网络分区标识符)​

网络的 Leader Partition Id。

Trait IDCode
0x4E2DPartitionId
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO

OverrunCount Trait(溢出丢包计数)​

因缓冲区内存不足无法保留全部数据包而在入口或出口丢弃的数据包数量。

Trait IDCode
0x4E2COverrunCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVO
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO

AverageRssi Trait(平均信号强度指示)​

所有接收帧的平均 RSSI。

Trait IDCode
0x4E2BAverageRssi
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueint80RVO
0x0002Maximum Valueint80RO
0x0003Minimum Valueint8-128RO

NeighborTable Trait(邻居表)​

当前值应指示构成设备邻居表的当前设备列表。

Trait IDCode
0x8150NeighborTable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

RoutingRole Trait(路由角色)​

该 Trait 用于「路由角色」相关数据的访问与上报。

Trait IDCode
0x814FRoutingRole
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

RouteTable Trait(路由表)​

当前值应指示已建立路由的具备路由能力的设备当前列表。

Trait IDCode
0x814ERouteTable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

NetworkName Trait(网络名称)​

当前值应指示节点已配置加入的 Thread 网络的可读(可显示)名称。取值为 NULL 表示该接口当前未配置或未运行。

Trait IDCode
0x814DNetworkName
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

Channel Trait(无线信道)​

当前值指示 Zigbee 网络信道号。

Trait IDCode
0x814AChannel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO

ThreadPingResult Trait(Thread Ping 结果)​

表示对 Thread 设备执行 ping 操作的结果。值为结构体,包含目标 IP 地址(IpAddr,string)和状态码(StatusCode,uint8)。状态码为 0(成功)时,结构体还包含可选字段:AvgRoundTrip(平均 RTT,ms)、MaxRoundTrip(最大 RTT,ms)、MinRoundTrip(最小 RTT,ms)及 LossPercent(丢包率,0-100)。状态码非零(1 = 超时,2 = 忙)时,这些可选字段不存在。

Trait IDCode
0x5003ThreadPingResult
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueThreadPingResultTraitPresentValueStructureRVO

Command 定义​

本 Function 不包含 Command。

GarageDoorOpener(车库门控制器)​

简介​

提供车库门控制与状态反馈,包括开/关/停止及位置状态。

Function 标识​

Function IDCode名称
0x00B6GarageDoorOpener车库门控制器

Trait​

Trait IDCode名称Conformance
0x815CCurrentGarageDoorState当前(车库)门状态M
0x815DTargetGarageDoorState目标(车库)门状态M

Command​

Command IDCode名称Conformance
0x809AToggle开/关O

数据类型​

CurrentGarageDoorStateEnum8 Type​

该枚举定义 CurrentGarageDoorState Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Unknown未知
0x02Open打开
0x03Closed关闭
0x04Opening打开中
0x05Closing关闭中
0x06NotFullyOpen未完全打开
0x07NotFullyClosed未完全关闭
TargetGarageDoorStateEnum8 Type​

该枚举定义 TargetGarageDoorState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Closed关闭
0x01Open打开

Trait 定义​

Trait IDNameConformance
0x815CCurrentGarageDoorStateM
0x815DTargetGarageDoorStateM

CurrentGarageDoorState Trait(当前(车库)门状态)​

描述车库门当前状态。取值:1=Unknown,2=Open,3=Closed,4=Opening,5=Closing,6=Not Fully Open,7=Not Fully Closed。

Trait IDCode
0x815CCurrentGarageDoorState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCurrentGarageDoorStateEnum81RVM
0x0006Supported Valuelist[CurrentGarageDoorStateEnum8]RO

TargetGarageDoorState Trait(目标(车库)门状态)​

该 Trait 用于「目标(车库)门状态」相关数据的访问与上报。

Trait IDCode
0x815DTargetGarageDoorState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTargetGarageDoorStateEnum80RVWM
0x0006Supported Valuelist[TargetGarageDoorStateEnum8]RO
0x0007Default ValueTargetGarageDoorStateEnum80RWO

Command 定义​

Command IDNameConformance
0x809AToggleO

Toggle Command​

该 Command 用于执行「开/关」操作。

该 Command 无参数。

MatterBridgeCommissioning(MatterBridge分享给第三方Matter生态)​

简介​

管理 Matter Bridge 向第三方 Matter 生态分享桥接设备的能力。

Function 标识​

Function IDCode名称
0x00B7MatterBridgeCommissioningMatterBridge分享给第三方Matter生态

Trait​

Trait IDCode名称Conformance
0x815EMatterPairingSwitchMatter配对开关M
0x815FMatterDACStateMatter设备证书就绪状态M
0x8160MatterBindStateMatter绑定状态M
0x8161MatterOnboardingPayloadMatter二维码信息M
0x8162MatterManufacturerListMatter已绑定厂商列表M
0x8163MatterPairingStateMatter配对状态M
0x8164MatterBridgeSupported是否支持Matter桥接M

Command​

Command IDCode名称Conformance
0x88C5RemoveOneMatterManufacturerMatter Bridge移除某个Matter生态平台M
0x88C6RemoveAllMatterManufacturerMatter Bridge移除所有Matter生态平台M

数据类型​

MatterDACStateEnum8 Type​

该枚举定义 MatterDACState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00LoadingDACLoadingDAC
0x01FailedDACFailedDAC
0x02ReadyDACReadyDAC
MatterBindStateEnum8 Type​

该枚举定义 MatterBindState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00UnboundUnbound
0x01BoundBound
MatterPairingStateEnum8 Type​

该枚举定义 MatterPairingState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NonMatterPairingState非 Matter 配网状态
0x01MatterPairingStateMatter 配网状态
0x02LimitExceeded超出限制
0x03InvalidDAC无效设备认证证书
0x04UnderPreparation准备中
MatterBridgeSupportedEnum8 Type​

该枚举定义 MatterBridgeSupported 属性的 Present Value 有效取值。

ValueNameDescription
0FalseFalse
1TrueTrue

Trait 定义​

Trait IDNameConformance
0x815EMatterPairingSwitchM
0x815FMatterDACStateM
0x8160MatterBindStateM
0x8161MatterOnboardingPayloadM
0x8162MatterManufacturerListM
0x8163MatterPairingStateM
0x8164MatterBridgeSupportedM

MatterPairingSwitch Trait(Matter配对开关)​

写入 true 时在网桥上启动 Matter 配对模式;若未完成,10 分钟后自动退出配对。写入 false 时立即禁用配对。读取表示配对模式当前是否激活。取值:true = 进入配对,false = 关闭/禁用配对。

Trait IDCode
0x815EMatterPairingSwitch
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWM
0x0007Default Valueboolean0RWO

MatterDACState Trait(Matter设备证书就绪状态)​

指示 Matter 设备认证证书(DAC)的就绪状态。0:正在获取 DAC;1:DAC 获取失败;2:DAC 已就绪。

Trait IDCode
0x815FMatterDACState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMatterDACStateEnum80RVM
0x0006Supported Valuelist[MatterDACStateEnum8]RO

MatterBindState Trait(Matter绑定状态)​

指示设备的 Matter 绑定状态。0:尚未绑定任何 Matter 生态;1:已成功绑定至少一个 Matter 生态。

Trait IDCode
0x8160MatterBindState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMatterBindStateEnum80RVM
0x0006Supported Valuelist[MatterBindStateEnum8]RO

MatterOnboardingPayload Trait(Matter二维码信息)​

提供 Matter 配网所需的入网信息。值为 JSON 对象,包含 onboarding payload 字符串和手动配对码。示例:{"onboarding_payload":"MT:AR7A0OEP01C26Y2SQ10","manual_pairing_code":"0118-064-9202"}。

Trait IDCode
0x8161MatterOnboardingPayload
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

MatterManufacturerList Trait(Matter已绑定厂商列表)​

提供设备已绑定的 Matter 生态系统(fabric)列表。值为 JSON 数组,每个对象包含:vendor_id(十进制整数)、Manufacturer(显示名称字符串)、fabric(共享信任域标识符)、node_id(设备标识符字符串)。示例格式:{"list":[{"vendor_id":24582,"Manufacturer":"Google","fabric":"10001","node_id":"10001"}, ...]}。

Trait IDCode
0x8162MatterManufacturerList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

MatterPairingState Trait(Matter配对状态)​

指示当前 Matter 配对状态或错误原因。可能取值:0x00 = 未处于配对模式;0x01 = 正常配对模式激活;0x02 = 超出设备绑定上限(最多 10 个),请移除部分生态后重试;0x03 = 设备证书无效,请稍后重试;0x04 = 准备中,请稍后重试。

Trait IDCode
0x8163MatterPairingState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMatterPairingStateEnum80RVM
0x0006Supported Valuelist[MatterPairingStateEnum8]RO

MatterBridgeSupported Trait(是否支持Matter桥接)​

指示当前网关版本是否支持 Matter Bridge 功能。若为 true,App 可在设备详情中显示"Start Matter Journey"入口和"Bind Matter"选项;若为 false,则隐藏此类入口。值:false = 不支持,true = 支持。

Trait IDCode
0x8164MatterBridgeSupported
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM

Command 定义​

Command IDNameConformance
0x88C5RemoveOneMatterManufacturerM
0x88C6RemoveAllMatterManufacturerM

RemoveOneMatterManufacturer Command​

该 Command 用于执行「Matter Bridge移除某个Matter生态平台」操作。

该 Command 无参数。

RemoveAllMatterManufacturer Command​

该 Command 用于执行「Matter Bridge移除所有Matter生态平台」操作。

该 Command 无参数。

MARSConfiguration(智能负载配置)​

简介​

提供智能负载(MARS)相关配置,用于负载识别与智能配电管理。

Function 标识​

Function IDCode名称
0x00B8MARSConfiguration智能负载配置

Trait​

Trait IDCode名称Conformance
0x816BLoadType负载类型M
0x816CMarsSmartLoadList负载设备列表O
0x816DPulseDuration脉宽时长O
0x5113EnableMarsForceOff智能负载强制关闭O

Command​

本 Function 不包含 Command。

数据类型​

LoadTypeEnum8 Type​

该枚举定义 LoadType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unspecified未定义
0x01Linkable智能负载
0x02Pulsed脉冲控制
MarsSmartLoadListTraitPresentValueStructure Type​

该结构体定义 MarsSmartLoadList Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0DeviceIDcharacterStringM目标负载灯设备 ID。
1PointPathcharacterStringM目标负载灯设备里的开关控制状态数据点的访问路径,包含 Endpoint ID、Function ID、Trait ID、Parameter ID,用 . 分隔,例如 2.132.32920.1。
2SubscribeRecordIduint32O该字段只适用于Zigbee协议的开关设备,表示开关设备已保存的和目标负载灯设备之间所需的数据订阅记录 ID。
3GroupIduint16O该字段只适用于Zigbee协议的开关设备,表示火星技术智能负载模式时目标负载灯设备所属的设备组 ID。

Trait 定义​

Trait IDNameConformance
0x816BLoadTypeM
0x816CMarsSmartLoadListO
0x816DPulseDurationO
0x5113EnableMarsForceOffO

LoadType Trait(负载类型)​

描述连接到开关的负载类型。0:Unspecified(未定义),1:Linkable(智能负载),2:Pulsed(脉冲控制)。

Trait IDCode
0x816BLoadType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLoadTypeEnum80RVWM
0x0006Supported Valuelist[LoadTypeEnum8]RO
0x0007Default ValueLoadTypeEnum80RWO

MarsSmartLoadList Trait(负载设备列表)​

用于查询可与智能负载联动的设备列表。目前仅支持部分照明设备。

Trait IDCode
0x816CMarsSmartLoadList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[MarsSmartLoadListTraitPresentValueStructure]RVWO
0x000FMax Item Numuint32RO

PulseDuration Trait(脉宽时长)​

定义脉冲负载的脉冲持续时间。单位:ms。

Trait IDCode
0x816DPulseDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16200RVWO
0x0002Maximum Valueuint163000RO
0x0003Minimum Valueuint16200RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16200RWO

EnableMarsForceOff Trait(智能负载强制关闭)​

用于控制是否启用 MARS 强制关闭能力。

Trait IDCode
0x5113EnableMarsForceOff
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

Command 定义​

本 Function 不包含 Command。

CustomizedConfiguration(自定义配置)​

简介​

提供厂商或用户自定义扩展配置项的读写能力。

Function 标识​

Function IDCode名称
0x00B9CustomizedConfiguration自定义配置

Trait​

Trait IDCode名称Conformance
0x816EEnableIndicator指示灯使能O
0x8099StartUpOnOff上电开关O

Command​

本 Function 不包含 Command。

数据类型​

StartUpOnOffEnum8 Type​

该枚举定义 StartUpOnOff Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off上电关闭
0x01On上电开启
0x02Toggle上电反转
0x03Hold上电记忆

Trait 定义​

Trait IDNameConformance
0x816EEnableIndicatorO
0x8099StartUpOnOffO

EnableIndicator Trait(指示灯使能)​

该 Trait 用于「指示灯使能」相关数据的访问与上报。

Trait IDCode
0x816EEnableIndicator
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuetlvRVWO

StartUpOnOff Trait(上电开关)​

定义设备上电时一组自定义配置参数的启动行为(例如恢复用户自定义配置)。可能覆盖默认 OnOff 行为。

Trait IDCode
0x8099StartUpOnOff
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStartUpOnOffEnum8RVWO
0x0006Supported Valuelist[StartUpOnOffEnum8]RO
0x0007Default ValueStartUpOnOffEnum80RWO

Command 定义​

本 Function 不包含 Command。

FreshAirControl(新风控制)​

简介​

提供新风系统控制能力,支持引入室外空气并进行风量、模式等调节。

Function 标识​

Function IDCode名称
0x00BAFreshAirControl新风控制

Trait​

Trait IDCode名称Conformance
0x4E27FreshAirMode新风模式M
0x515CFreshAirBrand新风品牌O
0x515DFilterRemainingDuration滤网剩余使用时长O
0x5162FreshAirErrorCode新风故障码O
0x5166FilterRemainingPercent滤网剩余百分比O

Command​

本 Function 不包含 Command。

数据类型​

FreshAirModeEnum8 Type​

该枚举定义 FreshAirMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Manual手动
0x01Auto自动
0x02Exhaust排风
0x03HeatExchange热交换
0x04InternalCirculation内循环
0x05ExternalCirculation外循环
0x06PowerSaving省电
0x07Strong强劲
0x08FreshAir新风
0x09Bypass旁通

Trait 定义​

Trait IDNameConformance
0x4E27FreshAirModeM
0x515CFreshAirBrandO
0x515DFilterRemainingDurationO
0x5162FreshAirErrorCodeO
0x5166FilterRemainingPercentO

FreshAirMode Trait(新风模式)​

该特征定义新风模式。

Trait IDCode
0x4E27FreshAirMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFreshAirModeEnum80RVWM
0x0006Supported Valuelist[FreshAirModeEnum8]RO
0x0007Default Valueuint80RWO

FreshAirBrand Trait(新风品牌)​

表示当前温控器所连接的新风(通风)系统的品牌名称。该值为可读文本字符串。

Trait IDCode
0x515CFreshAirBrand
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

FilterRemainingDuration Trait(滤网剩余使用时长)​

表示系统中滤网的剩余有效使用寿命,以秒为单位。该值由设备根据实际运行时间或使用情况动态更新,并定期上报。当值降至 0 时,表示滤网已耗尽,需要进行更换或清洗。

Trait IDCode
0x515DFilterRemainingDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

FreshAirErrorCode Trait(新风故障码)​

表示新风设备的故障代码,用于诊断运行异常。该值为可读文本字符串。

Trait IDCode
0x5162FreshAirErrorCode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

FilterRemainingPercent Trait(滤网剩余百分比)​

表示滤网剩余有效使用寿命的百分比,100 表示滤网为全新状态,0 表示滤网已完全耗尽,需要进行更换或清洗。该值由设备根据实际运行时间或使用情况计算并上报。

Trait IDCode
0x5166FilterRemainingPercent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat100RVO
0x0002Maximum Valuefloat100RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat1RO
0x0007Default Valuefloat100RWO

Command 定义​

本 Function 不包含 Command。

ScreenDisplay(屏幕显示)​

简介​

管理屏幕显示相关硬件属性,如分辨率、亮度、背光及显示状态。

Function 标识​

Function IDCode名称
0x00BBScreenDisplay屏幕显示

Trait​

Trait IDCode名称Conformance
0x4FF7ScreenOnOff熄屏亮屏开关O
0x519AThemeSquareSupport是否支持主题广场O
0x813CDisplayLocale屏幕显示语言O
0x8139DNDTimePeriod勿扰时间段O
0x8138EnableDNDMode勿扰模式使能O
0x4E36ScreenBrightness屏幕亮度O
0x507DSupportsDslConfig是否支持DSL配置能力O
0x50F2StandbyTimeout待机时间设置O
0x50F3KeyToneEnable屏幕按键音使能O
0x50F4ThemeUpdateFlag主题更新标记O
0x50F5CurrentThemeSetting当前主题设置O
0x50F6WallpaperSetting壁纸设置O
0x50F7AlwaysOnInStandby待机常亮使能O
0x517ADarkScreenOffEnable黑暗息屏使能O
0x517BWakeUpScreenSetting唤醒界面设置O
0x5100WakeDistanceSetting智能唤醒距离设置O
0x5102SmartWakeEnabled智能唤醒使能O
0x4EE2ScreensaverStyle屏保样式O

Command​

Command IDCode名称Conformance
0x9D46DownloadDSL下载DSLO
0x9D9CDownloadDSLResponse下载DSL响应结果O
0x9DAFDeliverThemeResource主题资源包下发O
0x9DB0DeliverThemeResourceResponse主题资源包下发响应结果O
0x9D5DDeviceDataRefresh设备数据刷新O
0x9D5CTriggerWeatherUpdate触发更新天气数据O
0x9DB2ClearPanelConfig清除面板配置O

数据类型​

ScreensaverStyleEnum32 Type​

该枚举定义 ScreensaverStyle Trait 的 Present Value 有效取值。

ValueNameDescription
0x00DigitalClock数字时钟
0x01FamousArt名画
0x02PhotoAlbum相册
0x03AnalogClock模拟时钟
0x04Weather天气
0x05RhythmNotes律动音符
0x06Environment环境
0x07WeatherUpdates动态天气
0x08Cat猫
0x09ColorNumbers彩色数字
WakeDistanceSettingEnum32 Type​

该枚举定义 WakeDistanceSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Level00
0x01Level1档位1
0x02Level2档位2
0x03Level3档位3
0x04Level4档位4
0x05Level5档位5
0x06Level6档位6
0x07Level7档位7
0x08Level8档位8
0x09Level9档位9
0x0ALevel10档位10
WakeUpScreenSettingEnum8 Type​

该枚举定义 WakeUpScreenSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Home进入主页
0x01Screensaver进入屏保
ClearPanelConfigTypeEnum8 Type​

该枚举定义 ClearPanelConfig Command 支持清除的面板配置类型。

ValueNameDescription
0x01ClearHomeDSL清除主页DSL
ClearPanelConfig Command Structure Type​

ClearPanelConfig Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ConfigTypeClearPanelConfigTypeEnum8M要清除的面板配置类型。

DownloadDSLConfigItem Structure Type​

DownloadDSL Command 单个 DSL 配置项结构体。

结构体成员序号字段名类型必须说明
0UrlcharacterStringM配置文件下载 URL。
1Md5characterStringM文件 MD5(32 位十六进制字符串)。
2Ordint32M顺序索引,用于按顺序应用配置。
3IdcharacterStringM配置唯一标识符。
4PreviewUrlcharacterStringO屏保配置预览图在云文件服务上的相对路径。主屏配置项应省略或置空。

DownloadDSL Command Structure Type​

DownloadDSL Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Itemslist[DownloadDSLConfigItem Structure]O主屏 DSL 配置项列表。
1ScreensaverItemslist[DownloadDSLConfigItem Structure]O屏保 DSL 配置项列表。

DownloadDSLResponseResultItem Structure Type​

DownloadDSLResponse Command 单个配置项处理结果结构体。

结构体成员序号字段名类型必须说明
0IdcharacterStringM配置唯一标识符(与请求中的 id 对应)。
1ResultCodeint32M结果码:0 表示成功,-1 表示失败。
2ErrorMessagecharacterStringO错误信息;通常仅在 ResultCode 为 -1 时返回。

DownloadDSLResponse Structure Type​

DownloadDSLResponse Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Itemslist[DownloadDSLResponseResultItem Structure]O主屏 DSL 配置项处理结果列表,顺序应与请求中的 Items 保持一致。
1ScreensaverItemslist[DownloadDSLResponseResultItem Structure]O屏保 DSL 配置项处理结果列表,顺序应与请求中的 ScreensaverItems 保持一致。
DeliverThemeResource Command Structure Type​

DeliverThemeResource Command 的参数结构体。

结构体成员序号字段名类型必须说明
0IdcharacterStringM本次主题资源包下发的通讯标识(主题 ID 标识)。
1VersioncharacterStringM该资源包对应的主题版本号。
2PathcharacterStringM主题资源 zip/bin 包在服务器(主题广场)的文件相对路径。
3HashcharacterStringM主题包文件校验标识(MD5/Hash)。
DeliverThemeResourceResponse Command Structure Type​

DeliverThemeResourceResponse Command 的参数结构体。

结构体成员序号字段名类型必须说明
0IdcharacterStringM此次主题资源包下发的通讯标识(与请求中的 Id 对应)。
1ResultCodeint32M处理结果码:0 表示成功,-1 表示失败。
2ErrorMessagecharacterStringO失败原因描述;成功时应省略。
DeviceDataRefresh Command Structure Type​

DeviceDataRefresh Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Actionenum8M动作;默认值为 1。
TriggerWeatherUpdate Command Structure Type​

TriggerWeatherUpdate Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Actionenum8M动作;默认值为 1。

Trait 定义​

Trait IDNameConformance
0x4FF7ScreenOnOffO
0x519AThemeSquareSupportO
0x813CDisplayLocaleO
0x8139DNDTimePeriodO
0x8138EnableDNDModeO
0x4E36ScreenBrightnessO
0x507DSupportsDslConfigO
0x50F2StandbyTimeoutO
0x50F3KeyToneEnableO
0x50F4ThemeUpdateFlagO
0x50F5CurrentThemeSettingO
0x50F6WallpaperSettingO
0x50F7AlwaysOnInStandbyO
0x517ADarkScreenOffEnableO
0x517BWakeUpScreenSettingO
0x5100WakeDistanceSettingO
0x5102SmartWakeEnabledO
0x4EE2ScreensaverStyleO

ScreenOnOff Trait(熄屏亮屏开关)​

通过布尔值控制显示屏电源状态:0 表示立即熄屏(背光完全关闭),1 表示亮屏并恢复上一帧画面。

Trait IDCode
0x4FF7ScreenOnOff
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanO0RVWO
0x0007Default ValuebooleanO0RWO

ThemeSquareSupport Trait(是否支持主题广场)​

表示屏设备是否支持主题广场功能。true 表示支持,false 表示不支持。该 Trait 为只读、可上报,由设备根据自身能力上报。

Trait IDCode
0x519AThemeSquareSupport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO
0x0007Default Valueboolean0RWO

DisplayLocale Trait(屏幕显示语言)​

该 Trait 用于「屏幕显示语言」相关数据的访问与上报,表示语言-地区代码,遵循 RFC 5646 (BCP 47) 标准。

语言代码语言名称
af南非语
af-ZA南非语
ar阿拉伯语
ar-AE阿拉伯语(阿联酋)
ar-BH阿拉伯语(巴林)
ar-DZ阿拉伯语(阿尔及利亚)
ar-EG阿拉伯语(埃及)
ar-IQ阿拉伯语(伊拉克)
ar-JO阿拉伯语(约旦)
ar-KW阿拉伯语(科威特)
ar-LB阿拉伯语(黎巴嫩)
ar-LY阿拉伯语(利比亚)
ar-MA阿拉伯语(摩洛哥)
ar-OM阿拉伯语(阿曼)
ar-QA阿拉伯语(卡塔尔)
ar-SA阿拉伯语(沙特阿拉伯)
ar-SY阿拉伯语(叙利亚)
ar-TN阿拉伯语(突尼斯)
ar-YE阿拉伯语(也门)
az阿塞拜疆语
az-AZ阿塞拜疆语(拉丁文)
az-AZ阿塞拜疆语(西里尔文)
be比利时语
be-BY比利时语
bg保加利亚语
bg-BG保加利亚语
bs-BA波斯尼亚语(拉丁文,波斯尼亚和黑塞哥维那)
ca加泰隆语
ca-ES加泰隆语
cs捷克语
cs-CZ捷克语
cy威尔士语
cy-GB威尔士语
da丹麦语
da-DK丹麦语
de德语
de-AT德语(奥地利)
de-CH德语(瑞士)
de-DE德语(德国)
de-LI德语(列支敦士登)
de-LU德语(卢森堡)
dv第维埃语
dv-MV第维埃语
el希腊语
el-GR希腊语
en英语
en-AU英语(澳大利亚)
en-BZ英语(伯利兹)
en-CA英语(加拿大)
en-CB英语(加勒比海)
en-GB英语(英国)
en-IE英语(爱尔兰)
en-JM英语(牙买加)
en-NZ英语(新西兰)
en-PH英语(菲律宾)
en-TT英语(特立尼达)
en-US英语(美国)
en-ZA英语(南非)
en-ZW英语(津巴布韦)
eo世界语
es西班牙语
es-AR西班牙语(阿根廷)
es-BO西班牙语(玻利维亚)
es-CL西班牙语(智利)
es-CO西班牙语(哥伦比亚)
es-CR西班牙语(哥斯达黎加)
es-DO西班牙语(多米尼加共和国)
es-EC西班牙语(厄瓜多尔)
es-ES西班牙语(传统)
es-ES西班牙语(国际)
es-GT西班牙语(危地马拉)
es-HN西班牙语(洪都拉斯)
es-MX西班牙语(墨西哥)
es-NI西班牙语(尼加拉瓜)
es-PA西班牙语(巴拿马)
es-PE西班牙语(秘鲁)
es-PR西班牙语(波多黎各(美))
es-PY西班牙语(巴拉圭)
es-SV西班牙语(萨尔瓦多)
es-UY西班牙语(乌拉圭)
es-VE西班牙语(委内瑞拉)
et爱沙尼亚语
et-EE爱沙尼亚语
eu巴士克语
eu-ES巴士克语
fa法斯语
fa-IR法斯语
fi芬兰语
fi-FI芬兰语
fo法罗语
fo-FO法罗语
fr法语
fr-BE法语(比利时)
fr-CA法语(加拿大)
fr-CH法语(瑞士)
fr-FR法语(法国)
fr-LU法语(卢森堡)
fr-MC法语(摩纳哥)
gl加里西亚语
gl-ES加里西亚语
gu古吉拉特语
gu-IN古吉拉特语
he希伯来语
he-IL希伯来语
hi印地语
hi-IN印地语
hr克罗地亚语
hr-BA克罗地亚语(波斯尼亚和黑塞哥维那)
hr-HR克罗地亚语
hu匈牙利语
hu-HU匈牙利语
hy亚美尼亚语
hy-AM亚美尼亚语
id印度尼西亚语
id-ID印度尼西亚语
is冰岛语
is-IS冰岛语
it意大利语
it-CH意大利语(瑞士)
it-IT意大利语(意大利)
ja日语
ja-JP日语
ka格鲁吉亚语
ka-GE格鲁吉亚语
kk哈萨克语
kk-KZ哈萨克语
kn卡纳拉语
kn-IN卡纳拉语
ko朝鲜语
ko-KR朝鲜语(南朝鲜、韩语)
kok孔卡尼语
kok-IN孔卡尼语
ky吉尔吉斯语
ky-KG吉尔吉斯语(西里尔文)
lt立陶宛语
lt-LT立陶宛语
lv拉脱维亚语
lv-LV拉脱维亚语
mi毛利语
mi-NZ毛利语
mk马其顿语
mk-MK马其顿语(FYROM)
mn蒙古语
mn-MN蒙古语(西里尔文)
mr马拉地语
mr-IN马拉地语
ms马来语
ms-BN马来语(文莱达鲁萨兰)
ms-MY马来语(马来西亚)
mt马耳他语
mt-MT马耳他语
nb挪威语(伯克梅尔)
nb-NO挪威语(伯克梅尔)(挪威)
nl荷兰语
nl-BE荷兰语(比利时)
nl-NL荷兰语(荷兰)
nn-NO挪威语(尼诺斯克)(挪威)
ns北梭托语
ns-ZA北梭托语
pa旁遮普语
pa-IN旁遮普语
pl波兰语
pl-PL波兰语
pt葡萄牙语
pt-BR葡萄牙语(巴西)
pt-PT葡萄牙语(葡萄牙)
qu克丘亚语
qu-BO克丘亚语(玻利维亚)
qu-EC克丘亚语(厄瓜多尔)
qu-PE克丘亚语(秘鲁)
ro罗马尼亚语
ro-RO罗马尼亚语
ru俄语
ru-RU俄语
sa梵文
sa-IN梵文
se北萨摩斯语
se-FI北萨摩斯语(芬兰)
se-FI斯科特萨摩斯语(芬兰)
se-FI伊那里萨摩斯语(芬兰)
se-NO北萨摩斯语(挪威)
se-NO律勒欧萨摩斯语(挪威)
se-NO南萨摩斯语(挪威)
se-SE北萨摩斯语(瑞典)
se-SE律勒欧萨摩斯语(瑞典)
se-SE南萨摩斯语(瑞典)
sk斯洛伐克语
sk-SK斯洛伐克语
sl斯洛文尼亚语
sl-SI斯洛文尼亚语
sq阿尔巴尼亚语
sq-AL阿尔巴尼亚语
sr-BA塞尔维亚语(拉丁文,波斯尼亚和黑塞哥维那)
sr-BA塞尔维亚语(西里尔文,波斯尼亚和黑塞哥维那)
sr-SP塞尔维亚(拉丁)
sr-SP塞尔维亚(西里尔文)
sv瑞典语
sv-FI瑞典语(芬兰)
sv-SE瑞典语
sw斯瓦希里语
sw-KE斯瓦希里语
syr叙利亚语
syr-SY叙利亚语
ta泰米尔语
ta-IN泰米尔语
te泰卢固语
te-IN泰卢固语
th泰语
th-TH泰语
tl塔加路语
tl-PH塔加路语(菲律宾)
tn茨瓦纳语
tn-ZA茨瓦纳语
tr土耳其语
tr-TR土耳其语
ts宗加语
tt鞑靼语
tt-RU鞑靼语
uk乌克兰语
uk-UA乌克兰语
ur乌都语
ur-PK乌都语
uz乌兹别克语
uz-UZ乌兹别克语(拉丁文)
uz-UZ乌兹别克语(西里尔文)
vi越南语
vi-VN越南语
xh班图语
xh-ZA班图语
zh中文
zh-CN中文(简体)
zh-HK中文(香港)
zh-MO中文(澳门)
zh-SG中文(新加坡)
zh-TW中文(繁体)
zu祖鲁语
zu-ZA祖鲁语
Trait IDCode
0x813CDisplayLocale
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

DNDTimePeriod Trait(勿扰时间段)​

该 Trait 用于定义针对屏幕显示的勿扰时间段(Do Not Disturb Time Period)。

该 Trait 在本 Function 中复用,完整定义请参见 IndicationLight Function 下的 DNDTimePeriod。

Trait IDCode
0x8139DNDTimePeriod

EnableDNDMode Trait(勿扰模式使能)​

该 Trait 用于控制是否启用针对屏幕显示的勿扰模式(Do Not Disturb Mode)。

该 Trait 在本 Function 中复用,完整定义请参见 IndicationLight Function 下的 EnableDNDMode。

Trait IDCode
0x8138EnableDNDMode

ScreenBrightness Trait(屏幕亮度)​

控制屏幕亮度级别的特质,值范围为1%到100%。

Trait IDCode
0x4E36ScreenBrightness
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default ValuefloatO50RWO

SupportsDslConfig Trait(是否支持DSL配置能力)​

指示设备是否支持 DSL(Domain‑Specific Language)配置。值 true 表示设备可解析并应用基于 DSL 的配置;false 表示不支持该能力。

Trait IDCode
0x507DSupportsDslConfig
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanO0RVO
0x0007Default ValuebooleanO0RWO

StandbyTimeout Trait(待机时间设置)​

该 Trait 用于设置屏幕自动进入待机的超时时间,单位为秒。0 表示永不自动待机。

Trait IDCode
0x50F2StandbyTimeout
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1615RVWO
0x0002Maximum Valueuint163600RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint325RO
0x0007Default Valueuint1615RWO

KeyToneEnable Trait(屏幕按键音使能)​

该 Trait 用于控制屏幕按键音开关。0 表示关闭,1 表示开启。

Trait IDCode
0x50F3KeyToneEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ThemeUpdateFlag Trait(主题更新标记)​

该 Trait 表示主题更新标记值。若下发值大于当前值,表示存在可用的新主题更新。

Trait IDCode
0x50F4ThemeUpdateFlag
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

CurrentThemeSetting Trait(当前主题设置)​

该 Trait 用于表示当前主题设置值,采用高 16 位为 themeId、低 16 位为 version 的编码方式。

Trait IDCode
0x50F5CurrentThemeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

WallpaperSetting Trait(壁纸设置)​

该 Trait 用于表示当前壁纸类型设置值:1-9 为本地主题,10 为相册,11-20 为云端主题,21 以上为云端壁纸。

Trait IDCode
0x50F6WallpaperSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

AlwaysOnInStandby Trait(待机常亮使能)​

该 Trait 用于控制待机/屏保状态下是否常亮。0 表示关闭(默认值),1 表示开启。

Trait IDCode
0x50F7AlwaysOnInStandby
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

DarkScreenOffEnable Trait(黑暗息屏使能)​

黑暗息屏使能。启用或禁用黑暗息屏功能。当该功能开启时,若环境光线变暗且低于预设阈值,屏幕将自动熄屏以节省电量并提升观看舒适度;关闭时,屏幕不会因环境变暗而自动熄屏。取值:0 = False(关闭),1 = True(开启)。

Trait IDCode
0x517ADarkScreenOffEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

WakeUpScreenSetting Trait(唤醒界面设置)​

唤醒界面设置。用于设置屏幕从唤醒界面唤醒后自动进入的界面,可配置为进入主页或进入屏保。取值:0 = 进入主页,1 = 进入屏保。

Trait IDCode
0x517BWakeUpScreenSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWakeUpScreenSettingEnum80RVWO
0x0006Supported Valuelist[WakeUpScreenSettingEnum8]RO
0x0007Default Valueuint80RWO

WakeDistanceSetting Trait(智能唤醒距离设置)​

设置智能唤醒距离/灵敏度档位。

Trait IDCode
0x5100WakeDistanceSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWakeDistanceSettingEnum328RVWO
0x0006Supported Valuelist[WakeDistanceSettingEnum32]RO
0x0007Default Valueuint328RWO

SmartWakeEnabled Trait(智能唤醒使能)​

启用或禁用智能唤醒功能。

Trait IDCode
0x5102SmartWakeEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ScreensaverStyle Trait(屏保样式)​

该 Trait 用于「屏保样式」相关数据的访问与上报。

Trait IDCode
0x4EE2ScreensaverStyle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueScreensaverStyleEnum320RVWO
0x0006Supported Valuelist[ScreensaverStyleEnum32]RO
0x0007Default Valueuint320RWO

Command 定义​

Command IDNameConformance
0x9D46DownloadDSLO
0x9D9CDownloadDSLResponseO
0x9DAFDeliverThemeResourceO
0x9DB0DeliverThemeResourceResponseO
0x9D5DDeviceDataRefreshO
0x9D5CTriggerWeatherUpdateO
0x9DB2ClearPanelConfigO

DownloadDSL Command​

该命令用于批量下载 DSL(领域特定语言)配置文件,支持主屏与屏保两类配置项同时下发。

设备应下载每个配置文件,使用 MD5 校验完整性,并按 ord 指定顺序应用配置。

参数​

DownloadDSL Command Structure

上行结果​

设备完成下载与应用后,SHALL 通过 DownloadDSLResponse Command 上报各配置项处理结果。

DownloadDSLResponse Command​

该命令用于上报 DownloadDSL 各配置项的处理结果,支持主屏与屏保两类配置项分别返回。

参数​

DownloadDSLResponse Structure

DeliverThemeResource Command​

主题资源包下发。服务端通过该命令(invokeCommand,下发为 request)通知屏端前往指定文件路径下载主题资源包,并携带通讯标识、主题版本号及文件校验标识(MD5/Hash)等信息。屏端收到后根据提供信息下载并校验资源包。

参数​

DeliverThemeResource Command Structure

上行结果​

屏端完成下载、校验和应用后,SHALL 通过 DeliverThemeResourceResponse Command 上报处理结果。

DeliverThemeResourceResponse Command​

主题资源包下发响应结果。用于屏端接收到主题资源包下发数据后,根据资源包下载、校验和应用结果,以 invokeCommand 的 response 方式向服务端上报处理结果。

参数​

DeliverThemeResourceResponse Command Structure

DeviceDataRefresh Command​

该命令指示屏端设备(启动器)全面刷新数据,包括从服务端重新请求当前仪表盘列表、卡片数据及其他相关信息。收到该命令后,设备应获取最新数据并相应更新显示。

参数​

DeviceDataRefresh Command Structure

TriggerWeatherUpdate Command​

该命令触发设备立即从已配置的天气服务更新天气数据。

参数​

TriggerWeatherUpdate Command Structure

ClearPanelConfig Command​

清除面板配置。用户确认清除后,设备应清除 ConfigType 指定类型的面板配置内容。当前支持清除屏端首页 DSL 配置,后续可扩展其他配置类型。

参数​

ClearPanelConfig Command Structure

ValveControl(阀门控制)​

简介​

提供阀门自动控制或手动控制能力,用于精确调节水/气流量。

Function 标识​

Function IDCode名称
0x00BCValveControl阀门控制

Trait​

Trait IDCode名称Conformance
0x4E46RemainingDuration剩余时间O
0x4E47CurrentValveState当前阀门状态O
0x4E5DDefaultOpenDuration默认阀门打开时间O

Command​

Command IDCode名称Conformance
0x9C44Close关闭O
0x9C43Open打开O
0x9C45OpenWithDuration打开并保持指定时间O

数据类型​

CurrentValveStateEnum8 Type​

该枚举定义 CurrentValveState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Closed关闭
0x01Open打开
0x02Transitioning过渡
OpenWithDuration Command Structure Type​

OpenWithDuration Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PresentValuefloatM当前值;默认值为 1。

Trait 定义​

Trait IDNameConformance
0x4E46RemainingDurationO
0x4E47CurrentValveStateO
0x4E5DDefaultOpenDurationO

RemainingDuration Trait(剩余时间)​

RemainingDuration 指阀在自动关闭之前将继续运行的剩余时,单位:S。

Trait IDCode
0x4E46RemainingDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO0RVWO
0x0002Maximum Valuefloat100000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default ValuefloatO0RWO
0x000DIs NullbooleanFalseRVWO

CurrentValveState Trait(当前阀门状态)​

CurrentValveState 表示阀门当前的工作状态。

Trait IDCode
0x4E47CurrentValveState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCurrentValveStateEnum80RVO
0x0006Supported Valuelist[CurrentValveStateEnum8]RO

DefaultOpenDuration Trait(默认阀门打开时间)​

DefaultOpenDuration 表示若 OpenDuration 字段未指定时,阀门保持开启的默认时长(秒)。

Trait IDCode
0x4E5DDefaultOpenDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO1RVWO
0x0002Maximum Valuefloat100000.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default ValuefloatO1RWO

Command 定义​

Command IDNameConformance
0x9C44CloseO
0x9C43OpenO
0x9C45OpenWithDurationO

Close Command​

关闭命令

该 Command 无参数。

Open Command​

打开命令。

该 Command 无参数。

OpenWithDuration Command​

按时长打开。

参数​

OpenWithDuration Command Structure

FilterMonitoring(滤芯监控)​

简介​

持续监测各类滤芯(如 HEPA、活性炭)的使用状态与剩余寿命。

Function 标识​

Function IDCode名称
0x00BDFilterMonitoring滤芯监控

Trait​

Trait IDCode名称Conformance
0x4E4AFilterType滤芯类型M
0x4E49ChangeIndication滤芯寿命状态M
0x4E48Condition滤芯剩余寿命O

Command​

Command IDCode名称Conformance
0x9C46ResetCondition重置滤芯O

数据类型​

FilterTypeEnum8 Type​

该枚举定义 FilterType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00HEPAHEPA
0x01Activated Carbon活性炭
0x02Photocatalytic光触媒
0x03UV紫外线
ChangeIndicationEnum8 Type​

该枚举定义 ChangeIndication Trait 的 Present Value 有效取值。

ValueNameDescription
0x00OKOK
0x01Warming警告
0x02Critical紧急

Trait 定义​

Trait IDNameConformance
0x4E4AFilterTypeM
0x4E49ChangeIndicationM
0x4E48ConditionO

FilterType Trait(滤芯类型)​

FilterType 定义了滤芯类型.

Trait IDCode
0x4E4AFilterType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFilterTypeEnum80RVM
0x0006Supported Valuelist[FilterTypeEnum8]RO

ChangeIndication Trait(滤芯寿命状态)​

ChangeIndication 定义了滤芯寿命的状态.

Trait IDCode
0x4E49ChangeIndication
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueChangeIndicationEnum80RVM
0x0006Supported Valuelist[ChangeIndicationEnum8]RO
0x0007Default Valueuint80RWO

Condition Trait(滤芯剩余寿命)​

表示滤芯剩余寿命,单位为百分比%

Trait IDCode
0x4E48Condition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat100RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat100RWO

Command 定义​

Command IDNameConformance
0x9C46ResetConditionO

ResetCondition Command​

ResetCondition表示重置滤芯。

该 Command 无参数。

OperationalState(设备状态)​

简介​

描述设备当前运行状态,如空闲、运行中、暂停、故障等。

Function 标识​

Function IDCode名称
0x00BEOperationalState设备状态

Trait​

Trait IDCode名称Conformance
0x4E4COperationalError设备报错M
0x4E4BOperationalState设备状态M

Command​

Command IDCode名称Conformance
0x9C47Start启动O
0x80C5Stop停止O
0x80C4Pause暂停O
0x9C48Resume恢复O

数据类型​

OperationalErrorEnum16 Type​

该枚举定义 OperationalError Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NoError无错误
0x01UnableToStartOrResume无法开始或恢复
0x02UnableToCompleteOperation无法完成操作
0x03CommandInvalidInState状态下命令无效
OperationalStateEnum16 Type​

该枚举定义 OperationalState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Stopped停止
0x01Running运行中
0x02Paused暂停
0x03Error错误

Trait 定义​

Trait IDNameConformance
0x4E4COperationalErrorM
0x4E4BOperationalStateM

OperationalError Trait(设备报错)​

OperationalError 指设备或系统无法执行其预期 functi

Trait IDCode
0x4E4COperationalError
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOperationalErrorEnum160RVM
0x0006Supported Valuelist[OperationalErrorEnum16]RO
0x0007Default Valueuint160RWO

OperationalState Trait(设备状态)​

OperationalState 指设备的当前功能状态或工况,指示其活动或空闲状态。It defin

Trait IDCode
0x4E4BOperationalState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOperationalStateEnum160RVM
0x0006Supported Valuelist[OperationalStateEnum16]RO
0x0007Default Valueuint160RWO

Command 定义​

Command IDNameConformance
0x9C47StartO
0x80C5StopO
0x80C4PauseO
0x9C48ResumeO

Start Command​

启动

该 Command 无参数。

Stop Command​

该命令应请求设备停止当前操作。

该 Command 无参数。

Pause Command​

该 Command 用于执行「暂停」操作。

该 Command 无参数。

Resume Command​

恢复

该 Command 无参数。

Flow(流量)​

简介​

测量并上报液体或气体的流量速率。

Function 标识​

Function IDCode名称
0x00BFFlow流量

Trait​

Trait IDCode名称Conformance
0x4E4DCurrentFlow当前流量M
0x51BECumulativeFlow流量累计O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4E4DCurrentFlowM
0x51BECumulativeFlowO

CurrentFlow Trait(当前流量)​

CurrentFlow表示当前流量值,单位为 m^3/h。

Trait IDCode
0x4E4DCurrentFlow
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat65535.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

CumulativeFlow Trait(流量累计)​

表示当前计数器代际内流量计记录的累计通过量,用于统计介质总输送量和历史用量变化。单位:m^3。设备重启不得清零读数或代际;复位、无法补偿的回卷或流量计更换须递增 Counter Generation。

Trait IDCode
0x51BECumulativeFlow
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat100000000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

Mode(模式)​

简介​

提供设备特性模式接口,支持在多种预定义模式间切换。

Function 标识​

Function IDCode名称
0x00C0Mode模式

Trait​

Trait IDCode名称Conformance
0x4E4ECurrentMode当前模式M
0x4E4FChangeToModeResponse模式切换反馈M

Command​

Command IDCode名称Conformance
0x9C4DChangeToMode修改模式M

数据类型​

ChangeToModeResponseEnum16 Type​

该枚举定义 ChangeToModeResponse Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Success成功
0x01UnsupportedMode不支持的模式
0x02GenericFailure一般故障
0x03InvalidInMode模式下无效
0x41Stuck被卡住
0x42DustBinMissing尘盒缺失
0x43DustBinFull尘盒已满
0x44WaterTankEmpty水箱为空
0x45WaterTankMissing水箱缺失
0x46WaterTankLidOpen水箱盖未关闭
0x47MopCleaningPadMissing拖布清洁垫缺失
0x48BatteryLow电池电量低
ChangeToMode Command Structure Type​

ChangeToMode Command 的参数结构体。

结构体成员序号字段名类型必须说明
0CurrentModeuint16M当前模式。

Trait 定义​

Trait IDNameConformance
0x4E4ECurrentModeM
0x4E4FChangeToModeResponseM

CurrentMode Trait(当前模式)​

CurrentMode 表示设备当前的工作状态或设置,取值来自预定义选项集。

Trait IDCode
0x4E4ECurrentMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueenum80RVM
0x0002Maximum Valueenum8255RO
0x0003Minimum Valueenum80RO
0x0007Default Valueenum80RWO

ChangeToModeResponse Trait(模式切换反馈)​

ChangeToModeResponse是一个响应消息或状态,指示将设备切换到特定模式的请求的结果。

Trait IDCode
0x4E4FChangeToModeResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueChangeToModeResponseEnum160RVM
0x0006Supported Valuelist[ChangeToModeResponseEnum16]RO
0x0007Default Valueuint160RWO

Command 定义​

Command IDNameConformance
0x9C4DChangeToModeM

ChangeToMode Command​

ChangeToMode用于设置设备的模式。

参数​

ChangeToMode Command Structure

VacuumOperationalState(扫地机状态)​

简介​

描述扫地机器人当前运行状态,如清扫中、回充中、充电中等。

Function 标识​

Function IDCode名称
0x00C1VacuumOperationalState扫地机状态

Trait​

Trait IDCode名称Conformance
0x4E51VacuumOperationalError扫地机器人错误M
0x4E50VacuumOperationalState扫地机器人状态M

Command​

Command IDCode名称Conformance
0x9C49GoHome返回基座M
0x9C47Start启动O
0x80C4Pause暂停O
0x80C5Stop停止O
0x9C48Resume恢复O

数据类型​

VacuumOperationalErrorEnum16 Type​

该枚举定义 VacuumOperationalError Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NoError无错误
0x01UnableToStartOrResume无法开始或恢复
0x02UnableToCompleteOperation无法完成操作
0x03CommandInvalidInState状态下命令无效
0x40FailedToFindChargingDock未能找到充电座
0x41Stuck被卡住
0x42DustBinMissing尘盒缺失
0x43DustBinFull尘盒已满
0x44WaterTankEmpty水箱为空
0x45WaterTankMissing水箱缺失
0x46WaterTankLidOpen水箱盖未关闭
0x47MopCleaningPadMissing拖布清洁垫缺失
VacuumOperationalStateEnum16 Type​

该枚举定义 VacuumOperationalState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Stopped停止
0x01Running运行中
0x02Paused暂停
0x03Error错误
0x40SeekingCharger寻找充电器
0x41Charging充电中
0x42Docked停靠

Trait 定义​

Trait IDNameConformance
0x4E51VacuumOperationalErrorM
0x4E50VacuumOperationalStateM

VacuumOperationalError Trait(扫地机器人错误)​

VacuumOperationalError 指设备或系统无法执行预期功能时遇到的特定错误类型。

Trait IDCode
0x4E51VacuumOperationalError
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVacuumOperationalErrorEnum160RVM
0x0006Supported Valuelist[VacuumOperationalErrorEnum16]RO
0x0007Default Valueuint160RWO

VacuumOperationalState Trait(扫地机器人状态)​

VacuumOperationalState 指吸尘设备当前的运行状态或模式。

Trait IDCode
0x4E50VacuumOperationalState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVacuumOperationalStateEnum160RVM
0x0006Supported Valuelist[VacuumOperationalStateEnum16]RO
0x0007Default Valueuint160RWO

Command 定义​

Command IDNameConformance
0x9C49GoHomeM
0x9C47StartO
0x80C4PauseO
0x80C5StopO
0x9C48ResumeO

GoHome Command​

Vacuum GoHome 命令用于指示扫地机器人返回充电座或基站。

该 Command 无参数。

Start Command​

启动

该 Command 无参数。

Pause Command​

该 Command 用于执行「暂停」操作。

该 Command 无参数。

Stop Command​

该命令应请求设备停止当前操作。

该 Command 无参数。

Resume Command​

恢复

该 Command 无参数。

RefrigeratorState(冰箱状态)​

简介​

描述冰箱运行状态,包括空闲、制冷、除霜、故障等。

Function 标识​

Function IDCode名称
0x00C2RefrigeratorState冰箱状态

Trait​

Trait IDCode名称Conformance
0x4E52RefrigeratorAlarm冰箱报警O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4E52RefrigeratorAlarmO

RefrigeratorAlarm Trait(冰箱报警)​

RefrigeratorAlarm 指当前冰箱报警状态。

Trait IDCode
0x4E52RefrigeratorAlarm
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

Command 定义​

本 Function 不包含 Command。

EVSE(电动汽车供电设备)​

简介​

提供电动汽车供电设备(EVSE)控制能力,包括充电启停、电流限制及充电状态。

车载电池数据表示当前连接车辆的电池,不是充电桩自身的备用电池。车辆连接状态复用 EvseState,车辆标识复用 VehicleID;车辆电池容量和读写设定使用本 Function 下的专用 Trait。

Function 标识​

Function IDCode名称
0x00C3EVSE电动汽车供电设备

Trait​

Trait IDCodeConformance
0x4E53EvseStateM
0x4E54EvseSupplyStateM
0x4E5AMinChargeCurrentM
0x4E59VehicleIDM
0x4E58BatteryCapacityM
0x4E57MaxChargeCurrentM
0x4E4DCurrentFlowM
0x4E56ChargingEnabledUntilM
0x4E55EvseFaultStateM
0x80CDBatPercentRemainingM
0x5219VehicleDischargeableCapacityO
0x521AVehicleDischargeableCapacityPercentO
0x521BVehicleDischargeableRemainingCapacityO
0x521CVehicleDischargeableRemainingCapacityPercentO
0x521DVehicleUsedCapacityO
0x521EVehicleUsedCapacityPercentO
0x521FEVSERatedChargingCapabilityO
0x5220EVSERatedDischargingCapabilityO
0x5221MinDischargeCurrentO
0x5222MaxDischargeCurrentO
0x5223EVSEChargeDischargePowerO
0x5224EVSEChargeDischargeCurrentO
0x5225EVSEChargeDischargeVoltageO
0x5226EVSERatedVoltageO
0x5227VehicleChargingAmountSettingO
0x5228VehicleChargingAmountPercentSettingO
0x5229VehicleChargingPowerSettingO
0x522AVehicleDischargingPowerSettingO
0x522BVehicleChargingCurrentSettingO
0x522CVehicleDischargingCurrentSettingO
0x522DEVSEIndependentRatedVoltageO
0x5240ChargerDischargerTypeO

Command​

Command IDCodeConformance
0x9C4BDisableChargingM
0x9C4AEnableChargingM
0x9C4CEnableChargingUntilO

数据类型​

EvseStateEnum32 Type​

该枚举定义 EvseState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NotPluggedIn未插入
0x01PluggedInNoDemand插入但无需求
0x02PluggedInDemand插入有需求
0x03PluggedInCharging插入充电中
0x04PluggedInDischarging插入放电中
0x05SessionEnding会话结束
0x06Fault故障
EvseSupplyStateEnum32 Type​

该枚举定义 EvseSupplyState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Disabled禁用
0x01ChargingEnabled允许充电
0x02DischargingEnabled允许放电
0x03DisabledError禁用错误
0x04DisabledDiagnostics禁用诊断
0x05EnabledChargingandDischarging允许充电和放电
EvseFaultStateEnum32 Type​

该枚举定义 EvseFaultState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NoError无错误
0x01MeterFailure电表故障
0x02OverVoltage过电压
0x03UnderVoltage欠电压
0x04OverCurrent过电流
0x05ContactWetFailure接触湿故障
0x06ContactDryFailure接触干故障
0x07GroundFault地面故障
0x08PowerLoss电力丢失
0x09PowerQuality电力质量
0x0APilotShortCircuit引导短路
0x0BEmergencyStop紧急停止
0x0CEVDisconnected电动车断开
0x0DWrongPowerSupply电源错误
0x0ELiveNeutralSwap火线零线交换
0x0FOverTemperature过温度
0xFFOther其他
EnableChargingUntil Command Structure Type​

EnableChargingUntil Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PresentValueint32M当前值。

Trait 定义​

Trait IDNameConformance
0x4E53EvseStateM
0x4E54EvseSupplyStateM
0x4E5AMinChargeCurrentM
0x4E59VehicleIDM
0x4E58BatteryCapacityM
0x4E57MaxChargeCurrentM
0x4E4DCurrentFlowM
0x4E56ChargingEnabledUntilM
0x4E55EvseFaultStateM
0x80CDBatPercentRemainingM
0x5219VehicleDischargeableCapacityO
0x521AVehicleDischargeableCapacityPercentO
0x521BVehicleDischargeableRemainingCapacityO
0x521CVehicleDischargeableRemainingCapacityPercentO
0x521DVehicleUsedCapacityO
0x521EVehicleUsedCapacityPercentO
0x521FEVSERatedChargingCapabilityO
0x5220EVSERatedDischargingCapabilityO
0x5221MinDischargeCurrentO
0x5222MaxDischargeCurrentO
0x5223EVSEChargeDischargePowerO
0x5224EVSEChargeDischargeCurrentO
0x5225EVSEChargeDischargeVoltageO
0x5226EVSERatedVoltageO
0x5227VehicleChargingAmountSettingO
0x5228VehicleChargingAmountPercentSettingO
0x5229VehicleChargingPowerSettingO
0x522AVehicleDischargingPowerSettingO
0x522BVehicleChargingCurrentSettingO
0x522CVehicleDischargingCurrentSettingO
0x522DEVSEIndependentRatedVoltageO
0x5240ChargerDischargerTypeO

EvseState Trait​

EVSEState 表示电动汽车供电设备(EVSE)的当前状态。

Trait IDCode
0x4E53EvseState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueEvseStateEnum320RVM
0x0006Supported Valuelist[EvseStateEnum32]RO

EvseSupplyState Trait​

EvseSupplyState 表示电动汽车供电设备(EVSE)的当前供电状态。

Trait IDCode
0x4E54EvseSupplyState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueEvseSupplyStateEnum320RVM
0x0006Supported Valuelist[EvseSupplyStateEnum32]RO

MinChargeCurrent Trait​

MinChargeCurrent 指电动汽车可充电的最低电流等级。单位:A。

Trait IDCode
0x4E5AMinChargeCurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO0RVM
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default ValuefloatO0RWO

VehicleID Trait​

VehicleID 为每辆电动汽车(EV)分配的唯一标识符。

Trait IDCode
0x4E59VehicleID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuestring32RVM

BatteryCapacity Trait​

BatteryCapacity 表示与 EVSE 关联的车辆电池标称容量,单位 W·h。该值描述连接车辆的电池,不表示 EVSE 自身备用电池容量;若设备提供当前可放电容量,应使用 VehicleDischargeableCapacity。

Trait IDCode
0x4E58BatteryCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO0RVM
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default ValuefloatO0RWO

MaxChargeCurrent Trait​

MaxChargeCurrent 指电动汽车可充电的最高电流等级。单位:A。

Trait IDCode
0x4E57MaxChargeCurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO0RVM
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default ValuefloatO0RWO

CurrentFlow Trait​

CurrentFlow表示当前流量值,单位为 m^3/h。

Trait IDCode
0x4E4DCurrentFlow
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO0RVM
0x0002Maximum Valuefloat65535.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default ValuefloatO0RWO

ChargingEnabledUntil Trait​

ChargingEnabledUntil指允许电动汽车( EV )或设备的充电过程持续

Trait IDCode
0x4E56ChargingEnabledUntil
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO6RVM
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default ValuefloatO6RWO
0x000DIs NullbooleanFalseRVO

EvseFaultState Trait​

EvseFaultState 表示电动汽车供电设备(EVSE)的当前故障状态。

Trait IDCode
0x4E55EvseFaultState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueEvseFaultStateEnum320RVM
0x0006Supported Valuelist[EvseFaultStateEnum32]RO

BatPercentRemaining Trait​

指示剩余电池电量百分比。

Trait IDCode
0x80CDBatPercentRemaining
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatO50RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default ValuefloatO50RWO

VehicleDischargeableCapacity Trait​

车载电池可放电容量表示当前连接车辆可用于放电的能量容量,单位 W·h。

Trait IDCode
0x5219VehicleDischargeableCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000 W·h无固定默认值;报告当前车辆值RVO
0x0002Maximum Valuefloat1000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

VehicleDischargeableCapacityPercent Trait​

车载电池可放电容量百分比表示可用于放电的容量占其百分比基准的比例,单位 %。

Trait IDCode
0x521AVehicleDischargeableCapacityPercent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-100 %无固定默认值;报告当前车辆值RVO
0x0002Maximum Valuefloat100RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

VehicleDischargeableRemainingCapacity Trait​

车载电池可放电剩余容量表示当前仍可从车辆电池放出的能量,单位 W·h。

Trait IDCode
0x521BVehicleDischargeableRemainingCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000 W·h无固定默认值;报告当前车辆值RVO
0x0002Maximum Valuefloat1000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

VehicleDischargeableRemainingCapacityPercent Trait​

车载电池可放电剩余容量百分比表示可放电剩余能量相对于其百分比基准的比例,单位 %。

Trait IDCode
0x521CVehicleDischargeableRemainingCapacityPercent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-100 %无固定默认值;报告当前车辆值RVO
0x0002Maximum Valuefloat100RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

VehicleUsedCapacity Trait​

车载电池已用容量表示车辆电池中已消耗的能量容量,单位 W·h。

Trait IDCode
0x521DVehicleUsedCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000 W·h无固定默认值;报告当前车辆值RVO
0x0002Maximum Valuefloat1000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

VehicleUsedCapacityPercent Trait​

车载电池已用容量百分比表示已消耗能量相对于其百分比基准的比例,单位 %。

Trait IDCode
0x521EVehicleUsedCapacityPercent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-100 %无固定默认值;报告当前车辆值RVO
0x0002Maximum Valuefloat100RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

EVSERatedChargingCapability Trait​

充电机额定充电能力表示设备的标称最大充电功率,单位 W。

Trait IDCode
0x521FEVSERatedChargingCapability
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-5000000 W无固定默认值;由产品规格确定RVO
0x0002Maximum Valuefloat5000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

EVSERatedDischargingCapability Trait​

放电机额定放电能力表示设备的标称最大放电功率,单位 W。

Trait IDCode
0x5220EVSERatedDischargingCapability
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-5000000 W无固定默认值;由产品规格确定RVO
0x0002Maximum Valuefloat5000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

MinDischargeCurrent Trait​

MinDischargeCurrent 表示车辆允许放电的最小电流,单位 A。

Trait IDCode
0x5221MinDischargeCurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-10000 A0RVO
0x0002Maximum Valuefloat10000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.001RO

MaxDischargeCurrent Trait​

MaxDischargeCurrent 表示车辆允许放电的最大电流,单位 A。

Trait IDCode
0x5222MaxDischargeCurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-10000 A0RVO
0x0002Maximum Valuefloat10000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.001RO

EVSEChargeDischargePower Trait​

充放电机瞬时充放电功率采用带符号值表示,单位 W;正值表示充电,负值表示放电。

Trait IDCode
0x5223EVSEChargeDischargePower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat-5000000-5000000 W0RVO
0x0002Maximum Valuefloat5000000RO
0x0003Minimum Valuefloat-5000000RO
0x0005Step Valuefloat0.1RO

EVSEChargeDischargeCurrent Trait​

充放电机瞬时充放电电流采用带符号值表示,单位 A;正值表示充电,负值表示放电。

Trait IDCode
0x5224EVSEChargeDischargeCurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat-10000-10000 A0RVO
0x0002Maximum Valuefloat10000RO
0x0003Minimum Valuefloat-10000RO
0x0005Step Valuefloat0.001RO

EVSEChargeDischargeVoltage Trait​

充放电机瞬时充放电电压表示设备报告的当前电压,单位 V。

Trait IDCode
0x5225EVSEChargeDischargeVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000 V无固定默认值;报告当前值RVO
0x0002Maximum Valuefloat1000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

EVSERatedVoltage Trait​

充放电机额定电压表示设备的标称工作电压,单位 V。

Trait IDCode
0x5226EVSERatedVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000 V无固定默认值;由产品规格确定RVO
0x0002Maximum Valuefloat1000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

VehicleChargingAmountSetting Trait​

车辆充电量设定表示目标充电电量,单位 W·h。

Trait IDCode
0x5227VehicleChargingAmountSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320-1000000000 W·h无固定默认值;报告当前设定RVWO
0x0002Maximum Valueuint321000000000RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

VehicleChargingAmountPercentSetting Trait​

车辆充电量百分比设定表示目标充电量占容量基准的比例,单位 %。

Trait IDCode
0x5228VehicleChargingAmountPercentSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-100 %无固定默认值;报告当前设定RVWO
0x0002Maximum Valuefloat100RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

VehicleChargingPowerSetting Trait​

车辆充电功率设定表示目标充电功率,单位 W。

Trait IDCode
0x5229VehicleChargingPowerSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320-5000000 W无固定默认值;报告当前设定RVWO
0x0002Maximum Valueuint325000000RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

VehicleDischargingPowerSetting Trait​

车辆放电功率设定表示目标放电功率,单位 W。

Trait IDCode
0x522AVehicleDischargingPowerSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320-5000000 W无固定默认值;报告当前设定RVWO
0x0002Maximum Valueuint325000000RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

VehicleChargingCurrentSetting Trait​

车辆充电电流设定表示目标充电电流,单位 A。

Trait IDCode
0x522BVehicleChargingCurrentSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-10000 A无固定默认值;报告当前设定RVWO
0x0002Maximum Valuefloat10000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.001RO

VehicleDischargingCurrentSetting Trait​

车辆放电电流设定表示目标放电电流,单位 A。

Trait IDCode
0x522CVehicleDischargingCurrentSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-10000 A无固定默认值;报告当前设定RVWO
0x0002Maximum Valuefloat10000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.001RO

EVSEIndependentRatedVoltage Trait​

自立运行额定电压表示 EVSE 自立运行时的标称输出电压,单位 V。

Trait IDCode
0x522DEVSEIndependentRatedVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000 V无固定默认值;由产品规格确定RVO
0x0002Maximum Valuefloat1000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ChargerDischargerType Trait​

充放电机类型表示设备对外显示的充电/放电设备类别名称。该 Trait 保留设备提供的类型文本,不作为运行状态使用。

Trait IDCode
0x5240ChargerDischargerType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterString设备定义的类别名称无固定默认值RVO

Command 定义​

Command IDNameConformance
0x9C4BDisableChargingM
0x9C4AEnableChargingM
0x9C4CEnableChargingUntilO

DisableCharging Command​

DisableCharging Command(禁用充电命令)。

该 Command 无参数。

EnableCharging Command​

EnableCharging Command(启用充电命令)。

该 Command 无参数。

EnableChargingUntil Command​

EnableChargingUntil Command(启用充电至指定条件命令)。

参数​

EnableChargingUntil Command Structure

VacuumRunMode(扫地机运行模式)​

简介​

控制扫地机器人运行模式,如自动、沿边、定点等。

Function 标识​

Function IDCode名称
0x00C4VacuumRunMode扫地机运行模式

Trait​

Trait IDCode名称Conformance
0x4E4ECurrentMode当前模式M
0x4E4FChangeToModeResponse模式切换反馈M

Command​

Command IDCode名称Conformance
0x9C4DChangeToMode修改模式M

数据类型​

ChangeToModeResponseEnum16 Type​

该枚举定义 ChangeToModeResponse Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Success成功
0x01UnsupportedMode不支持的模式
0x02GenericFailure一般故障
0x03InvalidInMode模式下无效
0x41Stuck被卡住
0x42DustBinMissing尘盒缺失
0x43DustBinFull尘盒已满
0x44WaterTankEmpty水箱为空
0x45WaterTankMissing水箱缺失
0x46WaterTankLidOpen水箱盖未关闭
0x47MopCleaningPadMissing拖布清洁垫缺失
0x48BatteryLow电池电量低
ChangeToMode Command Structure Type​

ChangeToMode Command 的参数结构体。

结构体成员序号字段名类型必须说明
0CurrentModeuint16M当前模式。

Trait 定义​

Trait IDNameConformance
0x4E4ECurrentModeM
0x4E4FChangeToModeResponseM

CurrentMode Trait(当前模式)​

CurrentMode 表示设备当前的工作状态或设置,取值来自预定义选项集。

Trait IDCode
0x4E4ECurrentMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueenum80RVM
0x0002Maximum Valueenum8255RO
0x0003Minimum Valueenum80RO
0x0007Default Valueenum80RWO

ChangeToModeResponse Trait(模式切换反馈)​

ChangeToModeResponse是一个响应消息或状态,指示将设备切换到特定模式的请求的结果。

Trait IDCode
0x4E4FChangeToModeResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueChangeToModeResponseEnum160RVM
0x0006Supported Valuelist[ChangeToModeResponseEnum16]RO
0x0007Default Valueuint160RWO

Command 定义​

Command IDNameConformance
0x9C4DChangeToModeM

ChangeToMode Command​

ChangeToMode用于设置设备的模式。

参数​

ChangeToMode Command Structure

VacuumCleanMode(扫地机清洁模式)​

简介​

控制扫地机器人清洁模式,如标准、强力、静音等。

Function 标识​

Function IDCode名称
0x00C5VacuumCleanMode扫地机清洁模式

Trait​

Trait IDCode名称Conformance
0x4E4ECurrentMode当前模式M
0x4E4FChangeToModeResponse模式切换反馈M

Command​

Command IDCode名称Conformance
0x9C4DChangeToMode修改模式M

数据类型​

ChangeToModeResponseEnum16 Type​

该枚举定义 ChangeToModeResponse Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Success成功
0x01UnsupportedMode不支持的模式
0x02GenericFailure一般故障
0x03InvalidInMode模式下无效
0x41Stuck被卡住
0x42DustBinMissing尘盒缺失
0x43DustBinFull尘盒已满
0x44WaterTankEmpty水箱为空
0x45WaterTankMissing水箱缺失
0x46WaterTankLidOpen水箱盖未关闭
0x47MopCleaningPadMissing拖布清洁垫缺失
0x48BatteryLow电池电量低
ChangeToMode Command Structure Type​

ChangeToMode Command 的参数结构体。

结构体成员序号字段名类型必须说明
0CurrentModeuint16M当前模式。

Trait 定义​

Trait IDNameConformance
0x4E4ECurrentModeM
0x4E4FChangeToModeResponseM

CurrentMode Trait(当前模式)​

CurrentMode 表示设备当前的工作状态或设置,取值来自预定义选项集。

Trait IDCode
0x4E4ECurrentMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueenum80RVM
0x0002Maximum Valueenum8255RO
0x0003Minimum Valueenum80RO
0x0007Default Valueenum80RWO

ChangeToModeResponse Trait(模式切换反馈)​

ChangeToModeResponse是一个响应消息或状态,指示将设备切换到特定模式的请求的结果。

Trait IDCode
0x4E4FChangeToModeResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueChangeToModeResponseEnum160RVM
0x0006Supported Valuelist[ChangeToModeResponseEnum16]RO
0x0007Default Valueuint160RWO

Command 定义​

Command IDNameConformance
0x9C4DChangeToModeM

ChangeToMode Command​

ChangeToMode用于设置设备的模式。

参数​

ChangeToMode Command Structure

TemperatureControl(温度控制)​

简介​

提供温度设定与调节能力,用于恒温设备的目标温度控制。

Function 标识​

Function IDCode名称
0x00C6TemperatureControl温度控制

Trait​

Trait IDCode名称Conformance
0x4E5CSetTemperatureLevel设置温度等级O
0x4E5BSetTemperature设置温度O

Command​

Command IDCode名称Conformance
0x9C4FChangeTemperatureLevel修改温度等级O
0x9C4EChangeTemperature修改温度O

数据类型​

ChangeTemperatureLevel Command Structure Type​

ChangeTemperatureLevel Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SetTemperatureLeveluint8M设置温度等级;默认值为 0。
ChangeTemperature Command Structure Type​

ChangeTemperature Command 的参数结构体。

结构体成员序号字段名类型必须说明
0SetTemperaturefloatM设置温度;默认值为 20。

Trait 定义​

Trait IDNameConformance
0x4E5CSetTemperatureLevelO
0x4E5BSetTemperatureO

SetTemperatureLevel Trait(设置温度等级)​

etTemperatureLevel 允许用户将温度调节至预设档位。Parameter Supported Values 表示支持的档位列表。

Trait IDCode
0x4E5CSetTemperatureLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVWO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO
0x0006Supported Valuelist[characterString]RO
0x0007Default Valueuint80RWO

SetTemperature Trait(设置温度)​

SetTemperature 允许用户指定和调整设备或系统的目标温度。单位:deg C。

Trait IDCode
0x4E5BSetTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat20RVWO
0x0002Maximum Valuefloat32RO
0x0003Minimum Valuefloat5RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat20RWO

Command 定义​

Command IDNameConformance
0x9C4FChangeTemperatureLevelO
0x9C4EChangeTemperatureO

ChangeTemperatureLevel Command​

允许用户将温度调节至预设档位。Parameter Supported Values 表示支持的温度档位列表。

参数​

ChangeTemperatureLevel Command Structure

ChangeTemperature Command​

ChangeTemperature允许用户指定和调整设备或系统的目标温度。

参数​

ChangeTemperature Command Structure

MediaInput(播放源)​

简介​

描述媒体输入源管理与切换,支持选择当前播放源及输入列表。

Function 标识​

Function IDCode名称
0x00C7MediaInput播放源

Trait​

Trait IDCode名称Conformance
0x4E5EMediaInput播放源M

Command​

Command IDCode名称Conformance
0x9C53SelectInput选择播放源M

数据类型​

SelectInput Command Structure Type​

SelectInput Command 的参数结构体。

结构体成员序号字段名类型必须说明
0MediaInputuint8M输入源;默认值为 0。

Trait 定义​

Trait IDNameConformance
0x4E5EMediaInputM

MediaInput Trait(播放源)​

MediaInput 提供可用输入源列表,并提供选择与重命名命令。

Trait IDCode
0x4E5EMediaInput
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueenum80RVWM
0x0007Default Valueenum80RWO

Command 定义​

Command IDNameConformance
0x9C53SelectInputM

SelectInput Command​

该 Command 用于执行「选择播放源」操作。

参数​

SelectInput Command Structure

HEPAFilterMonitoring(HEPA滤芯监控)​

简介​

监测 HEPA 滤芯使用情况、剩余寿命及更换提醒。

Function 标识​

Function IDCode名称
0x00C8HEPAFilterMonitoringHEPA滤芯监控

Trait​

Trait IDCode名称Conformance
0x4E49ChangeIndication滤芯寿命状态M
0x4E48Condition滤芯剩余寿命O

Command​

Command IDCode名称Conformance
0x9C46ResetCondition重置滤芯O

数据类型​

ChangeIndicationEnum8 Type​

该枚举定义 ChangeIndication Trait 的 Present Value 有效取值。

ValueNameDescription
0x00OKOK
0x01Warming警告
0x02Critical紧急

Trait 定义​

Trait IDNameConformance
0x4E49ChangeIndicationM
0x4E48ConditionO

ChangeIndication Trait(滤芯寿命状态)​

ChangeIndication 定义了滤芯寿命的状态.

Trait IDCode
0x4E49ChangeIndication
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueChangeIndicationEnum80RVM
0x0006Supported Valuelist[ChangeIndicationEnum8]RO
0x0007Default Valueuint80RWO

Condition Trait(滤芯剩余寿命)​

表示滤芯剩余寿命,单位为百分比%

Trait IDCode
0x4E48Condition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat100RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat100RWO

Command 定义​

Command IDNameConformance
0x9C46ResetConditionO

ResetCondition Command​

ResetCondition表示重置滤芯。

该 Command 无参数。

ActivatedCarbonFilterMonitoring(活性炭滤芯监控)​

简介​

监测活性炭滤芯使用情况、剩余寿命及更换提醒。

Function 标识​

Function IDCode名称
0x00C9ActivatedCarbonFilterMonitoring活性炭滤芯监控

Trait​

Trait IDCode名称Conformance
0x4E49ChangeIndication滤芯寿命状态M
0x4E48Condition滤芯剩余寿命O

Command​

Command IDCode名称Conformance
0x9C46ResetCondition重置滤芯O

数据类型​

ChangeIndicationEnum8 Type​

该枚举定义 ChangeIndication Trait 的 Present Value 有效取值。

ValueNameDescription
0x00OKOK
0x01Warming警告
0x02Critical紧急

Trait 定义​

Trait IDNameConformance
0x4E49ChangeIndicationM
0x4E48ConditionO

ChangeIndication Trait(滤芯寿命状态)​

ChangeIndication 定义了滤芯寿命的状态.

Trait IDCode
0x4E49ChangeIndication
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueChangeIndicationEnum80RVM
0x0006Supported Valuelist[ChangeIndicationEnum8]RO
0x0007Default Valueuint80RWO

Condition Trait(滤芯剩余寿命)​

表示滤芯剩余寿命,单位为百分比%

Trait IDCode
0x4E48Condition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat100RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat100RWO

Command 定义​

Command IDNameConformance
0x9C46ResetConditionO

ResetCondition Command​

ResetCondition表示重置滤芯。

该 Command 无参数。

ThreadBorderRouter(边界路由器)​

简介​

管理 Thread 边界路由器及其所承载 Thread 网络的运行与配置。

Function 标识​

Function IDCode名称
0x00CAThreadBorderRouter边界路由器

Trait​

Trait IDCode名称Conformance
0x4E5FBorderRouterName边界路由器名称M
0x4E60BorderAgentID边界路由器IDM
0x4E61ThreadVersionThread版本M
0x4E62InterfaceEnabled界面使能M
0x4E63ActiveDatasetTimestampActive数据集时间戳M
0x4E64PendingDatasetTimestampPending数据集时间戳M
0x4E65DatasetResponse数据集回复O

Command​

Command IDCode名称Conformance
0x9C55GetActiveDatasetRequest请求Active数据集O
0x9C56GetPendingDatasetRequest请求Pending数据集O
0x9C57SetActiveDatasetRequest设置Active数据集请求O
0x9C58SetPendingDatasetRequest设置Pending数据集请求O

数据类型​

SetActiveDatasetRequest Command Structure Type​

SetActiveDatasetRequest Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ActiveDatasetcharacterStringM生效数据集。
SetPendingDatasetRequest Command Structure Type​

SetPendingDatasetRequest Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PendingDatasetcharacterStringM待处理数据集。

Trait 定义​

Trait IDNameConformance
0x4E5FBorderRouterNameM
0x4E60BorderAgentIDM
0x4E61ThreadVersionM
0x4E62InterfaceEnabledM
0x4E63ActiveDatasetTimestampM
0x4E64PendingDatasetTimestampM
0x4E65DatasetResponseO

BorderRouterName Trait(边界路由器名称)​

该 Trait 用于「边界路由器名称」相关数据的访问与上报。

Trait IDCode
0x4E5FBorderRouterName
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVM

BorderAgentID Trait(边界路由器ID)​

Thread 边界路由器设备的唯一 ID。

Trait IDCode
0x4E60BorderAgentID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuestring320RVM
0x0007Default Valuestring320RWO

ThreadVersion Trait(Thread版本)​

边界路由器的 Thread 版本。

Trait IDCode
0x4E61ThreadVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint160RWO

InterfaceEnabled Trait(界面使能)​

Thread 接口是否启用。

Trait IDCode
0x4E62InterfaceEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVM
0x0007Default Valueboolean1RWO

ActiveDatasetTimestamp Trait(Active数据集时间戳)​

从边界路由器所连接的 Thread 节点配置的 Active Dataset 值中提取的时间戳。

Trait IDCode
0x4E63ActiveDatasetTimestamp
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVM
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0007Default Valueuint640RWO
0x000DIs NullbooleanFalseRVO

PendingDatasetTimestamp Trait(Pending数据集时间戳)​

从边界路由器所连接的 Thread 节点配置的 Pending Dataset 值中提取的时间戳。

Trait IDCode
0x4E64PendingDatasetTimestamp
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVM
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0007Default Valueuint640RWO
0x000DIs NullbooleanFalseRVO

DatasetResponse Trait(数据集回复)​

若未配置任何数据集(按请求的活动或待定数据集),该字段应设为空。

Trait IDCode
0x4E65DatasetResponse
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterString0RVO
0x0007Default ValuecharacterString0RWO
0x000DIs NullbooleanFalseRVO

Command 定义​

Command IDNameConformance
0x9C55GetActiveDatasetRequestO
0x9C56GetPendingDatasetRequestO
0x9C57SetActiveDatasetRequestO
0x9C58SetPendingDatasetRequestO

GetActiveDatasetRequest Command​

该 Command 用于执行「请求Active数据集」操作。

该 Command 无参数。

GetPendingDatasetRequest Command​

该 Command 用于执行「请求Pending数据集」操作。

该 Command 无参数。

SetActiveDatasetRequest Command​

该 Command 用于执行「设置Active数据集请求」操作。

参数​

SetActiveDatasetRequest Command Structure

SetPendingDatasetRequest Command​

该 Command 用于执行「设置Pending数据集请求」操作。

参数​

SetPendingDatasetRequest Command Structure

ThemePack(主题包)​

简介​

管理设备主题包资源,包括主题下载、切换及版本信息。

Function 标识​

Function IDCode名称
0x00CBThemePack主题包

Trait​

Trait IDCode名称Conformance
0x4E78ThemeID主题IDM
0x4E77ThemeVersion主题版本M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4E78ThemeIDM
0x4E77ThemeVersionM

ThemeID Trait(主题ID)​

该 Trait 用于「主题ID」相关数据的访问与上报。

Trait IDCode
0x4E78ThemeID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0007Default Valueuint161RWO

ThemeVersion Trait(主题版本)​

主题版本

Trait IDCode
0x4E77ThemeVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO
0x0007Default Valueuint161RWO

Command 定义​

本 Function 不包含 Command。

WiFiNetworkDiagnostics(WiFi网络诊断)​

简介​

提供 Wi-Fi 网络标准化诊断指标,辅助排查连接质量与链路状态。

Function 标识​

Function IDCode名称
0x00CCWiFiNetworkDiagnosticsWiFi网络诊断

Trait​

Trait IDCode名称Conformance
0x0013CurrentMaxRate当前最大速率O
0x0012PacketUnicastTxCount发送单播包计数O
0x0011PacketUnicastRxCount接收单播包计数O
0x0010PacketMulticastTxCount发送多播包计数O
0x000FPacketMulticastRxCount接收多播包计数O
0x000EBeaconLostCount信标丢失计数O
0x000DWiFiVersionWiFi版本O
0x000CSecurityType安全类型O
0x4E7BBSSIDBSSIDO
0x4E2COverrunCount溢出丢包计数O
0x0014Networks网络名称O
0x0015SupportedWiFiBands支持的 WiFi 频段O

Command​

Command IDCode名称Conformance
0x9C68ResetCounts重置计数O

数据类型​

WiFiVersionEnum8 Type​

该枚举定义 WiFiVersion Trait 的 Present Value 有效取值。

ValueNameDescription
0x00aa
0x01bb
0x02gg
0x03nn
0x04acac
0x05axax
0x06ahah
SecurityTypeEnum8 Type​

该枚举定义 SecurityType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unspecified未指定
0x01None无
0x02WEPWEP
0x03WPAWPA
0x04WPA2WPA2
0x05WPA3WPA3
NetworksTraitPresentValueStructure Type​

该结构体定义 Networks Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0NetworkIDcharacterStringM网络标识。Wi-Fi 为 SSID;Thread 为 Extended PAN ID;Ethernet 为 OS 网络接口名。最大长度 32 字节。
1ConnectedbooleanM该网络是否已连接。Wi-Fi:已关联 AP;Ethernet:链路激活;Thread:处于 operational mesh。

Trait 定义​

Trait IDNameConformance
0x0013CurrentMaxRateO
0x0012PacketUnicastTxCountO
0x0011PacketUnicastRxCountO
0x0010PacketMulticastTxCountO
0x000FPacketMulticastRxCountO
0x000EBeaconLostCountO
0x000DWiFiVersionO
0x000CSecurityTypeO
0x4E7BBSSIDO
0x4E2COverrunCountO
0x0014NetworksO
0x0015SupportedWiFiBandsO

CurrentMaxRate Trait(当前最大速率)​

指示当前数据传输的最大 PHY 速率(比特/秒)。

Trait IDCode
0x0013CurrentMaxRate
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVO
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint321RO

PacketUnicastTxCount Trait(发送单播包计数)​

PacketUnicastTxCount 应指示节点发送的单播数据包数量。

Trait IDCode
0x0012PacketUnicastTxCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

PacketUnicastRxCount Trait(接收单播包计数)​

PacketUnicastRxCount 应指示节点接收的单播数据包数量。

Trait IDCode
0x0011PacketUnicastRxCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

PacketMulticastTxCount Trait(发送多播包计数)​

PacketMulticastTxCount 应指示节点发送的多播数据包数量。

Trait IDCode
0x0010PacketMulticastTxCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

PacketMulticastRxCount Trait(接收多播包计数)​

指示节点接收的多播数据包数量。

Trait IDCode
0x000FPacketMulticastRxCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

BeaconLostCount Trait(信标丢失计数)​

BeaconLostCount 应指示节点检测到的丢失信标数量。

Trait IDCode
0x000EBeaconLostCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

WiFiVersion Trait(WiFi版本)​

WiFiVersion 应指示节点当前使用的 802.11 标准版本。

Trait IDCode
0x000DWiFiVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWiFiVersionEnum80RVO
0x0006Supported Valuelist[WiFiVersionEnum8]RO

SecurityType Trait(安全类型)​

SecurityType 应指示当前使用的 Wi-Fi 安全类型。

Trait IDCode
0x000CSecurityType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSecurityTypeEnum80RVO
0x0006Supported Valuelist[SecurityTypeEnum8]RO
0x0007Default Valueuint80RWO

BSSID Trait​

BSSID 应指示节点当前所连接 Wi-Fi 网络的 BSSID。

Trait IDCode
0x4E7BBSSID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

OverrunCount Trait(溢出丢包计数)​

因缓冲区内存不足无法保留全部数据包而在入口或出口丢弃的数据包数量。

Trait IDCode
0x4E2COverrunCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVO
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO

Networks Trait(网络名称)​

Networks 特征应指示网络接口上可用的网络配置。

Trait IDCode
0x0014Networks
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[NetworksTraitPresentValueStructure]RVO

SupportedWiFiBands Trait(支持的 WiFi 频段)​

SupportedWiFiBands 应指示已配置的 Wi-Fi 接口所支持的全部频段。

Trait IDCode
0x0015SupportedWiFiBands
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

Command 定义​

Command IDNameConformance
0x9C68ResetCountsO

ResetCounts Command​

接收此命令应将以下属性重置为 0:

该 Command 无参数。

ZigbeeNetworkDiagnostics(Zigbee网络诊断)​

简介​

提供 Zigbee 网络诊断能力,包括信道、PAN、邻居及路由等信息。

Function 标识​

Function IDCode名称
0x00CDZigbeeNetworkDiagnosticsZigbee网络诊断

Trait​

Trait IDCode名称Conformance
0x4E84ZigbeeNextHopMac上行的下跳设备Zigbee MAC地址O
0x4F53ZigbeeKeySeqNumberZigbee网络密钥序列号O
0x4F4CZigbeeCoordNetworkKeyZigbee协调器网络密钥O
0x4F4DZigbeeCoordMacZigbee协调器的MAC地址O
0x8149RebootReason重启原因O
0x4EA9PreOperationModeZigbee设备前工作模式O
0x4E9BAPSRetransmissionCountAPS层重传次数O
0x4EA5MACRetransmissionCountMAC层重传次数O
0x4EA8NWKRetransmissionCount网络层重传次数O
0x4EA7RoutingAgingCountThreshold路由老化计数门槛O
0x4EA6MessageTransmissionFailureCountThreshold报文发送失败计数门槛O
0x4EA2EnableNWKACK网络层重传使能配置O
0x4E9FEnableAPSACKAPS应答使能配置O
0x4E9DCurOperationModeZigbee设备工作模式O
0x4E9CCCAModeCCA模式O
0x4E93ZigbeeTotalMessageInOneHour1小时内发送Zigbee报文总个数O
0x4E92ZigbeeResentMessageInOneHour1小时内发送Zigbee报文重发个数O
0x4E91ZigbeeFrameCounterZigbee帧计数值O
0x4E8FZigbeeAvgSuccessfulResendCountZigbee平均成功重发报文个数O
0x4E90ZigbeeFailedMessageInOneHour1小时内发送Zigbee报文失败个数O
0x5130ZigbeeNeighborInfoZigbee邻居信息O
0x8121ZigbeeDeviceInformationZigbee设备身份与安装信息O
0x4E8DZigbeeGeneralDiagnosticsZigbee设备通用诊断信息上报O
0x8153LQI链路质量指示O
0x814BPANID个人区域网络标识符O
0x814AChannel无线信道O
0x4FA7ZigbeeExtendedPANIDZigbee 网络扩展标识符O
0x50FEDeviceUnbindReason设备解绑原因O

Command​

本 Function 不包含 Command。

数据类型​

RebootReasonEnum8 Type​

该枚举定义 RebootReason Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unspecified未知
0x01PowerOnReboot上电重启
0x02BrownOutReset低压复位
0x03SoftwareWatchdogReset软件看门狗复位
0x04HardwareWatchdogReset硬件看门狗复位
0x05SoftwareUpdateCompleted软件更新完成
0x06SoftwareReset软件重启
PreOperationModeEnum8 Type​

该枚举定义 PreOperationMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00UnjoinedMode未入网模式
0x01NewlyJoinedMode新入网模式
0x02PollingMode仓储轮询模式
0x03UserMode用户模式
0x04DegradedMode亚健康模式
0x05RejoinMode仓储重连模式
CurOperationModeEnum8 Type​

该枚举定义 CurOperationMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00UnjoinedMode未入网模式
0x01NewlyJoinedMode新入网模式
0x02PollingMode仓储轮询模式
0x03UserMode用户模式
0x04DegradedMode亚健康模式
0x05RejoinMode仓储重连模式
CCAModeEnum8 Type​

该枚举定义 CCAMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00CCA1CCA1模式
0x01CCA1CCA2模式
ZigbeeNeighborInfo Type​

该结构体定义单个 Zigbee 邻居节点的信息。

IDNameTypeConstraintQualityDefaultAccessConformance
0x0000 sNeighborAddruint16RO
0x0001 sNeighborDescriptoruint8RO
0x0002 sNeighborLqiuint8RO
NeighborAddr Field​

该字段应指定 Zigbee 邻居节点的网络地址。

NeighborDescriptor Field​

该字段应指定 Zigbee 邻居节点的描述字节。 它是一个 8 位无符号整数,将 DeviceType、RxOnWhenIdle 和 Relationship 三部分信息组合编码到同一个字节中。

	7         6   5   4      3   2      1    0
+--------+------------+------------+----------+
|Reserved|Relationship|RxOnWhenIdle|DeviceType|
| 1 bit | 3 bit | 2 bit | 2 bit |
+--------+------------+------------+----------+
Relationship Field​

该字段应指定 Zigbee 邻居节点与当前设备之间的关系。

ValueNameSummaryConformance
0x00 sParent当前设备的父节点M
0x01 sChild当前设备的子节点M
0x02 sSibling当前设备的同级节点M
0x03 sUnknown未知关系M
RxOnWhenIdle Field​

该字段应指定邻居节点在空闲时是否保持接收开启状态。

ValueNameSummaryConformance
0x00 sRX on when idle空闲时保持接收开启M
0x01 sRX off when idle空闲时关闭接收M
DeviceType Field​

该字段应指定邻居节点类型。

ValueNameSummaryConformance
0x00 sCoordinator协调器M
0x01 sRouter路由器M
0x02 sEndDevice终端设备M
0x03 sUnknown未知类型M
NeighborLqi Field​

该字段应指定 Zigbee 邻居节点的链路质量指示值(LQI)。

DeviceUnbindReasonTypeEnum8 Type​

该枚举定义 DeviceUnbindReason 结构中 Type 字段的有效取值。

ValueNameDescription
0x00None无原因
0x01UserManualReset用户手动重置设备
0x02CloudDelete云端删除解绑
0x03GatewayActiveDelete网关主动删除解绑
0x04ChildCountExceed子设备数量超限
0x05BatchAddExceed批量添加超限
0x06PollingTimeout轮询超时
0x07IeeeAddressNotFoundIEEE 地址未找到
0x08DeviceAnnounceMissed未收到 Device Announce
DeviceUnbindReasonTraitPresentValueStructure Type​

该结构体定义 DeviceUnbindReason Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0TypeDeviceUnbindReasonTypeEnum8M解绑操作类型。
1Timeuint32M离线/解绑事件发生时间(UTC 秒级时间戳)。
2PrevDelbooleanM是否启用防删除保护。
3DidcharacterStringO被移除子设备 DID。
4ModelcharacterStringO被移除子设备型号。

Trait 定义​

Trait IDNameConformance
0x4E84ZigbeeNextHopMacO
0x4F53ZigbeeKeySeqNumberO
0x4F4CZigbeeCoordNetworkKeyO
0x4F4DZigbeeCoordMacO
0x8149RebootReasonO
0x4EA9PreOperationModeO
0x4E9BAPSRetransmissionCountO
0x4EA5MACRetransmissionCountO
0x4EA8NWKRetransmissionCountO
0x4EA7RoutingAgingCountThresholdO
0x4EA6MessageTransmissionFailureCountThresholdO
0x4EA2EnableNWKACKO
0x4E9FEnableAPSACKO
0x4E9DCurOperationModeO
0x4E9CCCAModeO
0x4E93ZigbeeTotalMessageInOneHourO
0x4E92ZigbeeResentMessageInOneHourO
0x4E91ZigbeeFrameCounterO
0x4E8FZigbeeAvgSuccessfulResendCountO
0x4E90ZigbeeFailedMessageInOneHourO
0x5130ZigbeeNeighborInfoO
0x8121ZigbeeDeviceInformationO
0x4E8DZigbeeGeneralDiagnosticsO
0x8153LQIO
0x814BPANIDO
0x814AChannelO
0x4FA7ZigbeeExtendedPANIDO
0x50FEDeviceUnbindReasonO

ZigbeeNextHopMac Trait(上行的下跳设备Zigbee MAC地址)​

定义下一跳设备的 Zigbee MAC 地址。

Trait IDCode
0x4E84ZigbeeNextHopMac
参数​

该 Function 无额外参数。

详细说明​

ZigbeeNetworkDiagnostics 用于汇总 Zigbee 网络运行状态、链路质量、重传统计、邻居/路由信息与重启原因等诊断数据。

该 Function 的目标是帮助网关、调试工具与云端诊断系统快速定位 Zigbee 网络中的链路劣化、入网异常、重启异常、消息失败和邻居关系变化。

适用范围​

该 Function 适用于作为 Zigbee 网络管理节点的设备,通常是网关、协调器或具备网络代理/诊断能力的公共节点。

当设备不具备完整 Zigbee 网络管理视角时,可仅实现与自身可见网络状态一致的 Trait 子集,但应保证已实现 Trait 的语义完整、值域一致且可稳定上报。

语义约定​

  • RebootReason 应反映最近一次启动或重启的原因。
  • PreOperationMode 应反映设备进入当前工作状态前所处的网络阶段。
  • CurOperationMode 应反映设备当前的 Zigbee 网络运行状态。
  • PANID、Channel、ZigbeeExtendedPANID 应描述设备当前所加入或所管理的 Zigbee 网络标识。
  • ZigbeeNeighborInfo 与 ZigbeeGeneralDiagnostics 应分别承载邻居信息列表与通用诊断统计信息;若设备内部采用更细粒度的诊断指标,也应通过这两个 Trait 的结构化值进行组织。
  • ZigbeeDeviceInformation 应承载设备的 Zigbee 身份与安装信息;其中 InstallCode 属于 commissioning-secret,SHALL NOT 经普通诊断接口回读。

Trait 使用建议​

ZigbeeNextHopMac、ZigbeeKeySeqNumber、ZigbeeCoordNetworkKey、ZigbeeCoordMac、ZigbeeDeviceInformation 更偏向网络安全与网络身份信息;RebootReason、PreOperationMode、CurOperationMode 更偏向系统状态;APSRetransmissionCount、MACRetransmissionCount、NWKRetransmissionCount、RoutingAgingCountThreshold、MessageTransmissionFailureCountThreshold、EnableNWKACK、EnableAPSACK、CCAMode 更偏向链路策略;ZigbeeTotalMessageInOneHour、ZigbeeResentMessageInOneHour、ZigbeeFrameCounter、ZigbeeAvgSuccessfulResendCount、ZigbeeFailedMessageInOneHour 更偏向运行统计;ZigbeeNeighborInfo、ZigbeeGeneralDiagnostics、LQI、PANID、Channel、ZigbeeExtendedPANID 更偏向网络观测值。

数据更新原则​

  • 计数型 Trait 应在设备运行期间单调递增或按实现定义刷新,但不应无故回退。
  • 网络标识型 Trait 在网络重入、切网或重新入网后可更新。
  • 枚举型 Trait 应始终落在其声明的有效枚举集合内。
  • 若设备暂时无法采集某项诊断值,应使用该 Trait 定义允许的空值、默认值或厂商实现定义的不可用语义,而不应输出越界值。

与上层系统的关系​

云端或本地调试工具可依据这些 Trait 判断:

  • 设备是否已成功加入 Zigbee 网络。
  • 当前 Zigbee 网络是否存在大量重传、失败或路由老化。
  • 邻居表是否出现异常增长、丢失或链路质量下降。
  • 设备是否发生过异常重启、看门狗复位或软件升级重启。
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

ZigbeeKeySeqNumber Trait(Zigbee网络密钥序列号)​

表示 Zigbee 协调器当前使用的 network key 序列号,用于标识密钥版本。Magic Pair 入网过程中,网关向云端或 App 上报该属性,入网设备必须获取该序列号并在本地配置,以确保与协调器使用相同 network key 的安全通信。默认值为 0。

Trait IDCode
0x4F53ZigbeeKeySeqNumber
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO
0x0007Default Valueuint80RWO

ZigbeeCoordNetworkKey Trait(Zigbee协调器网络密钥)​

用于表示 Zigbee 协调器的网络密钥。

Trait IDCode
0x4F4CZigbeeCoordNetworkKey
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

ZigbeeCoordMac Trait(Zigbee协调器的MAC地址)​

用于表示 Zigbee 协调器的 MAC 地址。

Trait IDCode
0x4F4DZigbeeCoordMac
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

RebootReason Trait(重启原因)​

当前值应指示设备最近一次启动的原因。

Trait IDCode
0x8149RebootReason
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRebootReasonEnum80RVO
0x0006Supported Valuelist[RebootReasonEnum8]RO

PreOperationMode Trait(Zigbee设备前工作模式)​

表示设备先前的 Zigbee 网络连接状态。

Trait IDCode
0x4EA9PreOperationMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePreOperationModeEnum80RVO
0x0006Supported Valuelist[PreOperationModeEnum8]RO

APSRetransmissionCount Trait(APS层重传次数)​

ZigBee APS 层在数据包未收到确认时尝试的自动重传次数。

Trait IDCode
0x4E9BAPSRetransmissionCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint83RVWO
0x0002Maximum Valueuint820RO
0x0003Minimum Valueuint83RO
0x0005Step Valueuint321RO
0x0007Default Valueuint83RWO

MACRetransmissionCount Trait(MAC层重传次数)​

指示数据包传输期间 MAC 层的重传次数。

Trait IDCode
0x4EA5MACRetransmissionCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint83RVWO
0x0002Maximum Valueuint814RO
0x0003Minimum Valueuint83RO
0x0005Step Valueuint321RO
0x0007Default Valueuint83RWO

NWKRetransmissionCount Trait(网络层重传次数)​

指示数据包传输期间网络层的重传次数。

Trait IDCode
0x4EA8NWKRetransmissionCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint83RVWO
0x0002Maximum Valueuint820RO
0x0003Minimum Valueuint83RO
0x0005Step Valueuint321RO
0x0007Default Valueuint83RWO

RoutingAgingCountThreshold Trait(路由老化计数门槛)​

设备数据包路由的老化计数阈值设置。

Trait IDCode
0x4EA7RoutingAgingCountThreshold
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint85RVWO
0x0002Maximum Valueuint820RO
0x0003Minimum Valueuint83RO
0x0005Step Valueuint321RO
0x0007Default Valueuint85RWO

MessageTransmissionFailureCountThreshold Trait(报文发送失败计数门槛)​

设备数据包传输失败的阈值计数设置。

Trait IDCode
0x4EA6MessageTransmissionFailureCountThreshold
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint810RVWO
0x0002Maximum Valueuint820RO
0x0003Minimum Valueuint83RO
0x0005Step Valueuint321RO
0x0007Default Valueuint810RWO

EnableNWKACK Trait(网络层重传使能配置)​

切换在网络通信中启用网络层确认的选项。

Trait IDCode
0x4EA2EnableNWKACK
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableAPSACK Trait(APS应答使能配置)​

切换在网络通信中启用 APS 确认的选项。

Trait IDCode
0x4E9FEnableAPSACK
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CurOperationMode Trait(Zigbee设备工作模式)​

表示设备当前的 Zigbee 网络连接状态。

Trait IDCode
0x4E9DCurOperationMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCurOperationModeEnum80RVO
0x0006Supported Valuelist[CurOperationModeEnum8]RO

CCAMode Trait(CCA模式)​

指示设备的 CCA 状态。

Trait IDCode
0x4E9CCCAMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCCAModeEnum80RVO
0x0006Supported Valuelist[CCAModeEnum8]RO

ZigbeeTotalMessageInOneHour Trait(1小时内发送Zigbee报文总个数)​

指示 1 小时内发送的 Zigbee 消息总数。

Trait IDCode
0x4E93ZigbeeTotalMessageInOneHour
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

ZigbeeResentMessageInOneHour Trait(1小时内发送Zigbee报文重发个数)​

表示一小时内重发的 Zigbee 消息数量。

Trait IDCode
0x4E92ZigbeeResentMessageInOneHour
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

ZigbeeFrameCounter Trait(Zigbee帧计数值)​

ZigBee 帧计数器为每条数据帧附加的唯一递增值,用于防止重放攻击并保障通信安全。

Trait IDCode
0x4E91ZigbeeFrameCounter
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

ZigbeeAvgSuccessfulResendCount Trait(Zigbee平均成功重发报文个数)​

指示 Zigbee 消息成功重发的平均次数。

Trait IDCode
0x4E8FZigbeeAvgSuccessfulResendCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

ZigbeeFailedMessageInOneHour Trait(1小时内发送Zigbee报文失败个数)​

表示一小时内发送失败的 Zigbee 消息数量。

Trait IDCode
0x4E90ZigbeeFailedMessageInOneHour
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

ZigbeeNeighborInfo Trait(Zigbee邻居信息)​

提供 Zigbee 邻居节点信息列表。

Trait IDCode
0x5130ZigbeeNeighborInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[ZigbeeNeighborInfo Type]RVO

ZigbeeGeneralDiagnostics Trait(Zigbee设备通用诊断信息上报)​

子设备自诊断信息的通用报告渠道。

Trait IDCode
0x4E8DZigbeeGeneralDiagnostics
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

LQI Trait(链路质量指示)​

指示 Thread 网络的 Link Quality Indicator(LQI),反映 Thread 设备间 RF 链路质量。范围:0-255。

Trait IDCode
0x8153LQI
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

PANID Trait(个人区域网络标识符)​

当前值指示 Zigbee 网络 PAN ID。

Trait IDCode
0x814BPANID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665534RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO

Channel Trait(无线信道)​

当前值指示 Zigbee 网络信道号。

Trait IDCode
0x814AChannel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO

ZigbeeExtendedPANID Trait(Zigbee 网络扩展标识符)​

表示Zigbee网络的64位扩展标识符的字符串。它与16位PAN ID一起用于唯一标识网络,通常表示为16个字符的十六进制字符串(例如"00124B0001234567" )。

Trait IDCode
0x4FA7ZigbeeExtendedPANID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

DeviceUnbindReason Trait(设备解绑原因)​

上报设备解绑原因及关联元数据(type、time、prevDel、did、model)。

Trait IDCode
0x50FEDeviceUnbindReason
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDeviceUnbindReasonTraitPresentValueStructureRVO

Command 定义​

本 Function 不包含 Command。

ZigbeeSubscribe(Zigbee订阅)​

简介​

提供 Zigbee 订阅能力,用于记录可订阅的设备资源、订阅能力范围以及订阅记录管理。该 Function 主要面向网关、桥接器或具备资源代理能力的 Zigbee 节点,用于将外部资源订阅关系与本地设备资源建立稳定映射。

该能力与 Zigbee 设备的实际资源读写能力相配合:设备自身不主动发起订阅,而是被动接收订阅记录,再根据订阅记录去查询或控制对应资源。

Function 标识​

Function IDCode名称
0x0125ZigbeeSubscribeZigbee订阅

Trait​

Trait IDCode名称Conformance
0x5131SubscribeRecordId订阅记录IDM
0x5132SubscribeCapability订阅能力M

Command​

Command IDCode名称Conformance
0x9D70AddSubscribeRecord新增订阅记录M
0x9D9DAddSubscribeRecordRsp新增订阅记录响应M
0x9D97RemoveSubscribeRecord移除订阅记录M
0x9D9ERemoveSubscribeRecordRsp移除订阅记录响应M
0x9D98GetSubscribeRecord获取订阅记录M
0x9D9FGetSubscribeRecordRsp获取订阅记录响应M
0x9D99PublishSubscribeData公开订阅数据M
0x9DA0PublishSubscribeDataRsp公开订阅数据响应M
0x9D9AQuerySubscribeData查询订阅数据M
0x9DA1QuerySubscribeDataRsp查询订阅数据响应M
0x9D9BSetSubscribeData设置订阅数据M
0x9DA2SetSubscribeDataRsp设置订阅数据响应M

数据类型​

SubscribeStatusCodeEnum Type​

该枚举定义订阅相关命令执行结果。

ValueNameDescription
0x00Success成功
0x01Failure失败
SubscribeData Type​

该结构体用于承载资源标识和值。

结构体成员序号字段名类型必须说明
0ResourceIDuint64M资源 ID(BACnet 格式)。
1Valueoctstr16M资源值。
SubscribeCapabilityTraitPresentValueStructure Type​

该类型描述 SubscribeCapability Trait 的解码语义。在线上协议中,SubscribeCapability 以 octstr16 透传,内容为 Header + nested CBOR Payload。

结构体成员序号字段名类型必须说明
0EffectDataHeaderoctstr16MEffectData 头,包含协议标识、版本与控制位。
1NestedCborPayloadoctstr16M嵌套 CBOR 负载,包含 Devices 能力树、每类设备端点上限以及可订阅 Aqara Spec 标签。

Trait 定义​

Trait IDNameConformance
0x5131SubscribeRecordIdM
0x5132SubscribeCapabilityM

SubscribeRecordId Trait(订阅记录ID)​

记录当前设备已保存的订阅记录 ID 列表,便于查询、删除与状态同步。

Trait IDCode
0x5131SubscribeRecordId
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[uint32]RVM

SubscribeCapability Trait(订阅能力)​

定义设备对可订阅资源的能力上限与资源标签集合。

Trait IDCode
0x5132SubscribeCapability
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueoctstr16Header + nested CBOR PayloadRVM

Command 定义​

AddSubscribeRecord Command​

该命令用于请求服务端新增一条订阅记录。

参数序号参数名类型Conformance说明
0SubscribeRecordoctstr16M订阅记录原文,编码格式见 SubscribeRecord Encoding 规范。
AddSubscribeRecordRsp Command​

该命令用于响应 AddSubscribeRecord,指示新增操作结果。

参数序号参数名类型Conformance说明
0StatusSubscribeStatusCodeEnumM执行状态。
1SubscribeRecordIduint32M新增成功后的订阅记录 ID。
RemoveSubscribeRecord Command​

该命令用于请求服务端删除指定订阅记录。

参数序号参数名类型Conformance说明
0SubscribeRecordIduint32M待删除的订阅记录 ID。
RemoveSubscribeRecordRsp Command​

该命令用于响应 RemoveSubscribeRecord,指示删除操作结果。

参数序号参数名类型Conformance说明
0StatusSubscribeStatusCodeEnumM执行状态。
GetSubscribeRecord Command​

该命令用于按订阅记录 ID 请求服务端返回订阅记录内容。

参数序号参数名类型Conformance说明
0SubscribeRecordIduint8M待读取的订阅记录 ID。
GetSubscribeRecordRsp Command​

该命令用于响应 GetSubscribeRecord,返回订阅记录内容。

参数序号参数名类型Conformance说明
0StatusSubscribeStatusCodeEnumM执行状态。
1SubscribeRecordoctstr16M订阅记录原文。
PublishSubscribeData Command​

该命令用于由客户端向服务端发布订阅数据。

参数序号参数名类型Conformance说明
0DeviceDidoctstrM设备 Did。
1SubscribeDatalist[SubscribeDataType]M待发布的订阅数据列表。
PublishSubscribeDataRsp Command​

该命令用于响应 PublishSubscribeData,指示发布操作结果。

参数序号参数名类型Conformance说明
0StatusSubscribeStatusCodeEnumM执行状态。
QuerySubscribeData Command​

该命令用于按设备和资源 ID 列表请求服务端查询订阅数据。

参数序号参数名类型Conformance说明
0DeviceDidoctstrM设备 Did。
1ResourceIDlist[uint64]M待查询的资源 ID 列表。
QuerySubscribeDataRsp Command​

该命令用于响应 QuerySubscribeData,返回订阅数据内容。

参数序号参数名类型Conformance说明
0StatusSubscribeStatusCodeEnumM执行状态。
1DeviceDidoctstrM设备 Did。
2SubscribeDatalist[SubscribeDataType]M查询返回的订阅数据列表。
SetSubscribeData Command​

该命令用于请求服务端按设备写入订阅数据。

参数序号参数名类型Conformance说明
0DeviceDidoctstrM设备 Did。
1SubscribeDatalist[SubscribeDataType]M待写入的订阅数据列表。
SetSubscribeDataRsp Command​

该命令用于响应 SetSubscribeData,指示写入操作结果。

参数序号参数名类型Conformance说明
0StatusSubscribeStatusCodeEnumM执行状态。

语义说明​

  • 订阅记录应以设备 Did 作为归属标识,以资源 ID 作为定位目标。
  • 订阅能力信息应尽量与设备真实可订阅能力一致,不应夸大支持范围。
  • 资源值编码应保持可逆和稳定,便于后续查询与数据同步。
  • 若记录不存在、资源不支持或数据格式非法,相关命令应返回失败状态。

编码规范​

SubscribeRecord 编码规范​

本节定义 SubscribeRecord 字段在 AddSubscribeRecord 与 GetSubscribeRecord 返回内容中的二进制编码格式。编码采用 Header + Payload 架构,其中 Payload 使用 CBOR(RFC 8949)编码。

通用 EffectData 头布局、Flags 语义、ProtocolID 分配、CBOR 规则以及解析流程,见本仓库复合数据编码协议相关说明。订阅记录协议使用如下固定参数:

  • ProtocolID = 0x04
  • ProtocolName = SubscribeRecord
  • Version = 0
  • PayloadFormat = CBOR

当前版本定义一种订阅记录类型:订阅设备资源值(SubscribeType = 0x00)。

总览​

EffectData 二进制格式由以下部分组成:

  • Header:最少 2 字节,包含协议标识、版本和控制标志。
  • Payload:CBOR 编码的 Map,用于描述订阅记录内容。

整体结构如下:

+------------------+-------+---------------+--------+---------+
| ProtocolVersion | Flags | PayloadLength | CRC16 | Payload |
| (1 byte) |(1 byte)| (opt 2B) |(opt 2B)| (CBOR) |
+------------------+-------+---------------+--------+---------+
required required optional optional required
Header 结构​
Byte 0 - ProtocolVersion​

该字节将 Protocol ID 与 Version 合并编码。

	7   6   5   4   3   2   1   0
+-------+---------------------------+
|Version| ProtocolID |
| 2 bit | 6 bit |
+-------+---------------------------+
BitsNameRangeDescription
bit 0-5ProtocolID0-63协议标识,0x04 表示 SubscribeRecord。
bit 6-7Version0-3版本号。

编码公式:ProtocolVersion = (Version &lt;&lt; 6) | ProtocolID

解码公式:ProtocolID = ProtocolVersion & 0x3F,Version = (ProtocolVersion &gt;&gt; 6) & 0x03

Byte 1 - Flags​

该字节用于控制可选字段是否存在,以及 Payload 属性。

	7   6   5   4   3   2   1   0
+-------+-------+---+---+---+---+
|Reserv |Format |Cmp|Enc|CRC|Len|
| 2 bit | 2 bit | 1 | 1 | 1 | 1 |
+-------+-------+---+---+---+---+
BitsNameDescription
bit 0HasPayloadLength1 表示存在 PayloadLength 字段(2 字节)。
bit 1HasCRC1 表示存在 CRC16 字段(2 字节),要求 HasPayloadLength = 1。
bit 2Encrypted预留位,必须为 0。
bit 3Compressed预留位,必须为 0。
bit 4-5PayloadFormat0x00 表示 CBOR(默认),其余值预留。
bit 6-7Reserved预留位,必须为 0。

常见 Flags 取值:

FlagsHeader LengthFields Present
0x002 bytes仅 ProtocolVersion + Flags
0x014 bytes+ PayloadLength
0x036 bytes+ PayloadLength + CRC16
备注

Flags = 0x02(仅有 CRC 而没有 PayloadLength)是非法配置,因为 CRC 计算需要明确 Payload 边界。

可选字段​
  • PayloadLength(2 字节,大端):当 Flags.bit0 = 1 时存在,表示 Payload 的字节长度。
  • CRC16(2 字节,大端):当 Flags.bit1 = 1 时存在,使用 CRC-16/MODBUS,对 Payload 本体计算,不包含 Header。
Payload 结构(CBOR)​

Payload 为 CBOR Map(RFC 8949),Map Key 使用无符号整数。键值 0-23 在 CBOR 中可编码为单字节,以降低开销。

CBOR Key 定义​

Map Key 使用无符号整数(CBOR major type 0);0-23 可编码为单字节。

KeyNameCBOR TypeRange/UnitDescription
0SubscribeTypeunsigned int0订阅记录类型,用于决定后续结构。
1RecordIdunsigned int订阅记录 ID。
2SourceDeviceMacbyte string8 bytes被订阅设备的 MAC 地址。
3SourceDeviceDidstring被订阅设备的 Did。
4DeviceTypeunsigned int设备类型。
5ResouceIdbyte string8 bytes资源值标识,用于 SubscribeItem 子 Map 内部。
6AqaraSpecbyte string8 bytesAqara Spec 标签,用于 SubscribeItem 子 Map 内部。
7SubscribeItemarray of map已订阅资源项列表。
SubscribeType 字段​

该字段用于指示订阅记录的类型。

ValueNameDescriptionRequired top-level keys (for this type)
0x00SubscribeDevice订阅设备资源值0、1、3、4、7(见下文结构),其中 key 2 可选。
RecordId 字段​

该字段承载订阅记录标识 RecordId。

SourceDeviceMac 字段​

该字段用于指示源设备 MAC 地址,固定为 8 字节 byte string。

SourceDeviceDid 字段​

该字段用于指示源设备 Did。

DeviceType 字段​

该字段用于指示设备类型。其值为 Aqara Spec 定义的无符号整数设备类型 ID,与 Aqara Spec Tag 中 function / trait 所使用的数值空间保持一致。

SubscribeItem 字段​

该字段为 CBOR Array,数组中的每个元素均为 Map,用于描述一个被订阅资源。每个 Map 必须包含 key 5(ResouceId)和 key 6(AqaraSpec)。

ResouceId 字段(位于 SubscribeItem 内)​

该字段用于指示需要订阅的资源值。协议原始拼写为 ResouceId,文档保持一致。

AqaraSpec 字段(位于 SubscribeItem 内)​

该字段用于指示该资源对应的 Aqara Spec 标签。

SubscribeType 编码细节​
SubscribeDevice(SubscribeType = 0x00)​

CBOR Payload 结构如下:

{
0: <SubscribeType> // [M] SubscribeType = SubscribeDevice (0x00)
1: <RecordId> // [M] Subscribe record ID
2: <SourceDeviceMac>, // [O] Subscribed device MAC
3: <SourceDeviceDid>, // [M] Subscribed device Did
4: <DeviceType> // [M] Device type
7: [ // [M] SubscribeItem
{ 5: <ResouceId>, // [M] Resource value
6: <AqaraSpec>, // [M] Aqara spec tag
},
...
]
}

接收端除要求上述必选键外,还应要求 SourceDeviceMac(key 2)或 SourceDeviceDid(key 3)至少存在一个,用于设备身份识别。

校验规则​
Header 校验​

接收端应校验:

  1. ProtocolID 为 0x04。
  2. Version 为 0。
  3. Flags 的 bit 2、bit 3、bit 6-7 均为 0。
  4. PayloadFormat 为 0(CBOR)。
  5. 若 HasCRC = 1,则 HasPayloadLength 也必须为 1。
Payload 校验​

接收端应校验:

  1. Payload 为 CBOR Map。
  2. 存在 SubscribeType(key 0),且在当前规范版本中其值必须为 0x00。
  3. SourceDeviceMac(key 2)与 SourceDeviceDid(key 3)至少存在一个。
  4. 每个 SubscribeItem 均包含 ResouceId(key 5)与 AqaraSpec(key 6)。
  5. 所有出现的 key 值均位于 0-100 范围。
  6. 未定义 key 建议忽略;严格实现可拒绝包含未知 key 的数据。
编码示例​
示例 1:订阅开关一路的开关状态​

资源值(point)为 4.1.85,Aqara Spec 为 1.132.32920.85。

EffectData 参数:

  • SubscribeType = SubscribeDevice (0)
  • RecordId = 1
  • SourceDeviceDid = lumi.54ef441000645ad1
  • DeviceType = 12

CBOR 诊断表示如下(为便于说明,下面 ResouceId 与 AqaraSpec 以 8 字节 byte string 展示):

{
0: 0,
1: 1,
3: "lumi.54ef441000645ad1",
4: 12,
7: [
{ 5: h'0100000100000055',
6: h'0001008480980055'
}
]
}

Payload(CBOR,hex):

A5 00 00 01 01 03 75 6C 75 6D 69 2E 35 34 65 66 34 34 31 30 30 30 36 34 35 61 64 31 04 0C 07 81 A2 05 48 01 00 00 01 00 00 00 55 06 48 00 01 00 84 80 98 00 55

完整 EffectData(最小 Header,Flags = 0x00):

Header:  04 00
Payload: A5 00 00 01 01 03 75 6C 75 6D 69 2E 35 34 65 66 34 34 31 30 30 30 36 34 35 61 64 31 04 0C 07 81 A2 05 48 01 00 00 01 00 00 00 55 06 48 00 01 00 84 80 98 00 55
Total: 53 bytes

解析要点(前几字节):

  1. 04:ProtocolVersion,表示 ProtocolID = 4、Version = 0。
  2. 00:Flags,表示无长度字段、无 CRC、Payload 为 CBOR。
  3. A5:CBOR Map,共 5 个键值对(key 0、1、3、4、7)。
  4. 00 / 00:key 0,表示 SubscribeType = SubscribeDevice。
  5. 01 / 01:key 1,表示 RecordId = 1。
  6. 03 ...:key 3,表示 UTF-8 文本 Did lumi.54ef441000645ad1。
  7. 04 / 0C:key 4,表示 DeviceType = 12。
  8. 07 ...:key 7,表示长度为 1 的数组,其中每个元素是包含 key 5 与 key 6 的 Map,分别对应 8 字节的 ResouceId 与 AqaraSpec(48 表示长度为 8 的 byte string)。
SubscribeCapability 编码规范​

本节定义 SubscribeCapability Trait 的二进制编码格式。编码采用 Header + Payload 架构,其中 Payload 使用 CBOR(RFC 8949)编码。

通用 EffectData 头布局、Flags 语义、ProtocolID 分配、CBOR 规则以及解析流程,见本仓库复合数据编码协议相关说明。订阅能力协议使用如下固定参数:

  • ProtocolID = 0x05
  • ProtocolName = SubscribeCapability
  • Version = 0
  • PayloadFormat = CBOR

当前版本将所有设备类型的订阅能力合并到一个嵌套 CBOR Map 中。每个设备类型内部的 Aqara Spec 标签以 function → trait → [parameter] 层级树编码,并省略 endpoint 段(在 capability 场景中始终为占位值)。

总览​

EffectData 二进制格式由以下部分组成:

  • Header:最少 2 字节,包含协议标识、版本和控制标志。
  • Payload:CBOR 编码的 Map,用于描述支持的设备类型及其订阅能力上限。

整体结构如下:

+------------------+-------+---------------+--------+---------+
| ProtocolVersion | Flags | PayloadLength | CRC16 | Payload |
| (1 byte) |(1 byte)| (opt 2B) |(opt 2B)| (CBOR) |
+------------------+-------+---------------+--------+---------+
required required optional optional required
Header 结构​
Byte 0 - ProtocolVersion​

该字节将 Protocol ID 与 Version 合并编码。

	7   6   5   4   3   2   1   0
+-------+---------------------------+
|Version| ProtocolID |
| 2 bit | 6 bit |
+-------+---------------------------+
BitsNameRangeDescription
bit 0-5ProtocolID0-63协议标识,0x05 表示 SubscribeCapability。
bit 6-7Version0-3版本号。

编码公式:ProtocolVersion = (Version &lt;&lt; 6) | ProtocolID

解码公式:ProtocolID = ProtocolVersion & 0x3F,Version = (ProtocolVersion &gt;&gt; 6) & 0x03

Byte 1 - Flags​

该字节用于控制可选字段是否存在,以及 Payload 属性。

	7   6   5   4   3   2   1   0
+-------+-------+---+---+---+---+
|Reserv |Format |Cmp|Enc|CRC|Len|
| 2 bit | 2 bit | 1 | 1 | 1 | 1 |
+-------+-------+---+---+---+---+
BitsNameDescription
bit 0HasPayloadLength1 表示存在 PayloadLength 字段(2 字节)。
bit 1HasCRC1 表示存在 CRC16 字段(2 字节),要求 HasPayloadLength = 1。
bit 2Encrypted预留位,必须为 0。
bit 3Compressed预留位,必须为 0。
bit 4-5PayloadFormat0x00 表示 CBOR(默认),其余值预留。
bit 6-7Reserved预留位,必须为 0。

常见 Flags 取值:

FlagsHeader LengthFields Present
0x002 bytes仅 ProtocolVersion + Flags
0x014 bytes+ PayloadLength
0x036 bytes+ PayloadLength + CRC16
备注

Flags = 0x02(仅有 CRC 而没有 PayloadLength)是非法配置,因为 CRC 计算需要明确 Payload 边界。

可选字段​
  • PayloadLength(2 字节,大端):当 Flags.bit0 = 1 时存在,表示 Payload 的字节长度。
  • CRC16(2 字节,大端):当 Flags.bit1 = 1 时存在,使用 CRC-16/MODBUS,对 Payload 本体计算,不包含 Header。
Payload 结构(CBOR)​

Payload 为 CBOR Map(RFC 8949),Map Key 使用无符号整数。键值 0-23 在 CBOR 中可编码为单字节,以降低开销。

CBOR Key 定义​

Map Key 使用无符号整数(CBOR major type 0);0-23 可编码为单字节。 固定 Key 空间由顶层 Payload Map 与 Devices 条目 Map 共享:

  • 顶层 Payload Map 使用 key 0(Devices)。
  • Devices 数组中每个元素使用 key 1、2、3。

在 AqaraSpecTree(key 3)内部,Map Key 不再使用此固定表,而是直接使用数值型 function 与 trait 值本身。

KeyNameCBOR TypeRange/UnitDescription
0Devicesarray of map各设备类型订阅能力条目列表。
1DeviceTypeunsigned intAqara Spec 定义的设备类型 ID,位于每个 Devices 条目中。
2MaxEndpointNumunsigned int1-255该设备类型允许订阅的最大不同 endpoint 数量,位于每个 Devices 条目中。
3AqaraSpecTreemap该设备类型支持订阅的 Aqara Spec 层级树,位于每个 Devices 条目中。
Devices 字段​

该字段为 CBOR Array,数组中的每个 Map 描述一个设备类型的订阅能力。空数组表示当前服务端不支持任何设备类型的订阅。

DeviceType 字段(位于 Devices 条目内)​

该字段用于指示能力条目所对应的设备类型,其值为 Aqara Spec 定义的无符号整数设备类型 ID。单个 Payload 内同一 DeviceType 只能出现一次。

MaxEndpointNum 字段(位于 Devices 条目内)​

该字段用于指示服务端对该设备类型最多可订阅多少个不同 endpoint。

AqaraSpecTree 字段(位于 Devices 条目内)​

该字段使用分层 CBOR Map 描述该设备类型可订阅的 Aqara Spec 标签集合,编码层级如下:

function → trait → [ parameter, ... ]

Aqara Spec Tag 由四部分组成:endpoint、function、trait、parameter,均为 16 位无符号整数。在 SubscribeCapability 中:

  • endpoint 为能力层占位段,编码时必须省略;接收端在将树路径还原为完整 Tag 时,应将其逻辑值视为 0xFFFF。
  • function 作为外层 Map Key(无符号整数)。
  • trait 作为内层 Map Key(无符号整数),位于各 function 下。
  • parameter 作为各 trait 对应的 CBOR Array 元素。通常值较小(绝大多数不超过 16),因此常可编码为单字节。

每一条路径 function F → trait T → parameter P 可展开为一个逻辑 Aqara Spec:(endpoint=0xFFFF, function=F, trait=T, parameter=P)。

编码约束如下:

  • function、trait、parameter 必须为无符号整数。
  • 同一棵树中,每个 function key 只能出现一次;同一 function 下,每个 trait key 只能出现一次。
  • 同一 (function, trait) 对应的参数数组中,每个 parameter 只能出现一次,且建议按升序排列。
  • 空 Map {} 表示该设备类型当前没有任何可订阅 Aqara Spec 标签。
Payload 编码形状​

CBOR Payload 结构如下:

{
0: [ // [M] Devices
{
1: <DeviceType>, // [M] Device type
2: <MaxEndpointNum>, // [M] Max endpoint count
3: { // [M] AqaraSpecTree
<function>: { // [M] function as map key
<trait>: [ <parameter>, ... ], // [M] trait as map key; parameter array
...
},
...
}
},
...
]
}
校验规则​
Header 校验​

接收端应校验:

  1. ProtocolID 为 0x05。
  2. Version 为 0。
  3. Flags 的 bit 2、bit 3、bit 6-7 均为 0。
  4. PayloadFormat 为 0(CBOR)。
  5. 若 HasCRC = 1,则 HasPayloadLength 也必须为 1。
Payload 校验​

接收端应校验:

  1. Payload 为 CBOR Map。
  2. 存在 Devices(key 0),且其类型为 Array。
  3. Devices 中每个元素均为 Map,且必须包含 DeviceType(key 1)、MaxEndpointNum(key 2)和 AqaraSpecTree(key 3)。
  4. 每个 DeviceType 均为 Aqara Spec 定义的无符号整数设备类型 ID。
  5. 单个 Payload 中 DeviceType 取值必须唯一。
  6. 每个 MaxEndpointNum 必须为 1-255 范围内的无符号整数。
  7. 每个 AqaraSpecTree 均为 Map,且满足:
  8. 出现的固定 Devices 条目 key 应位于 0-100 范围。
  9. 未定义固定 key 建议忽略;严格实现可拒绝未知固定 key。
编码示例​
示例 1:开关设备能力(单个 Spec)​

EffectData 参数:

  • DeviceType = 12(开关设备,定义见 Aqara Spec)
  • MaxEndpointNum = 4
  • 一个 Aqara Spec 路径:function=132、trait=32920、parameter=1

CBOR 诊断表示如下:

{
0: [
{
1: 12,
2: 4,
3: {
132: {
32920: [1]
}
}
}
]
}

Payload(CBOR,hex):

A1 00 81 A3 01 0C 02 04 03 A1 18 84 A1 19 80 98 81 01

完整 EffectData(最小 Header,Flags = 0x00):

Header:  05 00
Payload: A1 00 81 A3 01 0C 02 04 03 A1 18 84 A1 19 80 98 81 01
Total: 21 bytes

解析要点:

  1. 05:ProtocolVersion,表示 ProtocolID = 5、Version = 0。
  2. 00:Flags,表示无长度字段、无 CRC、Payload 为 CBOR。
  3. A1:CBOR Map,共 1 个键值对(key 0)。
  4. 00 / 81:key 0,表示长度为 1 的 Devices 数组。
  5. A3:Map,共 3 个键值对(key 1、2、3)。
  6. 01 / 0C:key 1,表示 DeviceType = 12(Switch)。
  7. 02 / 04:key 2,表示 MaxEndpointNum = 4。
  8. 03 / A1:key 3,表示 AqaraSpecTree,其中包含一个 function。
  9. 18 84:function key = 132。
  10. A1 19 80 98:trait key = 32920。
  11. 81 01:parameter 数组 [1]。
示例 2:同一 function / trait 下的多个 parameter​

CBOR 诊断表示如下:

{
0: [
{
1: 12,
2: 4,
3: {
132: {
32920: [1, 2, 3, 4, 5]
}
}
}
]
}

Payload(CBOR,hex):

A1 00 81 A3 01 0C 02 04 03 A1 18 84 A1 19 80 98 85 01 02 03 04 05

5 个逻辑 Spec 共享同一个 function key 与 trait key;Payload 长度为 22 字节,加上 2 字节 Header 后总计 24 字节。

示例 3:多个设备类型​

CBOR 诊断表示如下:

{
0: [
{
1: 12,
2: 4,
3: {
132: { 32920: [1] }
}
},
{
1: 10,
2: 2,
3: {
132: {
32920: [1],
32921: [1]
}
}
}
]
}

上述内容表示:

  • 开关设备(DeviceType = 12):最多 4 个 endpoint,支持 Spec (function=132, trait=32920, parameter=1)。
  • 灯设备(DeviceType = 10):最多 2 个 endpoint,支持 Spec (132, 32920, 1) 与 (132, 32921, 1)。

Payload(CBOR,hex):

A1 00 82 A3 01 0C 02 04 03 A1 18 84 A1 19 80 98 81 01 A3 01 0A 02 02 03 A1 18 84 A2 19 80 98 81 01 19 80 99 81 01

AnalogInputObject(模拟输入对象)​

简介​

以只读方式采集连续变化的模拟量输入(如电压、温度模拟信号)。

Function 标识​

. 同一 (function, trait) 下参数值必须唯一。

Function IDCode名称
0x00CEAnalogInputObject模拟输入对象

Trait​

Trait IDCode名称Conformance
0x4EB2AnalogInputPV模拟输入当前值M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4EB2AnalogInputPVM

AnalogInputPV Trait(模拟输入当前值)​

AnalogInputPV传达模拟输入通道的实时实时值及其工程元数据。

Trait IDCode
0x4EB2AnalogInputPV
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat4294967295RO
0x0003Minimum Valuefloat0RO

Command 定义​

本 Function 不包含 Command。

AnalogOutputObject(模拟输出对象)​

简介​

提供可写的连续模拟量输出控制信号。

Function 标识​

Function IDCode名称
0x00CFAnalogOutputObject模拟输出对象

Trait​

Trait IDCode名称Conformance
0x4EB3AnalogOutputPV模拟输出当前值M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4EB3AnalogOutputPVM

AnalogOutputPV Trait(模拟输出当前值)​

AnalogOutputPV携带模拟输出对象的指令值或实际值。

Trait IDCode
0x4EB3AnalogOutputPV
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuefloatRVWM
0x0002Maximum Valuefloat4294967295RO
0x0003Minimum Valuefloat0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

BinaryInputObject(二进制输入对象)​

简介​

采集二元状态输入,如门磁、开关等 true/false 或 active/inactive 量。

Function 标识​

Function IDCode名称
0x00D0BinaryInputObject二进制输入对象

Trait​

Trait IDCode名称Conformance
0x4EB4BinaryInputPV二进制输入当前值M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4EB4BinaryInputPVM

BinaryInputPV Trait(二进制输入当前值)​

BinaryInputPV报告离散输入的瞬时逻辑状态,并可选择描述极性反转。

Trait IDCode
0x4EB4BinaryInputPV
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVM
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

BinaryOutputObject(二进制输出对象)​

简介​

驱动二元执行器输出,如继电器、接触器、电磁阀或警号。

Function 标识​

Function IDCode名称
0x00D1BinaryOutputObject二进制输出对象

Trait​

Trait IDCode名称Conformance
0x4EB5BinaryOutputPV二进制输出当前值M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4EB5BinaryOutputPVM

BinaryOutputPV Trait(二进制输出当前值)​

BinaryOutputPV保存二进制输出的命令或实际开/关状态。

Trait IDCode
0x4EB5BinaryOutputPV
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWM
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

MultiStateInputObject(多状态输入对象)​

简介​

采集多状态离散输入,表示 N 种状态之一。

Function 标识​

Function IDCode名称
0x00D2MultiStateInputObject多状态输入对象

Trait​

Trait IDCode名称Conformance
0x4EB6MultiStateInputPV多状态输入当前值M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4EB6MultiStateInputPVM

MultiStateInputPV Trait(多状态输入当前值)​

MultiStateInputPV 提供当前枚举状态,以及人类可读的状态标签和可选描述文本。

Trait IDCode
0x4EB6MultiStateInputPV
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVM
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO

Command 定义​

本 Function 不包含 Command。

MultiStateOutputObject(多状态输出对象)​

简介​

输出多状态离散控制命令,如 HVAC 模式或灯光场景切换。

Function 标识​

Function IDCode名称
0x00D3MultiStateOutputObject多状态输出对象

Trait​

Trait IDCode名称Conformance
0x4EB7MultiStateOutputPV多状态输出当前值M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4EB7MultiStateOutputPVM

MultiStateOutputPV Trait(多状态输出当前值)​

MultiStateOutputPV 包含请求或当前活动的枚举输出状态。

Trait IDCode
0x4EB7MultiStateOutputPV
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32RVWM
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0007Default Valueuint320RWO

Command 定义​

本 Function 不包含 Command。

CharacterStringValueObject(字符串值对象)​

简介​

定义以字符串形式表示的数据对象及其外部可见特性。

Function 标识​

Function IDCode名称
0x00D4CharacterStringValueObject字符串值对象

Trait​

Trait IDCode名称Conformance
0x4EB8CharStringValuePV字符串对象当前值M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4EB8CharStringValuePVM

CharStringValuePV Trait(字符串对象当前值)​

指示 CharacterString Value Object 的当前值。

Trait IDCode
0x4EB8CharStringValuePV
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWM

Command 定义​

本 Function 不包含 Command。

ScreenUserInterface(屏端配置)​

简介​

管理屏端用户界面配置,包括页面布局、卡片、主题及展示数据。

Function 标识​

Function IDCode名称
0x00D5ScreenUserInterface屏端配置

Trait​

Trait IDCode名称Conformance
0x4EBCScreenHeight屏幕高度M
0x4EBBScreenWidth屏幕宽度M
0x4EBAMaxPageNum最大页面数量M
0x4EB9DataVersion数据版本M
0x4E78ThemeID主题IDM
0x4E77ThemeVersion主题版本M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4EBCScreenHeightM
0x4EBBScreenWidthM
0x4EBAMaxPageNumM
0x4EB9DataVersionM
0x4E78ThemeIDM
0x4E77ThemeVersionM

ScreenHeight Trait(屏幕高度)​

该 Trait 用于「屏幕高度」相关数据的访问与上报。

Trait IDCode
0x4EBCScreenHeight
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16O240RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint16O240RWO

ScreenWidth Trait(屏幕宽度)​

该 Trait 用于「屏幕宽度」相关数据的访问与上报。

Trait IDCode
0x4EBBScreenWidth
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16O240RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint16O240RWO

MaxPageNum Trait(最大页面数量)​

该 Trait 用于「最大页面数量」相关数据的访问与上报。

Trait IDCode
0x4EBAMaxPageNum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16O1RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint16O1RWO

DataVersion Trait(数据版本)​

该 Trait 用于「数据版本」相关数据的访问与上报。

Trait IDCode
0x4EB9DataVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint64O0RVM
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0007Default Valueuint64O0RWO

ThemeID Trait(主题ID)​

该 Trait 用于「主题ID」相关数据的访问与上报。

Trait IDCode
0x4E78ThemeID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16O1RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0007Default Valueuint16O1RWO

ThemeVersion Trait(主题版本)​

主题版本

Trait IDCode
0x4E77ThemeVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16O1RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16O1RWO

Command 定义​

本 Function 不包含 Command。

DeviceAnomalyMonitoring(设备异常监控)​

简介​

持续监测设备运行参数,及时发现并上报异常或故障状态。

Function 标识​

Function IDCode名称
0x00D6DeviceAnomalyMonitoring设备异常监控

Trait​

Trait IDCode名称Conformance
0x4ECAVoltageSafetyManagement电压安全管理O
0x4EC8LoadSafetyManagement负载安全管理O
0x4EC7TemperatureSafetyManagement温度安全管理O
0x4EC9CurrentSafetyManagement电流安全管理O
0x4ECBOverCurrentResponseSetting过流保护响应设置O
0x50DEOverTemperatureAlertEnable过温报警使能O
0x50DFUnderTemperatureAlertEnable低温报警使能O

Command​

本 Function 不包含 Command。

数据类型​

VoltageSafetyManagementEnum8 Type​

该枚举定义 VoltageSafetyManagement Trait 的 Present Value 有效取值。

ValueNameDescription
0x00VoltageNormal电压正常
0x01OverVoltageAnomaly过压异常
0x02OverVoltageProtection过压保护
0x03UnderVoltageProtection欠压保护
LoadSafetyManagementEnum8 Type​

该枚举定义 LoadSafetyManagement Trait 的 Present Value 有效取值。

ValueNameDescription
0x00LoadNormal负载正常
0x01OverLoadAnomaly过载异常
0x02OverLoadProtection过载保护
TemperatureSafetyManagementEnum8 Type​

该枚举定义 TemperatureSafetyManagement Trait 的 Present Value 有效取值。

ValueNameDescription
0x00TempNormal温度正常
0x01OverTempAnomaly过温异常
0x02OverTempProtection过温保护
0x0BUnderTempAnomaly低温异常
CurrentSafetyManagementEnum8 Type​

该枚举定义 CurrentSafetyManagement Trait 的 Present Value 有效取值。

ValueNameDescription
0x00CurrentNormal电流正常
0x01OverCurrentAnomaly过流异常
0x02OverCurrentProtection过流保护
OverCurrentResponseSettingEnum8 Type​

该枚举定义 OverCurrentResponseSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ShutdownSingle关断单个
0x01ShutdownAll关断全部

Trait 定义​

Trait IDNameConformance
0x4ECAVoltageSafetyManagementO
0x4EC8LoadSafetyManagementO
0x4EC7TemperatureSafetyManagementO
0x4EC9CurrentSafetyManagementO
0x4ECBOverCurrentResponseSettingO
0x5136OverTempTemperatureO
0x5137OverLoadPowerO
0x50DEOverTemperatureAlertEnableO
0x50DFUnderTemperatureAlertEnableO

VoltageSafetyManagement Trait(电压安全管理)​

一种安全机制,用于监控电源电压,在过电压或欠电压异常期间进行保护。

Trait IDCode
0x4ECAVoltageSafetyManagement
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVoltageSafetyManagementEnum80RVO
0x0006Supported Valuelist[VoltageSafetyManagementEnum8]RO
0x0007Default Valueuint80RWO

LoadSafetyManagement Trait(负载安全管理)​

一种监控电气或机械负载的安全机制,用于区分负载正常、过载异常与过载保护状态,便于设备在负载超限时及时告警并进入保护。

Trait IDCode
0x4EC8LoadSafetyManagement
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLoadSafetyManagementEnum80RVO
0x0006Supported Valuelist[LoadSafetyManagementEnum8]RO
0x0007Default Valueuint80RWO

TemperatureSafetyManagement Trait(温度安全管理)​

监控设备温度的安全机制,用于上报设备是否处于正常、过温异常或过温保护状态,并在异常触发后为后续恢复流程提供状态依据。

Trait IDCode
0x4EC7TemperatureSafetyManagement
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTemperatureSafetyManagementEnum80RVO
0x0006Supported Valuelist[TemperatureSafetyManagementEnum8]RO
0x0007Default Valueuint80RWO

CurrentSafetyManagement Trait(电流安全管理)​

一种监控设备电流的安全机制,用于上报电流是否处于正常、过流异常或过流保护状态,并支撑过流保护策略的执行。

Trait IDCode
0x4EC9CurrentSafetyManagement
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCurrentSafetyManagementEnum80RVO
0x0006Supported Valuelist[CurrentSafetyManagementEnum8]RO
0x0007Default Valueuint80RWO

OverCurrentResponseSetting Trait(过流保护响应设置)​

该配置用于设置过流保护的作用范围,决定设备在检测到过流时应作用于单个负载还是全部负载。

Trait IDCode
0x4ECBOverCurrentResponseSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOverCurrentResponseSettingEnum80RVWO
0x0006Supported Valuelist[OverCurrentResponseSettingEnum8]RO
0x0007Default ValueOverCurrentResponseSettingEnum80RWO

OverTempTemperature Trait​

该 Trait 用于承载超温告警对应的温度值或阈值,便于在上报告警时同步当前温度上下文。单位:deg C。

Trait IDCode
0x5136OverTempTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat70RVO
0x0002Maximum Valuefloat150RO
0x0003Minimum Valuefloat-50RO

OverTemperatureAlertEnable Trait(过温报警使能)​

开启或关闭过温(高温)报警功能。

Trait IDCode
0x50DEOverTemperatureAlertEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

UnderTemperatureAlertEnable Trait(低温报警使能)​

开启或关闭低温报警功能。

Trait IDCode
0x50DFUnderTemperatureAlertEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

OverLoadPower Trait​

该 Trait 用于承载过载告警对应的功率值或阈值,便于在上报告警时同步当前负载上下文。单位:W。

Trait IDCode
0x5137OverLoadPower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat60RVO
0x0002Maximum Valuefloat200RO
0x0003Minimum Valuefloat0RO
0x0007Default Valuefloat60RWO

Command 定义​

本 Function 不包含 Command。

OTA(升级功能)​

简介​

管理设备固件升级流程,包括下载、安装调度及升级进度与结果上报。

Function 标识​

Function IDCode名称
0x00D7OTA升级功能

Trait​

Trait IDCode名称Conformance
0x4F09OTAStateOTA状态O
0x4EE1UpgradeTypeSetting升级类型设置O
0x5070OTADegradeEnableOTA降级使能O

Command​

本 Function 不包含 Command。

数据类型​

OTAStateEnum8 Type​

该枚举定义 OTAState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00OTASuccessful升级成功
0x01Idle空闲
0x02DownloadInProgress下载中
0x03DownloadFailed下载失败
0x04DownloadComplete下载完成
0x05VerificationInProgress验证中
0x06VerificationSuccessful验证成功
0x07VerificationFailed验证失败
0x08OTAInProgress升级中
0x09OTAFailed升级失败
UpgradeTypeSettingEnum8 Type​

该枚举定义 UpgradeTypeSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ManualUpdate手动升级
0x01AutoUpdate自动升级

Trait 定义​

Trait IDNameConformance
0x4F09OTAStateO
0x4EE1UpgradeTypeSettingO
0x5070OTADegradeEnableO

OTAState Trait(OTA状态)​

一个枚举值,提供对设备固件空中( OTA )更新过程的整体进度和结果的实时可见性。它表示设备在固件更新生命周期内的特定阶段(例如,下载、验证、激活) ,作为管理系统监控状态、做出决策和诊断问题的核心信息。

Trait IDCode
0x4F09OTAState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOTAStateEnum81RVO
0x0006Supported Valuelist[OTAStateEnum8]RO
0x0007Default Valueuint81RWO

UpgradeTypeSetting Trait(升级类型设置)​

指示将使用的软件或固件升级方式,例如手动升级、自动升级等。

Trait IDCode
0x4EE1UpgradeTypeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueUpgradeTypeSettingEnum80RVWO
0x0006Supported Valuelist[UpgradeTypeSettingEnum8]RO
0x0007Default Valueuint80RWO

OTADegradeEnable Trait(OTA降级使能)​

启用或禁用 OTA 降级功能。启用(值 1)时允许固件版本降级;禁用(值 0)时禁止降级。

Trait IDCode
0x5070OTADegradeEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

HumanRecognition(人形检测)​

简介​

利用视觉等算法实时检测画面中的人形目标,区分人体与其他物体并上报事件。

Function 标识​

Function IDCode名称
0x00D8HumanRecognition人形检测

Trait​

Trait IDCode名称Conformance
0x4EF7HumanRecognitionReport人形检测事件上报M
0x4FCDHumanRecognitionEnable人形检测使能O
0x50C8HumanTrackingEnable人形跟踪使能O
0x50CBCloseUpHumanEnable特写对象人形使能O
0x4FB3TimePeriodSetting时段设置O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x4FB5PushEnable推送使能O
0x4FB6RecordEnable录像使能O
0x4FB7IntervalSetting时间间隔设置O
0x4FCCBitmaskRegionSetting侦测区域设置O
0x502DRegionDimension区域尺寸O

Command​

本 Function 不包含 Command。

数据类型​

HumanRecognitionReportEnum8 Type​

该枚举定义 HumanRecognitionReport Trait 的 Present Value 有效取值。

ValueNameDescription
0x01HumanDetected检测到人形事件
TimePeriodSettingTraitPresentValueStructure Type​

该结构体定义 TimePeriodSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高
BitmaskRegionSettingTraitPresentValueStructure Type​

该结构体定义 BitmaskRegionSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0detect_regioncharacterStringM十六进制字符串形式的位掩码,每一位对应一个网格单元。
1effective_bitsint32M位掩码中的有效 bit 数,超过该数量的 bit 应被忽略。
RegionDimensionTraitPresentValueStructure Type​

该结构体定义 RegionDimension Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0unitenum8M宽度和高度的单位,例如 GRID 或 PIXEL。
1widthuint32M指定单位下的区域总宽度。
2heightuint32M指定单位下的区域总高度。

Trait 定义​

Trait IDNameConformance
0x4EF7HumanRecognitionReportM
0x4FCDHumanRecognitionEnableO
0x50C8HumanTrackingEnableO
0x50CBCloseUpHumanEnableO
0x4FB3TimePeriodSettingO
0x4FB4SensitivityLevelEnumO
0x4FB5PushEnableO
0x4FB6RecordEnableO
0x4FB7IntervalSettingO
0x4FCCBitmaskRegionSettingO
0x502DRegionDimensionO

HumanRecognitionReport Trait(人形检测事件上报)​

上报在定义检测区域内是否检测到人形。

Trait IDCode
0x4EF7HumanRecognitionReport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHumanRecognitionReportEnum81VM
0x0006Supported Valuelist[HumanRecognitionReportEnum8]RO

HumanRecognitionEnable Trait(人形检测使能)​

启用或禁用人形检测(基于 AI)的总开关。

Trait IDCode
0x4FCDHumanRecognitionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

HumanTrackingEnable Trait(人形跟踪使能)​

启用或禁用摄像机的人形跟踪能力。开启后,摄像机会自动识别人形并调整云台保持目标居中。

Trait IDCode
0x50C8HumanTrackingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CloseUpHumanEnable Trait(特写对象人形使能)​

控制特写跟踪场景中是否对人形目标触发特写变焦。

Trait IDCode
0x50CBCloseUpHumanEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

TimePeriodSetting Trait(时段设置)​

定义时间段和工作日的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FB3TimePeriodSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimePeriodSettingTraitPresentValueStructureRVWO
0x0007Default ValueTimePeriodSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

PushEnable Trait(推送使能)​

控制特定功能(如检测事件、识别事件)触发时是否向用户发送推送通知。值为布尔类型:true(启用)表示事件发生时发送推送通知;false(禁用)表示即使事件发生也不发送通知。

Trait IDCode
0x4FB5PushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

RecordEnable Trait(录像使能)​

启用或禁用人脸识别时的本地录像。

Trait IDCode
0x4FB6RecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

IntervalSetting Trait(时间间隔设置)​

配置特定功能(例如,检测、识别)的两个连续事件触发器之间的最小时间间隔。值为数值,以秒为单位。触发事件后,在此间隔内对同一事件的任何进一步检测将不会生成新的触发器,直到间隔已经过去。

Trait IDCode
0x4FB7IntervalSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16180RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16180RWO

BitmaskRegionSetting Trait(侦测区域设置)​

基于网格掩码定义区域配置。包含两个字段:detect_region(十六进制字符串)和 effective_bits(整数)。十六进制字符串中的每一位对应一个网格单元(例如将画面划分为 24 个单元)。位值为 1 表示对应单元启用检测或识别功能,0 表示禁用。位的排列遵循预定义顺序(例如从左到右或从最高位到最低位)。effective_bits 字段指定十六进制字符串中实际有效的位数,使字符串可保持固定长度而仅前 N 位有意义。例如 "FF" 表示连续 8 位均为 1。若 effective_bits 为 32,则全部 32 位有效;若为 24,则仅前 24 位有效。该表示方式常用于运动检测、人形检测等需要在视频帧上灵活选择特定区域的功能。

Trait IDCode
0x4FCCBitmaskRegionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBitmaskRegionSettingTraitPresentValueStructureRVWO
0x0007Default ValueBitmaskRegionSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"ffffffffffffffffffffffffffffffffffff"}RWO

RegionDimension Trait(区域尺寸)​

定义客户端(如 App)可用于区域配置(如检测区域、隐私遮罩)的完整画布尺寸。其值为包含三个字段的结构体: unit(enum8):width 和 height 的单位,例如 GRID(网格单元)、PIXEL(像素)。 width(uint32):指定单位下的区域总宽度。 height(uint32):指定单位下的区域总高度。

Trait IDCode
0x502DRegionDimension
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRegionDimensionTraitPresentValueStructureRVO

Command 定义​

本 Function 不包含 Command。

SoundDetection(声音检测)​

简介​

通过麦克风采集环境声音,识别特定声音类型(如玻璃破碎、婴儿哭声)并告警。

Function 标识​

Function IDCode名称
0x00D9SoundDetection声音检测

Trait​

Trait IDCode名称Conformance
0x4EF6AnomalySoundDetected检测到异常声音M
0x4FBCSnoreDetectionEnable鼾声识别使能O
0x4FBDLoudSoundDetectionEnable较大声响识别使能O
0x4FFESoundDetectionEnable声音侦测使能O
0x4FB3TimePeriodSetting时段设置O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x4FB5PushEnable推送使能O
0x4FB6RecordEnable录像使能O
0x4FB7IntervalSetting时间间隔设置O
0x5004BabyCryDetectionEnable婴儿啼哭识别使能O
0x5005AlarmSoundDetectionEnable报警器报警音识别使能O
0x5006DogBarkDetectionEnable宠物吠叫识别使能O
0x5007CoughDetectionEnable咳嗽识别使能O

Command​

本 Function 不包含 Command。

数据类型​

AnomalySoundDetectedEnum8 Type​

该枚举定义 AnomalySoundDetected Trait 的 Present Value 有效取值。

ValueNameDescription
0x01CryDetected检测到哭声
0x02SnoreDetected检测到鼾声
0x03LoudSoundDetected检测到较大声响
0x04BabyCryDetected检测到婴儿啼哭
0x05AlarmSoundDetected检测到报警器报警音
0x06DogBarkDetected检测到宠物吠叫
0x07CoughDetected检测到咳嗽
TimePeriodSettingTraitPresentValueStructure Type​

该结构体定义 TimePeriodSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高

Trait 定义​

Trait IDNameConformance
0x4EF6AnomalySoundDetectedM
0x4FBCSnoreDetectionEnableO
0x4FBDLoudSoundDetectionEnableO
0x4FFESoundDetectionEnableO
0x4FB3TimePeriodSettingO
0x4FB4SensitivityLevelEnumO
0x4FB5PushEnableO
0x4FB6RecordEnableO
0x4FB7IntervalSettingO
0x5004BabyCryDetectionEnableO
0x5005AlarmSoundDetectionEnableO
0x5006DogBarkDetectionEnableO
0x5007CoughDetectionEnableO

AnomalySoundDetected Trait(检测到异常声音)​

该功能使设备能够智能识别环境中的异常声音。例如,检测到符合婴儿哭声特征的事件时将上报哭声事件。

Trait IDCode
0x4EF6AnomalySoundDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAnomalySoundDetectedEnum81VM
0x0006Supported Valuelist[AnomalySoundDetectedEnum8]RO

SnoreDetectionEnable Trait(鼾声识别使能)​

启用或禁用鼾声检测的总开关。启用后,摄像头持续监听音频以识别鼾声模式。

Trait IDCode
0x4FBCSnoreDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

LoudSoundDetectionEnable Trait(较大声响识别使能)​

启用或禁用大声检测的总开关。

Trait IDCode
0x4FBDLoudSoundDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SoundDetectionEnable Trait(声音侦测使能)​

启用或禁用 AI 声音检测(包括婴儿哭声、狗吠、咳嗽、鼾声等)的总开关。

Trait IDCode
0x4FFESoundDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

TimePeriodSetting Trait(时段设置)​

定义时间段和工作日的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FB3TimePeriodSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimePeriodSettingTraitPresentValueStructureRVWO
0x0007Default ValueTimePeriodSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

PushEnable Trait(推送使能)​

控制特定功能(如检测事件、识别事件)触发时是否向用户发送推送通知。值为布尔类型:true(启用)表示事件发生时发送推送通知;false(禁用)表示即使事件发生也不发送通知。

Trait IDCode
0x4FB5PushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

RecordEnable Trait(录像使能)​

启用或禁用人脸识别时的本地录像。

Trait IDCode
0x4FB6RecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

IntervalSetting Trait(时间间隔设置)​

配置特定功能(例如,检测、识别)的两个连续事件触发器之间的最小时间间隔。值为数值,以秒为单位。触发事件后,在此间隔内对同一事件的任何进一步检测将不会生成新的触发器,直到间隔已经过去。

Trait IDCode
0x4FB7IntervalSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16180RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16180RWO

BabyCryDetectionEnable Trait(婴儿啼哭识别使能)​

启用或禁用婴儿哭声检测的总开关。

Trait IDCode
0x5004BabyCryDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

AlarmSoundDetectionEnable Trait(报警器报警音识别使能)​

启用或禁用报警声识别的总开关。

Trait IDCode
0x5005AlarmSoundDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

DogBarkDetectionEnable Trait(宠物吠叫识别使能)​

启用或禁用狗吠检测的总开关。

Trait IDCode
0x5006DogBarkDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CoughDetectionEnable Trait(咳嗽识别使能)​

启用或禁用咳嗽检测的总开关。

Trait IDCode
0x5007CoughDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

PetRecognition(宠物识别)​

简介​

识别画面中的猫、狗等宠物个体,上报宠物出现或相关识别事件。

Function 标识​

Function IDCode名称
0x00DAPetRecognition宠物识别

Trait​

Trait IDCode名称Conformance
0x4EF8PetRecognitionReport宠物识别上报M
0x4FE3PetRecognitionEnable宠物识别使能O
0x50C9PetTrackingEnable宠物跟踪使能O
0x50CCCloseUpPetEnable特写对象猫狗使能O
0x4FB3TimePeriodSetting时段设置O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x4FB5PushEnable推送使能O
0x4FB6RecordEnable录像使能O
0x4FB7IntervalSetting时间间隔设置O
0x4FCCBitmaskRegionSetting侦测区域设置O
0x502DRegionDimension区域尺寸O

Command​

本 Function 不包含 Command。

数据类型​

PetRecognitionReportEnum16 Type​

该枚举定义 PetRecognitionReport Trait 的 Present Value 有效取值。

ValueNameDescription
0x01CatDetected检测到猫
0x02DogDetected检测到狗
0x03CatOrDogDetected检测到猫狗
TimePeriodSettingTraitPresentValueStructure Type​

该结构体定义 TimePeriodSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高
BitmaskRegionSettingTraitPresentValueStructure Type​

该结构体定义 BitmaskRegionSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0detect_regioncharacterStringM十六进制字符串形式的位掩码,每一位对应一个网格单元。
1effective_bitsint32M位掩码中的有效 bit 数,超过该数量的 bit 应被忽略。
RegionDimensionTraitPresentValueStructure Type​

该结构体定义 RegionDimension Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0unitenum8M宽度和高度的单位,例如 GRID 或 PIXEL。
1widthuint32M指定单位下的区域总宽度。
2heightuint32M指定单位下的区域总高度。

Trait 定义​

Trait IDNameConformance
0x4EF8PetRecognitionReportM
0x4FE3PetRecognitionEnableO
0x50C9PetTrackingEnableO
0x50CCCloseUpPetEnableO
0x4FB3TimePeriodSettingO
0x4FB4SensitivityLevelEnumO
0x4FB5PushEnableO
0x4FB6RecordEnableO
0x4FB7IntervalSettingO
0x4FCCBitmaskRegionSettingO
0x502DRegionDimensionO

PetRecognitionReport Trait(宠物识别上报)​

使智能设备准确识别宠物类型。检测到猫、狗或两者时,自动上报具体类型。

Trait IDCode
0x4EF8PetRecognitionReport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePetRecognitionReportEnum161VM
0x0006Supported Valuelist[PetRecognitionReportEnum16]RO

PetRecognitionEnable Trait(宠物识别使能)​

启用或禁用宠物检测(猫狗识别)的总开关。

Trait IDCode
0x4FE3PetRecognitionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

PetTrackingEnable Trait(宠物跟踪使能)​

启用或禁用摄像机对宠物(猫/狗)目标的自动跟踪能力。

Trait IDCode
0x50C9PetTrackingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CloseUpPetEnable Trait(特写对象猫狗使能)​

控制特写跟踪场景中是否对宠物(猫/狗)目标触发特写变焦。

Trait IDCode
0x50CCCloseUpPetEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

TimePeriodSetting Trait(时段设置)​

定义时间段和工作日的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FB3TimePeriodSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimePeriodSettingTraitPresentValueStructureRVWO
0x0007Default ValueTimePeriodSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

PushEnable Trait(推送使能)​

控制特定功能(如检测事件、识别事件)触发时是否向用户发送推送通知。值为布尔类型:true(启用)表示事件发生时发送推送通知;false(禁用)表示即使事件发生也不发送通知。

Trait IDCode
0x4FB5PushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

RecordEnable Trait(录像使能)​

启用或禁用人脸识别时的本地录像。

Trait IDCode
0x4FB6RecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

IntervalSetting Trait(时间间隔设置)​

配置特定功能(例如,检测、识别)的两个连续事件触发器之间的最小时间间隔。值为数值,以秒为单位。触发事件后,在此间隔内对同一事件的任何进一步检测将不会生成新的触发器,直到间隔已经过去。

Trait IDCode
0x4FB7IntervalSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16180RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16180RWO

BitmaskRegionSetting Trait(侦测区域设置)​

基于网格掩码定义区域配置。包含两个字段:detect_region(十六进制字符串)和 effective_bits(整数)。十六进制字符串中的每一位对应一个网格单元(例如将画面划分为 24 个单元)。位值为 1 表示对应单元启用检测或识别功能,0 表示禁用。位的排列遵循预定义顺序(例如从左到右或从最高位到最低位)。effective_bits 字段指定十六进制字符串中实际有效的位数,使字符串可保持固定长度而仅前 N 位有意义。例如 "FF" 表示连续 8 位均为 1。若 effective_bits 为 32,则全部 32 位有效;若为 24,则仅前 24 位有效。该表示方式常用于运动检测、人形检测等需要在视频帧上灵活选择特定区域的功能。

Trait IDCode
0x4FCCBitmaskRegionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBitmaskRegionSettingTraitPresentValueStructureRVWO
0x0007Default ValueBitmaskRegionSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"ffffffffffffffffffffffffffffffffffff"}RWO

RegionDimension Trait(区域尺寸)​

定义客户端(如 App)可用于区域配置(如检测区域、隐私遮罩)的完整画布尺寸。其值为包含三个字段的结构体: unit(enum8):width 和 height 的单位,例如 GRID(网格单元)、PIXEL(像素)。 width(uint32):指定单位下的区域总宽度。 height(uint32):指定单位下的区域总高度。

Trait IDCode
0x502DRegionDimension
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRegionDimensionTraitPresentValueStructureRVO

Command 定义​

本 Function 不包含 Command。

FaceRecognition(人脸识别)​

简介​

采集人脸特征并与本地库比对,上报人脸识别结果及匹配信息。

Function 标识​

Function IDCode名称
0x00DBFaceRecognition人脸识别

Trait​

Trait IDCode名称Conformance
0x4EF9FaceIDReport人脸识别ID上报M
0x4FD4StrangerFaceDetected人脸识别事件(陌生人)O
0x4FD5FaceRecognitionEnable人脸识别使能O
0x4FB3TimePeriodSetting时段设置O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x4FB5PushEnable推送使能O
0x4FB6RecordEnable录像使能O
0x4FB7IntervalSetting时间间隔设置O
0x4FCCBitmaskRegionSetting侦测区域设置O
0x4FDCFaceRecognitionAlgorithmType人脸识别算法类型O
0x502DRegionDimension区域尺寸O

Command​

本 Function 不包含 Command。

数据类型​

TimePeriodSettingTraitPresentValueStructure Type​

该结构体定义 TimePeriodSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高
BitmaskRegionSettingTraitPresentValueStructure Type​

该结构体定义 BitmaskRegionSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0detect_regioncharacterStringM十六进制字符串形式的位掩码,每一位对应一个网格单元。
1effective_bitsint32M位掩码中的有效 bit 数,超过该数量的 bit 应被忽略。
FaceRecognitionAlgorithmTypeEnum8 Type​

该枚举定义 FaceRecognitionAlgorithmType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NotSupported不支持人脸识别
0x01OnDevice人脸识别端侧算法
0x02Cloud人脸识别云端算法
RegionDimensionTraitPresentValueStructure Type​

该结构体定义 RegionDimension Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0unitenum8M宽度和高度的单位,例如 GRID 或 PIXEL。
1widthuint32M指定单位下的区域总宽度。
2heightuint32M指定单位下的区域总高度。

Trait 定义​

Trait IDNameConformance
0x4EF9FaceIDReportM
0x4FD4StrangerFaceDetectedO
0x4FD5FaceRecognitionEnableO
0x4FB3TimePeriodSettingO
0x4FB4SensitivityLevelEnumO
0x4FB5PushEnableO
0x4FB6RecordEnableO
0x4FB7IntervalSettingO
0x4FCCBitmaskRegionSettingO
0x4FDCFaceRecognitionAlgorithmTypeO
0x502DRegionDimensionO

FaceIDReport Trait(人脸识别ID上报)​

与特定面部相关联的唯一标识符,用于面部识别或身份验证。

Trait IDCode
0x4EF9FaceIDReport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640VM
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint321RO

StrangerFaceDetected Trait(人脸识别事件(陌生人))​

检测到未识别(陌生人)人脸时触发的事件。值恒为 "0",表示未知人员。

Trait IDCode
0x4FD4StrangerFaceDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640VO
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint321RO
0x0007Default Valueuint640RWO

FaceRecognitionEnable Trait(人脸识别使能)​

启用人脸识别功能的总开关。启用后,摄像头检测人脸并与已知数据库进行匹配。

Trait IDCode
0x4FD5FaceRecognitionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

TimePeriodSetting Trait(时段设置)​

定义时间段和工作日的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FB3TimePeriodSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimePeriodSettingTraitPresentValueStructureRVWO
0x0007Default ValueTimePeriodSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

PushEnable Trait(推送使能)​

控制特定功能(如检测事件、识别事件)触发时是否向用户发送推送通知。值为布尔类型:true(启用)表示事件发生时发送推送通知;false(禁用)表示即使事件发生也不发送通知。

Trait IDCode
0x4FB5PushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

RecordEnable Trait(录像使能)​

启用或禁用人脸识别时的本地录像。

Trait IDCode
0x4FB6RecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

IntervalSetting Trait(时间间隔设置)​

配置特定功能(例如,检测、识别)的两个连续事件触发器之间的最小时间间隔。值为数值,以秒为单位。触发事件后,在此间隔内对同一事件的任何进一步检测将不会生成新的触发器,直到间隔已经过去。

Trait IDCode
0x4FB7IntervalSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16180RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16180RWO

BitmaskRegionSetting Trait(侦测区域设置)​

基于网格掩码定义区域配置。包含两个字段:detect_region(十六进制字符串)和 effective_bits(整数)。十六进制字符串中的每一位对应一个网格单元(例如将画面划分为 24 个单元)。位值为 1 表示对应单元启用检测或识别功能,0 表示禁用。位的排列遵循预定义顺序(例如从左到右或从最高位到最低位)。effective_bits 字段指定十六进制字符串中实际有效的位数,使字符串可保持固定长度而仅前 N 位有意义。例如 "FF" 表示连续 8 位均为 1。若 effective_bits 为 32,则全部 32 位有效;若为 24,则仅前 24 位有效。该表示方式常用于运动检测、人形检测等需要在视频帧上灵活选择特定区域的功能。

Trait IDCode
0x4FCCBitmaskRegionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBitmaskRegionSettingTraitPresentValueStructureRVWO
0x0007Default ValueBitmaskRegionSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"ffffffffffffffffffffffffffffffffffff"}RWO

FaceRecognitionAlgorithmType Trait(人脸识别算法类型)​

指定人脸识别算法的运行位置。端侧处理具有隐私性好、时延低的优势;云端处理可支持更大规模的人脸库。

Trait IDCode
0x4FDCFaceRecognitionAlgorithmType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFaceRecognitionAlgorithmTypeEnum81RVWO
0x0006Supported Valuelist[FaceRecognitionAlgorithmTypeEnum8]RO
0x0007Default Valueuint81RWO

RegionDimension Trait(区域尺寸)​

定义客户端(如 App)可用于区域配置(如检测区域、隐私遮罩)的完整画布尺寸。其值为包含三个字段的结构体: unit(enum8):width 和 height 的单位,例如 GRID(网格单元)、PIXEL(像素)。 width(uint32):指定单位下的区域总宽度。 height(uint32):指定单位下的区域总高度。

Trait IDCode
0x502DRegionDimension
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRegionDimensionTraitPresentValueStructureRVO

Command 定义​

本 Function 不包含 Command。

GestureRecognition(手势识别)​

简介​

实时分析手势动作,将预定义手势转换为控制指令。

Function 标识​

Function IDCode名称
0x00DCGestureRecognition手势识别

Trait​

Trait IDCode名称Conformance
0x4EFAGestureRecognitionReport手势识别事件上报M
0x500DGestureRecognitionAntiFalseTrigger手势识别防误触使能O
0x500CGestureRecognitionMode手势识别类型O
0x500BRectangularRegionSetting手势识别区域O
0x5008GestureRecognitionEnable手势识别使能O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x4FB3TimePeriodSetting时段设置O
0x4FE1GestureRecognitionSoundEnable手势识别声音提示使能O

Command​

本 Function 不包含 Command。

数据类型​

GestureRecognitionReportEnum16 Type​

该枚举定义 GestureRecognitionReport Trait 的 Present Value 有效取值。

ValueNameDescription
0x02Two二
0x04Four四
0x05Five五
0x06Eight八
0x0AGood好
0x65TwoBothHands二(双手)
0x66FourBothHands四(双手)
0x67FiveBothHands五(双手)
0x68EightBothHands八(双手)
GestureRecognitionModeEnum8 Type​

该枚举定义 GestureRecognitionMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00OneHand单手模式
0x01TwoHand双手模式
RectangularRegionSettingTraitPresentValueStructure Type​

该结构体定义 RectangularRegionSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0x_beginint32M左上角 X 坐标。
1y_beginint32M左上角 Y 坐标。
2x_endint32M右下角 X 坐标。
3y_endint32M右下角 Y 坐标。
SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高
TimePeriodSettingTraitPresentValueStructure Type​

该结构体定义 TimePeriodSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。

Trait 定义​

Trait IDNameConformance
0x4EFAGestureRecognitionReportM
0x500DGestureRecognitionAntiFalseTriggerO
0x500CGestureRecognitionModeO
0x500BRectangularRegionSettingO
0x5008GestureRecognitionEnableO
0x4FB4SensitivityLevelEnumO
0x4FB3TimePeriodSettingO
0x4FE1GestureRecognitionSoundEnableO

GestureRecognitionReport Trait(手势识别事件上报)​

使设备通过视觉传感器识别特定用户手势。检测到预定义手势动作时,自动上报对应手势事件。

Trait IDCode
0x4EFAGestureRecognitionReport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueGestureRecognitionReportEnum162VM
0x0006Supported Valuelist[GestureRecognitionReportEnum16]RO

GestureRecognitionAntiFalseTrigger Trait(手势识别防误触使能)​

启用或禁用手势识别防误触保护,以减少意外触发。

Trait IDCode
0x500DGestureRecognitionAntiFalseTrigger
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

GestureRecognitionMode Trait(手势识别类型)​

指定手势识别为单手模式还是双手模式。

Trait IDCode
0x500CGestureRecognitionMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueGestureRecognitionModeEnum80RVWO
0x0006Supported Valuelist[GestureRecognitionModeEnum8]RO
0x0007Default Valueuint80RWO

RectangularRegionSetting Trait(手势识别区域)​

使用左上角 (XBegin, YBegin) 和右下角 (XEnd, YEnd) 的绝对坐标定义矩形区域;坐标原点在图像左上角,X 轴向右递增,Y 轴向下递增。常用于配置检测区域、隐私遮罩区域等类似功能。

Trait IDCode
0x500BRectangularRegionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRectangularRegionSettingTraitPresentValueStructureRVWO

GestureRecognitionEnable Trait(手势识别使能)​

启用手势识别的总开关。

Trait IDCode
0x5008GestureRecognitionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

TimePeriodSetting Trait(时段设置)​

定义时间段和工作日的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FB3TimePeriodSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimePeriodSettingTraitPresentValueStructureRVWO
0x0007Default ValueTimePeriodSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

GestureRecognitionSoundEnable Trait(手势识别声音提示使能)​

启用或禁用手势识别时的声音反馈(如静态/动态手势执行或动态手势激活)。启用后,设备发出声音提示。

Trait IDCode
0x4FE1GestureRecognitionSoundEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

VehicleDetection(车辆检测)​

简介​

检测监控区域内的车辆出现,上报车辆存在事件供安防或自动化使用。

Function 标识​

Function IDCode名称
0x00DDVehicleDetection车辆检测

Trait​

Trait IDCode名称Conformance
0x4EFBVehicleDetected车辆识别M
0x4FEAVehicleDetectionEnable车辆识别使能O
0x502DRegionDimension区域尺寸O
0x4FCCBitmaskRegionSetting侦测区域设置O
0x4FB6RecordEnable录像使能O
0x4FB7IntervalSetting时间间隔设置O
0x4FB5PushEnable推送使能O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x4FB3TimePeriodSetting时段设置O
0x4E59VehicleID车辆IDO
0x5066StrangeVehicleDetected识别到陌生车辆O
0x5196VehicleEntryExitEvent车辆进出事件O

Command​

本 Function 不包含 Command。

数据类型​

VehicleDetectedEnum8 Type​

该枚举定义 VehicleDetected Trait 的 Present Value 有效取值。

ValueNameDescription
0x01VehicleDetected识别到车辆
RegionDimensionTraitPresentValueStructure Type​

该结构体定义 RegionDimension Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0unitenum8M宽度和高度的单位,例如 GRID 或 PIXEL。
1widthuint32M指定单位下的区域总宽度。
2heightuint32M指定单位下的区域总高度。
BitmaskRegionSettingTraitPresentValueStructure Type​

该结构体定义 BitmaskRegionSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0detect_regioncharacterStringM十六进制字符串形式的位掩码,每一位对应一个网格单元。
1effective_bitsint32M位掩码中的有效 bit 数,超过该数量的 bit 应被忽略。
SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高
TimePeriodSettingTraitPresentValueStructure Type​

该结构体定义 TimePeriodSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
StrangeVehicleDetectedEnum8 Type​

该枚举定义 StrangeVehicleDetected Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Detected识别到
VehicleEntryExitEventEnum8 Type​

该枚举定义 VehicleEntryExitEvent Trait 的 Present Value 有效取值。

ValueKey中文名称英文名称Description
0x01VehicleExit车辆驶出Vehicle Exit检测到车辆驶出(离开)。
0x02VehicleEntry车辆驶入Vehicle Entry检测到车辆驶入(进入)。

Trait 定义​

Trait IDNameConformance
0x4EFBVehicleDetectedM
0x4FEAVehicleDetectionEnableO
0x502DRegionDimensionO
0x4FCCBitmaskRegionSettingO
0x4FB6RecordEnableO
0x4FB7IntervalSettingO
0x4FB5PushEnableO
0x4FB4SensitivityLevelEnumO
0x4FB3TimePeriodSettingO
0x4E59VehicleIDO
0x5066StrangeVehicleDetectedO
0x5196VehicleEntryExitEventO

VehicleDetected Trait(车辆识别)​

使设备识别监控区域内的车辆。观察到车辆进入、移动或停放时,自动上报车辆检测事件。

Trait IDCode
0x4EFBVehicleDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVehicleDetectedEnum81VM
0x0006Supported Valuelist[VehicleDetectedEnum8]RO

VehicleDetectionEnable Trait(车辆识别使能)​

启用或禁用车辆检测(基于云端)的总开关。

Trait IDCode
0x4FEAVehicleDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

RegionDimension Trait(区域尺寸)​

定义客户端(如 App)可用于区域配置(如检测区域、隐私遮罩)的完整画布尺寸。其值为包含三个字段的结构体: unit(enum8):width 和 height 的单位,例如 GRID(网格单元)、PIXEL(像素)。 width(uint32):指定单位下的区域总宽度。 height(uint32):指定单位下的区域总高度。

Trait IDCode
0x502DRegionDimension
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRegionDimensionTraitPresentValueStructureRVO

BitmaskRegionSetting Trait(侦测区域设置)​

基于网格掩码定义区域配置。包含两个字段:detect_region(十六进制字符串)和 effective_bits(整数)。十六进制字符串中的每一位对应一个网格单元(例如将画面划分为 24 个单元)。位值为 1 表示对应单元启用检测或识别功能,0 表示禁用。位的排列遵循预定义顺序(例如从左到右或从最高位到最低位)。effective_bits 字段指定十六进制字符串中实际有效的位数,使字符串可保持固定长度而仅前 N 位有意义。例如 "FF" 表示连续 8 位均为 1。若 effective_bits 为 32,则全部 32 位有效;若为 24,则仅前 24 位有效。该表示方式常用于运动检测、人形检测等需要在视频帧上灵活选择特定区域的功能。

Trait IDCode
0x4FCCBitmaskRegionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBitmaskRegionSettingTraitPresentValueStructureRVWO
0x0007Default ValueBitmaskRegionSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"ffffffffffffffffffffffffffffffffffff"}RWO

RecordEnable Trait(录像使能)​

启用或禁用人脸识别时的本地录像。

Trait IDCode
0x4FB6RecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

IntervalSetting Trait(时间间隔设置)​

配置特定功能(例如,检测、识别)的两个连续事件触发器之间的最小时间间隔。值为数值,以秒为单位。触发事件后,在此间隔内对同一事件的任何进一步检测将不会生成新的触发器,直到间隔已经过去。

Trait IDCode
0x4FB7IntervalSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16180RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16180RWO

PushEnable Trait(推送使能)​

控制特定功能(如检测事件、识别事件)触发时是否向用户发送推送通知。值为布尔类型:true(启用)表示事件发生时发送推送通知;false(禁用)表示即使事件发生也不发送通知。

Trait IDCode
0x4FB5PushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

TimePeriodSetting Trait(时段设置)​

定义时间段和工作日的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FB3TimePeriodSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimePeriodSettingTraitPresentValueStructureRVWO
0x0007Default ValueTimePeriodSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

VehicleID Trait(车辆ID)​

VehicleID 为每辆电动汽车(EV)分配的唯一标识符。

Trait IDCode
0x4E59VehicleID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuestring32RVO

StrangeVehicleDetected Trait(识别到陌生车辆)​

用于上报检测到陌生车辆时的事件。

Trait IDCode
0x5066StrangeVehicleDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStrangeVehicleDetectedEnum81VO
0x0006Supported Valuelist[StrangeVehicleDetectedEnum8]RO
0x0007Default Valueuint81RWO

VehicleEntryExitEvent Trait(车辆进出事件)​

车辆进出事件。表示设备检测到车辆驶入或驶出的事件。该 Trait 为枚举型(uint8),只上报,由设备在检测到车辆进出事件时主动上报。

Trait IDCode
0x5196VehicleEntryExitEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVehicleEntryExitEventEnum8VO
0x0006Supported Valuelist[VehicleEntryExitEventEnum8]RO

Command 定义​

本 Function 不包含 Command。

FlameDetection(火焰检测)​

简介​

通过图像或传感器算法检测可见火焰,即时上报火情事件以便早期预警。

Function 标识​

Function IDCode名称
0x00DEFlameDetection火焰检测

Trait​

Trait IDCode名称Conformance
0x4EFCFlameDetected火焰检测M
0x4FF8FlameDetectionEnable火焰识别使能O
0x4FB5PushEnable推送使能O
0x4FB6RecordEnable录像使能O

Command​

本 Function 不包含 Command。

数据类型​

FlameDetectedEnum8 Type​

该枚举定义 FlameDetected Trait 的 Present Value 有效取值。

ValueNameDescription
0x01FlameDetected识别到火焰

Trait 定义​

Trait IDNameConformance
0x4EFCFlameDetectedM
0x4FF8FlameDetectionEnableO
0x4FB5PushEnableO
0x4FB6RecordEnableO

FlameDetected Trait(火焰检测)​

使设备识别监控区域内的明火或火焰特征。检测到疑似火焰时,自动触发并上报事件。

Trait IDCode
0x4EFCFlameDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFlameDetectedEnum81VM
0x0006Supported Valuelist[FlameDetectedEnum8]RO

FlameDetectionEnable Trait(火焰识别使能)​

启用或禁用火焰检测的总开关。

Trait IDCode
0x4FF8FlameDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

PushEnable Trait(推送使能)​

控制特定功能(如检测事件、识别事件)触发时是否向用户发送推送通知。值为布尔类型:true(启用)表示事件发生时发送推送通知;false(禁用)表示即使事件发生也不发送通知。

Trait IDCode
0x4FB5PushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

RecordEnable Trait(录像使能)​

启用或禁用人脸识别时的本地录像。

Trait IDCode
0x4FB6RecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

Command 定义​

本 Function 不包含 Command。

PackageRecognition(包裹识别)​

简介​

自动识别画面中的包裹,在投递或取走时可发送提醒并记录事件。

Function 标识​

Function IDCode名称
0x00DFPackageRecognition包裹识别

Trait​

Trait IDCode名称Conformance
0x4EFDPackageRecognitionReport包裹识别上报M
0x4FF1PackageRecognitionEnable包裹识别侦测使能O
0x4FB3TimePeriodSetting时段设置O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x4FB5PushEnable推送使能O
0x4FB6RecordEnable录像使能O
0x4FB7IntervalSetting时间间隔设置O
0x4FCCBitmaskRegionSetting侦测区域设置O
0x502DRegionDimension区域尺寸O

Command​

本 Function 不包含 Command。

数据类型​

PackageRecognitionReportEnum8 Type​

该枚举定义 PackageRecognitionReport Trait 的 Present Value 有效取值。

ValueNameDescription
0x01PackageAppeared包裹出现
0x02PackageDisappeared包裹消失
TimePeriodSettingTraitPresentValueStructure Type​

该结构体定义 TimePeriodSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高
BitmaskRegionSettingTraitPresentValueStructure Type​

该结构体定义 BitmaskRegionSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0detect_regioncharacterStringM十六进制字符串形式的位掩码,每一位对应一个网格单元。
1effective_bitsint32M位掩码中的有效 bit 数,超过该数量的 bit 应被忽略。
RegionDimensionTraitPresentValueStructure Type​

该结构体定义 RegionDimension Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0unitenum8M宽度和高度的单位,例如 GRID 或 PIXEL。
1widthuint32M指定单位下的区域总宽度。
2heightuint32M指定单位下的区域总高度。

Trait 定义​

Trait IDNameConformance
0x4EFDPackageRecognitionReportM
0x4FF1PackageRecognitionEnableO
0x4FB3TimePeriodSettingO
0x4FB4SensitivityLevelEnumO
0x4FB5PushEnableO
0x4FB6RecordEnableO
0x4FB7IntervalSettingO
0x4FCCBitmaskRegionSettingO
0x502DRegionDimensionO

PackageRecognitionReport Trait(包裹识别上报)​

当包裹投递、取走或状态发生变化时自动上报事件。

Trait IDCode
0x4EFDPackageRecognitionReport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePackageRecognitionReportEnum81VM
0x0006Supported Valuelist[PackageRecognitionReportEnum8]RO

PackageRecognitionEnable Trait(包裹识别侦测使能)​

启用或禁用包裹检测的总开关。

Trait IDCode
0x4FF1PackageRecognitionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

TimePeriodSetting Trait(时段设置)​

定义时间段和工作日的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FB3TimePeriodSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimePeriodSettingTraitPresentValueStructureRVWO
0x0007Default ValueTimePeriodSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

PushEnable Trait(推送使能)​

控制特定功能(如检测事件、识别事件)触发时是否向用户发送推送通知。值为布尔类型:true(启用)表示事件发生时发送推送通知;false(禁用)表示即使事件发生也不发送通知。

Trait IDCode
0x4FB5PushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

RecordEnable Trait(录像使能)​

启用或禁用人脸识别时的本地录像。

Trait IDCode
0x4FB6RecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

IntervalSetting Trait(时间间隔设置)​

配置特定功能(例如,检测、识别)的两个连续事件触发器之间的最小时间间隔。值为数值,以秒为单位。触发事件后,在此间隔内对同一事件的任何进一步检测将不会生成新的触发器,直到间隔已经过去。

Trait IDCode
0x4FB7IntervalSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16180RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16180RWO

BitmaskRegionSetting Trait(侦测区域设置)​

基于网格掩码定义区域配置。包含两个字段:detect_region(十六进制字符串)和 effective_bits(整数)。十六进制字符串中的每一位对应一个网格单元(例如将画面划分为 24 个单元)。位值为 1 表示对应单元启用检测或识别功能,0 表示禁用。位的排列遵循预定义顺序(例如从左到右或从最高位到最低位)。effective_bits 字段指定十六进制字符串中实际有效的位数,使字符串可保持固定长度而仅前 N 位有意义。例如 "FF" 表示连续 8 位均为 1。若 effective_bits 为 32,则全部 32 位有效;若为 24,则仅前 24 位有效。该表示方式常用于运动检测、人形检测等需要在视频帧上灵活选择特定区域的功能。

Trait IDCode
0x4FCCBitmaskRegionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBitmaskRegionSettingTraitPresentValueStructureRVWO
0x0007Default ValueBitmaskRegionSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"ffffffffffffffffffffffffffffffffffff"}RWO

RegionDimension Trait(区域尺寸)​

定义客户端(如 App)可用于区域配置(如检测区域、隐私遮罩)的完整画布尺寸。其值为包含三个字段的结构体: unit(enum8):width 和 height 的单位,例如 GRID(网格单元)、PIXEL(像素)。 width(uint32):指定单位下的区域总宽度。 height(uint32):指定单位下的区域总高度。

Trait IDCode
0x502DRegionDimension
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRegionDimensionTraitPresentValueStructureRVO

Command 定义​

本 Function 不包含 Command。

HumanPresence(人存在检测)​

简介​

检测空间内人体存在,支持人数统计、轨迹及身份关联等高级感知能力。

Function 标识​

Function IDCode名称
0x00E0HumanPresence人存在检测

Trait​

Trait IDCode名称Conformance
0x4F01Presence人存在M
0x4F02ActivityDetected人活动检测O
0x4E72HoldTime无人判定延时O
0x4F06PresenceConfiguration空间有无人软传感配置O

Command​

Command IDCode名称Conformance
0x9C73ResetPresence重置为无人O

数据类型​

PresenceEnum8 Type​

该枚举定义 Presence Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01NoHumanDetected未检测到人
0x02HumanDetected检测到人
PresenceConfigurationTraitPresentValueStructure Type​

该结构体定义 PresenceConfiguration Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0HubListlist[characterString]M网关的 Device ID 列表。
1EventsStructO事件配置,包含 DeviceID 和 ResList。
2StatesStructO状态配置,包含 DeviceID 和 ResList。
3EntriescharacterStringO入口配置。
4Configuint32O配置项,例如 DetDuration、UnKnownDuration。

Trait 定义​

Trait IDNameConformance
0x4F01PresenceM
0x4F02ActivityDetectedO
0x4E72HoldTimeO
0x4F06PresenceConfigurationO

Presence Trait(人存在)​

Presence 用于检测监测区域内是否有人。

Trait IDCode
0x4F01Presence
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePresenceEnum80RVM
0x0006Supported Valuelist[PresenceEnum8]RO
0x0007Default Valueuint80RWO

ActivityDetected Trait(人活动检测)​

指示在空间被占用期间是否检测到任何人为活动。

Trait IDCode
0x4F02ActivityDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0VO
0x0007Default Valueboolean0RWO

HoldTime Trait(无人判定延时)​

无人判定延时,单位:S。

Trait IDCode
0x4E72HoldTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0007Default Valueuint161RWO

PresenceConfiguration Trait(空间有无人软传感配置)​

用于配置有无人软传感相关设置。

Trait IDCode
0x4F06PresenceConfiguration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePresenceConfigurationTraitPresentValueStructureRVWO

Command 定义​

Command IDNameConformance
0x9C73ResetPresenceO

ResetPresence Command​

ResetPresence 命令用于重置设备或空间的当前存在检测状态。

该 Command 无参数。

HeartMonitoring(心脏监测)​

简介​

利用传感器持续或周期性测量用户心率,记录并分析心脏健康相关数据。

Function 标识​

Function IDCode名称
0x00E1HeartMonitoring心脏监测

Trait​

Trait IDCode名称Conformance
0x4F08HeartRate心率M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4F08HeartRateM

HeartRate Trait(心率)​

实时测量每分钟心跳次数。单位:bpm。

Trait IDCode
0x4F08HeartRate
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

BreathingMonitoring(呼吸监测)​

简介​

利用传感器持续或周期性测量用户呼吸频率与模式,支持健康监测。

Function 标识​

Function IDCode名称
0x00E2BreathingMonitoring呼吸监测

Trait​

Trait IDCode名称Conformance
0x4F07BreathingRate呼吸率M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4F07BreathingRateM

BreathingRate Trait(呼吸率)​

实时测量每分钟呼吸次数。单位:bpm。

Trait IDCode
0x4F07BreathingRate
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat60.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

AmbientSensingConfiguration(环境传感配置)​

简介​

提供 Aqara 环境传感配置能力,覆盖区域管理、安装模式选择、跌倒检测、接近感应及 PIR/Radar 协同感应等配置项,用于对环境传感设备进行实时参数配置与区域化管理。

Function 标识​

Function IDCode名称
0x00E3AmbientSensingConfiguration环境传感配置

Trait​

Trait IDCode名称Conformance
0x4F8DZonesInfo区域信息M
0x4F19Zones区域M
0x4F5AProximityDistanceLevel接近感应距离O
0x4F32AIEntryExitRegionRecognitionAI进出口区域识别O
0x4F31AutoEdgeRecognition自动边缘识别O
0x4F30AutoInterferenceSourceRecognition自动干扰源识别O
0x4F2EBedHeightSetting床高度设置O
0x4F2FFallDelayTimeSetting跌倒延时设置O
0x4F2DFallDetectionSensitivity辅助跌倒检测灵敏度O
0x4F2CFallMaskBitmask跌倒区域O
0x4F2BEnableFallDetection使能辅助跌倒检测O
0x4F2ADetectionDirectionSetting检测方向设置O
0x4F15InstallHeightSetting安装高度设置O
0x4F29CoordinateReverseSetting坐标反向设置O
0x4F28EnableAIAdaptiveSensitivity使能AI自适应灵敏度O
0x4F27EnableAIInterferenceSourceRecognition使能AI干扰源识别O
0x4F25EnableAverageOccupancyDurationDetection使能平均存在时长检测O
0x4F24EnableActivityDetection使能活动检测O
0x4F23EnableAIHighPrecisionRecognition使能AI高精度检测O
0x4F22EnableTrafficFlowDetection使能人流检测O
0x4F21EnableWalkingDistanceDetection使能步行距离检测O
0x4F20EnableVisitorCountDetection使能访客数量检测O
0x4F1FEnableHumanCountDetection使能人员数量检测O
0x4F1EEnableLargeMotionRecognition使能大动作识别O
0x4F1DEdgeRegionBitmask边缘区域O
0x4F1CInterferenceRegionBitmask干扰源区域O
0x4F1BEntryExitRegionBitmask进出口区域O
0x4F1AEnablePostureRecognition使能姿态识别O
0x4F18MaxDetectionAreas最大检测区域O
0x4F17InstallAngle安装角度O
0x4F13InstallMode安装模式O
0x4F14SideInstall侧面安装O
0x4F16InstallStatus安装状态O
0x4FAAAISpaceBackgroundLearningCompleteAI空间背景学习完成O
0x4FA9AISpaceBackgroundLearningReportingTimeoutAI空间背景学习超时O
0x4FA8InterferenceSourceRecognitionReportingTimeout干扰源识别超时O
0x5117DetectionRange侦测范围O
0x5187MinDetectionRange最小侦测范围O
0x5188MaxDetectionRange最大侦测范围O
0x5189DetectionRangeStep侦测范围步进O
0x5118SensingMode传感器模式O
0x511ADetectionRangeTargetPosition检测范围内目标位置距离O

Command​

Command IDCode名称Conformance
0x9C7ERemoveZone删除区域O
0x9C7DUpdateZone更新区域O
0x9C7BEnableAISpaceBackgroundLearning开启AI空间背景学习O
0x9C7ASubscribeAIEntryExitRegionRecognitionData订阅AI进出口区域识别数据O
0x9C79SubscribeAutoEdgeRecognitionData订阅自动边缘识别数据O
0x9C78SubscribeAutoInterferenceSourceRecognitionData订阅自动干扰源识别数据O
0x9C7CAppendZone新增区域O
0x9D36SetZones设置区域O
0x9D89SubscribeDetectionRangeTargetPosition订阅检测范围内目标位置O

数据类型​

ZonesInfoTraitPresentValueStructure Type​

该结构体定义 ZonesInfo Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0ZoneIDuint8M区域 ID。
1ZoneNamecharacterStringM区域名称。
2ZoneColorIDuint8M区域颜色 ID。
3ZoneTagIDuint8M区域标签 ID。
4ZoneTagNamecharacterStringM区域标签名称。
ZonesTraitPresentValueStructure Type​

该结构体定义 Zones Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0ZoneIDuint8M区域 ID。
1ZoneTypeenum8M区域类型(例如 0x00=Other,0x01=LivingRoom 等,完整枚举见 aqara-spec AppendZone 命令)。
2ZoneBitmaskcharacterStringM区域位掩码。
3ZoneProximityDetectionEnablebooleanM是否启用区域接近检测。
ProximityDistanceLevelEnum8 Type​

该枚举定义 ProximityDistanceLevel Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Far远
0x01Medium中
0x02Near近
FallDetectionSensitivityEnum8 Type​

该枚举定义 FallDetectionSensitivity Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Low低
0x01Medium中
0x02High高
DetectionDirectionSettingEnum8 Type​

该枚举定义 DetectionDirectionSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00OmniDirectional全向
0x01LeftRight左右
CoordinateReverseSettingEnum8 Type​

该枚举定义 CoordinateReverseSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Disabled禁用
0x01Enabled启用
0x02Auto自动
InstallModeEnum8 Type​

该枚举定义 InstallMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01SideMount侧装
0x02TopMount顶装
SideInstallEnum8 Type​

该枚举定义 SideInstall Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01Wall墙面
0x02LeftCorner左角落
0x03RightCorner右角落
InstallStatusEnum8 Type​

该枚举定义 InstallStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00LevelFacingUp水平朝上
0x01LevelTiltedFacingUp水平倾斜朝上
0x02LevelReverseTiltedFacingUp水平反向倾斜朝上
0x03SideFacingForward侧面朝前
0x04SideReverseFacingForward侧面反向朝前
0x05TopFacingDown顶部朝下
0x06TiltedFacingDown倾斜朝下
0x07ReverseTiltedFacingDown反向倾斜朝下
0x08Invalid无效
AISpaceBackgroundLearningCompleteEnum8 Type​

该枚举定义 AISpaceBackgroundLearningComplete Trait 的 Present Value 有效取值。

ValueNameDescription
0x00SUCCESS成功
0x01INVALID_ARGUMENT无效参数
0x02INVALID_STATE无效状态
0x03RESOURCE_EXHAUSTED资源耗尽
0x04BUSY繁忙
0x05DUPLICATE_ZONE_ID重复的区域ID
RemoveZone Command Structure Type​

RemoveZone Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ZoneIDuint8M区域ID。
UpdateZone Command Structure Type​

UpdateZone Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ZonesZonesTraitPresentValueStructureM区域。
AppendZone Command Structure Type​

AppendZone Command 的参数结构体。

结构体成员序号字段名类型必须说明
0ZoneZonesTraitPresentValueStructureM区域。
SetZones Command Structure Type​

SetZones Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Zoneslist[ZonesTraitPresentValueStructure]M区域。
SubscribeAutoEdgeRecognitionData Command Structure Type​

SubscribeAutoEdgeRecognitionData Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Timeoutuint8M订阅超时时间。

Trait 定义​

Trait IDNameConformance
0x4F8DZonesInfoM
0x4F19ZonesM
0x4F5AProximityDistanceLevelO
0x4F32AIEntryExitRegionRecognitionO
0x4F31AutoEdgeRecognitionO
0x4F30AutoInterferenceSourceRecognitionO
0x4F2EBedHeightSettingO
0x4F2FFallDelayTimeSettingO
0x4F2DFallDetectionSensitivityO
0x4F2CFallMaskBitmaskO
0x4F2BEnableFallDetectionO
0x4F2ADetectionDirectionSettingO
0x4F15InstallHeightSettingO
0x4F29CoordinateReverseSettingO
0x4F28EnableAIAdaptiveSensitivityO
0x4F27EnableAIInterferenceSourceRecognitionO
0x4F25EnableAverageOccupancyDurationDetectionO
0x4F24EnableActivityDetectionO
0x4F23EnableAIHighPrecisionRecognitionO
0x4F22EnableTrafficFlowDetectionO
0x4F21EnableWalkingDistanceDetectionO
0x4F20EnableVisitorCountDetectionO
0x4F1FEnableHumanCountDetectionO
0x4F1EEnableLargeMotionRecognitionO
0x4F1DEdgeRegionBitmaskO
0x4F1CInterferenceRegionBitmaskO
0x4F1BEntryExitRegionBitmaskO
0x4F1AEnablePostureRecognitionO
0x4F18MaxDetectionAreasO
0x4F17InstallAngleO
0x4F13InstallModeO
0x4F14SideInstallO
0x4F16InstallStatusO
0x4FAAAISpaceBackgroundLearningCompleteO
0x4FA9AISpaceBackgroundLearningReportingTimeoutO
0x4FA8InterferenceSourceRecognitionReportingTimeoutO
0x5117DetectionRangeO
0x5187MinDetectionRangeO
0x5188MaxDetectionRangeO
0x5189DetectionRangeStepO
0x5118SensingModeO
0x511ADetectionRangeTargetPositionO

ZonesInfo Trait(区域信息)​

包含区域颜色和名称等参数。此特征不由设备报告,而是由云生成。

Trait IDCode
0x4F8DZonesInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[ZonesInfoTraitPresentValueStructure]RVWM

Zones Trait(区域)​

该 Trait 用于配置和读取检测区域信息,包括区域类型、区域位图以及该区域是否启用接近检测。

Trait IDCode
0x4F19Zones
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[ZonesTraitPresentValueStructure]RVM

ProximityDistanceLevel Trait(接近感应距离)​

该 Trait 用于设置当前接近感应距离等级,并声明设备支持的最大接近感应等级范围。

Trait IDCode
0x4F5AProximityDistanceLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueProximityDistanceLevelEnum80RVWO
0x0006Supported Valuelist[ProximityDistanceLevelEnum8]RO
0x0007Default ValueProximityDistanceLevelEnum80RWO

AIEntryExitRegionRecognition Trait(AI进出口区域识别)​

该 Trait 用于上报 AI 进出口区域识别结果,供上层系统进行区域进出行为分析。

Trait IDCode
0x4F32AIEntryExitRegionRecognition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringVO

AutoEdgeRecognition Trait(自动边缘识别)​

该 Trait 用于上报自动边缘识别结果,帮助确定有效检测边界。

Trait IDCode
0x4F31AutoEdgeRecognition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringVO

AutoInterferenceSourceRecognition Trait(自动干扰源识别)​

该 Trait 用于上报自动干扰源识别结果,用于识别可能影响感应质量的环境因素。

Trait IDCode
0x4F30AutoInterferenceSourceRecognition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringVO

BedHeightSetting Trait(床高度设置)​

该 Trait 用于「床高度设置」相关数据的访问与上报。单位:mm。

Trait IDCode
0x4F2EBedHeightSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1640RVWO
0x0002Maximum Valueuint161500RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint1640RWO

FallDelayTimeSetting Trait(跌倒延时设置)​

该 Trait 用于「跌倒延时设置」相关数据的访问与上报。单位:S。

Trait IDCode
0x4F2FFallDelayTimeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1620RVWO
0x0002Maximum Valueuint16300RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint1620RWO

FallDetectionSensitivity Trait(辅助跌倒检测灵敏度)​

该 Trait 用于「跌倒检测灵敏度」相关数据的访问与上报。

Trait IDCode
0x4F2DFallDetectionSensitivity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFallDetectionSensitivityEnum80RVWO
0x0006Supported Valuelist[FallDetectionSensitivityEnum8]RO
0x0007Default ValueFallDetectionSensitivityEnum80RWO

FallMaskBitmask Trait(跌倒区域)​

该 Trait 用于「跌倒区域」相关数据的访问与上报。

Trait IDCode
0x4F2CFallMaskBitmask
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

EnableFallDetection Trait(使能辅助跌倒检测)​

该 Trait 用于「使能跌倒检测」相关数据的访问与上报。

Trait IDCode
0x4F2BEnableFallDetection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

DetectionDirectionSetting Trait(检测方向设置)​

该 Trait 用于「检测方向设置」相关数据的访问与上报。

Trait IDCode
0x4F2ADetectionDirectionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDetectionDirectionSettingEnum80RVWO
0x0006Supported Valuelist[DetectionDirectionSettingEnum8]RO
0x0007Default ValueDetectionDirectionSettingEnum80RWO

InstallHeightSetting Trait(安装高度设置)​

该 Trait 用于「安装高度设置」相关数据的访问与上报。单位:mm。

Trait IDCode
0x4F15InstallHeightSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVWO
0x0002Maximum Valueuint164000RO
0x0003Minimum Valueuint161500RO
0x0005Step Valueuint321RO
0x0007Default Valueuint160RWO

CoordinateReverseSetting Trait(坐标反向设置)​

该 Trait 用于「坐标反向设置」相关数据的访问与上报。

Trait IDCode
0x4F29CoordinateReverseSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCoordinateReverseSettingEnum80RVWO
0x0006Supported Valuelist[CoordinateReverseSettingEnum8]RO
0x0007Default ValueCoordinateReverseSettingEnum80RWO

EnableAIAdaptiveSensitivity Trait(使能AI自适应灵敏度)​

该 Trait 用于「使能AI自适应灵敏度」相关数据的访问与上报。

Trait IDCode
0x4F28EnableAIAdaptiveSensitivity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableAIInterferenceSourceRecognition Trait(使能AI干扰源识别)​

该 Trait 用于「使能AI干扰源识别」相关数据的访问与上报。

Trait IDCode
0x4F27EnableAIInterferenceSourceRecognition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableAverageOccupancyDurationDetection Trait(使能平均存在时长检测)​

该 Trait 用于「使能平均存在时长检测」相关数据的访问与上报。

Trait IDCode
0x4F25EnableAverageOccupancyDurationDetection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableActivityDetection Trait(使能活动检测)​

该 Trait 用于「使能活动检测」相关数据的访问与上报。

Trait IDCode
0x4F24EnableActivityDetection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableAIHighPrecisionRecognition Trait(使能AI高精度检测)​

该 Trait 用于「使能AI高精度检测」相关数据的访问与上报。

Trait IDCode
0x4F23EnableAIHighPrecisionRecognition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableTrafficFlowDetection Trait(使能人流检测)​

该 Trait 用于「使能交通流检测」相关数据的访问与上报。

Trait IDCode
0x4F22EnableTrafficFlowDetection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableWalkingDistanceDetection Trait(使能步行距离检测)​

该 Trait 用于「使能步行距离检测」相关数据的访问与上报。

Trait IDCode
0x4F21EnableWalkingDistanceDetection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableVisitorCountDetection Trait(使能访客数量检测)​

该 Trait 用于「使能访客数量检测」相关数据的访问与上报。

Trait IDCode
0x4F20EnableVisitorCountDetection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableHumanCountDetection Trait(使能人员数量检测)​

该 Trait 用于「使能人员数量检测」相关数据的访问与上报。

Trait IDCode
0x4F1FEnableHumanCountDetection
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EnableLargeMotionRecognition Trait(使能大动作识别)​

该 Trait 用于「使能大动作识别」相关数据的访问与上报。

Trait IDCode
0x4F1EEnableLargeMotionRecognition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

EdgeRegionBitmask Trait(边缘区域)​

该 Trait 用于「边缘区域」相关数据的访问与上报。

Trait IDCode
0x4F1DEdgeRegionBitmask
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

InterferenceRegionBitmask Trait(干扰源区域)​

该 Trait 用于「干扰源区域」相关数据的访问与上报。

Trait IDCode
0x4F1CInterferenceRegionBitmask
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

EntryExitRegionBitmask Trait(进出口区域)​

该 Trait 用于「进出口区域」相关数据的访问与上报。

Trait IDCode
0x4F1BEntryExitRegionBitmask
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

EnablePostureRecognition Trait(使能姿态识别)​

该 Trait 用于「使能姿态识别」相关数据的访问与上报。

Trait IDCode
0x4F1AEnablePostureRecognition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

MaxDetectionAreas Trait(最大检测区域)​

该 Trait 用于「最大检测区域」相关数据的访问与上报。

Trait IDCode
0x4F18MaxDetectionAreas
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint321RO

InstallAngle Trait(安装角度)​

该 Trait 用于「安装角度」相关数据的访问与上报。

Trait IDCode
0x4F17InstallAngle
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO

InstallMode Trait(安装模式)​

该 Trait 用于「安装模式」相关数据的访问与上报。

Trait IDCode
0x4F13InstallMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueInstallModeEnum80RVWO
0x0006Supported Valuelist[InstallModeEnum8]RO
0x0007Default ValueInstallModeEnum80RWO

SideInstall Trait(侧面安装)​

该 Trait 用于「侧面安装」相关数据的访问与上报。

Trait IDCode
0x4F14SideInstall
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSideInstallEnum80RVWO
0x0006Supported Valuelist[SideInstallEnum8]RO
0x0007Default ValueSideInstallEnum80RWO

InstallStatus Trait(安装状态)​

该 Trait 用于「安装状态」相关数据的访问与上报。

Trait IDCode
0x4F16InstallStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueInstallStatusEnum80RVO
0x0006Supported Valuelist[InstallStatusEnum8]RO

AISpaceBackgroundLearningComplete Trait(AI空间背景学习完成)​

该 Trait 用于「AI空间背景学习完成」相关数据的访问与上报。

Trait IDCode
0x4FAAAISpaceBackgroundLearningComplete
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAISpaceBackgroundLearningCompleteEnum80VO
0x0006Supported Valuelist[AISpaceBackgroundLearningCompleteEnum8]RO
0x0007Default ValueAISpaceBackgroundLearningCompleteEnum80RWO

AISpaceBackgroundLearningReportingTimeout Trait(AI空间背景学习超时)​

该 Trait 用于「AI空间背景学习超时」相关数据的访问与上报。单位:S。

Trait IDCode
0x4FA9AISpaceBackgroundLearningReportingTimeout
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO

InterferenceSourceRecognitionReportingTimeout Trait(干扰源识别超时)​

该 Trait 用于「干扰源识别超时」相关数据的访问与上报。单位:S。

Trait IDCode
0x4FA8InterferenceSourceRecognitionReportingTimeout
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO

DetectionRange Trait(侦测范围)​

该 Trait 用于将雷达检测范围配置为一组离散的检测范围单元。

MinDetectionRange、MaxDetectionRange 和 DetectionRangeStep 的距离单位均为 cm。服务端应确保 (MaxDetectionRange - MinDetectionRange) / DetectionRangeStep 始终为 8 的整数倍,使检测范围单元能够完整映射为字节而无需填充位。

该 Trait 的 bitmask 字节长度为 (MaxDetectionRange - MinDetectionRange) / DetectionRangeStep / 8。例如,最小范围为 0、最大范围为 600、步长为 25 cm 时,bitmask 长度为 600 / 25 / 8 = 3 字节,表示 24 个、每个 25 cm 的检测范围单元。

image::../images/aqara_Ambient_configuration_cluster/detection_range_bitmask.svg[DetectionRangeBitmask 布局示例,780]

第 n 位(最低有效位为 bit 0)对应从 MinDetectionRange + n × DetectionRangeStep 到 MinDetectionRange + (n+1) × DetectionRangeStep cm 的检测范围单元。置 1 表示该单元包含在当前检测范围内,置 0 表示不包含。

当该 Trait 为 NULL 时,表示未配置检测范围。写入操作应更新设备的检测范围配置,读取操作应返回当前配置;写入 NULL 应清除已配置的检测范围。至少应选择一个检测范围单元,不允许所有 bit 均为 0。

Trait IDCode
0x5117DetectionRange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16RVWO

MinDetectionRange Trait(最小侦测范围)​

该 Trait 指示设备支持的最小检测距离,单位为 cm。值为 0 表示 0 cm。

Trait IDCode
0x5187MinDetectionRange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint16600RO
0x0003Minimum Valueuint160RO

MaxDetectionRange Trait(最大侦测范围)​

该 Trait 指示设备支持的最大检测距离,单位为 cm。值为 600 表示 600 cm。

Trait IDCode
0x5188MaxDetectionRange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16600RVO
0x0002Maximum Valueuint16600RO
0x0003Minimum Valueuint160RO

DetectionRangeStep Trait(侦测范围步进)​

该 Trait 指示每个检测范围单元的步长,单位为 cm。值为 25 表示 25 cm。客户端应结合 MinDetectionRange 和 MaxDetectionRange,使用该值确定 DetectionRange bitmask 的预期字节长度以及每个 bit 所表示的距离。

Trait IDCode
0x5189DetectionRangeStep
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1625RVO
0x0002Maximum Valueuint16600RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint1625RWO

SensingMode Trait(传感器模式)​

该 Trait 用于配置 PIR 与 Radar 的感应工作模式,例如 PIR-only、Radar-only 或双模协同。

Trait IDCode
0x5118SensingMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVWO
0x0006Supported Valuelist[uint8]RO
0x0007Default Valueuint80RWO

DetectionRangeTargetPosition Trait(检测范围内目标位置距离)​

该 Trait 用于上报检测范围内目标位置相关数据,便于可视化标定与范围校准。

Trait IDCode
0x511ADetectionRangeTargetPosition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterString0VO
0x0002Maximum ValuecharacterString65535RO
0x0003Minimum ValuecharacterString0RO

Command 定义​

Command IDNameConformance
0x9C7ERemoveZoneO
0x9C7DUpdateZoneO
0x9C7BEnableAISpaceBackgroundLearningO
0x9C7ASubscribeAIEntryExitRegionRecognitionDataO
0x9C79SubscribeAutoEdgeRecognitionDataO
0x9C78SubscribeAutoInterferenceSourceRecognitionDataO
0x9C7CAppendZoneO
0x9D36SetZonesO
0x9D89SubscribeDetectionRangeTargetPositionO

RemoveZone Command​

该 Command 用于执行「删除区域」操作。

参数​

RemoveZone Command Structure

UpdateZone Command​

该 Command 用于执行「更新区域」操作。

参数​

UpdateZone Command Structure

EnableAISpaceBackgroundLearning Command​

该 Command 用于执行「开启AI空间背景学习」操作。

该 Command 无参数。

SubscribeAIEntryExitRegionRecognitionData Command​

该 Command 用于执行「订阅AI进出口区域识别数据」操作。

该 Command 无参数。

SubscribeAutoEdgeRecognitionData Command​

该 Command 用于执行「订阅自动边缘识别数据」操作。

参数​

SubscribeAutoEdgeRecognitionData Command Structure

SubscribeAutoInterferenceSourceRecognitionData Command​

该 Command 用于执行「订阅自动干扰源识别数据」操作。

该 Command 无参数。

AppendZone Command​

该 Command 用于执行「新增区域」操作。

参数​

AppendZone Command Structure

SetZones Command​

该 Command 用于执行「设置区域」操作。

参数​

SetZones Command Structure

SubscribeDetectionRangeTargetPosition Command​

该 Command 用于执行「订阅检测范围目标位置」操作。

该 Command 无参数。

RadarSensingUnion(雷达传感集)​

简介​

提供环境传感联合数据的统一聚合接口,用于汇总子端点列表、区域标识、人数统计与运动状态等能力,支持 Leader/Child 场景下的跨区域信息汇总与分区上报。

Function 标识​

Function IDCode名称
0x00E4RadarSensingUnion雷达传感集

Trait​

Trait IDCode名称Conformance
0x4F57DataStayCheck空间驻留人数校准M
0x4F58StartTime统计起始时间M
0x4F59ViewZoom宫格视图放大功能M
0x4F56FirstNetIn设备首次入网M
0x4F3CCumulativeHumanExitCount累计人流离开量O
0x4F3BCumulativeHumanEntryCount累计人流进入量O
0x4F39PeriodicAverageOccupancyDuration周期平均存在时长O
0x4F3APeriodicTotalWalkingDistance周期总步行距离O
0x4F38PeriodicPeakVisitorCount周期峰值访客流量O
0x4F37CurrentVisitorCount当前访客流量O
0x4F36PeriodicPeakHumanCount周期峰值人流量O
0x4F35CurrentHumanCount当前人流量O
0x4F34ZoneID区域IDO
0x4F33ChildEndpointList子节点列表O
0x80EAMotionDetected移动方向侦测O
0x50E2VisitCountDelta访客人数变化O
0x50E3OccupancyDurationDelta存在时长变化O
0x50E4WalkingDistanceDelta行走距离变化O
0x50E5HumanEntryCountDelta入口人流量变化O
0x50E6HumanExitCountDelta出口人流量变化O

Command​

本 Function 不包含 Command。

数据类型​

FirstNetInEnum8 Type​

该枚举定义 FirstNetIn Trait 的 Present Value 有效取值。

ValueNameDescription
0x00FirstNetIn首次入网
0x01NetInGuide完成入网引导
0x02SecondStep进入第二步
0x03ThirdStep进入第三步
0x04FourthStep进入第四步
CumulativeHumanExitCountTraitPresentValueStructure Type​

该结构体定义 CumulativeHumanExitCount Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0StartTimeuint32M开始时间,单位 s。
1EndTimeuint32M结束时间,单位 s。
2Countuint16M累计离开人数。
CumulativeHumanEntryCountTraitPresentValueStructure Type​

该结构体定义 CumulativeHumanEntryCount Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0StartTimeuint32M开始时间,单位 s。
1EndTimeuint32M结束时间,单位 s。
2Countuint16M累计进入人数。
PeriodicAverageOccupancyDurationTraitPresentValueStructure Type​

该结构体定义 PeriodicAverageOccupancyDuration Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0StartTimeuint32M开始时间,单位 s。
1EndTimeuint32M结束时间,单位 s。
2Durationuint32M平均占用时长,单位 s。
PeriodicTotalWalkingDistanceTraitPresentValueStructure Type​

该结构体定义 PeriodicTotalWalkingDistance Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0StartTimeuint32M开始时间,单位 s。
1EndTimeuint32M结束时间,单位 s。
2Distanceuint32M总行走距离,单位 m。
PeriodicPeakVisitorCountTraitPresentValueStructure Type​

该结构体定义 PeriodicPeakVisitorCount Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0StartTimeuint32M开始时间,单位 s。
1EndTimeuint32M结束时间,单位 s。
2Countuint16M访客统计值。
PeriodicPeakHumanCountTraitPresentValueStructure Type​

该结构体定义 PeriodicPeakHumanCount Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0StartTimeuint32M开始时间,单位 s。
1EndTimeuint32M结束时间,单位 s。
2Countuint16M人数统计值。
MotionDetectedEnum8 Type​

该枚举定义 MotionDetected Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Enter进入
0x01Left离开
0x02LeftIn左进
0x03RightOut右出
0x04RightIn右进
0x05LeftOut左出
0x06Access接近
0x07Away远离
VisitCountDeltaTraitPresentValueStructure Type​

该结构体定义 VisitCountDelta Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0CountDeltauint16M自上次 VisitCountDelta 上报以来检测到的访客增量,单位为次,取值至少为 1。
1ObservationDurationuint32M采集该增量的观测时长,单位 s。
OccupancyDurationDeltaTraitPresentValueStructure Type​

该结构体定义 OccupancyDurationDelta Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0DurationDeltauint32M自上次 OccupancyDurationDelta 上报以来累计的占用时长增量,单位 s,取值至少为 1。
1ObservationDurationuint32M采集该增量的观测时长,单位 s。
WalkingDistanceDeltaTraitPresentValueStructure Type​

该结构体定义 WalkingDistanceDelta Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0DistanceDeltauint32M自上次 WalkingDistanceDelta 上报以来累计的步行距离增量,单位 m,取值至少为 1。
1ObservationDurationuint32M采集该增量的观测时长,单位 s。
HumanEntryCountDeltaTraitPresentValueStructure Type​

该结构体定义 HumanEntryCountDelta Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0CountDeltauint16M自上次 HumanEntryCountDelta 上报以来检测到的人流进入增量,单位为次,取值至少为 1。
1ObservationDurationuint32M采集该增量的观测时长,单位 s。
HumanExitCountDeltaTraitPresentValueStructure Type​

该结构体定义 HumanExitCountDelta Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0CountDeltauint16M自上次 HumanExitCountDelta 上报以来检测到的人流离开增量,单位为次,取值至少为 1。
1ObservationDurationuint32M采集该增量的观测时长,单位 s。

Trait 定义​

Trait IDNameConformance
0x4F57DataStayCheckM
0x4F58StartTimeM
0x4F59ViewZoomM
0x4F56FirstNetInM
0x4F3CCumulativeHumanExitCountO
0x4F3BCumulativeHumanEntryCountO
0x4F39PeriodicAverageOccupancyDurationO
0x4F3APeriodicTotalWalkingDistanceO
0x4F38PeriodicPeakVisitorCountO
0x4F37CurrentVisitorCountO
0x4F36PeriodicPeakHumanCountO
0x4F35CurrentHumanCountO
0x4F34ZoneIDO
0x4F33ChildEndpointListO
0x80EAMotionDetectedO
0x50E2VisitCountDeltaO
0x50E3OccupancyDurationDeltaO
0x50E4WalkingDistanceDeltaO
0x50E5HumanEntryCountDeltaO
0x50E6HumanExitCountDeltaO

DataStayCheck Trait(空间驻留人数校准)​

该 Trait 用于「空间驻留人数校准」相关数据的访问与上报。

Trait IDCode
0x4F57DataStayCheck
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVWM
0x0002Maximum Valueuint3210000RO
0x0003Minimum Valueuint32-10000RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

StartTime Trait(统计起始时间)​

该 Trait 用于「统计起始时间」相关数据的访问与上报。单位:minute。

Trait IDCode
0x4F58StartTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVWM
0x0002Maximum Valueuint161440RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint160RWO

ViewZoom Trait(宫格视图放大功能)​

该 Trait 用于「宫格视图放大功能」相关数据的访问与上报。

Trait IDCode
0x4F59ViewZoom
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWM
0x0007Default Valueboolean0RWO

FirstNetIn Trait(设备首次入网)​

用于设备首次入网进入设备详情页面的相关引导等功能

Trait IDCode
0x4F56FirstNetIn
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFirstNetInEnum80RVWM
0x0006Supported Valuelist[FirstNetInEnum8]RO
0x0007Default ValueFirstNetInEnum80RWO

CumulativeHumanExitCount Trait(累计人流离开量)​

该 Trait 用于「累计人流离开量」相关数据的访问与上报。

Trait IDCode
0x4F3CCumulativeHumanExitCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCumulativeHumanExitCountTraitPresentValueStructureRVO

CumulativeHumanEntryCount Trait(累计人流进入量)​

该 Trait 用于「累计人流进入量」相关数据的访问与上报。

Trait IDCode
0x4F3BCumulativeHumanEntryCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCumulativeHumanEntryCountTraitPresentValueStructureRVO

PeriodicAverageOccupancyDuration Trait(周期平均存在时长)​

该 Trait 用于「周期平均存在时长」相关数据的访问与上报。

Trait IDCode
0x4F39PeriodicAverageOccupancyDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePeriodicAverageOccupancyDurationTraitPresentValueStructureRVO

PeriodicTotalWalkingDistance Trait(周期总步行距离)​

该 Trait 用于「周期总步行距离」相关数据的访问与上报。

Trait IDCode
0x4F3APeriodicTotalWalkingDistance
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePeriodicTotalWalkingDistanceTraitPresentValueStructureRVO

PeriodicPeakVisitorCount Trait(周期峰值访客流量)​

该 Trait 用于「周期峰值访客流量」相关数据的访问与上报。

Trait IDCode
0x4F38PeriodicPeakVisitorCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePeriodicPeakVisitorCountTraitPresentValueStructureRVO

CurrentVisitorCount Trait(当前访客流量)​

该 Trait 用于「当前访客流量」相关数据的访问与上报。

Trait IDCode
0x4F37CurrentVisitorCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO

PeriodicPeakHumanCount Trait(周期峰值人流量)​

该 Trait 用于「周期峰值人流量」相关数据的访问与上报。

Trait IDCode
0x4F36PeriodicPeakHumanCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePeriodicPeakHumanCountTraitPresentValueStructureRVO

CurrentHumanCount Trait(当前人流量)​

该 Trait 用于「当前人流量」相关数据的访问与上报。

Trait IDCode
0x4F35CurrentHumanCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint160RVO
0x0002Maximum Valueuint1610RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint160RWO

ZoneID Trait(区域ID)​

该 Trait 用于「区域ID」相关数据的访问与上报。

Trait IDCode
0x4F34ZoneID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO

ChildEndpointList Trait(子节点列表)​

该 Trait 用于上报由 Leader 端点管理的 Child 端点标识列表。若列表为空,表示当前未管理任何 Child 端点。

Trait IDCode
0x4F33ChildEndpointList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

MotionDetected Trait(移动方向侦测)​

该 Trait 用于上报运动状态变化。在 Leader 角色下可上报全局运动状态;在 Child 角色下上报其绑定区域的运动状态。

Trait IDCode
0x80EAMotionDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMotionDetectedEnum80VO
0x0006Supported Valuelist[MotionDetectedEnum8]RO

VisitCountDelta Trait(访客人数变化)​

用于上报自上次 VisitCountDelta 上报以来检测到的访客增量,客户端可累加该增量得到累计访客次数。

Trait IDCode
0x50E2VisitCountDelta
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVisitCountDeltaTraitPresentValueStructureRVO

OccupancyDurationDelta Trait(存在时长变化)​

用于上报自上次 OccupancyDurationDelta 上报以来累计的占用时长增量,单位为秒。

Trait IDCode
0x50E3OccupancyDurationDelta
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOccupancyDurationDeltaTraitPresentValueStructureRVO

WalkingDistanceDelta Trait(行走距离变化)​

用于上报自上次 WalkingDistanceDelta 上报以来累计的步行距离增量,单位为米。

Trait IDCode
0x50E4WalkingDistanceDelta
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWalkingDistanceDeltaTraitPresentValueStructureRVO

HumanEntryCountDelta Trait(入口人流量变化)​

用于上报自上次 HumanEntryCountDelta 以来检测到的人流进入增量(delta,非累计总量),由雷达传感 Union Event 映射上报。服务端可逐次上报(CountDelta=1),也可聚合多次后上报;同一检测不得重复上报。客户端应累加 CountDelta 得到累计进入量,且不应依赖服务端持久化或重放丢失的事件。

Trait IDCode
0x50E5HumanEntryCountDelta
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHumanEntryCountDeltaTraitPresentValueStructureRVO

HumanExitCountDelta Trait(出口人流量变化)​

用于上报自上次 HumanExitCountDelta 以来检测到的人流离开增量(delta,非累计总量),由雷达传感 Union Event 映射上报。服务端可逐次上报(CountDelta=1),也可聚合多次后上报;同一检测不得重复上报。客户端应累加 CountDelta 得到累计离开量,且不应依赖服务端持久化或重放丢失的事件。

Trait IDCode
0x50E6HumanExitCountDelta
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueHumanExitCountDeltaTraitPresentValueStructureRVO

Command 定义​

本 Function 不包含 Command。

OccupantLocation(存在位置)​

简介​

用于同步存在目标的位置数据,提供目标类型、姿态与活动状态等信息,支持按目标进行位置订阅与检测目标管理。

Function 标识​

Function IDCode名称
0x00E5OccupantLocation存在位置

Trait​

Trait IDCode名称Conformance
0x4F3EMaxDetectionTargets最大检测目标量M
0x4F46LocationInfo位置信息O
0x4F45ActivityState活动状态O
0x4F44FallState跌倒状态O
0x4F43LargeMotionState大动作状态O
0x4F42LyingState躺下状态O
0x4F41StandingState站立状态O
0x4F40SittingState坐下状态O
0x4F3FWalkingState行走状态O

Command​

Command IDCode名称Conformance
0x9C80RemoveDetectionTarget删除检测目标O
0x9C7FSubscribeLocationData订阅位置数据O

数据类型​

LocationInfoTraitPresentValueStructure Type​

该结构体定义 LocationInfo Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0TargetIduint8M目标 ID。
1TargetXCoordinateint16M目标 X 坐标。
2TargetYCoordinateint16M目标 Y 坐标。
3TargetZCoordinateint16M目标 Z 坐标。
4TargetVelocityint16M目标速度。
5TargetSignalToNoiseRatiouint16M目标信噪比。
6TargetTypeenum8M目标类型:0=Person,1=NotPerson,2=Fan,3=Pet,4=Curtain,5=GreenPlants,6=Sweeper,7=AirPurifier,8=Child,0xFF=Unknown。
7TargetPostureenum8M目标姿态:0=Walk,1=Sit,2=Stand,3=Lie,4=Fall,0xFF=Undefined。
8TargetZoneIduint8M目标所在检测区域 ID。
ActivityStateEnum8 Type​

该枚举定义 ActivityState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unknown未知
0x01Active活跃
0x02Still静止
FallStateEnum8 Type​

该枚举定义 FallState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Cleared已清除
0x01Fall跌倒
0x02SuspectedFall疑似跌倒
LargeMotionStateEnum8 Type​

该枚举定义 LargeMotionState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00None无
0x01Action1动作1
0x02Action2动作2
LyingStateEnum8 Type​

该枚举定义 LyingState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00None无
0x01Present存在
StandingStateEnum8 Type​

该枚举定义 StandingState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00None无
0x01Present存在
SittingStateEnum8 Type​

该枚举定义 SittingState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00None无
0x01Present存在
WalkingStateEnum8 Type​

该枚举定义 WalkingState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00None无
0x01Present存在
RemoveDetectionTarget Command Structure Type​

RemoveDetectionTarget Command 的参数结构体。

结构体成员序号字段名类型必须说明
0TargetIDuint8M目标ID。
SubscribeLocationData Command Structure Type​

SubscribeLocationData Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Timeoutuint16M订阅超时时间,单位为秒。

Trait 定义​

Trait IDNameConformance
0x4F3EMaxDetectionTargetsM
0x4F46LocationInfoO
0x4F45ActivityStateO
0x4F44FallStateO
0x4F43LargeMotionStateO
0x4F42LyingStateO
0x4F41StandingStateO
0x4F40SittingStateO
0x4F3FWalkingStateO

MaxDetectionTargets Trait(最大检测目标量)​

该 Trait 用于上报设备支持的最大检测目标数量。

Trait IDCode
0x4F3EMaxDetectionTargets
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVM
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO

LocationInfo Trait(位置信息)​

该 Trait 用于上报当前检测到的目标位置与跟踪信息列表。

Trait IDCode
0x4F46LocationInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[LocationInfoTraitPresentValueStructure]RVO

ActivityState Trait(活动状态)​

该 Trait 用于上报聚合活动状态,例如活跃、静止或未知。

Trait IDCode
0x4F45ActivityState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueActivityStateEnum80RVO
0x0006Supported Valuelist[ActivityStateEnum8]RO

FallState Trait(跌倒状态)​

该 Trait 用于「跌倒状态」相关数据的访问与上报。

Trait IDCode
0x4F44FallState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFallStateEnum80RVO
0x0006Supported Valuelist[FallStateEnum8]RO

LargeMotionState Trait(大动作状态)​

该 Trait 用于「大动作状态」相关数据的访问与上报。

Trait IDCode
0x4F43LargeMotionState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLargeMotionStateEnum80RVO
0x0006Supported Valuelist[LargeMotionStateEnum8]RO

LyingState Trait(躺下状态)​

该 Trait 用于「躺下状态」相关数据的访问与上报。

Trait IDCode
0x4F42LyingState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLyingStateEnum80RVO
0x0006Supported Valuelist[LyingStateEnum8]RO

StandingState Trait(站立状态)​

该 Trait 用于「站立状态」相关数据的访问与上报。

Trait IDCode
0x4F41StandingState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStandingStateEnum80RVO
0x0006Supported Valuelist[StandingStateEnum8]RO

SittingState Trait(坐下状态)​

该 Trait 用于「坐下状态」相关数据的访问与上报。

Trait IDCode
0x4F40SittingState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSittingStateEnum80RVO
0x0006Supported Valuelist[SittingStateEnum8]RO

WalkingState Trait(行走状态)​

该 Trait 用于「行走状态」相关数据的访问与上报。

Trait IDCode
0x4F3FWalkingState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWalkingStateEnum80RVO
0x0006Supported Valuelist[WalkingStateEnum8]RO

Command 定义​

Command IDNameConformance
0x9C80RemoveDetectionTargetO
0x9C7FSubscribeLocationDataO

RemoveDetectionTarget Command​

该 Command 用于执行「删除检测目标」操作。

参数​

RemoveDetectionTarget Command Structure

SubscribeLocationData Command​

该 Command 用于执行「订阅位置数据」操作。

参数​

SubscribeLocationData Command Structure

MatterCoordination(Matter功能协同)​

简介​

集中管理 Matter 协议相关协同操作,包括入网、绑定、数据同步及证书管理。

Function 标识​

Function IDCode名称
0x00E6MatterCoordinationMatter功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9C81APIUnbindMatterDeviceDownMatter设备下行解绑O
0x9C82APIUnbindMatterDeviceUPMatter设备上行解绑O
0x9C83APIPushMatterBindInfoMatter绑定信息下发O
0x9C84APIStartBindMatterDeviceToHubAqara设备入网绑定启动O
0x9C85APIReportDeviceAqaraSpecModelAqara Spec物模型上报O
0x9C86APISyncAqaraSpecDataToCloudAqara Spec设备数据云端同步O
0x9C87APIGenNextMatterNodeIdMatter节点ID生成O
0x9C88APIGenHomeMatterNoc家庭Matter NOC证书生成O
0x9C89APIQueryMatterJoinLimitMatter设备入网限制查询O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9C81APIUnbindMatterDeviceDownO
0x9C82APIUnbindMatterDeviceUPO
0x9C83APIPushMatterBindInfoO
0x9C84APIStartBindMatterDeviceToHubO
0x9C85APIReportDeviceAqaraSpecModelO
0x9C86APISyncAqaraSpecDataToCloudO
0x9C87APIGenNextMatterNodeIdO
0x9C88APIGenHomeMatterNocO
0x9C89APIQueryMatterJoinLimitO

APIUnbindMatterDeviceDown Command(Matter设备下行解绑)​

Matter 设备解绑命令(下行)。云端向网关发送命令,将指定 Matter 设备从家庭网络中移除(解绑)。网关执行本地解绑流程并更新网络拓扑。

该 Command 无参数。

APIUnbindMatterDeviceUP Command(Matter设备上行解绑)​

Matter 设备解绑状态上报(上行)。网关向云端上报本地触发的 Matter 设备解绑事件的结果或状态,确保云端设备列表与本地网络状态同步。

该 Command 无参数。

APIPushMatterBindInfo Command(Matter绑定信息下发)​

Matter 设备入网/绑定信息下发。云端向网关发送新 Matter 设备的入网许可、网络凭据或配置信息,引导并授权设备加入本地 Matter 网络。

该 Command 无参数。

APIStartBindMatterDeviceToHub Command(Aqara设备入网绑定启动)​

Aqara Spec设备绑定开始。网关将新Aqara Spec设备的发现报告给云,并请求启动绑定过程。这是多步骤设备入门流程的第一步。

该 Command 无参数。

APIReportDeviceAqaraSpecModel Command(Aqara Spec物模型上报)​

Aqara Spec设备Thing模型详细信息报告。在设备入门过程中,网关将新发现的Aqara Spec设备支持的完整事物模型定义(功能、属性、命令等)报告给云,用于设备功能注册和动态UI生成。

该 Command 无参数。

APISyncAqaraSpecDataToCloud Command(Aqara Spec设备数据云端同步)​

Aqara Spec设备资源数据云同步。网关将本地Aqara Spec设备的所有当前状态数据(例如,所有属性值)批量同步到云。这通常用于初始设备启用或网络恢复后的全状态恢复。

该 Command 无参数。

APIGenNextMatterNodeId Command(Matter节点ID生成)​

Matter 网络 Node ID 生成请求。在准备为新 Matter 设备分配网络身份时,网关请求云端生成全局唯一且符合规范的 Node ID。

该 Command 无参数。

APIGenHomeMatterNoc Command(家庭Matter NOC证书生成)​

家庭 Matter NOC 证书生成请求。建立或管理 Matter Fabric 时,网关请求云端为当前用户家庭生成或更新 Matter Network Operation Certificate(NOC),用于安全认证。

该 Command 无参数。

APIQueryMatterJoinLimit Command(Matter设备入网限制查询)​

Matter 设备入网限制策略查询。在允许新设备加入 Matter 网络之前,网关向云端查询当前家庭或网关是否已达设备上限,或是否存在其他入网限制策略。

该 Command 无参数。

OTACoordination(OTA功能协同)​

简介​

管理 OTA 固件升级协同流程,包括任务下发、进度上报、结果反馈及版本查询。

Function 标识​

Function IDCode名称
0x00E7OTACoordinationOTA功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9C8AAPIUpgradeDeviceFirmware子设备固件升级O
0x9C8BAPICancelOtaUpgrade设备OTA升级取消O
0x9C8CAPIReportOtaProgressOTA升级进度上报O
0x9C8DAPIReportOtaResultOTA升级结果上报O
0x9C8EAPIReportOtaDeviceListStateOTA设备列表状态上报O
0x9C8FAPIInquiryFirmwareInfo网关固件信息查询O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9C8AAPIUpgradeDeviceFirmwareO
0x9C8BAPICancelOtaUpgradeO
0x9C8CAPIReportOtaProgressO
0x9C8DAPIReportOtaResultO
0x9C8EAPIReportOtaDeviceListStateO
0x9C8FAPIInquiryFirmwareInfoO

APIUpgradeDeviceFirmware Command(子设备固件升级)​

子设备固件升级命令下发。云端向网关下发指定子设备(Zigbee、蓝牙等)的空中(OTA)固件升级命令,包含固件版本及下载地址信息。

该 Command 无参数。

APICancelOtaUpgrade Command(设备OTA升级取消)​

设备 OTA 升级取消 Command。云端向网关下发命令,取消指定设备正在进行的固件升级任务。

该 Command 无参数。

APIReportOtaProgress Command(OTA升级进度上报)​

OTA 升级进度上报。网关实时向云端上报子设备固件升级的当前进度(例如下载百分比、刷写状态),供前端界面展示。

该 Command 无参数。

APIReportOtaResult Command(OTA升级结果上报)​

OTA 升级最终结果上报。子设备固件升级任务完成后(成功或失败),网关向云端上报最终结果及详情(例如成功版本号、失败错误码)。

该 Command 无参数。

APIReportOtaDeviceListState Command(OTA设备列表状态上报)​

OTA 升级设备列表状态上报。网关向云端上报当前正在升级、等待升级或升级失败的所有设备的汇总状态列表,供云端集中监控升级批次。

该 Command 无参数。

APIInquiryFirmwareInfo Command(网关固件信息查询)​

网关固件信息查询请求。网关主动向云端查询是否有适用于自身的新固件版本及相关元数据(如版本号、更新日志、文件大小),用于触发网关自身的 OTA 升级检查。

该 Command 无参数。

StudioCoordination(Studio功能协同)​

简介​

管理网关与 Aqara Studio 开发环境的集成,包括账号认证、项目备份与设备同步。

Function 标识​

Function IDCode名称
0x00E8StudioCoordinationStudio功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9C90APIGetPositionByDeviceId根据设备获取所属房间O
0x9C91APIGetAuthCode验证码获取O
0x9C92APILoginByAuthCode验证码登录O
0x9C93APILoginByGuardCode账号密码登录O
0x9C94APIGetUserDeviceList用户设备列表获取O
0x9C95APIGetStudioBackupUploadUrlStudio备份上传URL获取O
0x9C96APIGetStudioBackupInfoStudio云端备份信息获取O
0x9C97APIConfirmStudioBackupSuccessStudio云端备份上传确认O
0x9C98APIDeleteStudioBackupStudio云端备份删除O
0x9C99APIReportStudioInfoStudio信息上报O
0x9C9AAPIGetProxyServerInfo代理服务器信息查询O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9C90APIGetPositionByDeviceIdO
0x9C91APIGetAuthCodeO
0x9C92APILoginByAuthCodeO
0x9C93APILoginByGuardCodeO
0x9C94APIGetUserDeviceListO
0x9C95APIGetStudioBackupUploadUrlO
0x9C96APIGetStudioBackupInfoO
0x9C97APIConfirmStudioBackupSuccessO
0x9C98APIDeleteStudioBackupO
0x9C99APIReportStudioInfoO
0x9C9AAPIGetProxyServerInfoO

APIGetPositionByDeviceId Command(根据设备获取所属房间)​

按设备 ID 查询房间。当网关需要组织设备列表或执行房间级控制时,向云端查询指定设备 ID 当前所属的房间名称或房间 ID。

该 Command 无参数。

APIGetAuthCode Command(验证码获取)​

用户认证码获取请求。

该 Command 无参数。

APILoginByAuthCode Command(验证码登录)​

验证码登录请求。

该 Command 无参数。

APILoginByGuardCode Command(账号密码登录)​

账号密码登录请求。

该 Command 无参数。

APIGetUserDeviceList Command(用户设备列表获取)​

用户设备列表获取请求。网关向云端请求当前登录用户账号下所有已绑定设备的列表,包括设备 ID、名称、类型及基本状态,通常在初始化、刷新或管理界面操作时发起。

该 Command 无参数。

APIGetStudioBackupUploadUrl Command(Studio备份上传URL获取)​

Studio 备份文件上传 URL 请求。在创建本地 Studio(开发/配置环境)备份后,网关向云端请求临时、安全的文件上传 URL,以将备份文件传输至云存储。

该 Command 无参数。

APIGetStudioBackupInfo Command(Studio云端备份信息获取)​

Studio 云端备份信息查询请求。网关向云端查询当前用户或网关已有的 Studio 备份文件列表及其元数据(如备份时间、大小、描述),用于恢复或备份管理。

该 Command 无参数。

APIConfirmStudioBackupSuccess Command(Studio云端备份上传确认)​

Studio 云端备份上传成功确认。备份文件成功上传至云端后,网关向云端发送确认通知,提示云端将备份文件标记为可用并完成存储流程。

该 Command 无参数。

APIDeleteStudioBackup Command(Studio云端备份删除)​

Studio 云端备份删除请求。网关请求云端删除指定的历史 Studio 备份文件,以释放存储空间或清理旧数据。

该 Command 无参数。

APIReportStudioInfo Command(Studio信息上报)​

Studio 运行信息上报。网关主动向云端上报本地运行的 Aqara Studio 实例的运行状态、版本及配置摘要等信息,用于监控与统计分析。

该 Command 无参数。

APIGetProxyServerInfo Command(代理服务器信息查询)​

代理服务器连接信息查询请求。网关(或其 Studio 环境)向云端请求可用的代理服务器地址和配置信息,以建立特定网络连接(例如远程调试、外部服务访问)。

该 Command 无参数。

CameraCoordination(摄像头功能协同)​

简介​

处理摄像机复杂业务逻辑,包括 WebRTC 通话、云台控制、识别数据同步及扩展事件。

Function 标识​

Function IDCode名称
0x00E9CameraCoordination摄像头功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9C9BAPIIssueTokenForWebRTCCallWebRTC呼叫令牌颁发O
0x9C9CAPIGetSignallingServerAddress信令服务器地址获取O
0x9CCAAPIOperateCameraDown摄像机下行操作O
0x9CCBAPIOperateBridgedDevice桥接设备操作O
0x9CD3APIUnbindWiFiSubdeviceWiFi子设备解绑O
0x9CD1APIDeviceCameraCall设备摄像机主动呼叫O
0x9CD0APIOperateCameraUp摄像机上行操作O
0x9CD2APIBindWiFiSubdeviceWiFi子设备绑定O
0x9CCCAPICheckFaceDataConsistency人脸数据一致性校验O
0x9CCEAPIReportCameraExtEvents摄像机扩展业务事件上报O
0x9CCDAPICheckCarDataConsistency车辆数据一致性校验O
0x9CC9APIConfigCameraSpecific摄像机特定配置O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9C9BAPIIssueTokenForWebRTCCallO
0x9C9CAPIGetSignallingServerAddressO
0x9CCAAPIOperateCameraDownO
0x9CCBAPIOperateBridgedDeviceO
0x9CD3APIUnbindWiFiSubdeviceO
0x9CD1APIDeviceCameraCallO
0x9CD0APIOperateCameraUpO
0x9CD2APIBindWiFiSubdeviceO
0x9CCCAPICheckFaceDataConsistencyO
0x9CCEAPIReportCameraExtEventsO
0x9CCDAPICheckCarDataConsistencyO
0x9CC9APIConfigCameraSpecificO

APIIssueTokenForWebRTCCall Command(WebRTC呼叫令牌颁发)​

WebRTC 设备通话令牌签发请求。当支持 WebRTC 的视频设备(如摄像机)需建立点对点音视频通话或流媒体时,设备请求云端代为签发临时安全令牌,用于认证与会话建立。

该 Command 无参数。

APIGetSignallingServerAddress Command(信令服务器地址获取)​

信令服务器地址获取请求。设备向云端查询当前可用的信令服务器地址列表,以支持采用 WebRTC 等实时通信协议的设备进行 P2P 连接协商。

该 Command 无参数。

APIOperateCameraDown Command(摄像机下行操作)​

摄像头下游操作命令。云向摄像头设备发送特定的控制命令,如云台控制、添加/调用预设、人脸数据库管理、巡航设置等。

该 Command 无参数。

APIOperateBridgedDevice Command(桥接设备操作)​

桥接设备操作命令。云通过网关向充当桥接器的设备(例如,多功能网关、中继器)发送命令,指示其对其连接或管理的子设备执行特定操作(例如,开/关、配置)。

该 Command 无参数。

APIUnbindWiFiSubdevice Command(WiFi子设备解绑)​

WiFi 子设备解绑成功上报。设备向云端上报 WiFi 子设备已成功从本设备或其桥接管理中解绑(移除)。

该 Command 无参数。

APIDeviceCameraCall Command(设备摄像机主动呼叫)​

设备(如 Camera)发起呼叫请求。摄像头或其他设备在检测到特定事件(如门铃按下、移动检测)时主动向云端发起音视频呼叫或推送通知请求,供用户接听或查看。

该 Command 无参数。

APIOperateCameraUp Command(摄像机上行操作)​

摄像头上游操作请求。设备主动向云端发起针对摄像头的特殊操作请求,如请求云端AI分析视频片段、申请临时云端存储配额提升、上报自检异常等。

该 Command 无参数。

APIBindWiFiSubdevice Command(WiFi子设备绑定)​

WiFi 子设备绑定成功上报。设备向云端上报 WiFi 子设备(如 WiFi 摄像机、智能插座)已通过本设备或其桥接功能成功绑定至家庭网络和用户账号。

该 Command 无参数。

APICheckFaceDataConsistency Command(人脸数据一致性校验)​

人脸识别数据一致性校验请求。设备向云端上报本地存储的人脸识别特征库摘要信息,请求比对并接收差异(需添加或删除的人脸数据),以保持人脸库同步。

该 Command 无参数。

APIReportCameraExtEvents Command(摄像机扩展业务事件上报)​

相机扩展业务事件报告。该设备将摄像头生成的超出基本状态变化的扩展事件(例如,智能识别结果、异常行为警报、场景分析事件)报告给云,用于高级应用程序和人工智能分析。

该 Command 无参数。

APICheckCarDataConsistency Command(车辆数据一致性校验)​

车辆识别数据一致性校验请求。设备将本地存储的车辆识别特征库摘要信息上报至云端,请求比对并接收差异(需添加或删除的车辆数据),以维持车辆数据库同步。

该 Command 无参数。

APIConfigCameraSpecific Command(摄像机特定配置)​

摄像头特定的配置操作命令。云将针对摄像机特定功能(例如RTSP流地址、编码参数、运动检测区域)的配置查询、设置或修改命令发送到摄像机。

该 Command 无参数。

SecurityGuardCoordination(安防卫士协同)​

简介​

管理家庭空间安防警戒能力,包括警戒启停、告警确认及本地/云端配置同步。

Function 标识​

Function IDCode名称
0x00EASecurityGuardCoordination安防卫士协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9C9DAPIConfirmSecurityAlert家庭警戒告警确认O
0x9C9EAPIEnableSecurity家庭警戒使能O
0x9C9FAPIRepairSecurityEnable家庭警戒使能修复O
0x9CA0APISyncSecurityLanInfo家庭警戒局域网状态同步O
0x9CA1APIDeleteSecurityLocal家庭警戒本地化删除O
0x9CA2APICheckSecurityConfigConsistency家庭警戒配置一致性检测O
0x9CA3APICheckSecurityEnableConsistency家庭警戒使能状态一致性检测O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9C9DAPIConfirmSecurityAlertO
0x9C9EAPIEnableSecurityO
0x9C9FAPIRepairSecurityEnableO
0x9CA0APISyncSecurityLanInfoO
0x9CA1APIDeleteSecurityLocalO
0x9CA2APICheckSecurityConfigConsistencyO
0x9CA3APICheckSecurityEnableConsistencyO

APIConfirmSecurityAlert Command(家庭警戒告警确认)​

家庭安防告警确认 Command。用户通过云端 App 确认设备上报的家庭安防告警(如入侵检测)后,云端向设备下发该确认 Command。设备随后停止推送该告警并可能更新本地状态。

该 Command 无参数。

APIEnableSecurity Command(家庭警戒使能)​

家庭安防功能启用/禁用 Command。云端下发命令以启用或禁用设备上的家庭安防子系统整体功能。

该 Command 无参数。

APIRepairSecurityEnable Command(家庭警戒使能修复)​

家庭安防启用状态修复 Command。云端检测到设备本地安防启用状态与云端记录不一致时,下发该 Command 强制设备本地启用状态与云端指定状态同步,用于修复状态漂移。

该 Command 无参数。

APISyncSecurityLanInfo Command(家庭警戒局域网状态同步)​

家庭安防 LAN 状态同步 Command。云端向设备下发最新家庭安防相关配置、设备状态或场景信息,确保网关本地安防逻辑与云端配置一致。

该 Command 无参数。

APIDeleteSecurityLocal Command(家庭警戒本地化删除)​

家庭安防本地配置删除 Command。云端命令网关删除本地存储的特定家庭安防配置(如安防场景或设备绑定),通常用于配置清理或重置。

该 Command 无参数。

APICheckSecurityConfigConsistency Command(家庭警戒配置一致性检测)​

家庭安防配置一致性校验请求。设备主动请求云端比对双方存储的详细家庭安防配置(如布防模式、联动规则)是否完全一致,并返回比对结果。

该 Command 无参数。

APICheckSecurityEnableConsistency Command(家庭警戒使能状态一致性检测)​

家庭安防启用状态一致性校验请求。设备向云端查询并校验家庭安防功能记录的"总开关"状态(开/关)在双方是否一致。

该 Command 无参数。

SceneCoordination(场景联动协同)​

简介​

管理智能场景(自动化规则)生命周期,包括同步、删除、触发执行及一致性校验。

Function 标识​

Function IDCode名称
0x00EBSceneCoordination场景联动协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9CA4APIRunScene场景执行O
0x9CA5APIRunLocalScene云端触发本地场景执行O
0x9CA7APIDownloadLocalScene场景本地化同步O
0x9CA8APIDownloadCentralScene中枢场景本地化同步O
0x9CA9APIDeleteLocalScene本地化场景删除O
0x9CAAAPICheckLocalSceneSync本地场景信息同步校验O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9CA4APIRunSceneO
0x9CA5APIRunLocalSceneO
0x9CA7APIDownloadLocalSceneO
0x9CA8APIDownloadCentralSceneO
0x9CA9APIDeleteLocalSceneO
0x9CAAAPICheckLocalSceneSyncO

APIRunScene Command(场景执行)​

场景执行命令(通用)。云端向设备发送命令,立即执行指定的预配置场景。设备负责解析场景动作并控制本地或子设备执行相应操作。

该 Command 无参数。

APIRunLocalScene Command(云端触发本地场景执行)​

云触发的本地场景执行命令。云触发已经存储并在设备上本地运行的自动化场景(而不是云虚拟化场景)。收到后,设备直接执行本地场景逻辑进行低延迟响应。

该 Command 无参数。

APIDownloadLocalScene Command(场景本地化同步)​

场景配置本地化同步命令。云端将用户创建的自动化场景的完整定义(触发条件、执行动作)下发至设备。设备本地存储并负责后续执行,使场景可离线可用。

该 Command 无参数。

APIDownloadCentralScene Command(中枢场景本地化同步)​

中央场景配置本地化同步命令。对于支持多网关集线器/边缘计算的系统,云将涉及跨网关协作的"中心场景"配置发送到充当集线器的网关,以实现本地化存储和分布式协调执行。

该 Command 无参数。

APIDeleteLocalScene Command(本地化场景删除)​

本地化场景删除命令。云端命令设备从其本地存储中删除一个或多个指定同步场景,通常用于用户在云端删除场景后的同步清理。

该 Command 无参数。

APICheckLocalSceneSync Command(本地场景信息同步校验)​

本地场景信息同步校验请求。设备向云端上报所有本地存储场景的摘要信息(例如 ID、版本),请求比对并接收需更新或删除的场景列表,以保持双向同步。

该 Command 无参数。

HubCoordination(网关功能协同)​

简介​

作为网关核心协同模块,管理子设备入网、配置、心跳、令牌及各类代理服务。

Function 标识​

Function IDCode名称
0x00ECHubCoordination网关功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9CA6APISyncTokenDownToken同步下发O
0x9CACAPIRpcDebugCommandRPC调试命令O
0x9CD4APIEnableSubdeviceJoining子设备入网模式启用O
0x9CD5APIDisableSubdeviceJoining子设备入网模式禁用O
0x9CD6APIUnbindSubdeviceDown子设备下行解绑O
0x9CD7APIUnbindHubDown网关下行解绑O
0x9CD8APISetSubdeviceMixing子设备组合集成设备O
0x9CD9APISyncDataCloudToHub云端至网关数据同步O
0x9CDAAPIClearLocalData本地数据清除O
0x9CDBAPICheckHubDataConsistency网关数据一致性校验O
0x9CDDAPICheckHubConfig网关配置校验O
0x9CDEAPIPushHubConfig网关配置下发O
0x9CDFAPIClearHubConfig网关配置清除O
0x9CE0APINotifyConfigChange网关配置变更通知O
0x9CE1APINotifyNoSubdevice无子设备通知O
0x9CE2APIStartHubProvisioning网关入网地址下发O
0x9CE3APIBindBleDeviceToHub蓝牙设备绑定至网关O
0x9CE4APIRunFunctionInstruction云端指令执行O
0x9CE5APITriggerSubdeviceRead子设备数据读取触发O
0x9CE6APIBindSubdeviceWithSecurityCode安全码绑定子设备O
0x9CE7APIRefreshHubToken网关令牌刷新O
0x9CE8APIConnectHub新版网关入网(V1.0)O
0x9CE9APIBindSubdeviceNoAuth免认证绑定子设备O
0x9CEAAPIUnbindSubdeviceUp子设备上行解绑O
0x9CEBAPIUnbindHubUp网关上行解绑O
0x9CECAPISubdeviceKeepAlive子设备心跳O
0x9CEDAPIReportPropertyExamination调试信息上报O
0x9CEEAPIReportDeviceResponse设备响应上报O
0x9CEFAPIReportHubLocalInfo网关本地信息上报O
0x9CF0APICheckHubLocalSync网关本地信息同步校验O
0x9CF1APIExecuteSubstituteCommand代执行命令O
0x9CF2APIAskOtherHubToken其他网关令牌获取O
0x9CF3APIUploadDeviceInfo设备信息更新O
0x9CF4APIReportHubLocalConfig网关本地配置上报O
0x9CF5APISyncSubdeviceList子设备列表同步O
0x9CF6APIQueryDeviceResMultiExt设备资源多值查询O
0x9CF7APIQueryDeviceResMultiExtGbk设备资源多值查询(GBK编码)O
0x9CF8APIUploadLogFileEvent日志文件上传事件O
0x9CF9APIGetSubdeviceServiceConfig子设备服务配置获取O
0x9CFAAPIGetInstallCode安装码获取O
0x9CFBAPIGetRandomJoinCode入网随机码获取O
0x9CFCAPIReportHeartbeat网关心跳上报O
0x9CFDAPIGetVoiceFileUrl语音文件URL获取O
0x9CFEAPIGetWeatherData天气数据获取O
0x9CFFAPISubscribeDeviceResource设备资源订阅O
0x9D00APIUnsubscribeDeviceResource设备资源取消订阅O
0x9D01APIReportExceptionLog设备异常日志上报O
0x9D02APIGetLoginRandomCode登录随机码获取O
0x9D04APIRegisterDirectDevice直连设备重新入网O
0x9D06APIGetSubdeviceConfig子设备配置查询O
0x9D07APIReportSubdeviceModel子设备模型上报O
0x9D08APINotifySubdeviceReadResult子设备数据读取完成通知O
0x9D09APIReportCommandExecResult云端命令执行结果上报O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9CA6APISyncTokenDownO
0x9CACAPIRpcDebugCommandO
0x9CD4APIEnableSubdeviceJoiningO
0x9CD5APIDisableSubdeviceJoiningO
0x9CD6APIUnbindSubdeviceDownO
0x9CD7APIUnbindHubDownO
0x9CD8APISetSubdeviceMixingO
0x9CD9APISyncDataCloudToHubO
0x9CDAAPIClearLocalDataO
0x9CDBAPICheckHubDataConsistencyO
0x9CDDAPICheckHubConfigO
0x9CDEAPIPushHubConfigO
0x9CDFAPIClearHubConfigO
0x9CE0APINotifyConfigChangeO
0x9CE1APINotifyNoSubdeviceO
0x9CE2APIStartHubProvisioningO
0x9CE3APIBindBleDeviceToHubO
0x9CE4APIRunFunctionInstructionO
0x9CE5APITriggerSubdeviceReadO
0x9CE6APIBindSubdeviceWithSecurityCodeO
0x9CE7APIRefreshHubTokenO
0x9CE8APIConnectHubO
0x9CE9APIBindSubdeviceNoAuthO
0x9CEAAPIUnbindSubdeviceUpO
0x9CEBAPIUnbindHubUpO
0x9CECAPISubdeviceKeepAliveO
0x9CEDAPIReportPropertyExaminationO
0x9CEEAPIReportDeviceResponseO
0x9CEFAPIReportHubLocalInfoO
0x9CF0APICheckHubLocalSyncO
0x9CF1APIExecuteSubstituteCommandO
0x9CF2APIAskOtherHubTokenO
0x9CF3APIUploadDeviceInfoO
0x9CF4APIReportHubLocalConfigO
0x9CF5APISyncSubdeviceListO
0x9CF6APIQueryDeviceResMultiExtO
0x9CF7APIQueryDeviceResMultiExtGbkO
0x9CF8APIUploadLogFileEventO
0x9CF9APIGetSubdeviceServiceConfigO
0x9CFAAPIGetInstallCodeO
0x9CFBAPIGetRandomJoinCodeO
0x9CFCAPIReportHeartbeatO
0x9CFDAPIGetVoiceFileUrlO
0x9CFEAPIGetWeatherDataO
0x9CFFAPISubscribeDeviceResourceO
0x9D00APIUnsubscribeDeviceResourceO
0x9D01APIReportExceptionLogO
0x9D02APIGetLoginRandomCodeO
0x9D04APIRegisterDirectDeviceO
0x9D06APIGetSubdeviceConfigO
0x9D07APIReportSubdeviceModelO
0x9D08APINotifySubdeviceReadResultO
0x9D09APIReportCommandExecResultO

APISyncTokenDown Command(Token同步下发)​

设备 Token 同步下行 Command。云端将用户或设备的最新授权 Token 或其他安全凭证下发至设备,更新设备与云端或其他服务通信时使用的认证信息。

该 Command 无参数。

APIRpcDebugCommand Command(RPC调试命令)​

网关远程过程调用(RPC)调试 Command。云端向网关发送通用 RPC 调试 Command,用于远程执行诊断、获取内部状态、测试特定功能或修改调试参数。是开发与运维的重要工具。

该 Command 无参数。

APIEnableSubdeviceJoining Command(子设备入网模式启用)​

子设备入网模式启用命令。云端命令网关进入配对/发现模式,允许新子设备(Zigbee、蓝牙等)在指定时长内或直至收到停止命令前加入网络。

该 Command 无参数。

APIDisableSubdeviceJoining Command(子设备入网模式禁用)​

子设备入网模式禁用命令。云端命令网关立即退出新子设备的配对/发现模式并恢复正常运行。

该 Command 无参数。

APIUnbindSubdeviceDown Command(子设备下行解绑)​

子设备下行解绑命令。云端向网关发送命令,将指定子设备从其管理列表中移除(解绑)。网关将执行本地解绑流程并停止与其通信。

该 Command 无参数。

APIUnbindHubDown Command(网关下行解绑)​

Hub 下行解绑 Command。云端命令 Hub 执行与当前用户账户的解绑流程,通常包括重置网络配置、清除用户数据并为新用户绑定做准备。

该 Command 无参数。

APISetSubdeviceMixing Command(子设备组合集成设备)​

子设备组合与集成配置命令。云端命令网关将多个独立的物理子设备在逻辑上组合或集成为虚拟复合设备,以实现统一控制或复杂场景。

该 Command 无参数。

APISyncDataCloudToHub Command(云端至网关数据同步)​

云到集线器批处理数据同步命令。云端向集线器发送数据包,对用户配置、设备关系、场景规则等非实时业务数据进行批量同步,确保集线器在离线或初始化后能够恢复完整的服务状态。

该 Command 无参数。

APIClearLocalData Command(本地数据清除)​

Hub 本地数据清除 Command。云端命令 Hub 清除从云端同步并本地存储的特定类型或全部用户数据与配置(如场景、设备绑定),通常用于账户切换或数据重置。

该 Command 无参数。

APICheckHubDataConsistency Command(网关数据一致性校验)​

Hub 数据一致性校验 Command。云端主动请求 Hub 将其存储数据摘要与云端进行比对。

该 Command 无参数。

APICheckHubConfig Command(网关配置校验)​

Hub 系统配置校验 Command。云端下发命令要求 Hub 对当前系统级配置进行自检并上报校验结果或配置摘要。

该 Command 无参数。

APIPushHubConfig Command(网关配置下发)​

Hub 系统配置下发 Command。云端向 Hub 下发系统级配置参数或策略文件,以更新或初始化其运行环境、功能模块参数或连接策略。

该 Command 无参数。

APIClearHubConfig Command(网关配置清除)​

Hub 系统配置清除 Command。云端命令 Hub 清除指定系统配置,恢复为出厂默认或空状态。

该 Command 无参数。

APINotifyConfigChange Command(网关配置变更通知)​

Hub 配置变更通知 Command。云端通知 Hub 其部分配置已在云端变更,要求 Hub 主动拉取最新配置或准备应用新配置,实现变更主动推送。

该 Command 无参数。

APINotifyNoSubdevice Command(无子设备通知)​

无子设备状态通知命令。云端通知网关,根据云端记录,当前账号下未绑定任何子设备。

该 Command 无参数。

APIStartHubProvisioning Command(网关入网地址下发)​

Hub 入网配置信息下发 Command。新 Hub 首次上电或重置后,云端向其下发入网所需的引导信息,如可连接服务器地址、配置 Token 或初始配置,引导其完成初始化。

该 Command 无参数。

APIBindBleDeviceToHub Command(蓝牙设备绑定至网关)​

蓝牙设备绑定到 Zigbee 集线器。本 Command 属于云端与 Hub 之间的协同接口,请求体由 YApi 定义,不在 Magic Pair 应用通道上使用。

Magic Pair BLE Endpoint 本地入网 SHALL 通过 VerifyDeviceAuthenticity Cmd 9 WriteUserId 写入当前账户 UserID,再由设备发现附近指定 BLE 网关;不得把本 Command 当作配对或网络凭证下发入口。

该 Command 无本地应用通道参数。

APIRunFunctionInstruction Command(云端指令执行)​

云预定义函数指令执行请求。云将预定义的函数指令代码或脚本标识符发送到集线器,要求其在本地解释和执行相应的复杂逻辑或一系列操作。

该 Command 无参数。

APITriggerSubdeviceRead Command(子设备数据读取触发)​

子设备数据主动读取触发命令。云端命令网关立即向指定子设备发起主动数据读取请求(如查询最新传感器值),并异步将读取结果上报至云端,以按需获取设备状态。

该 Command 无参数。

APIBindSubdeviceWithSecurityCode Command(安全码绑定子设备)​

基于安全码的五元组模型子设备绑定请求。新网关(采用五元组认证模型)绑定子设备时,向云端上报子设备信息和预共享安全码,请求云端验证安全码合法性以完成安全绑定。

该 Command 无参数。

APIRefreshHubToken Command(网关令牌刷新)​

五元组网关 Token 刷新请求。采用五元组认证模型的网关在其当前安全 token 即将过期时,向云端请求新的有效 token,以维持与云端的安全通信。

该 Command 无参数。

APIConnectHub Command(新版网关入网(V1.0))​

Hub 入网请求。Hub 使用新版入网协议与流程(版本 V1.0)向云端发起入网请求,提交设备凭证与网络信息以完成身份注册和网络接入。

该 Command 无参数。

APIBindSubdeviceNoAuth Command(免认证绑定子设备)​

无需身份验证的子设备绑定请求。在特定模式(例如,本地调试、受信任的网络)中,集线器请求云绑定子设备,声明绕过严格的安全认证(例如,五重验证)。

该 Command 无参数。

APIUnbindSubdeviceUp Command(子设备上行解绑)​

子设备上行解绑通知。网关主动向云端上报其已在本地移除(解绑)某子设备,请求云端更新设备关系并清理相关数据。

该 Command 无参数。

APIUnbindHubUp Command(网关上行解绑)​

Hub 上行解绑请求。Hub 主动向云端发起与当前用户账户的解绑请求,通常由用户触发。

该 Command 无参数。

APISubdeviceKeepAlive Command(子设备心跳)​

子设备在线心跳上报。网关定期或在子设备状态变化时,将其管理的子设备在线状态(心跳)上报至云端,供云端监测设备存活状态并更新设备列表中的在线标识。

该 Command 无参数。

APIReportPropertyExamination Command(调试信息上报)​

调试与诊断信息上报。设备在系统运行期间向云端上报调试日志、诊断事件、网络环境参数等非业务信息,用于远程排障、系统优化和数据分析。

该 Command 无参数。

APIReportDeviceResponse Command(设备响应上报)​

设备 Command 执行响应上报。设备在执行云端下发的控制或查询 Command 后,上报设备返回的具体响应结果(含成功、失败及详细数据),完成 Command 交互闭环。

该 Command 无参数。

APIReportHubLocalInfo Command(网关本地信息上报)​

设备本地综合信息上报。设备主动向云端上报本地信息,用于整体状态感知和数据备份。

该 Command 无参数。

APICheckHubLocalSync Command(网关本地信息同步校验)​

Hub 本地信息双向同步校验请求。Hub 主动向云端发起校验请求,比对本地信息摘要与云端,检测并修正不一致,确保数据完整性。

该 Command 无参数。

APIExecuteSubstituteCommand Command(代执行命令)​

Hub 请求云端代执行 Command。Hub 因权限、能力或网络限制无法直接执行 Command 时,请求云端代理向目标设备或服务下发 Command 并将结果返回 Hub。

该 Command 无参数。

APIAskOtherHubToken Command(其他网关令牌获取)​

请求其他网关安全 Token。在需要跨网关协作或访问的场景中,网关向云端请求另一指定网关的安全 token,以与其建立安全直连或间接通信。

该 Command 无参数。

APIUploadDeviceInfo Command(设备信息更新)​

设备信息更新上报。设备上报自身或所管理子设备属性信息变更(如名称修改、位置调整、图标更新),请求云端同步更新设备档案。

该 Command 无参数。

APIReportHubLocalConfig Command(网关本地配置上报)​

Hub 详细本地配置上报。Hub 主动向云端上报其详细本地系统配置。

该 Command 无参数。

APISyncSubdeviceList Command(子设备列表同步)​

Hub 子设备列表批量同步。Hub 向云端上报其所管理全部子设备的完整列表及基本信息(ID、类型、状态),刷新云端记录并确保设备清单准确。

该 Command 无参数。

APIQueryDeviceResMultiExt Command(设备资源多值查询)​

设备资源多值扩展查询请求。网关请求云端同时查询多个设备或单个设备的多个资源(属性)当前值,支持扩展查询选项以实现高效批量数据获取。

该 Command 无参数。

APIQueryDeviceResMultiExtGbk Command(设备资源多值查询(GBK编码))​

设备资源多值扩展查询请求(GBK 编码)。请求与响应文本数据采用 GBK 字符编码,以兼容需要该编码格式的系统或设备。

该 Command 无参数。

APIUploadLogFileEvent Command(日志文件上传事件)​

日志文件上传事件通知。设备通知云端已完成日志文件上传,触发云端日志处理流程。

该 Command 无参数。

APIGetSubdeviceServiceConfig Command(子设备服务配置获取)​

子设备服务配置查询请求。网关向云端查询特定子设备所需或推荐的服务配置参数,如连接策略、数据上报频率、功能启用建议等。

该 Command 无参数。

APIGetInstallCode Command(安装码获取)​

五元组 Install Code 获取请求。采用五元组安全模型的设备向云端请求其唯一的"Install Code",用于安全入网过程中的身份验证。

该 Command 无参数。

APIGetRandomJoinCode Command(入网随机码获取)​

五元组子设备入网随机码获取请求。在五元组安全框架下,网关为准备入网的新子设备向云端请求一次性随机加入码,确保入网过程的安全性与唯一性。

该 Command 无参数。

APIReportHeartbeat Command(网关心跳上报)​

Hub 自身在线心跳上报。Hub 定期向云端发送心跳信号,表明自身(非子设备)在线且运行正常,供云端监测 Hub 存活状态。

该 Command 无参数。

APIGetVoiceFileUrl Command(语音文件URL获取)​

语音提示文件 URL 获取请求。网关向云端请求语音提示文件(如告警音、欢迎语)的下载 URL 或配置信息,用于本地播放。

该 Command 无参数。

APIGetWeatherData Command(天气数据获取)​

天气数据获取请求。设备向云端请求指定位置的当前天气、预报及其他气象信息,用于智能场景触发或界面显示。

该 Command 无参数。

APISubscribeDeviceResource Command(设备资源订阅)​

设备发起的资源订阅请求。设备(或代表它的网关)请求云端开始订阅一个或多个设备资源的变更。资源值变更时,云端将主动推送更新。

该 Command 无参数。

APIUnsubscribeDeviceResource Command(设备资源取消订阅)​

设备发起的资源取消订阅请求。设备(或代表它的网关)请求云端停止推送一个或多个此前已订阅设备资源的更新。

该 Command 无参数。

APIReportExceptionLog Command(设备异常日志上报)​

Device Exception Log Report. The hub or device reports exceptions, error logs, or crash information captured during operation to the cloud, facilitating故障诊断和系统改进 (fault diagnosis and system improvement) by developers.

该 Command 无参数。

APIGetLoginRandomCode Command(登录随机码获取)​

设备登录随机数(Nonce)获取请求。在设备登录或认证过程中,向云端请求随机数(Nonce),用于构造防重放攻击的安全凭证。

该 Command 无参数。

APIRegisterDirectDevice Command(直连设备重新入网)​

直连设备重新入网注册请求。直连设备(如通过 Wi-Fi Direct)向云端请求恢复网络连接和服务。

该 Command 无参数。

APIGetSubdeviceConfig Command(子设备配置查询)​

子设备详细配置查询请求。网关向云端查询指定子设备的详细配置信息。

该 Command 无参数。

APIReportSubdeviceModel Command(子设备模型上报)​

子设备物模型信息上报。在发现新子设备或子设备固件升级后,网关将其完整支持的物模型定义(功能、属性、命令、事件)上报至云端,用于更新设备能力库及动态 UI 生成。

该 Command 无参数。

APINotifySubdeviceReadResult Command(子设备数据读取完成通知)​

子设备数据主动读取结果异步上报。响应云端的 APITriggerSubdeviceRead 命令,在完成对目标子设备的数据读取后,网关异步将读取结果(或超时/失败状态)上报至云端,完成此次按需查询的闭环。

该 Command 无参数。

APIReportCommandExecResult Command(云端命令执行结果上报)​

云预定义指令执行结果报告。在通过APIRunFunctionInstruction执行云交付的预定义函数指令后,集线器将指令执行的成功/失败结果、输出数据或错误详细信息报告给云。

该 Command 无参数。

LightBoxCoordination(灯箱功能协同)​

简介​

管理智能灯箱设备的配置下发,控制展示内容与效果。

Function 标识​

Function IDCode名称
0x00EDLightBoxCoordination灯箱功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9CABAPIPushLightBoxConfig灯箱配置下发O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9CABAPIPushLightBoxConfigO

APIPushLightBoxConfig Command(灯箱配置下发)​

灯箱设备配置信息下发命令。云端将智能灯箱设备的特定配置(例如灯光效果、配色方案、定时计划)下发至网关,网关随后转发或应用到目标灯箱设备。

该 Command 无参数。

IRCoordination(红外遥控协同)​

简介​

管理网关红外学习与发射,包括码库同步、虚拟遥控器创建及按键控制。

Function 标识​

Function IDCode名称
0x00EEIRCoordination红外遥控协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9D58APIStartIrLearningForApp开启红外码学习O
0x9D4EAPIListIrControllersForApp查询网关下遥控器列表O
0x9D4CAPIGetMatchTreeForApp获取匹配树信息O
0x9D59APICreateIrVirtualDeviceForApp创建本地化的红外码虚拟设备O
0x9D57APICancelIrLearningForApp取消红外码学习O
0x9D48APIQueryIrSpsForApp查询运营商列表O
0x9D4DAPIReadLearnedIrCodeForApp读取学习到的红外码O
0x9D53APIAddIrKeyForApp遥控器增加按键O
0x9D54APIGetAirConditionerFunctionsForApp获取有状态空调支持的功能组合O
0x9D49APIQueryIrAreaForApp查询区域列表O
0x9D4AAPIGetBrandByIdForApp根据品牌 ID 查询品牌信息O
0x9D4BAPIGetBrandsByCategoryForApp根据设备类型获取品牌列表O
0x9D55APIGetKeysByRemoteIdForApp根据遥控器 ID 获取按键信息O
0x9D56APIMatchRemoteByIrCodeForApp根据红外码获取匹配状态结果O
0x9D5AAPIGetSupportIrGatewaysForApp获取位置支持红外设备的网关列表O
0x9D4FAPIGetControllerKeysForApp获取遥控器所有按键信息O
0x9D50APIDeleteIrKeysForApp删除遥控器按键O
0x9D51APIClickIrKeyForApp单击遥控器按键O
0x9D5BAPIGetIrControllerInfoForApp获取遥控器信息O
0x9D47APIGetIrDeviceCategoriesForApp获取红外设备类型列表O
0x9D52APIUpdateIrKeyNameForApp更新遥控器按键名称O
0x9CB6APISyncIrLearningCodes红外学习码同步O
0x9CB7APIGetIrCodeDownloadUrl红外码下载URL获取O
0x9CB3APIQueryIrLearningCode红外学习码查询O
0x9CB2APIQueryIrCodeLibrary红外码库查询O
0x9CB4APIGetIrCode红外码获取O
0x9CB5APIGetIrCodeTarget红外码目标获取O
0x9CAEAPISendIrButtonPress红外码单击O
0x9CAFAPIDeleteLearnedIrCode已学习红外码删除O
0x9CB0APISaveLearnedIrKey红外学习码按键保存O
0x9CADAPIStartIrCodeLearning红外码学习启动O
0x9D64APISaveMatchedRemoteInfoForApp保存匹配成功的遥控器信息O

数据类型​

APISaveMatchedRemoteInfoForApp Command Structure Type​

APISaveMatchedRemoteInfoForApp Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Categoryuint32M设备类型;默认值为 0。
1BrandIduint32M品牌标识;默认值为 0。
2RemoteIduint32M遥控器 ID;默认值为 0。
3SpIduint32O机顶盒运营商 ID;默认值为 0。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9D58APIStartIrLearningForAppO
0x9D4EAPIListIrControllersForAppO
0x9D4CAPIGetMatchTreeForAppO
0x9D59APICreateIrVirtualDeviceForAppO
0x9D57APICancelIrLearningForAppO
0x9D48APIQueryIrSpsForAppO
0x9D4DAPIReadLearnedIrCodeForAppO
0x9D53APIAddIrKeyForAppO
0x9D54APIGetAirConditionerFunctionsForAppO
0x9D49APIQueryIrAreaForAppO
0x9D4AAPIGetBrandByIdForAppO
0x9D4BAPIGetBrandsByCategoryForAppO
0x9D55APIGetKeysByRemoteIdForAppO
0x9D56APIMatchRemoteByIrCodeForAppO
0x9D5AAPIGetSupportIrGatewaysForAppO
0x9D4FAPIGetControllerKeysForAppO
0x9D50APIDeleteIrKeysForAppO
0x9D51APIClickIrKeyForAppO
0x9D5BAPIGetIrControllerInfoForAppO
0x9D47APIGetIrDeviceCategoriesForAppO
0x9D52APIUpdateIrKeyNameForAppO
0x9CB6APISyncIrLearningCodesO
0x9CB7APIGetIrCodeDownloadUrlO
0x9CB3APIQueryIrLearningCodeO
0x9CB2APIQueryIrCodeLibraryO
0x9CB4APIGetIrCodeO
0x9CB5APIGetIrCodeTargetO
0x9CAEAPISendIrButtonPressO
0x9CAFAPIDeleteLearnedIrCodeO
0x9CB0APISaveLearnedIrKeyO
0x9CADAPIStartIrCodeLearningO
0x9D64APISaveMatchedRemoteInfoForAppO

APIStartIrLearningForApp Command(开启红外码学习)​

在网关上启动红外码学习并返回学习标识符。

该 Command 无参数。

APIListIrControllersForApp Command(查询网关下遥控器列表)​

列出网关下所有虚拟红外遥控器设备。

该 Command 无参数。

APIGetMatchTreeForApp Command(获取匹配树信息)​

检索品牌、机顶盒或 IPTV 遥控器的匹配树(按键映射)。

该 Command 无参数。

APICreateIrVirtualDeviceForApp Command(创建本地化的红外码虚拟设备)​

创建虚拟红外遥控器设备(匹配型或自定义型)。

该 Command 无参数。

APICancelIrLearningForApp Command(取消红外码学习)​

取消网关上正在进行的红外代码学习会话。

该 Command 无参数。

APIQueryIrSpsForApp Command(查询运营商列表)​

按城市 ID 查询机顶盒运营商列表。

该 Command 无参数。

APIReadLearnedIrCodeForApp Command(读取学习到的红外码)​

使用学习过程中返回的 keyId 从网关读取已学习的红外码。

该 Command 无参数。

APIAddIrKeyForApp Command(遥控器增加按键)​

将新学习的红外键添加到遥控器。

该 Command 无参数。

APIGetAirConditionerFunctionsForApp Command(获取有状态空调支持的功能组合)​

获取有状态空调遥控器支持的功能(模式、温度、风速等)。

该 Command 无参数。

APIQueryIrAreaForApp Command(查询区域列表)​

查询省、市、区等行政区划。

该 Command 无参数。

APIGetBrandByIdForApp Command(根据品牌 ID 查询品牌信息)​

检索给定类别和品牌 ID 的品牌信息。

该 Command 无参数。

APIGetBrandsByCategoryForApp Command(根据设备类型获取品牌列表)​

检索特定红外设备类别支持的品牌列表。

该 Command 无参数。

APIGetKeysByRemoteIdForApp Command(根据遥控器 ID 获取按键信息)​

使用 remoteId 获取遥控器码库支持的按键列表。

该 Command 无参数。

APIMatchRemoteByIrCodeForApp Command(根据红外码获取匹配状态结果)​

根据已学习的红外码匹配可能的遥控器。

该 Command 无参数。

APIGetSupportIrGatewaysForApp Command(获取位置支持红外设备的网关列表)​

获取指定位置支持红外功能的网关列表。

该 Command 无参数。

APIGetControllerKeysForApp Command(获取遥控器所有按键信息)​

获取指定遥控器设备的全部按键信息。

该 Command 无参数。

APIDeleteIrKeysForApp Command(删除遥控器按键)​

从遥控器中删除一个或多个按键。

该 Command 无参数。

APIClickIrKeyForApp Command(单击遥控器按键)​

向红外遥控器发送单次按键命令。

该 Command 无参数。

APIGetIrControllerInfoForApp Command(获取遥控器信息)​

获取单个红外遥控器的详细信息(品牌、类型等)。

该 Command 无参数。

APIGetIrDeviceCategoriesForApp Command(获取红外设备类型列表)​

查询遥控器支持的红外设备类别列表(例如 TV、空调)。

该 Command 无参数。

APIUpdateIrKeyNameForApp Command(更新遥控器按键名称)​

重命名红外遥控器上的按键。

该 Command 无参数。

APISyncIrLearningCodes Command(红外学习码同步)​

IR 学习码双向同步请求。设备向云端上报本地存储的全部 IR 学习码摘要信息,请求比对并接收差异列表(需添加或删除的码),以实现云端与设备 IR 码库最终一致。

该 Command 无参数。

APIGetIrCodeDownloadUrl Command(红外码下载URL获取)​

IR 码数据库下载 URL 请求。设备向云端请求用于下载完整或增量 IR 码数据库文件的 URL,以更新或初始化离线码库。

该 Command 无参数。

APIQueryIrLearningCode Command(红外学习码查询)​

已学习 IR 码信息查询请求。设备请求云端检索本地存储的所有用户自定义已学习 IR 码的列表及元数据(例如绑定的电器名称、按键名称)。

该 Command 无参数。

APIQueryIrCodeLibrary Command(红外码库查询)​

IR 码云库查询请求。设备向云端查询特定品牌型号家电的预置 IR 码库是否存在,使用户无需手动学习即可添加并控制常见家电。

该 Command 无参数。

APIGetIrCode Command(红外码获取)​

IR 码原始数据获取请求。设备向云端请求指定 IR 码的原始或波形数据,用于本地发送或校验。

该 Command 无参数。

APIGetIrCodeTarget Command(红外码目标获取)​

IR 码目标家电信息请求。设备向云端请求与特定 IR 码关联的目标家电详细信息(如品牌、型号、功能),以丰富用户界面展示。

该 Command 无参数。

APISendIrButtonPress Command(红外码单击)​

IR 码单次发送 Command。云端命令设备通过 IR 发射器向目标家电(如空调、电视)单次发送特定已学习或预置 IR 码,模拟遥控器单次按键。

该 Command 无参数。

APIDeleteLearnedIrCode Command(已学习红外码删除)​

已学习 IR 码删除命令。云端命令设备从其本地存储中删除一条或多条先前学习并保存的 IR 遥控码。

该 Command 无参数。

APISaveLearnedIrKey Command(红外学习码按键保存)​

已学习 IR 码按键绑定保存命令。IR 码学习成功后,云端发送命令将已学习的 IR 码绑定到用户定义的虚拟按键(或场景动作),并在设备存储中持久化该绑定。

该 Command 无参数。

APIStartIrCodeLearning Command(红外码学习启动)​

IR 码学习模式启动 Command。云端命令设备进入 IR 学习模式,准备接收用户物理 IR 遥控器信号并将其编码为可存储、可重发的数字格式。

该 Command 无参数。

APISaveMatchedRemoteInfoForApp Command(保存匹配成功的遥控器信息)​

该 Command 用于执行「保存匹配成功的遥控器信息」操作。

参数​

APISaveMatchedRemoteInfoForApp Command Structure

CommLinkCoordination(通信链路协同)​

简介​

监测网关与云端通信链路质量,执行耗时探测并上报结果。

Function 标识​

Function IDCode名称
0x00EFCommLinkCoordination通信链路协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9CB8APICheckLinkConsuming链路耗时检测O
0x9CB9APIReportLinkConsuming链路耗时上报O
0x9DA3GetAqaraCertificateInfoForApp获取 Aqara 证书信息请求O
0x9DA4GetAqaraCertificateInfoForAppRsp获取 Aqara 证书信息响应O

数据类型​

本 Function 无自定义数据类型。

GetAqaraCertificateInfoForAppRsp Command Structure Type​

GetAqaraCertificateInfoForAppRsp Command 的响应参数结构体。该命令属于平台级(App <-> Studio)交互;所有字段均为必填,JSON 编码时以字段索引作为键。

结构体成员序号字段名类型必须说明
0CaPemcharacterStringMCA 根证书(PEM 格式)。
1CaFingerprintSha256characterStringMCA 证书的 SHA-256 指纹(十六进制字符串)。
2ServerChainPemcharacterStringM服务器证书链(PEM 格式)。
3ServerNotAfterEpochMillisuint64M服务器证书失效时间戳(Unix epoch,毫秒)。
4DnsNameslist[characterString]M证书允许的域名列表。
5IpAddresseslist[characterString]M证书允许的 IP 地址列表。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9CB8APICheckLinkConsumingO
0x9CB9APIReportLinkConsumingO
0x9DA3GetAqaraCertificateInfoForAppO
0x9DA4GetAqaraCertificateInfoForAppRspO

APICheckLinkConsuming Command(链路耗时检测)​

网络链路时延探测命令。云端向设备发送探测命令,测量云端与设备之间的往返时延(RTT),通常用于网络质量监测与诊断。

该 Command 无参数。

APIReportLinkConsuming Command(链路耗时上报)​

网络链路时延探测结果上报。执行链路探测后,设备向云端上报测得的网络时延及其他结果,用于网络性能分析与统计。

该 Command 无参数。

GetAqaraCertificateInfoForApp Command(获取 Aqara 证书信息请求)​

该命令由 App 向 Aqara Studio 发起,用于请求 Aqara 证书信息。Studio 应通过 GetAqaraCertificateInfoForAppRsp Command 返回证书详情。该请求无参数。

参数​

该 Command 无参数。

备注

请求示例(JSON):

{}

GetAqaraCertificateInfoForAppRsp Command(获取 Aqara 证书信息响应)​

该命令由 Aqara Studio 作为对 GetAqaraCertificateInfoForApp 的响应返回。包含 CA 根证书、CA 证书 SHA-256 指纹、服务器证书链、服务器证书失效时间戳,以及允许的域名和 IP 地址列表。

参数​

GetAqaraCertificateInfoForAppRsp Command Structure

备注

响应示例(JSON,字段索引作为键):

{
"0": "-----BEGIN CERTIFICATE-----\nMIID...\n-----END CERTIFICATE-----",
"1": "a1b2c3d4e5f6...",
"2": "-----BEGIN CERTIFICATE-----\nMIID...\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIID...\n-----END CERTIFICATE-----",
"3": 1735689600000,
"4": ["aqarastudio-4829.local", "aqarastudio-1234.local"],
"5": ["10.11.51.142", "192.168.1.100"]
}

RingtoneCoordination(提示音管理协同)​

简介​

管理网关本地铃声/音乐文件,包括下载、删除及与云端库的一致性校验。

Function 标识​

Function IDCode名称
0x00F0RingtoneCoordination提示音管理协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9CBAAPIDownloadMusic音乐下载O
0x9CBBAPIDeleteMusic音乐删除O
0x9CBCAPICheckLocalMusicSync本地音乐信息一致性校验O
0x9D61APIGetSupportDeviceInfoForApp根据位置查询支持的设备信息O
0x9D62APIGetCustomRingtoneInfoForApp查询自定义铃声信息O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9CBAAPIDownloadMusicO
0x9CBBAPIDeleteMusicO
0x9CBCAPICheckLocalMusicSyncO
0x9D61APIGetSupportDeviceInfoForAppO
0x9D62APIGetCustomRingtoneInfoForAppO

APIDownloadMusic Command(音乐下载)​

设备音乐文件下载 Command。云端下发命令,指示设备从指定地址下载音频文件(如铃声、提示音)至本地存储,供后续播放。

该 Command 无参数。

APIDeleteMusic Command(音乐删除)​

设备本地音乐文件删除 Command。云端命令设备从本地存储删除一个或多个指定音频文件。

该 Command 无参数。

APICheckLocalMusicSync Command(本地音乐信息一致性校验)​

本地音乐文件信息同步校验请求。设备向云端上报本地存储的音乐文件列表(例如文件名、MD5),请求比对并接收需同步(下载或删除)的文件列表,以保持云端与本地音乐库一致。

该 Command 无参数。

APIGetSupportDeviceInfoForApp Command(根据位置查询支持的设备信息)​

该命令查询指定位置支持特定文件类型(如门铃文件)的设备列表。请求包含 positionId(位置 ID)和 fileType(文件类型)。响应返回设备数组,包含 did、deviceName、state、model、positionId 和 positionName 等详情。

该 Command 无参数。

APIGetCustomRingtoneInfoForApp Command(查询自定义铃声信息)​

该命令查询可分发至设备的自定义铃声文件(如门铃文件)列表及其当前分发状态。请求包含 did(设备 ID)和 fileType(文件类型,如 "bell_file")。响应返回文件数组,包含 fileId、fileName、fileUrl、加密密钥、sendState(分发状态)、dataState(有效/已删除)、failCode 和 failMsg 等详情。

该 Command 无参数。

ScreenCoordination(屏幕功能协同)​

简介​

管理智能场景面板交互,包括配置下发、状态查询及云端/面板双向透传。

Function 标识​

Function IDCode名称
0x00F1ScreenCoordination屏幕功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9CBDAPIPushPanelConfig场景面板配置下发O
0x9CBEAPICloudToPanelDownstream云端至面板下行通用O
0x9CBFAPICheckPanelConfigConsistency场景面板配置一致性校验O
0x9CC0APIPanelUpstreamRequest面板上行请求通用O
0x9CC6APISyncPositionDown位置信息下行同步O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9CBDAPIPushPanelConfigO
0x9CBEAPICloudToPanelDownstreamO
0x9CBFAPICheckPanelConfigConsistencyO
0x9CC0APIPanelUpstreamRequestO
0x9CC6APISyncPositionDownO

APIPushPanelConfig Command(场景面板配置下发)​

智能场景面板配置下发命令。云端将智能场景面板(实体或虚拟)相关配置下发至设备,包括按钮图标、背光颜色及关联的场景或设备控制逻辑。

该 Command 无参数。

APICloudToPanelDownstream Command(云端至面板下行通用)​

云到面板下游通用命令通道。云使用此通用接口向场景面板发送各种控制、查询或配置命令。

该 Command 无参数。

APICheckPanelConfigConsistency Command(场景面板配置一致性校验)​

场景面板配置一致性校验请求。设备向云端上报其管理的所有场景面板的当前配置摘要,请求比对并接收差异,以确保云端与本地面板配置同步。

该 Command 无参数。

APIPanelUpstreamRequest Command(面板上行请求通用)​

面板到云端上行通用请求通道。使用该通用接口向云端发起各类请求,例如获取天气、执行复杂场景或上报面板事件。

该 Command 无参数。

APISyncPositionDown Command(位置信息下行同步)​

设备位置信息下行同步 Command。云端将用户分配的房间、区域等位置信息下发至设备,确保设备本地设备-位置映射与云端设置一致。

该 Command 无参数。

ConfigurationCoordination(通用配置协同)​

简介​

通过组播或批量方式管理通用功能配置、资源订阅及位置信息同步。

Function 标识​

Function IDCode名称
0x00F2ConfigurationCoordination通用配置协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9CC1APIGetConfiguration通用配置获取O
0x9CC2APIDeleteConfiguration通用配置删除(组播)O
0x9CC3APIReportConfiguration通用配置上报(组播)O
0x9CC4APISyncConfiguration通用配置同步O
0x9CC5APIPushConfiguration通用配置下发(组播)O
0x9CC7APIPushSubscribedResource订阅资源下发O
0x9CC8APIWriteFunctionResource功能资源控制(组播)O
0x9D0AAPIReportThingModelDetail物模型详情上报O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9CC1APIGetConfigurationO
0x9CC2APIDeleteConfigurationO
0x9CC3APIReportConfigurationO
0x9CC4APISyncConfigurationO
0x9CC5APIPushConfigurationO
0x9CC7APIPushSubscribedResourceO
0x9CC8APIWriteFunctionResourceO
0x9D0AAPIReportThingModelDetailO

APIGetConfiguration Command(通用配置获取)​

通用功能配置获取请求。设备向云端请求指定功能模块(如特定传感器数据处理逻辑、设备行为规则)的最新配置参数或策略文件。

该 Command 无参数。

APIDeleteConfiguration Command(通用配置删除(组播))​

通用功能配置组播删除 Command。云端下发命令要求设备删除一种或多种指定类型的通用配置。该 Command 可通过组播发送,同时影响多个符合条件的网关或设备。

该 Command 无参数。

APIReportConfiguration Command(通用配置上报(组播))​

通用功能资源组播上报。设备通过组播或批量上报向云端报告本地存储的某类通用功能资源(如配置、状态缓存)的当前值或摘要信息,用于集中监控与同步。

该 Command 无参数。

APISyncConfiguration Command(通用配置同步)​

通用功能配置双向同步请求。设备向云端上报本地存储的通用功能配置摘要,请求比对并接收差异列表(需推送或删除的配置),以实现云端与设备最终一致。

该 Command 无参数。

APIPushConfiguration Command(通用配置下发(组播))​

通用功能配置组播下发 Command。云端向一个或多个设备下发通用功能配置(如设备行为规则、数据处理策略)。该 Command 可通过组播发送,高效同步一批设备的配置。

该 Command 无参数。

APIPushSubscribedResource Command(订阅资源下发)​

设备订阅资源下发 Command。根据设备或其子设备订阅的资源类型,云端向设备下发对应资源配置、状态更新或数据流,用于实时数据推送或配置更新。

该 Command 无参数。

APIWriteFunctionResource Command(功能资源控制(组播))​

通用功能资源组播控制 Command。云端通过组播向一个或多个设备发送对特定通用功能资源(如虚拟开关、计数器)的写操作 Command(如设值、触发动作),实现批量控制。

该 Command 无参数。

APIReportThingModelDetail Command(物模型详情上报)​

Aqara新设备Thing模型详细信息报告。对于支持Aqara设备Thing模型协议的集线器或设备,将详细的Thing模型(对象、属性、服务)报告给云。

该 Command 无参数。

LockCoordination(门锁功能协同)​

简介​

处理智能门锁扩展业务,包括专用透传通道、加解密协助及扩展事件上报。

Function 标识​

Function IDCode名称
0x00F3LockCoordination门锁功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9CCFAPIReportLockExtEvents锁扩展业务事件上报O
0x9CDCAPILockPassthroughDownstream外部透传网关下行O
0x9D03APIAssistDeviceCrypto设备数据加解密协助O
0x9D05APILockPassthroughUpstream外部透传上行上报O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9CCFAPIReportLockExtEventsO
0x9CDCAPILockPassthroughDownstreamO
0x9D03APIAssistDeviceCryptoO
0x9D05APILockPassthroughUpstreamO

APIReportLockExtEvents Command(锁扩展业务事件上报)​

智能门锁扩展业务事件上报。设备将智能门锁在基础状态变化之外产生的扩展事件(如特定用户开锁记录、胁迫告警、低电量警告、防拆告警等)上报至云端。

该 Command 无参数。

APILockPassthroughDownstream Command(外部透传网关下行)​

外部应用透传下行 Command(专用通道)。云端通过为特定外部应用预留的专用透传通道发送绕过业务层解析的原始 Command 或数据,直接转发至指定子设备(如智能锁)。

该 Command 无参数。

APIAssistDeviceCrypto Command(设备数据加解密协助)​

设备数据加解密协助请求。因安全策略或能力限制,网关请求云端使用指定设备的密钥对特定字符串数据进行加密或解密并返回结果。

该 Command 无参数。

APILockPassthroughUpstream Command(外部透传上行上报)​

外部应用透传上行信息上报(专用通道)。

该 Command 无参数。

WakeupCoordination(设备唤醒协同)​

简介​

为支持远程唤醒的低功耗设备获取唤醒服务地址或令牌。

Function 标识​

Function IDCode名称
0x00F4WakeupCoordination设备唤醒协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9D0BAPIGetWakeupUrl唤醒地址获取O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9D0BAPIGetWakeupUrlO

APIGetWakeupUrl Command(唤醒地址获取)​

设备远程唤醒服务地址获取请求。设备向云端查询支持远程唤醒的子设备(如低功耗设备)的唤醒服务器地址或访问 Token,以便按需激活。

该 Command 无参数。

CloudStorageCoordination(云存功能协同)​

简介​

管理云录像/云存业务资源配置,获取存储配额及上传凭证等信息。

Function 标识​

Function IDCode名称
0x00F5CloudStorageCoordination云存功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9D0CAPIRequestCloudStorageResource云存业务资源请求O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9D0CAPIRequestCloudStorageResourceO

APIRequestCloudStorageResource Command(云存业务资源请求)​

云存储业务资源配置请求。设备(通常表示相机等设备)从云中请求与云视频存储服务相关的资源配置信息,例如存储配额、上传凭据、录制计划等。

该 Command 无参数。

CentralHubCoordination(中枢功能协同)​

简介​

管理中枢网关高级能力,包括中枢启用、Broker 信息及数据透传通道。

Function 标识​

Function IDCode名称
0x00F6CentralHubCoordination中枢功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9D0DAPIEnableCentralHubFunction中枢功能启用O
0x9D0EAPIHubPassthroughDataDown网关透传数据下行O
0x9D0FAPIInquiryCentralBroker中枢Broker信息查询O
0x9D10APIInquiryCentralEnableState中枢使能状态查询O
0x9D11APIHubPassthroughDataUp网关透传数据上行O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9D0DAPIEnableCentralHubFunctionO
0x9D0EAPIHubPassthroughDataDownO
0x9D0FAPIInquiryCentralBrokerO
0x9D10APIInquiryCentralEnableStateO
0x9D11APIHubPassthroughDataUpO

APIEnableCentralHubFunction Command(中枢功能启用)​

Hub 中央网关核心功能启用 Command。云端命令 Hub 激活其作为"智能家居中央网关"的核心能力,如本地自动化引擎、跨协议协调、设备管理、边缘计算,将其从普通网关升级为家庭控制中心。

该 Command 无参数。

APIHubPassthroughDataDown Command(网关透传数据下行)​

Hub 数据透传下行通道。云端通过该通用透传接口向 Hub 发送无需 Hub 业务层解析的原始数据包,Hub 直接转发至其所连接的特定终端设备或服务。

该 Command 无参数。

APIInquiryCentralBroker Command(中枢Broker信息查询)​

中央消息代理信息查询请求。充当中央集线器的集线器向云查询其应连接的消息代理服务器的信息(用于设备间通信、事件分发)。

该 Command 无参数。

APIInquiryCentralEnableState Command(中枢使能状态查询)​

Central函数启用状态查询请求。集线器向云端查询其自身"中央集线器功能"的当前启用状态(开启或关闭) ,以进行状态同步或界面显示。

该 Command 无参数。

APIHubPassthroughDataUp Command(网关透传数据上行)​

Hub 数据透传上行通道。Hub 通过该通用透传接口将所连接设备收到的原始数据包直接上报至云端或指定外部服务,不经业务层解析。

该 Command 无参数。

IftttCoordination(IFTTT功能协同)​

简介​

作为自动化规则协同中心,管理 IFTTT/本地自动化规则的同步、订阅与执行。

Function 标识​

Function IDCode名称
0x00F7IftttCoordinationIFTTT功能协同

Trait​

本 Function 不包含 Trait。

Command​

Command IDCode名称Conformance
0x9D12APIEnableAutomation自动化使能O
0x9D13APIEnableIftttIFTTT使能O
0x9D14APIDownloadIftttLocalIFTTT本地化同步O
0x9D15APIDeleteIftttLocalIFTTT本地化删除O
0x9D16APIPushCentralAutomation中枢自动化下发O
0x9D17APIDeleteCentralAutomation中枢自动化删除O
0x9D18APIEnableCentralAutomation中枢自动化使能O
0x9D19APIPublishResourceChange资源变更发布O
0x9D1AAPIQueryHolidayList节假日列表查询O
0x9D1BAPICheckLocalIftttSync本地自动化信息一致性校验O
0x9D1CAPISubscribeIftttResChangeIFTTT资源变更订阅O
0x9D1DAPIUnsubscribeIftttResChangeIFTTT资源变更取消订阅O
0x9D1EAPIRunCloudAction云端动作执行O
0x9D1FAPIQueryIftttResIFTTT资源查询O
0x9D20APIGetSunriseSunsetByLatLon经纬度日出日落时间获取O

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

Command IDNameConformance
0x9D12APIEnableAutomationO
0x9D13APIEnableIftttO
0x9D14APIDownloadIftttLocalO
0x9D15APIDeleteIftttLocalO
0x9D16APIPushCentralAutomationO
0x9D17APIDeleteCentralAutomationO
0x9D18APIEnableCentralAutomationO
0x9D19APIPublishResourceChangeO
0x9D1AAPIQueryHolidayListO
0x9D1BAPICheckLocalIftttSyncO
0x9D1CAPISubscribeIftttResChangeO
0x9D1DAPIUnsubscribeIftttResChangeO
0x9D1EAPIRunCloudActionO
0x9D1FAPIQueryIftttResO
0x9D20APIGetSunriseSunsetByLatLonO

APIEnableAutomation Command(自动化使能)​

本地自动化规则总开关控制命令。云端发送命令以全局启用或禁用网关上本地存储并执行的所有自动化规则(IFTTT 场景),使其暂时生效或失效。

该 Command 无参数。

APIEnableIfttt Command(IFTTT使能)​

云端向网关发送专用命令,控制其 IFTTT(If This Then That)自动化功能的整体启用状态。

该 Command 无参数。

APIDownloadIftttLocal Command(IFTTT本地化同步)​

云端将用户创建的 IFTTT 自动化规则同步至网关本地存储,使其可在本地(离线)条件下触发和执行。

该 Command 无参数。

APIDeleteIftttLocal Command(IFTTT本地化删除)​

云端命令网关从其本地存储中删除指定的 IFTTT 自动化规则。

该 Command 无参数。

APIPushCentralAutomation Command(中枢自动化下发)​

中央级自动化规则交付命令。云提供复杂的自动化规则配置,这些配置需要跨多个集线器进行协调,或由集线器将处理集中到充当中心集线器的集线器。

该 Command 无参数。

APIDeleteCentralAutomation Command(中枢自动化删除)​

中央级自动化规则删除命令。云命令充当中央枢纽的枢纽从其存储中删除指定的中央级自动化规则。

该 Command 无参数。

APIEnableCentralAutomation Command(中枢自动化使能)​

中央级自动化规则启用命令。云端控制中央集线器集线器是否启用存储在其中的中央级自动化规则。

该 Command 无参数。

APIPublishResourceChange Command(资源变更发布)​

资源变更事件发布命令。当云端某资源值发生变化时,主动向已订阅该资源的本地网关"发布"此变更事件,以触发其本地自动化规则。

该 Command 无参数。

APIQueryHolidayList Command(节假日列表查询)​

设备向云端查询指定年份和地区的节假日列表。

该 Command 无参数。

APICheckLocalIftttSync Command(本地自动化信息一致性校验)​

本地自动化规则信息同步校验请求。网关向云端上报本地存储的所有 IFTTT 自动化规则摘要信息,请求比对并接收差异,以保持云端与本地规则库一致。

该 Command 无参数。

APISubscribeIftttResChange Command(IFTTT资源变更订阅)​

本地自动化规则订阅云端资源变更请求。网关代表本地自动化规则订阅云端一个或多个资源的变更。当这些资源在云端发生变化时,云端将通知网关。

该 Command 无参数。

APIUnsubscribeIftttResChange Command(IFTTT资源变更取消订阅)​

本地自动化规则取消订阅云端资源变更请求。网关请求云端停止推送先前已订阅的特定资源的变更通知。

该 Command 无参数。

APIRunCloudAction Command(云端动作执行)​

本地自动化触发云端动作执行请求。当网关上本地自动化规则的条件满足时,通过该接口请求云端执行仅能在云端完成的动作(例如发送通知、调用互联网 API、更新云端数据库)。

该 Command 无参数。

APIQueryIftttRes Command(IFTTT资源查询)​

与自动化相关的资源值查询请求。在评估规则条件时,集线器的本地自动化引擎向云查询指定资源的当前值(例如,另一个家庭的设备状态、天气数据、用户模式)。

该 Command 无参数。

APIGetSunriseSunsetByLatLon Command(经纬度日出日落时间获取)​

基于经纬度的日出日落时间查询请求。设备根据其经纬度坐标向云端查询当日具体的日出和日落时间,以实现与自然光相关的智能自动化场景(如"日落时开灯")。

该 Command 无参数。

NetworkManagement(网络管理)​

简介​

作为设备网络连接与访问策略的核心控制模块,管理远程代理及访问地址。

Function 标识​

Function IDCode名称
0x00F8NetworkManagement网络管理

Trait​

Trait IDCode名称Conformance
0x4F4ERemoteProxyAccessEnable远程代理访问使能O
0x4F4FInternetAccessAddress互联网访问地址O
0x4F50LanAccessAddress局域网访问地址O
0x516ENetworkSpeedTestMode网速测试模式O
0x516FNetworkSpeedTestResult网络测速结果O
0x5170NetworkSpeedThreshold网速达标阈值O
0x5186NetworkProtocolSupport支持的网络协议O

Command​

本 Function 不包含 Command。

数据类型​

NetworkSpeedTestResultTraitPresentValueStructure Type​

该结构体定义 NetworkSpeedTestResult Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0UpThresholdfloatO上行速率,单位 Mbps(兆比特每秒)。
1DownThresholdfloatO下行速率,单位 Mbps(兆比特每秒)。
NetworkSpeedThresholdTraitPresentValueStructure Type​

该结构体定义 NetworkSpeedThreshold Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0UpThresholdfloatO上行速率阈值,单位 Mbps(兆比特每秒)。
1DownThresholdfloatO下行速率阈值,单位 Mbps(兆比特每秒)。

Trait 定义​

Trait IDNameConformance
0x4F4ERemoteProxyAccessEnableO
0x4F4FInternetAccessAddressO
0x4F50LanAccessAddressO
0x516ENetworkSpeedTestModeO
0x516FNetworkSpeedTestResultO
0x5170NetworkSpeedThresholdO
0x5186NetworkProtocolSupportO

RemoteProxyAccessEnable Trait(远程代理访问使能)​

远程代理访问启用开关。该属性用于启用或禁用设备通过互联网云端代理被远程访问的能力。启用后,授权用户可通过安全云端隧道远程控制设备;禁用后,设备仅可在局域网(LAN)内访问。

Trait IDCode
0x4F4ERemoteProxyAccessEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

InternetAccessAddress Trait(互联网访问地址)​

云服务平台为设备分配的公网访问地址(通常为域名或 NAT 映射地址)。远程管理服务凭此地址定位并连接该设备,反映设备在广域网(WAN)中的逻辑位置。

Trait IDCode
0x4F4FInternetAccessAddress
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

LanAccessAddress Trait(局域网访问地址)​

路由器在家庭局域网(LAN)中为设备分配的 IP 地址(通常通过 DHCP)。同一网络上的其他设备(如手机 App、电脑)凭此地址在本地以低时延发现并通信。

Trait IDCode
0x4F50LanAccessAddress
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

NetworkSpeedTestMode Trait(网速测试模式)​

配置或获取设备的网络测速模式状态。写入 1 使设备进入测速模式,写入 0 使设备退出测速模式。设备在测速完成后自动将状态重置为 0(空闲)。该 Trait 可读、可写、可上报。

Trait IDCode
0x516ENetworkSpeedTestMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

NetworkSpeedTestResult Trait(网络测速结果)​

表示设备网络测速完成后得到的实际网络速率,单位为 Mbps(兆比特每秒),包含下行速率和上行速率两个维度。该 Trait 为只读属性,由设备在测速完成后主动上报,供客户端展示或用于达标判断。

Trait IDCode
0x516FNetworkSpeedTestResult
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNetworkSpeedTestResultTraitPresentValueStructureRVO

NetworkSpeedThreshold Trait(网速达标阈值)​

用于判断设备网络速率是否达标的参考阈值,单位为 Mbps(兆比特每秒),包含下行速率阈值和上行速率阈值两个维度。当实测速率(由 NetworkSpeedTestResult 提供)达到或超过对应阈值时,判定为"达标";否则为"不达标"。

Trait IDCode
0x5170NetworkSpeedThreshold
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNetworkSpeedThresholdTraitPresentValueStructureRVO

NetworkProtocolSupport Trait(支持的网络协议)​

支持的网络协议。表示设备在正常工作状态下所支持的网络通信协议集合。该 Trait 采用位掩码(Bitmap)形式:bit0 = Wi-Fi,bit1 = Thread,bit2 = Ethernet,bit3 = Zigbee,bit4 = BLE,bit5 = Aqara RS485。多个协议可同时置位。

Trait IDCode
0x5186NetworkProtocolSupport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

Command 定义​

本 Function 不包含 Command。

ToiletCore(马桶核心功能)​

简介​

集成智能马桶最基础的物理状态感知与部件控制,包括着座、翻盖、冲水、座圈加热及夜灯。

Function 标识​

Function IDCode名称
0x00F9ToiletCore马桶核心功能

Trait​

Trait IDCode名称Conformance
0x4F66SeatHeatingLevel座圈加热O
0x4F65SeatState座圈状态O
0x4F64LidState座盖状态O
0x4F62SeatOccupancy着座离座状态O
0x8098OnOff开关状态O
0x508BDeodorization除臭O

Command​

Command IDCode名称Conformance
0x9D28FlushCommand马桶冲水O
0x9D27SeatCommand座圈状态切换O
0x9D26LidCommand座盖状态切换O

数据类型​

SeatHeatingLevelEnum8 Type​

该枚举定义 SeatHeatingLevel Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off关
0x0126C26deg C
0x0227C27deg C
0x0328C28deg C
0x0429C29deg C
0x0530C30deg C
0x0631C31deg C
0x0732C32deg C
0x0833C33deg C
0x0934C34deg C
0x0A35C35deg C
0x0B36C36deg C
0x0C37C37deg C
0x0D38C38deg C
0x0E39C39deg C
0x0F40C40deg C
FlushCommand Command Structure Type​

FlushCommand Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M冲水类型。
SeatCommand Command Structure Type​

SeatCommand Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M操作类型。
LidCommand Command Structure Type​

LidCommand Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M操作类型。

Trait 定义​

Trait IDNameConformance
0x4F66SeatHeatingLevelO
0x4F65SeatStateO
0x4F64LidStateO
0x4F62SeatOccupancyO
0x8098OnOffO
0x508BDeodorizationO

SeatHeatingLevel Trait(座圈加热)​

设置座圈加热等级,提供舒适的坐感。"Off" 等级表示关闭加热。

Trait IDCode
0x4F66SeatHeatingLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSeatHeatingLevelEnum80RVWO
0x0006Supported Valuelist[SeatHeatingLevelEnum8]RO
0x0007Default ValueSeatHeatingLevelEnum80RWO

SeatState Trait(座圈状态)​

控制马桶座圈的打开或关闭。打开座圈时,若马桶盖处于关闭状态,将先自动打开马桶盖。

Trait IDCode
0x4F65SeatState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

LidState Trait(座盖状态)​

表示马桶盖状态。盖关闭时,写入 1 缓慢打开;盖打开时,写入 0 缓慢关闭。

Trait IDCode
0x4F64LidState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SeatOccupancy Trait(着座离座状态)​

指示马桶座圈是否被占用。0 表示无人,1 表示有人。

Trait IDCode
0x4F62SeatOccupancy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO

OnOff Trait(开关状态)​

写入时开启或关闭摄像机设备。读取表示当前电源状态。取值:false = 关闭,true = 开启。

Trait IDCode
0x8098OnOff
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Deodorization Trait(除臭)​

控制智能马桶的除臭功能。值为 0 表示关闭,值为 1 表示开启。

Trait IDCode
0x508BDeodorization
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

Command IDNameConformance
0x9D28FlushCommandO
0x9D27SeatCommandO
0x9D26LidCommandO

FlushCommand Command​

执行冲水 Command。选项包括 Full Flush(固体污物)或 Half Flush(液体污物或特定场景)。执行该 Command 将中断正在进行的清洗或烘干流程。

参数​

FlushCommand Command Structure

SeatCommand Command​

向马桶发送控制命令,例如 "toggle",使座圈执行与当前状态相反的动作(开则关,关则开)。

参数​

SeatCommand Command Structure

LidCommand Command​

向马桶发送控制命令,例如 "toggle",使盖板执行与当前状态相反的动作(开则关,关则开)。

参数​

LidCommand Command Structure

ToiletDiagnostic(马桶诊断信息)​

简介​

监测智能马桶关键硬件子系统健康状态,主动上报温度、流量、风机等故障信息。

Function 标识​

Function IDCode名称
0x00FAToiletDiagnostic马桶诊断信息

Trait​

Trait IDCode名称Conformance
0x4F67SeatTempSensorFault坐圈温度传感器异常O
0x4F68PressureValveFault稳压阀异常O
0x4F69WaterHeaterVoltageFault水加热电压异常O
0x4F6AFlowSensorFault流量传感器异常O
0x4F6BOutletWaterTempSensorFault出水温度传感器异常O
0x4F6CInletWaterTempSensorFault进水温度传感器异常O
0x4F6DWaterTempSensorsConsistencyFault进出水温度传感器校验异常O
0x4F6EDryerFanFault烘干风机异常O

Command​

本 Function 不包含 Command。

数据类型​

SeatTempSensorFaultEnum8 Type​

该枚举定义 SeatTempSensorFault Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Overheat超温
0x02Fault异常
PressureValveFaultEnum8 Type​

该枚举定义 PressureValveFault Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Fault异常
WaterHeaterVoltageFaultEnum8 Type​

该枚举定义 WaterHeaterVoltageFault Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Fault异常
FlowSensorFaultEnum8 Type​

该枚举定义 FlowSensorFault Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Insufficient不足
0x02Excessive超出
OutletWaterTempSensorFaultEnum8 Type​

该枚举定义 OutletWaterTempSensorFault Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Overheat超温
0x02Fault异常
InletWaterTempSensorFaultEnum8 Type​

该枚举定义 InletWaterTempSensorFault Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Overheat超温
0x02Fault异常
WaterTempSensorsConsistencyFaultEnum8 Type​

该枚举定义 WaterTempSensorsConsistencyFault Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Fault异常
DryerFanFaultEnum8 Type​

该枚举定义 DryerFanFault Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Fault异常

Trait 定义​

Trait IDNameConformance
0x4F67SeatTempSensorFaultO
0x4F68PressureValveFaultO
0x4F69WaterHeaterVoltageFaultO
0x4F6AFlowSensorFaultO
0x4F6BOutletWaterTempSensorFaultO
0x4F6CInletWaterTempSensorFaultO
0x4F6DWaterTempSensorsConsistencyFaultO
0x4F6EDryerFanFaultO

SeatTempSensorFault Trait(坐圈温度传感器异常)​

上报座温传感器状态:Normal、Overheat 或 Sensor Fault。

Trait IDCode
0x4F67SeatTempSensorFault
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSeatTempSensorFaultEnum80VO
0x0006Supported Valuelist[SeatTempSensorFaultEnum8]RO

PressureValveFault Trait(稳压阀异常)​

上报压力阀故障,例如电磁阀或膜片异常。

Trait IDCode
0x4F68PressureValveFault
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePressureValveFaultEnum80VO
0x0006Supported Valuelist[PressureValveFaultEnum8]RO

WaterHeaterVoltageFault Trait(水加热电压异常)​

上报热水器电压异常,例如温控器或保险丝开路。

Trait IDCode
0x4F69WaterHeaterVoltageFault
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWaterHeaterVoltageFaultEnum80VO
0x0006Supported Valuelist[WaterHeaterVoltageFaultEnum8]RO

FlowSensorFault Trait(流量传感器异常)​

上报水流状态:Normal、Insufficient Flow 或 Excessive Flow(可能因压力阀故障)。

Trait IDCode
0x4F6AFlowSensorFault
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFlowSensorFaultEnum80VO
0x0006Supported Valuelist[FlowSensorFaultEnum8]RO

OutletWaterTempSensorFault Trait(出水温度传感器异常)​

上报出水口水温传感器状态:Normal、Overheat 或 Sensor Fault。

Trait IDCode
0x4F6BOutletWaterTempSensorFault
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueOutletWaterTempSensorFaultEnum80VO
0x0006Supported Valuelist[OutletWaterTempSensorFaultEnum8]RO

InletWaterTempSensorFault Trait(进水温度传感器异常)​

上报进水口水温传感器状态:Normal、Overheat 或 Sensor Fault。

Trait IDCode
0x4F6CInletWaterTempSensorFault
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueInletWaterTempSensorFaultEnum80VO
0x0006Supported Valuelist[InletWaterTempSensorFaultEnum8]RO

WaterTempSensorsConsistencyFault Trait(进出水温度传感器校验异常)​

上报进水口与出水口水温传感器之间的一致性校验状态:Normal 或 Consistency Fault。

Trait IDCode
0x4F6DWaterTempSensorsConsistencyFault
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWaterTempSensorsConsistencyFaultEnum80VO
0x0006Supported Valuelist[WaterTempSensorsConsistencyFaultEnum8]RO

DryerFanFault Trait(烘干风机异常)​

上报烘干风扇的运行状态:Normal 或 Fault(例如端子松动、开路或堵转)。

Trait IDCode
0x4F6EDryerFanFault
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDryerFanFaultEnum80VO
0x0006Supported Valuelist[DryerFanFaultEnum8]RO

Command 定义​

本 Function 不包含 Command。

ToiletHygiene(马桶卫生维护)​

简介​

维护设备自身清洁卫生,包括喷嘴清洁、泡沫盾、等离子杀菌及管路清洗。

Function 标识​

Function IDCode名称
0x00FBToiletHygiene马桶卫生维护

Trait​

Trait IDCode名称Conformance
0x4F61PlasmaSterilizeStatus等离子杀菌O

Command​

Command IDCode名称Conformance
0x9D23NozzleClean马桶喷嘴清洁O
0x9D24FoamShieldControl泡沫盾控制O
0x9D25CleanFoamSystemCommand发泡装置水路清洗O

数据类型​

NozzleClean Command Structure Type​

NozzleClean Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M清洁类型。
FoamShieldControl Command Structure Type​

FoamShieldControl Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M操作类型。
CleanFoamSystemCommand Command Structure Type​

CleanFoamSystemCommand Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M操作类型。

Trait 定义​

Trait IDNameConformance
0x4F61PlasmaSterilizeStatusO

PlasmaSterilizeStatus Trait(等离子杀菌)​

启动深度等离子杀菌流程。仅可在座圈无人且无其他活动进行时触发。

Trait IDCode
0x4F61PlasmaSterilizeStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

Command IDNameConformance
0x9D23NozzleCleanO
0x9D24FoamShieldControlO
0x9D25CleanFoamSystemCommandO

NozzleClean Command​

控制喷嘴自清洁行为:Auto Clean(自动清洁)、Manual Maintenance(仅伸出维护)或 Off(收回)。

参数​

NozzleClean Command Structure

FoamShieldControl Command​

手动控制泡沫盾的释放与停止。设置为"Start"开始释放泡沫;设置为"Stop"停止释放。

参数​

FoamShieldControl Command Structure

CleanFoamSystemCommand Command​

执行泡沫系统管路清洁周期,防止堵塞。

参数​

CleanFoamSystemCommand Command Structure

ToiletWashDry(马桶清洗烘干)​

简介​

定义智能马桶清洗与烘干全流程,涵盖水洗模式、水温/水压、烘干风速及时长设置。

Function 标识​

Function IDCode名称
0x00FCToiletWashDry马桶清洗烘干

Trait​

Trait IDCode名称Conformance
0x4F7CToiletWashingMode清洗模式O
0x4F7DToiletMassageMode按摩洗模式O
0x4F7EToiletWaterTemperature清洗水温O
0x4F7FToiletWaterPressureLevel清洗强度O
0x4F80NozzlePosition清洗位置O
0x4F81ToiletDryingStatus马桶烘干O
0x4F82FanSpeedLevel烘干风速档位O
0x4F83RinseDuration设置臀洗清洗时长O
0x4F84FeminineWashDuration设置妇洗清洗时长O
0x4F85DryingDuration设置烘干时长O

Command​

Command IDCode名称Conformance
0x9D29WashDryCombinationCommand马桶清洗烘干控制O

数据类型​

ToiletWashingModeEnum8 Type​

该枚举定义 ToiletWashingMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Rinse臀洗
0x02RinseMoving臀洗(移动)
0x03FeminineWash妇洗
0x04FeminineWashMoving妇洗(移动)
0x00Stop停止
0x05Enema通便
0x06ChildWash儿童洗
ToiletMassageModeEnum8 Type​

该枚举定义 ToiletMassageMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off关
0x01PressureMassage强弱按摩
0x02TemperatureMassage冷热按摩
ToiletWaterTemperatureEnum8 Type​

该枚举定义 ToiletWaterTemperature Trait 的 Present Value 有效取值。

ValueNameDescription
0x00RoomTemp常温
0x0126C26deg C
0x0227C27deg C
0x0328C28deg C
0x0429C29deg C
0x0530C30deg C
0x0631C31deg C
0x0732C32deg C
0x0833C33deg C
0x0934C34deg C
0x0A35C35deg C
0x0B36C36deg C
0x0C37C37deg C
0x0D38C38deg C
0x0E39C39deg C
0x0F40C40deg C
ToiletWaterPressureLevelEnum8 Type​

该枚举定义 ToiletWaterPressureLevel Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Gentle轻柔
0x01Standard标准
0x02Strong强劲
NozzlePositionEnum8 Type​

该枚举定义 NozzlePosition Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Rear后
0x01Rearward较后
0x02Middle中
0x03Forward较前
0x04Front前
ToiletDryingStatusEnum8 Type​

该枚举定义 ToiletDryingStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off关
0x01RoomTemp常温
0x02LowTemp低温
0x03MediumLowTemp中低温
0x04MediumTemp中温
0x05MediumHighTemp中高温
0x06HighTemp高温
0x07On开
FanSpeedLevelEnum8 Type​

该枚举定义 FanSpeedLevel Trait 的 Present Value 有效取值。

ValueNameDescription
0x00LowSpeed低速
0x01MediumSpeed中速
0x02HighSpeed高速
WashDryCombinationCommand Command Structure Type​

WashDryCombinationCommand Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M操作类型。

Trait 定义​

Trait IDNameConformance
0x4F7CToiletWashingModeO
0x4F7DToiletMassageModeO
0x4F7EToiletWaterTemperatureO
0x4F7FToiletWaterPressureLevelO
0x4F80NozzlePositionO
0x4F81ToiletDryingStatusO
0x4F82FanSpeedLevelO
0x4F83RinseDurationO
0x4F84FeminineWashDurationO
0x4F85DryingDurationO

ToiletWashingMode Trait(清洗模式)​

选择清洗功能模式,包括 Rinse Wash、Feminine Wash 及其移动模式。

Trait IDCode
0x4F7CToiletWashingMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueToiletWashingModeEnum80RVWO
0x0006Supported Valuelist[ToiletWashingModeEnum8]RO
0x0007Default Valueuint80RWO

ToiletMassageMode Trait(按摩洗模式)​

选择并启动/停止按摩清洗功能。模式包括 "Pressure Massage" 和 "Temperature Massage"。

Trait IDCode
0x4F7DToiletMassageMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueToiletMassageModeEnum80RVWO
0x0006Supported Valuelist[ToiletMassageModeEnum8]RO
0x0007Default ValueToiletMassageModeEnum80RWO

ToiletWaterTemperature Trait(清洗水温)​

设置清洗水温等级,从室温到多个加热档位。

Trait IDCode
0x4F7EToiletWaterTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueToiletWaterTemperatureEnum80RVWO
0x0006Supported Valuelist[ToiletWaterTemperatureEnum8]RO
0x0007Default ValueToiletWaterTemperatureEnum80RWO

ToiletWaterPressureLevel Trait(清洗强度)​

调节洗涤的水压,例如温和、标准和强度。

Trait IDCode
0x4F7FToiletWaterPressureLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueToiletWaterPressureLevelEnum80RVWO
0x0006Supported Valuelist[ToiletWaterPressureLevelEnum8]RO
0x0007Default ValueToiletWaterPressureLevelEnum80RWO

NozzlePosition Trait(清洗位置)​

调整洗涤喷嘴的前后位置,以适应不同的清洁区域。

Trait IDCode
0x4F80NozzlePosition
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNozzlePositionEnum80RVWO
0x0006Supported Valuelist[NozzlePositionEnum8]RO
0x0007Default ValueNozzlePositionEnum80RWO

ToiletDryingStatus Trait(马桶烘干)​

控制烘干功能的启停,并设置风温档位。

Trait IDCode
0x4F81ToiletDryingStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueToiletDryingStatusEnum80RVWO
0x0006Supported Valuelist[ToiletDryingStatusEnum8]RO
0x0007Default ValueToiletDryingStatusEnum80RWO

FanSpeedLevel Trait(烘干风速档位)​

设置烘干风速等级,可选 Low、Medium 和 High。

Trait IDCode
0x4F82FanSpeedLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFanSpeedLevelEnum80RVWO
0x0006Supported Valuelist[FanSpeedLevelEnum8]RO
0x0007Default ValueFanSpeedLevelEnum80RWO

RinseDuration Trait(设置臀洗清洗时长)​

设置 Posterior Wash 模式的持续时间。单位:S。

Trait IDCode
0x4F83RinseDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat180RVWO
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat60.0RO
0x0005Step Valuefloat30.0RO
0x0007Default Valuefloat180RWO

FeminineWashDuration Trait(设置妇洗清洗时长)​

设置 Feminine Wash 模式的持续时间。单位:S。

Trait IDCode
0x4F84FeminineWashDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat180RVWO
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat60.0RO
0x0005Step Valuefloat30.0RO
0x0007Default Valuefloat180RWO

DryingDuration Trait(设置烘干时长)​

设置烘干功能的持续时间。单位:S。

Trait IDCode
0x4F85DryingDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat180RVWO
0x0002Maximum Valuefloat600.0RO
0x0003Minimum Valuefloat60.0RO
0x0005Step Valuefloat60.0RO
0x0007Default Valuefloat180RWO

Command 定义​

Command IDNameConformance
0x9D29WashDryCombinationCommandO

WashDryCombinationCommand Command​

洗护烘干一体的一键控制。选择 "Wash Only" 或 "Wash and Dry" 启动对应流程;"Start" 仅启动烘干;"Stop" 停止任何进行中的洗涤或烘干活动。

参数​

WashDryCombinationCommand Command Structure

ToiletSettings(马桶参数设置)​

简介​

允许用户个性化默认参数与自动化场景,如自动翻盖、自动冲水、泡沫盾及久坐提醒等。

Function 标识​

Function IDCode名称
0x00FDToiletSettings马桶参数设置

Trait​

Trait IDCode名称Conformance
0x4F63AutoFoamDuration释放泡沫盾时长O
0x4F6FAutoFoamGlobalEnable自动释放泡沫盾使能O
0x4F70AutoFoamOnSit落座释放泡沫盾O
0x4F71AutoFoamAfterFlush离座释放泡沫盾O
0x4F72AutoFoamOnFootFlip脚感翻圈释放泡沫盾O
0x4F73SittingReminderThreshold设置久坐提醒触发时间O
0x4F74AutoLidEnable自动翻盖使能O
0x4F75AutoFlushEnable离座冲水使能O
0x4F76PostFlushCloseMode冲水自动合盖合圈O
0x4F77PostFlushCloseDelay冲水自动合盖合圈延时O
0x4F78FootSensorEnable脚部感应使能O
0x4F79PreWettingEnable落座预润壁O
0x4F7AAutoDeodorizerEnable落座自动除臭使能O
0x4F7BSittingReminderAlert久坐提醒上报O

Command​

本 Function 不包含 Command。

数据类型​

PostFlushCloseModeEnum8 Type​

该枚举定义 PostFlushCloseMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Disable关闭
0x01CloseLidAndSeat自动合盖合圈
0x02CloseSeatOnly仅自动合圈
SittingReminderAlertEnum8 Type​

该枚举定义 SittingReminderAlert Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01SittingReminder久坐提醒

Trait 定义​

Trait IDNameConformance
0x4F63AutoFoamDurationO
0x4F6FAutoFoamGlobalEnableO
0x4F70AutoFoamOnSitO
0x4F71AutoFoamAfterFlushO
0x4F72AutoFoamOnFootFlipO
0x4F73SittingReminderThresholdO
0x4F74AutoLidEnableO
0x4F75AutoFlushEnableO
0x4F76PostFlushCloseModeO
0x4F77PostFlushCloseDelayO
0x4F78FootSensorEnableO
0x4F79PreWettingEnableO
0x4F7AAutoDeodorizerEnableO
0x4F7BSittingReminderAlertO

AutoFoamDuration Trait(释放泡沫盾时长)​

设置自动泡沫释放持续时间,适用于就座后、脚感翻座后、冲水后等场景。单位:S。

Trait IDCode
0x4F63AutoFoamDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat10RVWO
0x0002Maximum Valuefloat30.0RO
0x0003Minimum Valuefloat5.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat10RWO

AutoFoamGlobalEnable Trait(自动释放泡沫盾使能)​

启用或禁用全场景自动泡沫盾功能。

Trait IDCode
0x4F6FAutoFoamGlobalEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AutoFoamOnSit Trait(落座释放泡沫盾)​

启用或禁用就座时的自动泡沫释放。

Trait IDCode
0x4F70AutoFoamOnSit
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AutoFoamAfterFlush Trait(离座释放泡沫盾)​

启用或禁用冲水后自动补充泡沫。

Trait IDCode
0x4F71AutoFoamAfterFlush
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AutoFoamOnFootFlip Trait(脚感翻圈释放泡沫盾)​

启用或禁用脚感翻圈触发的自动泡沫释放(防溅)。

Trait IDCode
0x4F72AutoFoamOnFootFlip
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SittingReminderThreshold Trait(设置久坐提醒触发时间)​

设置触发久坐提醒的时间阈值。单位:S。

Trait IDCode
0x4F73SittingReminderThreshold
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1200RVWO
0x0002Maximum Valuefloat3600.0RO
0x0003Minimum Valuefloat600.0RO
0x0005Step Valuefloat60.0RO
0x0007Default Valuefloat1200RWO

AutoLidEnable Trait(自动翻盖使能)​

启用或禁用人接近时的自动开盖功能。默认禁用。

Trait IDCode
0x4F74AutoLidEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AutoFlushEnable Trait(离座冲水使能)​

启用或禁用根据用户离座后就座时长自动冲水(Full 或 Half)。

Trait IDCode
0x4F75AutoFlushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

PostFlushCloseMode Trait(冲水自动合盖合圈)​

设置冲水后自动关闭策略:Disabled、Close Lid and Seat 或 Close Seat Only。

Trait IDCode
0x4F76PostFlushCloseMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePostFlushCloseModeEnum80RVWO
0x0006Supported Valuelist[PostFlushCloseModeEnum8]RO
0x0007Default ValuePostFlushCloseModeEnum80RWO

PostFlushCloseDelay Trait(冲水自动合盖合圈延时)​

设置冲水后执行自动关盖/关座圈动作前的延迟秒数。

Trait IDCode
0x4F77PostFlushCloseDelay
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat15RVWO
0x0002Maximum Valuefloat30.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat3.0RO
0x0007Default Valuefloat15RWO

FootSensorEnable Trait(脚部感应使能)​

启用或禁用所有脚感功能(开盖、翻圈、冲水)。

Trait IDCode
0x4F78FootSensorEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

PreWettingEnable Trait(落座预润壁)​

启用或禁用就座时自动预润马桶内壁以增强冲水效果。

Trait IDCode
0x4F79PreWettingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AutoDeodorizerEnable Trait(落座自动除臭使能)​

启用或禁用就座时的自动除臭功能。

Trait IDCode
0x4F7AAutoDeodorizerEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

SittingReminderAlert Trait(久坐提醒上报)​

当实际久坐时长超过设定阈值时,上报 "sitting reminder" 事件。

Trait IDCode
0x4F7BSittingReminderAlert
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSittingReminderAlertEnum80VO
0x0006Supported Valuelist[SittingReminderAlertEnum8]RO

Command 定义​

本 Function 不包含 Command。

Lighting(调光功能)​

简介​

本 Function 提供对灯光动态效果的激活与控制能力。服务端提供可由不同来源驱动的效果列表,客户端可从中选择并触发。

动态灯效既可用于支持 Color Control Function 的灯具,也可用于仅支持 Level Control Function 的灯具(例如可调光灯)。

效果的具体实现属于厂商自定义范围。不同厂商设备即使使用相同 EffectID,也不保证表示同一种效果;同一厂商可在不同设备复用同一 EffectID 以表达一致实现。

Function 标识​

Function IDCode名称
0x00FELighting调光功能

Trait​

Trait IDCodeConformance
0x4F8AEffectInfoM
0x5062EffectOperationStateO
0x5032LightTypeO
0x4F9CMaxEffectNameLengthO
0x4F9BUserDefinedEffectsO
0x4F89MaxUserDefinedEffectsO
0x4F88CurrentEffectIDO
0x4F87BuiltInEffectsO
0x503FFlowModeColorListO
0x503EFlowModeSensitivityO
0x503DEnableFlowModeO
0x5033LedGridMaskO
0x5242SupportedLedGridMaskO
0x5034FlowModeO
0x5036ShortcutEffectsO
0x5035InstallationConfigurationO
0x4FAELightStripModelO
0x5177WireReversedO
0x4F33ChildEndpointListO
0x4FADSupportedSegmentPatternsO
0x4FACSupportedDynamicEffectIdsO
0x519DSupportedNaturalEffectIdsO
0x4FABSupportedActionTypesO
0x523ALightModeO
0x523BColorTemperaturePresetO
0x523CColorTemperatureLevelO

Command​

Command IDCodeConformance
0x9D39EnterConfigurationModeO
0x9D31PreviewTransitionO
0x9D30StopPreviewO
0x9D2FPreviewEffectO
0x9D2ERemoveUserDefinedEffectO
0x9D2DUpdateUserDefinedEffectO
0x9D2CAddUserDefinedEffectO
0x9D2BGetEffectDataO
0x9D2AStartEffectO
0x9D63RemoveUserDefinedEffectsO

数据类型​

EffectInfoTraitPresentValueStructure Type​

该结构体定义 EffectInfo Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EffectIDuint8M效果 ID。0x00-0x7F 表示内置效果,0x80-0xFE 表示用户自定义效果。
1EffectDatacharacterStringM效果数据。承载动态灯效原始编码,格式应与新增/更新/预览命令一致。
2EffectNamecharacterStringM效果名称。客户端展示名,长度应满足 MaxEffectNameLength 约束。
EffectOperationStateEnum8 Type​

该枚举定义 EffectOperationState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Idle空闲
0x01Executing执行中
0x02Previewing预览中
LightTypeEnum8 Type​

该枚举定义 LightType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00GenericLight通用灯
0x01CeilingLight吸顶灯
0x02Bulb灯泡
0x03EavesLight檐口灯
0x04FloorLamp落地灯
0x05StringLight灯串
0x06DimmingDriver调光驱动
0x07LightStrip灯带
0x08TrackLight轨道灯
0x09PendantLight吊灯
ActionTypeEnum8 Type​

该枚举定义 EffectData 中 ActionType 字段的有效取值,并由 SupportedActionTypes Trait 用于声明设备支持的效果数据模式。

ValueNameDescription
0x00StaticEffect静态场景
0x01DynamicEffect使用 DynamicEffectId 的动态场景
0x02SequenceEffect使用 StepList 的序列场景
0x03SegmentStaticEffect使用 SegmentPattern 的分段静态场景
0x04SegmentDynamicEffect分段动态场景
0x05NaturalAtmosphereEffect使用 NaturalEffectId 的自然氛围场景
NaturalEffectIdEnum8 Type​

该枚举定义 ActionType 为 NaturalAtmosphereEffect 时使用的自然氛围效果 ID。

ValueNameDescription
0x00NearThunder近雷
0x01DistantThunder远雷
0x02Meteor流星
0x03Firefly萤火虫
0x04BlueSkyWhiteClouds蓝天白云
0x05Overcast阴天
UserDefinedEffectsTraitPresentValueStructure Type​

该结构体定义 UserDefinedEffects Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EffectIDuint8M用户自定义效果 ID,取值范围为 0x80-0xFE。
1EffectNamecharacterStringM用户设置的效果名称,UTF-8 字节长度不得超过 MaxEffectNameLength。
BuiltInEffectsTraitPresentValueStructure Type​

该结构体定义 BuiltInEffects Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EffectIDuint8M内置效果 ID,取值范围为 0x00-0x7F。
1BuiltInEffectLabelIDenum8M内置效果标签 ID,用于标识该预设效果的人类可读语义。
FlowModeColorListTraitPresentValueStructure Type​

该结构体定义 FlowModeColorList Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Xuint16MCIE 1931 xy 色度坐标中的 X 分量。
1Yuint16MCIE 1931 xy 色度坐标中的 Y 分量。
FlowModeEnum8 Type​

该枚举定义 FlowMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Stretch伸缩
0x02Pulse脉冲
0x03Running跑动
0x04Blink闪烁
InstallationConfigurationTraitPresentValueStructure Type​

该结构体定义 InstallationConfiguration Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0EavesWhiteLightCountuint8EavesLight檐灯白光单元数量。仅 LightType 为 EavesLight 时有效;未配置时为255。
1EavesBlueLightCountuint8EavesLight檐灯蓝光单元数量。仅 LightType 为 EavesLight 时有效;未配置时为255。
2StringLightLengthSelectionuint8StringLight灯串长度档位。仅 LightType 为 StringLight 时有效;未配置时为255。
3LightStripTrimSegmentCountuint8LightStrip灯带裁剪段数。仅 LightType 为 LightStrip 时有效;未配置时为255。
LightStripModelEnum8 Type​

该枚举定义 LightStripModel Trait 的 Present Value 有效取值。

ValueNameDescription
0x01DCLBDD01LMDCLBDD01LM
EnterConfigurationMode Command Structure Type​

EnterConfigurationMode Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Stageuint8M配置阶段号。0 表示退出配置模式,1/2 表示前两个阶段,3-255 表示后续阶段。
PreviewTransition Command Structure Type​

PreviewTransition Command 的参数结构体。

结构体成员序号字段名类型必须说明
0OnTransitionTimeuint16M开灯过渡时间,单位为 100 毫秒。示例:10 表示 1 秒。
1OffTransitionTimeuint16M关灯过渡时间,单位为 100 毫秒。示例:10 表示 1 秒。
2DimmingCurvaturefloatM预览使用的调光曲线幂值。值越大,低亮区停留越久。
3InitialBrightnessuint8M预览使用的初始亮度百分比,取值范围与 InitialBrightness Trait 约束一致。
PreviewEffect Command Structure Type​

PreviewEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectDatacharacterStringM待预览的原始效果数据,编码格式与新增/更新用户自定义效果时一致。
RemoveUserDefinedEffect Command Structure Type​

RemoveUserDefinedEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDuint8M待删除的效果 ID。应为已存在的 UserDefined 效果(通常范围 0x80-0xFE)。
UpdateUserDefinedEffect Command Structure Type​

UpdateUserDefinedEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDuint8M待更新的效果 ID。应为已存在的 UserDefined 效果。
1EffectDatacharacterStringM更新后的原始效果数据,编码格式应与 Lighting EffectData 规范一致。
AddUserDefinedEffect Command Structure Type​

AddUserDefinedEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectNamecharacterStringM新增效果名称,UTF-8 字节长度不得超过 MaxEffectNameLength。
1EffectDatacharacterStringM新增效果的原始数据,编码格式应符合 Lighting EffectData 规范。
GetEffectData Command Structure Type​

GetEffectData Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDuint8M待读取效果数据的效果 ID,应存在于 BuiltIn 或 UserDefined 列表中。
StartEffect Command Structure Type​

StartEffect Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDenum8M待启动效果的效果 ID。应为设备已支持或已保存的有效 EffectID。
RemoveUserDefinedEffects Command Structure Type​

RemoveUserDefinedEffects Command 的参数结构体。

结构体成员序号字段名类型必须说明
0EffectIDslist[Struct]M待批量删除的效果 ID 列表。每项应为已存在的 UserDefined 效果 ID。

Trait 定义​

Trait IDNameConformance
0x4F8AEffectInfoM
0x5062EffectOperationStateO
0x5032LightTypeO
0x4F9CMaxEffectNameLengthO
0x4F9BUserDefinedEffectsO
0x4F89MaxUserDefinedEffectsO
0x4F88CurrentEffectIDO
0x4F87BuiltInEffectsO
0x503FFlowModeColorListO
0x503EFlowModeSensitivityO
0x503DEnableFlowModeO
0x5033LedGridMaskO
0x5242SupportedLedGridMaskO
0x5034FlowModeO
0x5036ShortcutEffectsO
0x5035InstallationConfigurationO
0x4FAELightStripModelO
0x5177WireReversedO
0x4F33ChildEndpointListO
0x4FADSupportedSegmentPatternsO
0x4FACSupportedDynamicEffectIdsO
0x519DSupportedNaturalEffectIdsO
0x4FABSupportedActionTypesO
0x523ALightModeO
0x523BColorTemperaturePresetO
0x523CColorTemperatureLevelO
LightModeEnum8 Type​

该枚举定义普通照明的工作模式。

ValueNameDescription
0x00Auto自动
0x01Normal普通
0x02Night夜灯
0x03Color彩光
0x04ColorTemperature色温
ColorTemperaturePresetEnum8 Type​

该枚举定义照明设备提供的离散色温类别;它不代表 Kelvin 色温数值。

ValueNameDescription
0x00Incandescent白炽灯
0x01White白色
0x02DaylightWhite日光白
0x03Daylight日光色
0x04Other其他

EffectInfo Trait​

该 Trait 提供效果信息列表,每项包含 EffectID、EffectData 与 EffectName,用于维护、展示与同步效果详情。

此 Trait 由云端维护,设备不上报。

EffectData 的编码应与效果写入/预览命令保持一致,以便客户端在读取后可直接展示、备份或复用。

EffectData 的二进制封装、CBOR 负载格式、字段定义、ActionType 编码及示例见 EffectData 编码规范。

Trait IDCode
0x4F8AEffectInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[EffectInfoTraitPresentValueStructure]RVM

EffectOperationState Trait​

该 Trait 指示设备当前效果操作状态,典型状态包括空闲、执行中与预览中。

客户端可据此判断是否存在可停止的预览、是否处于效果执行流程中,以及是否需要延后发送新的效果控制命令。

Trait IDCode
0x5062EffectOperationState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueEffectOperationStateEnum80RVO
0x0006Supported Valuelist[EffectOperationStateEnum8]RO

LightType Trait​

该 Trait 指示灯具物理形态或安装类型,客户端可据此判断设备所属产品形态与可用能力。

安装配置等复合参数的有效字段范围依赖该 Trait 的取值。

Trait IDCode
0x5032LightType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLightTypeEnum80RVO
0x0006Supported Valuelist[LightTypeEnum8]RO

WireReversed Trait​

该 Trait 表示防反接配置,用于指示两个输出通道之间的逻辑映射是否交换。

该 Trait 适用于具有两个输出通道的灯具。典型示例为双色温 PWM 灯,其中两个通道分别对应暖白和冷白。如果安装时暖白与冷白线反接,控制冷色温可能会导致灯具呈现暖色。在这种情况下,客户端可将该 Trait 设置为 true,使服务端交换两个通道输出,从而无需重新接线即可让灯具按预期发光。

当该 Trait 为 false 时,服务端应使用产品默认的两个输出通道映射,不进行反接校正。

当该 Trait 为 true 时,服务端应交换两个输出通道映射,将当前安装视为反接状态处理。

Trait IDCode
0x5177WireReversed
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

ChildEndpointList Trait​

该 Trait 指示与当前集群实例关联的端点列表。

该 Trait 应为非空列表。

当当前集群实例拥有其他端点的效果能力时,该 Trait 应列出这些端点。

当当前集群实例表示某个灯具的效果能力时,该 Trait 应包含该集群实例所在的端点,并可包含该灯具所代表的其他端点。

Trait IDCode
0x4F33ChildEndpointList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistallRVO

MaxEffectNameLength Trait​

该 Trait 指示用户自定义效果名称(EffectName)允许的 UTF-8 最大字节长度。

该值在单设备上固定,范围为 1-32。客户端写入名称时不应超过该上限。

Trait IDCode
0x4F9CMaxEffectNameLength
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81RVO
0x0002Maximum Valueuint832RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO

UserDefinedEffects Trait​

该 Trait 包含设备当前存储的全部用户自定义效果列表。每项包含 EffectID(0x80-0xFE)与 EffectName。

空列表表示当前没有用户自定义效果;为空值(Null)表示该信息当前不可用(例如设备初始化中或数据暂不可读取)。

Trait IDCode
0x4F9BUserDefinedEffects
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[UserDefinedEffectsTraitPresentValueStructure]RVO

MaxUserDefinedEffects Trait​

该 Trait 指示设备可支持的用户自定义效果最大数量。

当效果数量达到上限时,新增用户自定义效果操作应返回容量相关错误。

Trait IDCode
0x4F89MaxUserDefinedEffects
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81RVO
0x0002Maximum Valueuint832RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO

CurrentEffectID Trait​

该 Trait 指示当前激活效果的 EffectID;为空时表示当前没有激活效果。

该值可用于界面高亮当前生效效果,并作为后续查询、切换或停止逻辑的上下文。

Trait IDCode
0x4F88CurrentEffectID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x000DIs NullbooleanFalseRVO

BuiltInEffects Trait​

该 Trait 包含设备支持的全部内置效果列表。每项包含 EffectID(0x00-0x7F)与 BuiltInEffectLabelID。

空列表表示当前无内置效果;为空值(Null)表示该信息当前不可用。

Trait IDCode
0x4F87BuiltInEffects
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[BuiltInEffectsTraitPresentValueStructure]RVO
0x000DIs NullbooleanFalseRVO

FlowModeColorList Trait​

该 Trait 包含 Flow Mode 的有序颜色列表,每项为 CIE 1931 xy 色度点;列表长度不得超过 MaxFlowModeColors。

客户端配置该列表时,应保证顺序与数量满足约束,以获得可预测的律动配色表现。

Trait IDCode
0x503FFlowModeColorList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[FlowModeColorListTraitPresentValueStructure]RVWO

FlowModeSensitivity Trait​

该 Trait 指示 Flow Mode 使用的灵敏度百分比。

灵敏度越高,设备对输入变化(如音乐节奏)响应通常越敏捷。

Trait IDCode
0x503EFlowModeSensitivity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80RVWO
0x0002Maximum Valueuint8100RO
0x0003Minimum Valueuint80RO
0x0007Default Valueuint80RWO

EnableFlowMode Trait​

该 Trait 指示设备当前是否启用 Flow Mode。

客户端可通过该 Trait 进行显式开关控制,并与 FlowMode、FlowModeColorList、FlowModeSensitivity 组合配置。

Trait IDCode
0x503DEnableFlowMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanO0RVWO
0x0007Default ValuebooleanO0RWO

LedGridMask Trait​

该 Trait 指示并允许客户端通过掩码控制设备上各可配置 LED 网格单元的启用状态。位 1 表示对应网格单元已启用(参与效果渲染),位 0 表示对应网格单元已禁用(不参与效果渲染)。客户端可修改的位由 SupportedLedGridMask Trait 定义;尝试修改 SupportedLedGridMask 中值为 0 的位时,设备必须拒绝写入并保持该属性原值。

Trait IDCode
0x5033LedGridMask
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

SupportedLedGridMask Trait​

该 Trait 指示客户端可通过 LedGridEnableMask 配置设备上的哪些 LED 网格单元,掩码格式遵循 LedGridMask Type。位 1 表示对应网格单元实际存在于设备上,且开放给客户端配置;位 0 表示对应位置不可配置,原因可能是设备没有该物理网格单元,或服务端未开放该单元供客户端控制。该 Trait 描述固定的硬件或产品能力,在设备生命周期内不得改变。

Present Value 使用字符串承载该掩码;字符串编码应与设备采用的 LedGridMask 表示一致。

Trait IDCode
0x5242SupportedLedGridMask
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

FlowMode Trait​

该 Trait 指示当前配置的 Flow Mode 效果引擎。

客户端可结合 Supported Value 选择当前设备支持的律动效果类型。

Trait IDCode
0x5034FlowMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFlowModeEnum81RVWO
0x0006Supported Valuelist[FlowModeEnum8]RO
0x0007Default ValueFlowModeEnum81RWO

ShortcutEffects Trait​

该 Trait 包含快捷按键使用的 EffectID 有序列表,用于定义快捷按键的效果切换序列。

设备每次收到一次快捷按键触发时,应切换到该列表中的下一个 EffectID;当到达最后一项后,下一次触发应回绕到第一项。

列表中每一项均为 uint8 EffectID,且应引用已存在于 BuiltInEffects 或 UserDefinedEffects 中的效果。

列表项可混合内置 EffectID(0x00-0x7F)与用户自定义 EffectID(0x80-0xFE),且列表项数量不得超过 MaxShortcutEffects 约束值。

空列表(长度为 0)表示快捷按键禁用;在该状态下,按键不应通过本机制触发效果切换。

当客户端写入该 Trait 时,服务端应逐项校验每个 EffectID 是否存在于 BuiltInEffects 或 UserDefinedEffects;若存在无效项,应拒绝写入并返回相应错误。

Trait IDCode
0x5036ShortcutEffects
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVWO

InstallationConfiguration Trait​

该 Trait 指示当前安装(产品布局)配置;有效字段依 LightType 不同而变化。

例如檐灯场景使用白/蓝灯数量字段,灯串使用长度选择字段,灯带使用裁剪段数字段。不适用字段应为空;写入不匹配 LightType 的字段时,设备可返回 InvalidConfiguration。

Trait IDCode
0x5035InstallationConfiguration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueInstallationConfigurationTraitPresentValueStructureRVWO

LightStripModel Trait​

该 Trait 指示当前配置的灯带型号;仅在 LightType 为 LightStrip 时有意义。

为空值(Null)表示未设置灯带型号。非空时应属于 Supported Value 列表。

Trait IDCode
0x4FAELightStripModel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLightStripModelEnum81RVWO
0x0006Supported Valuelist[LightStripModelEnum8]RO
0x0007Default ValueLightStripModelEnum81RWO
0x000DIs NullbooleanFalseRVO

SupportedSegmentPatterns Trait​

该 Trait 指示服务器在 SegmentStaticEffect 场景下支持的分段模式列表。

若设备不支持 SegmentStaticEffect,或虽支持但未提供可用分段模式,则该列表应为空。

Trait IDCode
0x4FADSupportedSegmentPatterns
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

SupportedDynamicEffectIds Trait​

该 Trait 指示服务器在 DynamicEffect/SegmentDynamicEffect 下支持的动态效果 ID 列表。

若设备不支持上述动态模式,或支持模式但不支持任何 DynamicEffectId,则该列表应为空。

Trait IDCode
0x4FACSupportedDynamicEffectIds
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVO

SupportedNaturalEffectIds Trait​

该 Trait 指示服务器在 NaturalAtmosphereEffect 场景下支持的自然氛围效果 ID 列表。

客户端可在发送 AddUserDefinedEffect、UpdateUserDefinedEffect、PreviewEffect 前,使用该列表确定设备支持的 NaturalEffectId。若设备不支持 NaturalAtmosphereEffect,或不支持任何自然氛围效果 ID,则该列表应为空。

Trait IDCode
0x519DSupportedNaturalEffectIds
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[NaturalEffectIdEnum8]RVO

SupportedActionTypes Trait​

该 Trait 指示服务器在 EffectData 中支持的 ActionType 列表。

客户端可在发送 AddUserDefinedEffect、UpdateUserDefinedEffect、PreviewEffect 前,依据该列表约束可选编辑模式。

Trait IDCode
0x4FABSupportedActionTypes
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[ActionTypeEnum8]RVO

LightMode Trait​

照明模式表示灯具当前选择的工作模式,用于区分自动、普通、夜灯、彩光及色温模式。

Trait IDCode
0x523ALightMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLightModeEnum80-4无固定默认值RVWO

ColorTemperaturePreset Trait​

离散色温类别表示设备提供的白光颜色预设,与以 mired 或 Kelvin 表示的连续色温值分开建模。

Trait IDCode
0x523BColorTemperaturePreset
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueColorTemperaturePresetEnum80-4无固定默认值RVWO

ColorTemperatureLevel Trait​

色温等级表示设备定义的离散色温调节级别,范围 0-20;其数值不代表 Kelvin 或 mired。

Trait IDCode
0x523CColorTemperatureLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint80-20无固定默认值;由设备报告RVWO
0x0002Maximum Valueuint820RO
0x0003Minimum Valueuint80RO
0x0005Step Valueuint81RO

Command 定义​

Command IDNameConformance
0x9D39EnterConfigurationModeO
0x9D31PreviewTransitionO
0x9D30StopPreviewO
0x9D2FPreviewEffectO
0x9D2ERemoveUserDefinedEffectO
0x9D2DUpdateUserDefinedEffectO
0x9D2CAddUserDefinedEffectO
0x9D2BGetEffectDataO
0x9D2AStartEffectO
0x9D63RemoveUserDefinedEffectsO

EnterConfigurationMode Command​

该命令用于请求设备进入通用配置模式阶段;Stage=0 表示结束配置模式。

Stage=1 表示第一阶段,Stage=2 表示第二阶段,Stage=3-255 表示后续阶段。各阶段行为与超时策略由设备实现定义。

参数​

EnterConfigurationMode Command Structure

PreviewTransition Command​

该命令应请求设备使用所提供参数预览过渡效果。用户可在提交前查看灯光在指定时序与曲线设置下的开关过渡表现。

该命令用于预演 On/Off 过渡时间、调光曲线与初始亮度对视觉效果的综合影响。

参数​

PreviewTransition Command Structure

StopPreview Command​

该命令应请求设备停止当前运行的效果预览并恢复正常灯光运行。

若当前不存在预览效果,设备可返回"无活动效果预览"语义的状态码。

该 Command 无参数。

PreviewEffect Command​

该命令应请求设备使用提供的 EffectData 预览效果而不保存。用户可在添加或更新用户自定义效果前预览该效果。

EffectData 编码应与新增/更新用户自定义效果命令保持一致。

参数​

PreviewEffect Command Structure

RemoveUserDefinedEffect Command​

该命令应请求设备移除现有的用户自定义效果。仅 UserDefined 类型效果可移除,BuiltIn 效果不可移除。

若指定 EffectID 不存在或并非 UserDefined,设备应返回对应错误状态。

参数​

RemoveUserDefinedEffect Command Structure

UpdateUserDefinedEffect Command​

该命令应请求设备更新现有的用户自定义效果。仅 UserDefined 类型效果可更新。

更新请求可包含效果名称、效果数据或两者同时更新。

参数​

UpdateUserDefinedEffect Command Structure

AddUserDefinedEffect Command​

该命令应请求设备新增用户自定义效果;新效果的 EffectID 由设备分配。

当用户自定义效果数量达到上限时,设备应返回容量已满语义的状态码。

参数​

AddUserDefinedEffect Command Structure

GetEffectData Command​

该命令应请求设备返回指定 EffectID 的效果数据。客户端可用于读取已存储的效果数据(如显示、备份或编辑)。

当查询成功时,返回的 EffectData 应与写入该效果时所用编码一致。

参数​

GetEffectData Command Structure

StartEffect Command​

该命令应请求设备启动指定的灯光效果。

目标 EffectID 应存在于 BuiltInEffects 或 UserDefinedEffects 列表中。

参数​

StartEffect Command Structure

RemoveUserDefinedEffects Command​

该命令应请求设备批量移除用户自定义效果;仅 UserDefined 类型效果可移除。

设备可逐项返回每个 EffectID 的处理结果,或按实现定义返回整体错误。

参数​

RemoveUserDefinedEffects Command Structure

EffectData 编码规范​

本节定义灯光效果数据 EffectData 的二进制封装、CBOR 负载结构、字段编码方式及编码示例。EffectData 由 Header 和 Payload 组成:Header 至少包含协议标识/版本与标志位;Payload 使用 CBOR 描述灯光效果。单通道效果的 CBOR 顶层为 Map,多通道效果的顶层为 Map 数组。

总体格式​

EffectData 二进制数据由以下部分依次组成:

  • Header:至少 2 字节,包含协议标识、版本和控制标志。
  • Payload:CBOR 编码的灯光效果数据。单通道效果使用一个 CBOR Map;多通道效果使用 CBOR Map 数组。
+------------------+-------+---------------+--------+---------+
| ProtocolVersion | Flags | PayloadLength | CRC16 | Payload |
| (1 byte) |(1 byte)| (opt 2B) |(opt 2B)| (CBOR) |
+------------------+-------+---------------+--------+---------+
必须 必须 可选 可选 必须
Header 结构​
字节 0:ProtocolVersion​

ProtocolVersion 将 ProtocolID 与 Version 编码在同一个字节中:高 2 位表示版本,低 6 位表示协议标识。

  7   6   5   4   3   2   1   0
+-------+---------------------------+
|Version| ProtocolID |
| 2 bit | 6 bit |
+-------+---------------------------+

ProtocolVersion 位布局

位名称范围说明
bit 0-5ProtocolID0-63协议标识;0x01 表示 LightingEffect。
bit 6-7Version0-3协议版本号。

编码:ProtocolVersion = (Version &lt;&lt; 6) | ProtocolID

解码:ProtocolID = ProtocolVersion & 0x3F,Version = (ProtocolVersion &gt;&gt; 6) & 0x03

字节 1:Flags​

Flags 控制可选 Header 字段及 Payload 属性是否存在。

  7   6   5   4   3   2   1   0
+-------+-------+---+---+---+---+
|Reserved|Format|Cmp|Enc|CRC|Len|
| 2 bit | 2 bit | 1 | 1 | 1 | 1 |
+-------+-------+---+---+---+---+

Flags 位布局

位名称说明
bit 0HasPayloadLength为 1 时存在 2 字节的 PayloadLength 字段。
bit 1HasCRC为 1 时存在 2 字节 CRC16 字段;要求 HasPayloadLength = 1。
bit 2Encrypted保留位,必须为 0。
bit 3Compressed保留位,必须为 0。
bit 4-5PayloadFormat0x00 表示 CBOR(默认);其他值保留。
bit 6-7Reserved保留位,必须为 0。

常见 Flags 值:

FlagsHeader 长度包含字段
0x002 字节仅 ProtocolVersion 和 Flags
0x014 字节ProtocolVersion、Flags 和 PayloadLength
0x036 字节ProtocolVersion、Flags、PayloadLength 和 CRC16
备注

Flags = 0x02(存在 CRC、但不存在 PayloadLength)为无效配置,因为计算 CRC 前必须确定 Payload 的边界。

可选 Header 字段​
  • PayloadLength(2 字节,大端序):当 Flags.bit0 = 1 时存在,表示 Payload 的字节长度。
  • CRC16(2 字节,大端序):当 Flags.bit1 = 1 时存在。使用 CRC-16/MODBUS,仅对 Payload 计算 CRC,不包含 Header。
Payload 结构(CBOR)​

Payload 使用 CBOR(RFC 8949)编码,Map 的键为无符号整数。键 0-23 可使用单字节 CBOR 编码,以减少负载开销。

单通道与多通道 Payload​

Payload 结构向后兼容。客户端和服务器必须按以下方式判定其结构:

  • CBOR 顶层项为 Map 时,表示单通道(旧版)EffectData,不包含 Channel 键。
  • CBOR 顶层项为 Array 时,表示多通道 EffectData;数组中的每个元素都是 Map,且必须包含 Channel 键。

服务器也可以通过检查通道 Map 是否包含 Channel 键来判定多通道数据。

上层应用应检查产品是否声明 EffectOwner (EO) / EffectCapability (EC) 一致性,以决定编码并分发多通道还是单通道 EffectData:

  • 存在 EO/EC 时,应用必须使用多通道(Array)编码,并将 Channel 设置为各灯光 Endpoint 上报的 endpointTag。
  • 不存在 EO/EC 时(例如仅支持 DynamicLighting (DL) 的单灯产品),应用必须使用单通道(Map)编码。

多通道 Payload 规则如下:

  • 数组中的每个元素描述一个已配置通道,并且必须包含 Channel。
  • Channel 必须等于对应灯光 Endpoint 上报的 endpointTag。endpointTag 通常从 1 开始顺序递增。例如 Fixed Label 中 Label="Number"、Value 为 "1"、"2"、"3"、"4" 时,分别映射为 Channel 1、2、3、4。
  • 元素可以包含 OnOff。OnOff=false 表示选中该通道但保持关闭;此时可以省略 ActionType、Level、颜色等效果字段。
  • OnOff=true 或省略 OnOff 时,该元素必须包含应用该通道效果所需的 ActionType 专属字段。
  • 数组中未出现的通道不由此 EffectData 配置,必须保持原有状态。
CBOR 键定义​
Key名称CBOR 类型范围/单位说明
0ActionTypeunsigned int0-5效果动作类型,决定数据结构。
1SegmentPatternunsigned int0-4分段模式。
2Levelunsigned int1-100(%)亮度百分比。
3ColorTempunsigned intMired色温,单位为 Mired。
4ColorXYunsigned int0 至 2^32−1合并编码的 CIE XY:(X &lt;&lt; 16) \</td> <td>Y;X、Y 各为 0-65535。
5Reserved--保留。
6RelativeLevelsigned int1-100(%)相对亮度百分比。
7DynamicEffectIdunsigned int见对应枚举表动态效果标识。
8Speedunsigned int1-100(%)速度百分比。
9LedGridCountunsigned int1-255LED 网格单元(LED IC 芯片)数量。
10HoldTimeunsigned int100 ms 单位每个步骤的保持时间。
11TransitTimeunsigned int100 ms 单位步骤间的过渡时间。
12CompletionActionunsigned int0-2序列完成后的动作。
13LoopCountunsigned int0-255循环次数;0 表示无限循环。
14GradientEnabledbooltrue/false是否启用渐变效果。
15SegmentCountunsigned int0-255分段数量。
16SegmentListarray of map-分段定义列表。
17StepCountunsigned int0-255步骤数量。
18StepListarray of map-步骤定义列表。
19ColorCountunsigned int0-255颜色数量。
20ColorListarray of map-颜色列表。
21Variantunsigned int0-2效果变体档位:0=小,1=中,2=大。
22BlinkDensityunsigned int1-10闪烁密度档位:1 最低,10 最高。
23Channelunsigned int1-255多通道 EffectData 中目标灯光 Endpoint 的 endpointTag;多通道数组的每个元素都必须包含此键,通常从 1 开始顺序递增。
24OnOffbooltrue/false为 false 时选中该通道但保持关闭;为 true 或省略时应用该通道效果数据。
25NaturalEffectIdunsigned int见对应枚举表自然氛围效果标识(ActionType = NaturalEffect)。
26DurationSunsigned int0-65535(秒)效果持续时间;0 表示持续运行。
27RandSeedunsigned int0-65535随机种子;0 表示设备可以自行选择种子,1-65535 表示设备必须使用该种子。
28StartDelayMsunsigned int0-65535(毫秒)启动延迟;进入场景后等待此时长再执行效果数据。

ColorXY 编码(键 4):CIE X 与 Y 合并编码为一个无符号整数。编码:ColorXY = (X 16) \| Y。解码:X = ColorXY 16,Y = ColorXY & 0xFFFF。

ActionType 取值​
值名称说明必需键
0x00StaticEffect静态场景2,以及 3/4 之一(Level、ColorTemp/ColorXY)
0x01DynamicEffect动态场景7、8、19、20(DynamicEffectId、Speed、ColorCount、ColorList)
0x02SequenceEffect序列场景12、13、17、18(CompletionAction、LoopCount、StepCount、StepList)
0x03SegmentStaticEffect分段静态场景1(SegmentPattern);Whole 模式需要 2、3/4;其他模式需要 15、16(SegmentCount、SegmentList)
0x04SegmentDynamicEffect分段动态场景15、16(SegmentCount、SegmentList)
0x05NaturalEffect自然氛围场景25(NaturalEffectId);必需 3/4 之一(ColorTemp/ColorXY,互斥);可选 26、27、28、2、8、21(DurationS、RandSeed、StartDelayMs、Level、Speed、Variant)
DynamicEffectId 取值​
值名称中文效果名
0Undefined未定义
1Breathe呼吸
2Candle烛光
3Colorful幻彩
4Blink闪烁
5Gradient渐变
6AlternateBreath交替呼吸
7ForwardFlow正向流动
8ReverseFlow反向流动
9Jump跳变
10Celebration庆典
11BidirectionalCelebration双向庆典
12Chase追逐
13ReverseChase反向追逐
14Firefly萤光
15Starry星空
16Bounce反弹
17Meteor流星
18ReverseMeteor反向流星
19Stack堆积
NaturalEffectId 取值​

NaturalEffectId 与 DynamicEffectId 相互独立。所有 NaturalEffect Payload 共用同一组可选参数;本版本不定义各个自然效果分别必需的键或各自参数语义。

值名称中文名称
0NearThunder近雷
1DistantThunder远雷
2Meteor流星
3Firefly萤火虫
4BlueSkyWhiteClouds蓝天白云
5Overcast阴天

NaturalEffect 共用参数:

Key名称范围说明
3 / 4ColorTemp / ColorXY见键定义表必需颜色参数,二者互斥。
26DurationS0-65535 秒效果持续时间;0 表示持续运行。
27RandSeed0-65535随机种子;0 表示设备自行选择,1-65535 表示设备使用该种子。
28StartDelayMs0-65535 毫秒启动延迟;进入场景后等待此时长再执行效果数据。
2Level1-100(%)亮度。
8Speed1-100(%)速度。
21Variant0-2效果变体/档位:0=小,1=中,2=大。
CompletionAction 取值​
值名称说明
0TurnOff关闭灯光。
1Restore恢复执行前的状态。
2Hold保持最后一帧。
SegmentPattern 取值​
值名称说明
0Whole整灯,不分段。
1UnitLoop单元循环模式。
2Even均匀分布分段。
3Custom自定义分段尺寸及属性。
4DIYDIY 分段配置。
ActionType 编码详情​
StaticEffect(ActionType = 0x00)​
{
0: <ActionType>, // 必需:0x00
2: <Level>, // 必需:亮度百分比
3: <ColorTemp>, // 可选:色温(Mired)
4: <ColorXY> // 可选:合并编码的 CIE XY
}
DynamicEffect(ActionType = 0x01)​
{
0: <ActionType>, // 必需:0x01
7: <DynamicEffectId>, // 必需:效果 ID
8: <Speed>, // 条件字段:速度百分比
21: <Variant>, // 条件字段:效果变体
22: <BlinkDensity>, // 条件字段:闪烁密度
19: <ColorCount>, // 必需:颜色数量
20: [ // 必需:颜色列表
{ 4: <ColorXY> }, // 颜色 1
... // 颜色 2 至 N
]
}
SequenceEffect(ActionType = 0x02)​
{
0: <ActionType>, // 必需:0x02
12: <CompletionAction>, // 必需:完成后的动作
13: <LoopCount>, // 必需:循环次数(0 表示无限循环)
17: <StepCount>, // 必需:步骤数量
18: [ // 必需:步骤列表
{
10: <HoldTime>, // 必需:保持时间(100 ms 单位)
11: <TransitTime>, // 必需:过渡时间(100 ms 单位)
2: <Level>, // 必需:亮度百分比
3: <ColorTemp>, // 可选:色温
4: <ColorXY> // 可选:合并编码的 CIE XY
},
...
]
}
SegmentStaticEffect(ActionType = 0x03)​

数据结构根据 SegmentPattern(键 1)变化。

Whole(SegmentPattern = 0):整灯使用单一颜色。

{
0: 3, 1: 0, // ActionType + Whole 模式
2: <Level>, // 亮度百分比
3: <ColorTemp>, // 可选
4: <ColorXY> // 可选
}

UnitLoop(SegmentPattern = 1):分段以循环模式重复。

{
0: 3, 1: 1, // ActionType + UnitLoop 模式
15: <SegmentCount>,
16: [
{ 9: <LedGridCount>, 4: <ColorXY> },
...
]
}

Even(SegmentPattern = 2):均匀分布分段,可选渐变。

{
0: 3, 1: 2, // ActionType + Even 模式
14: <GradientEnabled>,
15: <SegmentCount>,
16: [
{ 4: <ColorXY> },
...
]
}

Custom(SegmentPattern = 3):自定义分段,每段可单独设置亮度。

{
0: 3, 1: 3, // ActionType + Custom 模式
14: <GradientEnabled>,
15: <SegmentCount>,
16: [
{ 9: <LedGridCount>, 6: <RelativeLevel>, 3: <ColorTemp>, 4: <ColorXY> },
...
]
}

DIY(SegmentPattern = 4):DIY 分段,各段可单独设置颜色。

{
0: 3, 1: 4, // ActionType + DIY 模式
15: <SegmentCount>,
16: [
{ 9: <LedGridCount>, 3: <ColorTemp>, 4: <ColorXY> },
...
]
}
SegmentDynamicEffect(ActionType = 0x04)​

每个分段具有独立的动态效果、速度和颜色列表。

{
0: 4, // ActionType = SegmentDynamicEffect
15: <SegmentCount>,
16: [
{
9: <LedGridCount>,
7: <DynamicEffectId>,
8: <Speed>,
21: <Variant>,
22: <BlinkDensity>,
19: <ColorCount>,
20: [ { 4: <ColorXY> }, ... ]
},
...
]
}
NaturalEffect(ActionType = 0x05)​

所有 NaturalEffectId 共用相同的参数集。必须提供 ColorTemp 或 ColorXY,二者互斥。其他键为条件字段;省略时由设备默认值/能力处理。本版本不规定各自然效果对参数的单独解释。

{
0: 5, // 必需:ActionType = NaturalEffect
25: <NaturalEffectId>, // 必需
3: <ColorTemp> | 4: <ColorXY>, // 必需:颜色(二选一)
26: <DurationS>, // 条件字段:持续时间 0–65535 秒;0 表示持续运行
27: <RandSeed>, // 条件字段:0 表示设备自行选择;1–65535 使用指定种子
28: <StartDelayMs>, // 条件字段:执行前延迟 0–65535 毫秒
2: <Level>, // 条件字段:亮度 1–100%
8: <Speed>, // 条件字段:速度 1–100%
21: <Variant> // 条件字段:变体 0–2
}
编码示例​
示例 1:StaticEffect--亮度 80% 的红色​

EffectData 参数:ActionType = StaticEffect,Level = 80,ColorXY = 0x9E9A4246(红色)。

CBOR 诊断表示:{0: 0, 2: 80, 4: 2660909638}

完整 EffectData(十六进制):

Header:  01 00
Payload: A3 00 00 02 18 50 04 1A 9E 9A 42 46
Total: 14 bytes
示例 2:DynamicEffect--含 3 种颜色的 Colorful 效果​

EffectData 参数:ActionType = DynamicEffect,DynamicEffectId = 3(Colorful),Speed = 50%,3 种颜色(红、绿、蓝)。

CBOR 诊断表示:{0: 1, 7: 3, 8: 50, 19: 3, 20: [{4: 2660909638}, {4: 1310044852}, {4: 616043336}]}

完整 EffectData(十六进制):

Header:  01 00
Payload: A5 00 01 07 03 08 18 32 13 03 14 83
A1 04 1A 9E 9A 42 46
A1 04 1A 4E 15 B2 B4
A1 04 1A 24 B8 13 48
Total: 35 bytes
示例 3:SequenceEffect--红色渐变到暖白,循环 3 次​

EffectData 参数:ActionType = SequenceEffect,CompletionAction = Hold,LoopCount = 3,包含 2 个步骤。

CBOR 诊断表示:{0: 2, 12: 2, 13: 3, 17: 2, 18: [{10: 20, 11: 10, 2: 100, 4: 2660909638}, {10: 20, 11: 10, 2: 100, 3: 172}]}

完整 EffectData(十六进制):

Header:  01 00
Payload: A5 00 02 0C 02 0D 03 11 02 12 82
A4 0A 14 0B 0A 02 18 64 04 1A 9E 9A 42 46
A4 0A 14 0B 0A 02 18 64 03 18 AC
Total: 38 bytes
示例 4:多通道--静态效果、动态效果与关闭通道​

支持 EffectOwner (EO) / EffectCapability (EC) 的产品上报灯光 endpointTag 1/2/3/4(Fixed Label Number)。一条 EffectData 配置 3 个通道,并保持 endpointTag 4 不变:

  • 通道 1(endpointTag 1):StaticEffect,Level = 80%,ColorXY 为红色(0x9E9A4246)。
  • 通道 2(endpointTag 2):DynamicEffect,DynamicEffectId = Colorful(3),Speed = 50%,ColorList 为红/绿/蓝。
  • 通道 3(endpointTag 3):已选中但关闭(OnOff = false)。
  • 通道 4(endpointTag 4):未出现在数组中,因此保持原有状态。

CBOR 诊断表示:

[
{23: 1, 0: 0, 2: 80, 4: 2660909638},
{23: 2, 0: 1, 7: 3, 8: 50, 19: 3, 20: [{4: 2660909638}, {4: 1310044852}, {4: 616043336}]},
{23: 3, 24: false}
]

完整 EffectData(十六进制):

Header:  01 00
Payload: 83
A4 17 01 00 00 02 18 50 04 1A 9E 9A 42 46
A6 17 02 00 01 07 03 08 18 32 13 03 14 83
A1 04 1A 9E 9A 42 46
A1 04 1A 4E 15 B2 B4
A1 04 1A 24 B8 13 48
A2 17 03 18 18 F4
Total: 58 bytes
示例 5:NaturalEffect--近雷​

EffectData 参数:ActionType = NaturalEffect,NaturalEffectId = NearThunder(0),ColorTemp = 250,Level = 80%,Speed = 50%,Variant = 1,DurationS = 30。

CBOR 诊断表示:{0: 5, 25: 0, 3: 250, 2: 80, 8: 50, 21: 1, 26: 30}

完整 EffectData(十六进制):

Header:  01 00
Payload: A7 00 05 18 19 00 03 18 FA 02 18 50 08 18 32 15 01 18 1A 18 1E
Total: 23 bytes

ScreenUIConfig(屏端统一配置)​

简介​

提供屏端统一 UI 配置,包括页面布局、主题、卡片数量及多页面信息管理。

Function 标识​

Function IDCode名称
0x00FFScreenUIConfig屏端统一配置

Trait​

Trait IDCode名称Conformance
0x4EB9DataVersion数据版本M
0x4ED0AssociatedDeviceIconSize关联设备图标大小M
0x4ECFAssociatedDeviceNameSize关联设备名称大小M
0x4ED6SupportedPageLayouts支持页面布局M
0x4ED5SupportedDeviceTypes支持设备类型M
0x4ED4PageLayoutSize页面布局大小M
0x4ED3MaxWidgetNum最大卡片数量M
0x4ED2UserDataSize用户数据大小M
0x4ED1PageNameSize页面名称大小M
0x4ECEHomePageIndex首页索引M
0x4EBCScreenHeight屏幕高度M
0x4EBBScreenWidth屏幕宽度M
0x4EBAMaxPageNum最大页面数量M
0x4E78ThemeID主题IDM
0x4E77ThemeVersion主题版本M
0x4F8FAllPagesInfo所有页面信息O

Command​

Command IDCode名称Conformance
0x9C6DRemovePage移除页面M
0x9D34SetAllPagesInfo配置所有页面信息O
0x9D35SetOnePageInfo配置单个页面信息O

数据类型​

RemovePage Command Structure Type​

RemovePage Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PageListlist[Struct]M页面列表。
SetAllPagesInfo Command Structure Type​

SetAllPagesInfo Command 的参数结构体。

结构体成员序号字段名类型必须说明
0AllPagesInfolist[Struct]M所有页面信息。
SetOnePageInfo Command Structure Type​

SetOnePageInfo Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PageInfostructM页面信息。

Trait 定义​

Trait IDNameConformance
0x4EB9DataVersionM
0x4ED0AssociatedDeviceIconSizeM
0x4ECFAssociatedDeviceNameSizeM
0x4ED6SupportedPageLayoutsM
0x4ED5SupportedDeviceTypesM
0x4ED4PageLayoutSizeM
0x4ED3MaxWidgetNumM
0x4ED2UserDataSizeM
0x4ED1PageNameSizeM
0x4ECEHomePageIndexM
0x4EBCScreenHeightM
0x4EBBScreenWidthM
0x4EBAMaxPageNumM
0x4E78ThemeIDM
0x4E77ThemeVersionM
0x4F8FAllPagesInfoO

DataVersion Trait(数据版本)​

该 Trait 用于「数据版本」相关数据的访问与上报。

Trait IDCode
0x4EB9DataVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVM
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0007Default Valueuint640RWO

AssociatedDeviceIconSize Trait(关联设备图标大小)​

该 Trait 用于「关联设备图标大小」相关数据的访问与上报。

Trait IDCode
0x4ED0AssociatedDeviceIconSize
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1632RVWM
0x0002Maximum Valueuint16128RO
0x0003Minimum Valueuint1632RO
0x0007Default Valueuint1632RWO

AssociatedDeviceNameSize Trait(关联设备名称大小)​

该 Trait 用于「关联设备名称大小」相关数据的访问与上报。

Trait IDCode
0x4ECFAssociatedDeviceNameSize
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1632RVWM
0x0002Maximum Valueuint16128RO
0x0003Minimum Valueuint1632RO
0x0007Default Valueuint1632RWO

SupportedPageLayouts Trait(支持页面布局)​

该 Trait 用于「支持页面布局」相关数据的访问与上报。

Trait IDCode
0x4ED6SupportedPageLayouts
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVWM

SupportedDeviceTypes Trait(支持设备类型)​

该 Trait 用于「支持设备类型」相关数据的访问与上报。

Trait IDCode
0x4ED5SupportedDeviceTypes
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuelistRVWM

PageLayoutSize Trait(页面布局大小)​

该 Trait 用于「页面布局大小」相关数据的访问与上报。

Trait IDCode
0x4ED4PageLayoutSize
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1632RVWM
0x0002Maximum Valueuint16128RO
0x0003Minimum Valueuint1632RO
0x0007Default Valueuint1632RWO

MaxWidgetNum Trait(最大卡片数量)​

该 Trait 用于「最大卡片数量」相关数据的访问与上报。

Trait IDCode
0x4ED3MaxWidgetNum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVWM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0007Default Valueuint161RWO

UserDataSize Trait(用户数据大小)​

该 Trait 用于「用户数据大小」相关数据的访问与上报。

Trait IDCode
0x4ED2UserDataSize
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16128RVWM
0x0002Maximum Valueuint16128RO
0x0003Minimum Valueuint1632RO
0x0007Default Valueuint16128RWO

PageNameSize Trait(页面名称大小)​

该 Trait 用于「页面名称大小」相关数据的访问与上报。

Trait IDCode
0x4ED1PageNameSize
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint1632RVWM
0x0002Maximum Valueuint16128RO
0x0003Minimum Valueuint1632RO
0x0007Default Valueuint1632RWO

HomePageIndex Trait(首页索引)​

该 Trait 用于「首页索引」相关数据的访问与上报。

Trait IDCode
0x4ECEHomePageIndex
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16RVWM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint160RWO

ScreenHeight Trait(屏幕高度)​

该 Trait 用于「屏幕高度」相关数据的访问与上报。

Trait IDCode
0x4EBCScreenHeight
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16240RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint16240RWO

ScreenWidth Trait(屏幕宽度)​

该 Trait 用于「屏幕宽度」相关数据的访问与上报。

Trait IDCode
0x4EBBScreenWidth
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16240RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint16240RWO

MaxPageNum Trait(最大页面数量)​

该 Trait 用于「最大页面数量」相关数据的访问与上报。

Trait IDCode
0x4EBAMaxPageNum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0007Default Valueuint161RWO

ThemeID Trait(主题ID)​

该 Trait 用于「主题ID」相关数据的访问与上报。

Trait IDCode
0x4E78ThemeID
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0007Default Valueuint161RWO

ThemeVersion Trait(主题版本)​

主题版本

Trait IDCode
0x4E77ThemeVersion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint161RVM
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint161RO
0x0005Step Valueuint321RO
0x0007Default Valueuint161RWO

AllPagesInfo Trait(所有页面信息)​

该特征应提供所有已配置页面及其组件的信息。

Trait IDCode
0x4F8FAllPagesInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[AllPagesInfoTraitPresentValueStructure]RVWO

Command 定义​

Command IDNameConformance
0x9C6DRemovePageM
0x9D34SetAllPagesInfoO
0x9D35SetOnePageInfoO

RemovePage Command​

该 Command 用于执行「移除页面」操作。

参数​

RemovePage Command Structure

SetAllPagesInfo Command​

该 Command 用于执行「配置所有页面信息」操作。

参数​

SetAllPagesInfo Command Structure

SetOnePageInfo Command​

该 Command 用于执行「配置单个页面信息」操作。

参数​

SetOnePageInfo Command Structure

Ringtone(铃声)​

简介​

提供铃声与音乐播放控制,支持选曲、音量/时长调节及播放状态监测。

Function 标识​

Function IDCode名称
0x0100Ringtone铃声

Trait​

Trait IDCode名称Conformance
0x4FA1RingtonePlayIndex铃声播放编号M
0x4FA4RingtonePlayDuration铃声播放时长O
0x4FA3RingtonePlayStatus铃声播放状态O
0x4FA2RingtonePlayVolume铃声播放音量O
0x50B5CustomRingtoneCapability自定义铃声能力O

Command​

Command IDCode名称Conformance
0x9D37PlayRingtone播放铃声O

数据类型​

RingtonePlayIndexEnum32 Type​

该枚举定义 RingtonePlayIndex Trait 的 Present Value 有效取值。

ValueNameDescription
0x00PoliceCar1警车音1
0x01PoliceCar2警车音2
0x02SafetyAccident安全事故音
0x03MissileCountdown导弹倒计时
0x04GhostSound鬼叫声
0x05SniperRifle狙击枪
0x06IntenseBattle激战声
0x07AirRaidSiren空袭警报
0x08DogBark狗叫声
0x0ADoorbell门铃音
0x0BKnock敲门音
0x0CFunny搞笑音
0x0DAlarmClock闹钟音
0x0EArming布防声
0x0FDisarming撤防声
0x14MiMixMiMix
0x15EnthusiasticEnthusiastic
0x16GuitarClassicGuitarClassic
0x17IceWorldPianoIceWorldPiano
0x18LeisureTimeLeisureTime
0x19ChildhoodChildhood
0x1AMorningStreamIetMorningStreamIet
0x1BMusixBoxMusixBox
0x1COrangeOrange
0x2710DefaultRingtone默认铃声
RingtonePlayStatusEnum8 Type​

该枚举定义 RingtonePlayStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Stopped停止
0x01Playing播放
CustomRingtoneCapabilityEnum8 Type​

该枚举定义 CustomRingtoneCapability Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Supported支持
PlayRingtone Command Structure Type​

PlayRingtone Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PlayStatusenum8M播放状态;默认值为 0。
1PlayIndexenum8O播放编号;默认值为 10000。
2PlayVolumefloatO播放音量;默认值为 50。
3PlayDurationuint32O播放时长;默认值为 0。

Trait 定义​

Trait IDNameConformance
0x4FA1RingtonePlayIndexM
0x4FA4RingtonePlayDurationO
0x4FA3RingtonePlayStatusO
0x4FA2RingtonePlayVolumeO
0x50B5CustomRingtoneCapabilityO

RingtonePlayIndex Trait(铃声播放编号)​

指示待播放铃声或音乐的索引。该特征允许从预定义列表中选择特定音轨,每个索引对应唯一的铃声或音乐标识符。该值为映射到音频文件的枚举。

Trait IDCode
0x4FA1RingtonePlayIndex
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRingtonePlayIndexEnum320RVWM
0x0006Supported Valuelist[RingtonePlayIndexEnum32]RO
0x0007Default ValueRingtonePlayIndexEnum320RWO

RingtonePlayDuration Trait(铃声播放时长)​

指示铃声或音乐播放时长。值表示播放时间(秒)。值为 0 表示播放一次(单次播放);大于 0 表示播放指定秒数。

Trait IDCode
0x4FA4RingtonePlayDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

RingtonePlayStatus Trait(铃声播放状态)​

指示铃声或音乐当前播放状态。值 0 通常表示停止或空闲,1 表示播放中。允许查询和控制当前是否正在播放音频。

Trait IDCode
0x4FA3RingtonePlayStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRingtonePlayStatusEnum80RVWO
0x0006Supported Valuelist[RingtonePlayStatusEnum8]RO
0x0007Default Valueuint80RWO

RingtonePlayVolume Trait(铃声播放音量)​

指示播放铃声或音乐的音量等级。取值范围为 0(静音)至 100(最大音量)。单位:%。

Trait IDCode
0x4FA2RingtonePlayVolume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

CustomRingtoneCapability Trait(自定义铃声能力)​

指示设备是否支持自定义铃声功能(例如上传并播放用户自定义铃声)。值 1 表示支持。

Trait IDCode
0x50B5CustomRingtoneCapability
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCustomRingtoneCapabilityEnum81RVO
0x0006Supported Valuelist[CustomRingtoneCapabilityEnum8]RO
0x0007Default Valueuint81RWO

Command 定义​

Command IDNameConformance
0x9D37PlayRingtoneO

PlayRingtone Command​

控制设备播放或停止指定铃声或音乐。第一个参数 PlayStatus 为必填项,用于指定播放状态(PLAYING 表示开始播放,STOPPED 表示停止播放)。当状态为 PLAYING 时,必须提供 PlayIndex 参数以指定要播放的铃声。可选参数 PlayVolume 设置播放音量(范围 0-100,0 为静音,100 为最大音量)。可选参数 PlayDuration 设置播放时长(秒)(0 表示播放一次,大于 0 表示播放指定秒数)。当状态为 STOPPED 时,应省略其他所有参数,设备将停止当前正在播放的铃声。

参数​

PlayRingtone Command Structure

FenceDetection(虚拟围栏侦测)​

简介​

在摄像机画面中定义虚拟围栏区域,检测人员进入或离开并支持录像、推送等联动策略。

Function 标识​

Function IDCode名称
0x0101FenceDetection虚拟围栏侦测

Trait​

Trait IDCode名称Conformance
0x4FB1FenceDetectionReport虚拟围栏侦测上报M
0x4FB2FenceDetectionEnable虚拟围栏使能O
0x4FB3TimePeriodSetting时段设置O
0x4FB4SensitivityLevelEnum识别灵敏度设置O
0x4FB5PushEnable推送使能O
0x4FB6RecordEnable录像使能O
0x4FB7IntervalSetting时间间隔设置O
0x4FB8FenceAreaSetting围栏区域设置O
0x4FB9FenceEntryDetectionEnable有人进入围栏上报使能O
0x4FBAFenceExitDetectionEnable有人离开围栏上报使能O
0x4FBBDisplayFenceAreaEnable显示围栏区域使能O
0x502DRegionDimension区域尺寸O

Command​

本 Function 不包含 Command。

数据类型​

FenceDetectionReportEnum8 Type​

该枚举定义 FenceDetectionReport Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Enter识别到有人进入围栏
0x02Exit识别到有人离开围栏
TimePeriodSettingTraitPresentValueStructure Type​

该结构体定义 TimePeriodSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
SensitivityLevelEnum8 Type​

该枚举定义 SensitivityLevelEnum Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高
FenceAreaSettingTraitPresentValueStructure Type​

该结构体定义 FenceAreaSetting Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0polygon_visiblebooleanM是否在实时画面中显示围栏区域。
1polygon_numint32M多边形数量,应与 polygons 数组长度一致。
2polygonsarray[Struct]M多边形数组。每个 Polygon 包含 id、points_num 和 points。
RegionDimensionTraitPresentValueStructure Type​

该结构体定义 RegionDimension Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0unitenum8M宽度和高度的单位,例如 GRID 或 PIXEL。
1widthuint32M指定单位下的区域总宽度。
2heightuint32M指定单位下的区域总高度。

Trait 定义​

Trait IDNameConformance
0x4FB1FenceDetectionReportM
0x4FB2FenceDetectionEnableO
0x4FB3TimePeriodSettingO
0x4FB4SensitivityLevelEnumO
0x4FB5PushEnableO
0x4FB6RecordEnableO
0x4FB7IntervalSettingO
0x4FB8FenceAreaSettingO
0x4FB9FenceEntryDetectionEnableO
0x4FBAFenceExitDetectionEnableO
0x4FBBDisplayFenceAreaEnableO
0x502DRegionDimensionO

FenceDetectionReport Trait(虚拟围栏侦测上报)​

人员进入或离开预定义虚拟围栏区域时触发的事件。该事件区分进入与离开方向。

Trait IDCode
0x4FB1FenceDetectionReport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFenceDetectionReportEnum81VM
0x0006Supported Valuelist[FenceDetectionReportEnum8]RO

FenceDetectionEnable Trait(虚拟围栏使能)​

启用或禁用虚拟围栏检测功能的总开关。启用后,摄像头分析视频帧以检测是否有人越过定义的多边形边界。

Trait IDCode
0x4FB2FenceDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

TimePeriodSetting Trait(时段设置)​

定义时间段和工作日的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FB3TimePeriodSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimePeriodSettingTraitPresentValueStructureRVWO
0x0007Default ValueTimePeriodSettingTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

SensitivityLevelEnum Trait(识别灵敏度设置)​

该枚举为多种设备功能(如检测、识别、感知、告警等)配置灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FB4SensitivityLevelEnum
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSensitivityLevelEnum81RVWO
0x0006Supported Valuelist[SensitivityLevelEnum8]RO
0x0007Default Valueuint81RWO

PushEnable Trait(推送使能)​

控制特定功能(如检测事件、识别事件)触发时是否向用户发送推送通知。值为布尔类型:true(启用)表示事件发生时发送推送通知;false(禁用)表示即使事件发生也不发送通知。

Trait IDCode
0x4FB5PushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

RecordEnable Trait(录像使能)​

启用或禁用人脸识别时的本地录像。

Trait IDCode
0x4FB6RecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

IntervalSetting Trait(时间间隔设置)​

配置特定功能(例如,检测、识别)的两个连续事件触发器之间的最小时间间隔。值为数值,以秒为单位。触发事件后,在此间隔内对同一事件的任何进一步检测将不会生成新的触发器,直到间隔已经过去。

Trait IDCode
0x4FB7IntervalSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16180RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16180RWO

FenceAreaSetting Trait(围栏区域设置)​

为虚拟围栏定义一个或多个多边形区域。包含三个字段:PolygonVisible(characterString,值为 "0" 或 "1",表示是否在实时预览中显示围栏区域)、PolygonNum(characterString,多边形总数)和 Polygons(存储各多边形定义的数组)。每个 Polygon 对象包含:Id(characterString,多边形唯一标识)、PointsNum(characterString,顶点数量)和 Points(顶点坐标数组)。每个顶点以 x 和 y 字符串表示,归一化值范围为 0.0 至 1.0,对应视频帧宽高的比例位置。顶点按顺序连接形成闭合多边形。该结构用于配置围栏功能的检测区域。

Trait IDCode
0x4FB8FenceAreaSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueFenceAreaSettingTraitPresentValueStructure{&quot;0&quot;:&quot;1&quot;,&quot;1&quot;:&quot;1&quot;,&quot;2&quot;:[{&quot;0&quot;:&quot;1&quot;,&quot;1&quot;:&quot;6&quot;,&quot;2&quot;:[{&quot;0&quot;:&quot;0.50000000&quot;,&quot;1&quot;:&quot;0.01694915&quot;},{&quot;0&quot;:&quot;0.73528814&quot;,&quot;1&quot;:&quot;0.25847459&quot;},{&quot;0&quot;:&quot;0.73528814&quot;,&quot;1&quot;:&quot;0.74152541&quot;},{&quot;0&quot;:&quot;0.50000000&quot;,&quot;1&quot;:&quot;0.98305082&quot;},{&quot;0&quot;:&quot;0.26471186&quot;,&quot;1&quot;:&quot;0.74152541&quot;},{&quot;0&quot;:&quot;0.26471186&quot;,&quot;1&quot;:&quot;0.25847459&quot;}]}]RVWO

FenceEntryDetectionEnable Trait(有人进入围栏上报使能)​

启用当人员进入虚拟围栏区域(由外向内)时的事件触发。

Trait IDCode
0x4FB9FenceEntryDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

FenceExitDetectionEnable Trait(有人离开围栏上报使能)​

启用当人员离开虚拟围栏区域(由内向外)时的事件触发。

Trait IDCode
0x4FBAFenceExitDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

DisplayFenceAreaEnable Trait(显示围栏区域使能)​

在实时视频流上显示或隐藏虚拟围栏多边形叠加层。显示时,用户可直观确认已定义的区域。

Trait IDCode
0x4FBBDisplayFenceAreaEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

RegionDimension Trait(区域尺寸)​

定义客户端(如 App)可用于区域配置(如检测区域、隐私遮罩)的完整画布尺寸。其值为包含三个字段的结构体: unit(enum8):width 和 height 的单位,例如 GRID(网格单元)、PIXEL(像素)。 width(uint32):指定单位下的区域总宽度。 height(uint32):指定单位下的区域总高度。

Trait IDCode
0x502DRegionDimension
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRegionDimensionTraitPresentValueStructureRVO

Command 定义​

本 Function 不包含 Command。

Security(隐私与安全)​

简介​

管理设备安全策略与访问权限,包括用户密码、丢失模式及相关验证机制。

Function 标识​

Function IDCode名称
0x0102Security隐私与安全

Trait​

Trait IDCode名称Conformance
0x502AUserPassword用户密码O
0x5178SecurityPassword安全密码O
0x5192SecurityPasswordLevel安全密码安全等级O
0x50EEPasswordReminder密码忽略设置O
0x50EFLockScreenPassword锁屏密码O
0x5193LockScreenPasswordLevel锁屏密码安全等级O
0x50F0PasswordRequirement设置是否需要密码O
0x501DTheftModeNotificationEnable丢失模式推送使能O
0x50ADTheftModeSupported是否支持丢失模式功能O
0x501CTheftModeEnable丢失模式使能O

Command​

本 Function 不包含 Command。

数据类型​

SecurityPasswordLevelEnum8 Type​

该枚举定义 SecurityPasswordLevel Trait 的 Present Value 有效取值。

ValueKey中文名称英文名称Description
0x00High高级别High安全密码强度为高级别(默认)。
0x01Low低级别Low安全密码强度为低级别。
LockScreenPasswordLevelEnum8 Type​

该枚举定义 LockScreenPasswordLevel Trait 的 Present Value 有效取值。

ValueKey中文名称英文名称Description
0x00High高级别High锁屏密码强度为高级别(默认)。
0x01Low低级别Low锁屏密码强度为低级别。

Trait 定义​

Trait IDNameConformance
0x502AUserPasswordO
0x5178SecurityPasswordO
0x5192SecurityPasswordLevelO
0x50EEPasswordReminderO
0x50EFLockScreenPasswordO
0x5193LockScreenPasswordLevelO
0x50F0PasswordRequirementO
0x501DTheftModeNotificationEnableO
0x50ADTheftModeSupportedO
0x501CTheftModeEnableO

UserPassword Trait(用户密码)​

用于设备认证与安全通信的用户密码。

Trait IDCode
0x502AUserPassword
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterString0RVWO
0x0007Default ValuecharacterString0RWO

SecurityPassword Trait(安全密码)​

安全密码。用于验证管理员权限的安全密码。在执行恢复出厂设置、修改高级配置等安全合规操作前,需要用户输入该密码进行验证。该属性可读、可写、可上报,通常由设备端或云端存储和管理。

Trait IDCode
0x5178SecurityPassword
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

SecurityPasswordLevel Trait(安全密码安全等级)​

安全密码安全等级。表示设备安全密码的安全等级。取值为枚举(uint8),0 表示高级别,1 表示低级别。该 Trait 为只读、可上报,由设备根据当前安全密码的强度上报。前端可以根据该安全等级,实现不同的处理机制。比如,如果是低安全级别,则在修改密码时可以无需输入原密码。

Trait IDCode
0x5192SecurityPasswordLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSecurityPasswordLevelEnum80RVO
0x0006Supported Valuelist[SecurityPasswordLevelEnum8]RO
0x0007Default Valueuint80RWO

PasswordReminder Trait(密码忽略设置)​

控制 App 配置流程中是否可跳过密码提醒。0 表示不跳过,1 表示跳过。

Trait IDCode
0x50EEPasswordReminder
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO
0x0006Supported Valuelist[boolean]RO
0x0007Default Valueboolean0RWO

LockScreenPassword Trait(锁屏密码)​

用于设置锁屏密码。密码为加密后的 6 位字符串;空字符串表示未设置锁屏密码。

Trait IDCode
0x50EFLockScreenPassword
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

LockScreenPasswordLevel Trait(锁屏密码安全等级)​

锁屏密码安全等级。表示设备锁屏密码的安全等级。取值为枚举(uint8),0 表示高级别,1 表示低级别。该 Trait 为只读、可上报,由设备根据当前锁屏密码的强度上报。前端可以根据该安全等级,实现不同的处理机制。比如,如果是低安全级别,则在修改密码时可以无需输入原密码。

Trait IDCode
0x5193LockScreenPasswordLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLockScreenPasswordLevelEnum80RVO
0x0006Supported Valuelist[LockScreenPasswordLevelEnum8]RO
0x0007Default Valueuint80RWO

PasswordRequirement Trait(设置是否需要密码)​

控制在非消费场景下执行解锁/开门等操作时是否要求输入密码。

Trait IDCode
0x50F0PasswordRequirement
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0006Supported Valuelist[boolean]RO
0x0007Default Valueboolean0RWO

TheftModeNotificationEnable Trait(丢失模式推送使能)​

启用或禁用防盗模式事件的推送通知。

Trait IDCode
0x501DTheftModeNotificationEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

TheftModeSupported Trait(是否支持丢失模式功能)​

指示设备是否支持丢失/被盗模式功能。

Trait IDCode
0x50ADTheftModeSupported
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVO
0x0007Default Valueboolean0RWO

TheftModeEnable Trait(丢失模式使能)​

启用或禁用防盗/丢失模式。

Trait IDCode
0x501CTheftModeEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

Storage(本地存储)​

简介​

管理本地 SD 卡录像、格式化、录像模式及存储状态监测与维护。

Function 标识​

Function IDCode名称
0x0103Storage本地存储

Trait​

Trait IDCode名称Conformance
0x507BNASServerBindingStatusNAS服务器绑定状态O
0x5067NewStorageDeviceDetected检测到新存储设备O
0x4FE4NASLastWriteTimestampNAS最后写入时间戳O
0x4FE7SDCardStatusSD卡状态O
0x4FD2RecordingMode录像模式O
0x5245RecordingDurationType录像时长类型O
0x5246MinRecordingDuration最小录像时长O
0x5247MaxRecordingDuration最大录像时长O
0x5025SetNASSharedFolder设置共享文件夹O
0x5024NASSharedFoldersList获取共享文件夹列表O
0x5023NASServersList获取NAS服务器列表O
0x502CNASStorageDurationNAS存储时长O
0x502BNASTransferIntervalNAS传输间隔O
0x5021NASStorageEnableNAS存储使能O
0x5022NASWorkModeNAS工作模式O
0x5020NASVerificationResultNAS验证结果O
0x501ESetNASServers设置NAS服务器O
0x501FNASStatusNAS状态O

Command​

Command IDCode名称Conformance
0x9D45DeleteNASServer删除NAS服务器O
0x9D3FTriggerSDCardStatusUpload触发SD卡状态上传O
0x9D3CNASClearHistoryVideos清除NAS历史视频O
0x9D3BFormatSDCardCommand格式化存储卡O

数据类型​

RecordingDurationTypeEnum8 Type​

该枚举定义 RecordingDurationType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Auto自动;设备根据电量等信息自动决定最小和最大录像时长
0x01Custom自定义;用户通过 MinRecordingDuration 和 MaxRecordingDuration 配置录像时长
NASServerBindingStatusEnum8 Type​

该枚举定义 NASServerBindingStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unbound解绑
0x01Bound绑定成功
NewStorageDeviceDetectedEnum8 Type​

该枚举定义 NewStorageDeviceDetected Trait 的 Present Value 有效取值。

ValueNameDescription
0x00NoDevice未接入存储设备
0x01SdCard已接SD卡
0x02Usb已接USB存储
0x03SdCardAndUsb已接SD卡和USB存储
SDCardStatusTraitPresentValueStructure Type​

该结构体定义 SDCardStatus Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0totalsizeuint32MSD 卡总容量,单位 KB。
1freesizeuint32MSD 卡可用容量,单位 KB。
2othersizeuint32M非摄像机文件占用容量,单位 KB。
3sdstatusenum8MSD 卡状态:0=Normal,1=Not inserted,2=Formatting,3=Error。
NASWorkModeEnum8 Type​

该枚举定义 NASWorkMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00TranscodeFromSD从本地存储卡转存
0x01DirectUpload直接上传NAS
NASVerificationResultEnum8 Type​

该枚举定义 NASVerificationResult Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Failed验证失败
0x01Success验证成功
SetNASServersTraitPresentValueStructure Type​

该结构体定义 SetNASServers Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0hostcharacterStringMNAS 服务器地址,可以是 IP 地址、主机名或 UNC 路径。
1usercharacterStringMNAS 认证用户名。
2passwordcharacterStringMNAS 认证密码。
NASStatusEnum8 Type​

该枚举定义 NASStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Transferring传输中
0x02Paused暂停传输
0x03Clearing清除视频中
0x04Error出错
DeleteNASServer Command Structure Type​

DeleteNASServer Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Statusenum8M状态;默认值为 0。
NASClearHistoryVideos Command Structure Type​

NASClearHistoryVideos Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M命令类型。
FormatSDCardCommand Command Structure Type​

FormatSDCardCommand Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M命令类型。

Trait 定义​

Trait IDNameConformance
0x507BNASServerBindingStatusO
0x5067NewStorageDeviceDetectedO
0x4FE4NASLastWriteTimestampO
0x4FE7SDCardStatusO
0x4FD2RecordingModeO
0x5245RecordingDurationTypeO
0x5246MinRecordingDurationO
0x5247MaxRecordingDurationO
0x5025SetNASSharedFolderO
0x5024NASSharedFoldersListO
0x5023NASServersListO
0x502CNASStorageDurationO
0x502BNASTransferIntervalO
0x5021NASStorageEnableO
0x5022NASWorkModeO
0x5020NASVerificationResultO
0x501ESetNASServersO
0x501FNASStatusO

NASServerBindingStatus Trait(NAS服务器绑定状态)​

指示设备与 NAS 服务器的绑定状态。值 0 表示未绑定(未连接或未配置),值 1 表示已绑定(已成功连接并认证)。

Trait IDCode
0x507BNASServerBindingStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNASServerBindingStatusEnum80RVO
0x0006Supported Valuelist[NASServerBindingStatusEnum8]RO
0x0007Default Valueuint80RWO

NewStorageDeviceDetected Trait(检测到新存储设备)​

表示检测到新存储设备(SD 卡或 USB 存储),且设备当前未将该存储用作所选录像位置。设备上报该 Trait 以触发弹窗通知。值表示检测到的存储设备类型:

0:未检测到存储设备 1:检测到 SD 卡 2:检测到 USB 存储 3:同时检测到 SD 卡和 USB 存储

Trait IDCode
0x5067NewStorageDeviceDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNewStorageDeviceDetectedEnum80RVO
0x0006Supported Valuelist[NewStorageDeviceDetectedEnum8]RO

NASLastWriteTimestamp Trait(NAS最后写入时间戳)​

指示最后一次成功写入 NAS 存储的 Unix 时间戳(毫秒,不含时区)。设备完成向 NAS 写入视频文件或任何数据时记录该时间戳。

Trait IDCode
0x4FE4NASLastWriteTimestamp
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVO
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint321RO
0x0007Default Valueuint640RWO

SDCardStatus Trait(SD卡状态)​

上报 SD 卡的存储信息及健康状态。包含 totalsize(总容量,KB)、freesize(可用空间,KB)、othersize(非摄像头文件占用空间,KB)及 sdstatus(卡状态:0=正常,1=未插入,2=格式化中,3=错误)。

Trait IDCode
0x4FE7SDCardStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSDCardStatusTraitPresentValueStructureRVO
0x0007Default ValueSDCardStatusTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":0,"1":0,"2":0,"3":0}RWO

RecordingMode Trait(录像模式)​

配置设备的录制行为。结构包含两个字段:模式( uint8 ,值: 0 =关闭, 1 =连续录制, 2 =事件触发录制)和覆盖( uint8 ,值: 1 =存储已满时的循环覆盖)。这两个字段都是必填字段。

Trait IDCode
0x4FD2RecordingMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRecordingModeTraitPresentValueStructureRVWO
0x0007Default ValueRecordingModeTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":2,"1":1}RWO

SetNASSharedFolder Trait(设置共享文件夹)​

设置用于 NAS 存储的共享文件夹路径。

Trait IDCode
0x5025SetNASSharedFolder
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

NASSharedFoldersList Trait(获取共享文件夹列表)​

以 JSON 数组形式检索 NAS 上的共享文件夹列表。

Trait IDCode
0x5024NASSharedFoldersList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuearrayRVO

NASServersList Trait(获取NAS服务器列表)​

以数组形式检索已配置的 NAS 服务器列表。

Trait IDCode
0x5023NASServersList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuearrayRVO

NASStorageDuration Trait(NAS存储时长)​

NAS 上视频保留时长(秒)。

Trait IDCode
0x502CNASStorageDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint322592000RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint322592000RWO

NASTransferInterval Trait(NAS传输间隔)​

视频传输至 NAS 的时间间隔(秒)。

Trait IDCode
0x502BNASTransferInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint3286400RVWO
0x0002Maximum Valueuint3286400RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint3260RWO

NASStorageEnable Trait(NAS存储使能)​

启用或禁用 NAS 视频存储。

Trait IDCode
0x5021NASStorageEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

NASWorkMode Trait(NAS工作模式)​

指定 NAS 存储模式:从 SD 卡转存或直接上传。

Trait IDCode
0x5022NASWorkMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNASWorkModeEnum80RVWO
0x0006Supported Valuelist[NASWorkModeEnum8]RO
0x0007Default ValueNASWorkModeEnum80RWO

NASVerificationResult Trait(NAS验证结果)​

上次 NAS 连接验证的结果。

Trait IDCode
0x5020NASVerificationResult
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNASVerificationResultEnum81RVO
0x0006Supported Valuelist[NASVerificationResultEnum8]RO

SetNASServers Trait(设置NAS服务器)​

配置设备连接到NAS服务器所需的参数。它包含三个参数:主机(characterString, NAS服务器的地址,可以是IP地址、主机名或UNC路径)、用户(characterString,用于NAS身份验证的用户名)和密码(characterString,与用户名对应的密码)。收到此命令后,设备将尝试使用提供的凭据连接到指定的NAS服务器,并返回连接结果(成功或失败)。

Trait IDCode
0x501ESetNASServers
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSetNASServersTraitPresentValueStructureRVWO

NASStatus Trait(NAS状态)​

NAS 视频存储的当前状态。

Trait IDCode
0x501FNASStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNASStatusEnum80RVO
0x0006Supported Valuelist[NASStatusEnum8]RO

RecordingDurationType Trait(录像时长类型)​

设备侧录像时长类型。0 为自动,设备根据电量等信息自动决定最小和最大录像时长;1 为自定义,使用 MinRecordingDuration 和 MaxRecordingDuration 配置的时长。默认值为 0,可读、可写、可上报。

Trait IDCode
0x5245RecordingDurationType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueRecordingDurationTypeEnum80RVWO
0x0006Supported Valuelist[RecordingDurationTypeEnum8]RO
0x0007Default ValueRecordingDurationTypeEnum80RWO

MinRecordingDuration Trait(最小录像时长)​

设备侧最小录像时长,单位为秒(s),范围为 1 至 6,步长为 1,默认值为 6。RecordingDurationType 为自定义时使用该配置。开始录像后,即使侦测对象停止移动或离开视野,也会持续录像至最小录像时长,以确保记录足够的事件画面。可读、可写、可上报。

Trait IDCode
0x5246MinRecordingDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint81..66RVWO
0x0002Maximum Valueuint86RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint81RO
0x0007Default Valueuint81..66RWO

MaxRecordingDuration Trait(最大录像时长)​

设备侧最大录像时长,单位为秒(s),范围为 10 至 30,步长为 1,默认值为 30。RecordingDurationType 为自定义时使用该配置。开始录像后,如果侦测对象停止移动或离开视野,在达到最小录像时长后停止录像以节能;如果侦测对象持续移动,则持续录像直至最大录像时长。可读、可写、可上报。

Trait IDCode
0x5247MaxRecordingDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint810..3030RVWO
0x0002Maximum Valueuint830RO
0x0003Minimum Valueuint810RO
0x0005Step Valueuint81RO
0x0007Default Valueuint810..3030RWO

Command 定义​

Command IDNameConformance
0x9D45DeleteNASServerO
0x9D3FTriggerSDCardStatusUploadO
0x9D3CNASClearHistoryVideosO
0x9D3BFormatSDCardCommandO

DeleteNASServer Command​

表示解绑 NAS 服务器的操作。

参数​

DeleteNASServer Command Structure

TriggerSDCardStatusUpload Command​

触发设备主动向云端或客户端上报当前 SDCardStatus(包括总容量、可用空间、其他占用及卡状态)。

该 Command 无参数。

NASClearHistoryVideos Command​

该 Command 用于执行「清除NAS历史视频」操作。

参数​

NASClearHistoryVideos Command Structure

FormatSDCardCommand Command​

该 Command 用于执行「格式化存储卡」操作。

参数​

FormatSDCardCommand Command Structure

ImageMediaManagement(图像媒体管理)​

简介​

管理画布布局与图像资源,支持图像下载、存储、删除、状态上报及 ID 列表维护。

Function 标识​

Function IDCode名称
0x0104ImageMediaManagement图像媒体管理

Trait​

Trait IDCode名称Conformance
0x4FEDCanvasLayoutConfiguration画布布局配置O
0x4FEECurrentImageId当前图像IDO
0x4FEFDisplayImage显示图像O
0x4FF0DownloadImageData下载图像数据O
0x4FF2ImageTransferState图像传输状态O
0x4FF3ImageDataList图像数据列表O
0x4FF4ImageIdList图像ID列表O
0x5135OnDeviceImageIdList设备端图像ID列表O
0x4FF5RemoveImages删除图像列表O
0x50F1FreeStorageCapacity图片剩余存储空间容量O

Command​

本 Function 不包含 Command。

数据类型​

ImageTransferStateEnum8 Type​

该枚举定义 ImageTransferState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Idle空闲
0x01DownloadFailed下载失败
0x02NoSpace下载失败-空间不足
0x03DownloadFailedInProgress下载失败-正在下载中
0x04CheckFailed校验失败
0x10Downloading下载中
0x20DownloadComplete下载完成
0x21TransferProgress10图传进度10%
0x22TransferProgress20图传进度20%
0x23TransferProgress30图传进度30%
0x24TransferProgress40图传进度40%
0x25TransferProgress50图传进度50%
0x26TransferProgress60图传进度60%
0x27TransferProgress70图传进度70%
0x28TransferProgress80图传进度80%
0x29TransferProgress90图传进度90%
0x2FTransferStart图传开始
0x30TransferComplete图传完成
0x31DisplayFailedNoData图显失败-无图像数据
0x32DisplayFailedTransferring图显失败-正在传输中
0x40DisplayComplete图显完成
0xFFOperationFailed操作失败

Trait 定义​

Trait IDNameConformance
0x4FEDCanvasLayoutConfigurationO
0x4FEECurrentImageIdO
0x4FEFDisplayImageO
0x4FF0DownloadImageDataO
0x4FF2ImageTransferStateO
0x4FF3ImageDataListO
0x4FF4ImageIdListO
0x5135OnDeviceImageIdListO
0x4FF5RemoveImagesO
0x50F1FreeStorageCapacityO

CanvasLayoutConfiguration Trait(画布布局配置)​

前端使用的画布布局的配置参数。

Trait IDCode
0x4FEDCanvasLayoutConfiguration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

CurrentImageId Trait(当前图像ID)​

当前显示图像的 ID,类型为 uint32。

Trait IDCode
0x4FEECurrentImageId
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

DisplayImage Trait(显示图像)​

待显示图像的 ID,类型为 uint32,由 App 下发。

Trait IDCode
0x4FEFDisplayImage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320WO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

DownloadImageData Trait(下载图像数据)​

用于下载图片的数据,包括 URL、MD5、大小、类型、ID、存储标志。

Trait IDCode
0x4FF0DownloadImageData
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringWO

ImageTransferState Trait(图像传输状态)​

图像传输状态(空闲、下载中、已完成、失败等)。

Trait IDCode
0x4FF2ImageTransferState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueImageTransferStateEnum80RVO
0x0006Supported Valuelist[ImageTransferStateEnum8]RO
0x0007Default Valueuint80RWO

ImageDataList Trait(图像数据列表)​

供 App/服务端使用的图像数据列表。

Trait IDCode
0x4FF3ImageDataList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

ImageIdList Trait(图像ID列表)​

图像 ID 列表,包含若干个 uint32 类型图像 ID,例如 [123456, 345678]。

Trait IDCode
0x4FF4ImageIdList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuearray[uint32]RVO

OnDeviceImageIdList Trait(设备端图像ID列表)​

中文名称:设备端图像ID列表。

表示存储在末端执行设备自身本地存储器(而非网关或云端)中的图像 ID 列表。每个 ID 对应一个保存在设备内部存储介质(如 Flash、SD 卡)中的图像数据。该列表为可读可上报,由设备端维护,客户端可利用该列表枚举、预览或管理设备本地的图像资源。 列表内每个图像 ID 均为 uint32。

Trait IDCode
0x5135OnDeviceImageIdList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuearray[uint32]RVO

RemoveImages Trait(删除图像列表)​

待删除图像 ID 列表,包含若干个 uint32 类型图像 ID,例如 [123456, 345678]。

Trait IDCode
0x4FF5RemoveImages
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuearray[uint32]WO

FreeStorageCapacity Trait(图片剩余存储空间容量)​

上报设备相册可用剩余存储容量,单位为 KB。

Trait IDCode
0x50F1FreeStorageCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

Command 定义​

本 Function 不包含 Command。

VoiceAssistant(语音助手)​

简介​

管理设备语音交互能力,包括唤醒词、语音控制开关、语音音色、连续对话、语音控制语言、近场唤醒及空间区域配置。

Function 标识​

Function IDCode名称
0x0105VoiceAssistant语音助手

Trait​

Trait IDCodeConformance
0x4FF9VoiceAssistantEnabledM
0x50FCVoiceAssistantAuthStateO
0x50FDOneShotEnableO
0x50FFWakeWordSettingO
0x5101ControlScopeSettingO
0x5103WakeSensitivityO
0x5104NearFieldWakeEnabledO
0x5105AiRecommendEnabledO
0x51F2VoiceTimbreO
0x51F3ContinuousChatEnableO
0x51F4VoiceControlLanguageO

Command​

Command IDCodeConformance
0x9D5FTriggerVoiceAssistantWakeO

数据类型​

VoiceAssistantAuthStateEnum8 Type​

该枚举定义 VoiceAssistantAuthState Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Authorized已授权
0x01Unauthorized未授权
ControlScopeSettingEnum32 Type​

该枚举定义 ControlScopeSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00CurrentRoom当前房间
0x01WholeHouse全屋
WakeSensitivityEnum32 Type​

该枚举定义 WakeSensitivity Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Low低
0x01Medium中
0x02High高
VoiceTimbreEnum8 Type​

该枚举定义 VoiceTimbre Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Male男声
0x01Female女声
VoiceControlLanguageEnum8 Type​

该枚举定义 VoiceControlLanguage Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Chinese中文
0x02English英文
TriggerVoiceAssistantWake Command Structure Type​

TriggerVoiceAssistantWake Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Actionenum8M动作;0 = NO_ACTION(无操作),1 = WAKE(激活语音助手),2 = ExitVoiceControl(退出语控);默认值为 1。

Trait 定义​

Trait IDNameConformance
0x4FF9VoiceAssistantEnabledM
0x50FCVoiceAssistantAuthStateO
0x50FDOneShotEnableO
0x50FFWakeWordSettingO
0x5101ControlScopeSettingO
0x5103WakeSensitivityO
0x5104NearFieldWakeEnabledO
0x5105AiRecommendEnabledO
0x51F2VoiceTimbreO
0x51F3ContinuousChatEnableO
0x51F4VoiceControlLanguageO

VoiceAssistantEnabled Trait​

确定设备是否响应语音指令;启用时(默认)所有内置语音功能生效;禁用时麦克风忽略所有唤醒词和指令,等效于无语音硬件。

Trait IDCode
0x4FF9VoiceAssistantEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuebooleanO1RVWM
0x0007Default ValuebooleanO1RWO

VoiceAssistantAuthState Trait​

表示语音控制授权状态。

Trait IDCode
0x50FCVoiceAssistantAuthState
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVoiceAssistantAuthStateEnum80RVWO
0x0006Supported Valuelist[VoiceAssistantAuthStateEnum8]RO
0x0007Default Valueuint80RWO

OneShotEnable Trait​

启用或禁用 One-Shot 语控能力。0 表示关闭,1 表示开启。

Trait IDCode
0x50FDOneShotEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

WakeWordSetting Trait​

用于配置语音助手唤醒词,支持主唤醒词、辅助唤醒词及用户自定义唤醒词。

Trait IDCode
0x50FFWakeWordSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

ControlScopeSetting Trait​

设置语音控制作用范围。

Trait IDCode
0x5101ControlScopeSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueControlScopeSettingEnum321RVWO
0x0006Supported Valuelist[ControlScopeSettingEnum32]RO
0x0007Default Valueuint321RWO

WakeSensitivity Trait​

设置语音唤醒灵敏度等级。

Trait IDCode
0x5103WakeSensitivity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueWakeSensitivityEnum320RVWO
0x0006Supported Valuelist[WakeSensitivityEnum32]RO
0x0007Default Valueuint320RWO

NearFieldWakeEnabled Trait​

启用或禁用近场唤醒功能。

Trait IDCode
0x5104NearFieldWakeEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AiRecommendEnabled Trait​

启用或禁用 AI 推荐功能。

Trait IDCode
0x5105AiRecommendEnabled
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

VoiceTimbre Trait​

表示语音助手使用的语音音色。0 表示男声,1 表示女声。

Trait IDCode
0x51F2VoiceTimbre
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVoiceTimbreEnum80RVWO
0x0006Supported Valuelist[VoiceTimbreEnum8]RO
0x0007Default Valueuint80RWO

ContinuousChatEnable Trait​

用于开启或关闭语音助手的连续对话功能。开启后,用户可连续对话,无需频繁唤醒语音助手;用户说"再见"可快速结束当次连续对话。

Trait IDCode
0x51F3ContinuousChatEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

VoiceControlLanguage Trait​

表示语音控制所支持识别的语言类型。

Trait IDCode
0x51F4VoiceControlLanguage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVoiceControlLanguageEnum81RVWO
0x0006Supported Valuelist[VoiceControlLanguageEnum8]RO
0x0007Default Valueuint81RWO

Command 定义​

Command IDNameConformance
0x9D5FTriggerVoiceAssistantWakeO

TriggerVoiceAssistantWake Command​

该命令触发设备唤醒语音助手,使其准备接收语音命令。action 参数为枚举:NO_ACTION(0)无操作,WAKE(1)激活语音助手,ExitVoiceControl(2)退出语控。

参数​

TriggerVoiceAssistantWake Command Structure

VoiceIntercom(语音对讲)​

简介​

管理设备语音对讲相关能力,包括可用于对讲的在线设备列表。

Function 标识​

Function IDCode名称
TBDVoiceIntercom语音对讲

Trait​

Trait IDCode名称Conformance
0x50F8IntercomDevicesList在线的对讲设备列表O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x50F8IntercomDevicesListO

IntercomDevicesList Trait(在线的对讲设备列表)​

上报网关当前发现的、支持对讲且在线的设备列表。

Trait IDCode
0x50F8IntercomDevicesList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

Command 定义​

本 Function 不包含 Command。

SpaceSecurity(空间安防)​

简介​

管理设备在特定空间内的安防能力,包括报警铃声、音量、布撤防状态及告警时长。

Function 标识​

Function IDCode名称
0x0106SpaceSecurity空间安防

Trait​

Trait IDCode名称Conformance
0x4FFAAlarmStatus安防报警状态M
0x50F9AlarmBellIndex报警铃声O
0x50FAAlarmDuration报警时长O
0x50FBGuardStatus安防守护状态O

Command​

本 Function 不包含 Command。

数据类型​

AlarmStatusEnum8 Type​

该枚举定义 AlarmStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01ConfirmedAbnormal确认的异常
0x02UnconfirmedNormal未确认的正常
0x03UnconfirmedAbnormal未确认的异常
AlarmBellIndexEnum32 Type​

该枚举定义 AlarmBellIndex Trait 的 Present Value 有效取值。

ValueNameDescription
0x00PoliceCarSound1警车音1
0x01PoliceCarSound2警车音2
0x02SafetyAccidentSound安全事故音
0x03MissileCountdown导弹倒计时
0x04GhostScream鬼叫声
0x05SniperGun狙击枪
0x06BattleSound激战声
0x07AirRaidAlarm空袭警报
0x08DogBark狗叫声
0x2710DefaultRingtone默认铃声
GuardStatusEnum8 Type​

该枚举定义 GuardStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Home在家守护
0x01Away离家守护
0x02Sleep睡眠守护
0x03Off撤防
0x04Basic基础守护

Trait 定义​

Trait IDNameConformance
0x4FFAAlarmStatusM
0x50F9AlarmBellIndexO
0x50FAAlarmDurationO
0x50FBGuardStatusO

AlarmStatus Trait(安防报警状态)​

指定系统当前告警状态,取值包括:Normal 表示无异常;ConfirmedAbnormal 表示已确认异常且需采取行动;UnconfirmedNormal 表示尚未确认异常且持续监测中;UnconfirmedAbnormal 表示可能存在异常且需核实。

Trait IDCode
0x4FFAAlarmStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAlarmStatusEnum80RVWM
0x0006Supported Valuelist[AlarmStatusEnum8]RO
0x0007Default Valueuint80RWO

AlarmBellIndex Trait(报警铃声)​

设置或读取安防报警铃声索引。当取值为 10000 时播放默认铃声。

Trait IDCode
0x50F9AlarmBellIndex
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAlarmBellIndexEnum320RVWO
0x0006Supported Valuelist[AlarmBellIndexEnum32]RO
0x0007Default Valueuint320RWO

AlarmDuration Trait(报警时长)​

设置或读取报警铃声持续时长,单位为秒。取值 0 表示单次播放。

Trait IDCode
0x50FAAlarmDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint3260RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint3260RWO

GuardStatus Trait(安防守护状态)​

表示当前安防守护模式,并用于与 HomeKit 等生态进行守护状态同步。

Trait IDCode
0x50FBGuardStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueGuardStatusEnum80RVWO
0x0006Supported Valuelist[GuardStatusEnum8]RO
0x0007Default ValueGuardStatusEnum80RWO

Command 定义​

本 Function 不包含 Command。

Massage(按摩)​

简介​

管理电动床舒适与姿态调节,包括背/腿升降、按摩模式/强度/定时及童锁与急停。

Function 标识​

Function IDCode名称
0x0107Massage按摩

Trait​

Trait IDCode名称Conformance
0x507EMassageLevel按摩强度O
0x507FMassageMode按摩模式O
0x5081MassageEffect按摩场景O
0x5082MassageTimer按摩定时O
0x5083BackrestLift背部升降调节O
0x5084LegrestLift腿部升降调节O
0x5085BackLegLift背腿同升O
0x5086BackLegDown背腿同降O

Command​

Command IDCode名称Conformance
0x80C5Stop停止O

数据类型​

MassageLevelEnum8 Type​

该枚举定义 MassageLevel Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Low弱
0x01Medium中
0x02High强
MassageModeEnum8 Type​

该枚举定义 MassageMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off关
0x01ContinuousVibration持续振动按摩
0x02IntermittentPulse间断脉冲按摩
0x03WaveCushion波浪缓冲按摩
MassageEffectEnum8 Type​

该枚举定义 MassageEffect Trait 的 Present Value 有效取值。

ValueNameDescription
0x00ZeroPressure零压力
0x01Yoga瑜伽
0x02Sleep睡眠
0x03Movie观影
0x04Nursing哺乳
0x05AntiSnoring止鼾
MassageTimerEnum8 Type​

该枚举定义 MassageTimer Trait 的 Present Value 有效取值。

ValueNameDescription
0x0010mins10分钟
0x0120mins20分钟
0x0230mins30分钟
BackLegLiftEnum8 Type​

该枚举定义 BackLegLift Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Pause暂停
0x01Start执行
BackLegDownEnum8 Type​

该枚举定义 BackLegDown Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Pause暂停
0x01Start执行

Trait 定义​

Trait IDNameConformance
0x507EMassageLevelO
0x507FMassageModeO
0x5081MassageEffectO
0x5082MassageTimerO
0x5083BackrestLiftO
0x5084LegrestLiftO
0x5085BackLegLiftO
0x5086BackLegDownO

MassageLevel Trait(按摩强度)​

定义按摩功能的强度或速度档位,通常从低到高。

Trait IDCode
0x507EMassageLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMassageLevelEnum80RVWO
0x0006Supported Valuelist[MassageLevelEnum8]RO
0x0007Default ValueMassageLevelEnum80RWO

MassageMode Trait(按摩模式)​

指定按摩功能的运行模式或风格。

Trait IDCode
0x507FMassageMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMassageModeEnum80RVWO
0x0006Supported Valuelist[MassageModeEnum8]RO
0x0007Default ValueMassageModeEnum80RWO

MassageEffect Trait(按摩场景)​

指定预设按摩场景或环境,提供精选体验。

Trait IDCode
0x5081MassageEffect
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMassageEffectEnum80RVWO
0x0006Supported Valuelist[MassageEffectEnum8]RO
0x0007Default ValueMassageEffectEnum80RWO

MassageTimer Trait(按摩定时)​

指定按摩会话的目标时长或定时设置,超时后自动关闭。

Trait IDCode
0x5082MassageTimer
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMassageTimerEnum80RVWO
0x0006Supported Valuelist[MassageTimerEnum8]RO
0x0007Default ValueMassageTimerEnum80RWO

BackrestLift Trait(背部升降调节)​

控制靠背部分的调整,使其可以升高或降低以支撑用户的上半身。单位: deg。

Trait IDCode
0x5083BackrestLift
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat60.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

LegrestLift Trait(腿部升降调节)​

控制腿部支撑部分的调整,使其可以升高或降低以支撑用户的腿部。单位: deg。

Trait IDCode
0x5084LegrestLift
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat40.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

BackLegLift Trait(背腿同升)​

执行或控制靠背与腿托同时上升,实现同步抬升。

Trait IDCode
0x5085BackLegLift
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBackLegLiftEnum80RVWO
0x0006Supported Valuelist[BackLegLiftEnum8]RO
0x0007Default ValueBackLegLiftEnum80RWO

BackLegDown Trait(背腿同降)​

执行或控制靠背与腿托同时下降,将床体放平。

Trait IDCode
0x5086BackLegDown
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueBackLegDownEnum80RVWO
0x0006Supported Valuelist[BackLegDownEnum8]RO
0x0007Default ValueBackLegDownEnum80RWO

Command 定义​

Command IDNameConformance
0x80C5StopO

Stop Command​

该命令应请求设备停止当前操作。

该 Command 无参数。

TowelRackDry(毛巾架烘干)​

简介​

管理毛巾架烘干流程,控制目标温度、烘干时长,并反馈剩余时间与故障状态。

Function 标识​

Function IDCode名称
0x0108TowelRackDry毛巾架烘干

Trait​

Trait IDCode名称Conformance
0x80B8CurrentTemperature温度O
0x5087TowelRackFault毛巾架故障O
0x4E46RemainingDuration剩余时间O
0x4F85DryingDuration设置烘干时长O
0x4E5BSetTemperature设置温度O
0x5078DryingMode烘干模式O

Command​

本 Function 不包含 Command。

数据类型​

TowelRackFaultEnum8 Type​

该枚举定义 TowelRackFault Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01TemperatureSensorFault温度探头故障
0x02HeatingWireFault发热线故障(没有温升)
0x03WiFiFaultWiFi 故障
0x04ControllerFault控制器故障
DryingModeEnum8 Type​

该枚举定义 DryingMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Off关闭
0x01On打开

Trait 定义​

Trait IDNameConformance
0x80B8CurrentTemperatureO
0x5087TowelRackFaultO
0x4E46RemainingDurationO
0x4F85DryingDurationO
0x4E5BSetTemperatureO
0x5078DryingModeO

CurrentTemperature Trait(温度)​

指示当前温度。单位:deg C。

Trait IDCode
0x80B8CurrentTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat26RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat26RWO

TowelRackFault Trait(毛巾架故障)​

指示检测到的与烘干系统相关的运行错误或硬件故障。

Trait IDCode
0x5087TowelRackFault
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTowelRackFaultEnum80RVO
0x0006Supported Valuelist[TowelRackFaultEnum8]RO

RemainingDuration Trait(剩余时间)​

RemainingDuration 指阀在自动关闭之前将继续运行的剩余时,单位:S。

Trait IDCode
0x4E46RemainingDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat100000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO
0x000DIs NullbooleanFalseRVWO

DryingDuration Trait(设置烘干时长)​

设置烘干功能的持续时间。单位:S。

Trait IDCode
0x4F85DryingDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat180RVWO
0x0002Maximum Valuefloat600.0RO
0x0003Minimum Valuefloat60.0RO
0x0005Step Valuefloat60.0RO
0x0007Default Valuefloat180RWO

SetTemperature Trait(设置温度)​

SetTemperature 允许用户指定和调整设备或系统的目标温度。单位:deg C。

Trait IDCode
0x4E5BSetTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat20RVWO
0x0002Maximum Valuefloat32RO
0x0003Minimum Valuefloat5RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat20RWO

DryingMode Trait(烘干模式)​

应指示烘干模式的开关状态。

Trait IDCode
0x5078DryingMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDryingModeEnum80RVWO
0x0006Supported Valuelist[DryingModeEnum8]RO
0x0007Default ValueDryingModeEnum80RWO

Command 定义​

本 Function 不包含 Command。

Live(实时)​

简介​

控制实时视频流,支持延时摄影、变焦、休眠/唤醒及关联事件录像等增强能力。

Function 标识​

Function IDCode名称
0x0109Live实时

Trait​

Trait IDCode名称Conformance
0x4FFFCloudTimelapseInfo云端延时摄影信息O
0x50CACloseUpTrackingEnable特写跟踪使能O
0x4FC0RelatedEventRecordEnable关联事件录像使能O
0x4FC7TimelapseEnable延时摄影使能O
0x4FC8TimelapseTimePeriod延时摄影时段O
0x517ETimelapsePushEnable延时摄影推送使能O
0x51EESmartEventFilterEnable智能事件过滤使能O

Command​

Command IDCode名称Conformance
0x9D3ACameraActiveToggle摄像机休眠切换命令O

数据类型​

CameraActiveToggle Command Structure Type​

CameraActiveToggle Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M命令类型。

Trait 定义​

Trait IDNameConformance
0x4FFFCloudTimelapseInfoO
0x50CACloseUpTrackingEnableO
0x4FC0RelatedEventRecordEnableO
0x4FC7TimelapseEnableO
0x4FC8TimelapseTimePeriodO
0x517ETimelapsePushEnableO
0x51EESmartEventFilterEnableO

SmartEventFilterEnable Trait(智能事件过滤使能)​

智能事件过滤使能。开启后,摄像机会减少相似事件的重复录像与上报。首次侦测到事件时正常录制事件录像;短时间内持续发生相似事件时,将降低记录频率,以间隔抓拍的方式记录事件变化,并可在时间轴中连续查看。该 Trait 为布尔型,默认值为 0(禁用)。

Trait IDCode
0x51EESmartEventFilterEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CloudTimelapseInfo Trait(云端延时摄影信息)​

提供云端延时摄影任务信息,包括任务数量、任务 ID、激活状态、每日重复标志、起止日期、起止时间(绝对时间或相对日出/日落)及拍摄间隔。

Trait IDCode
0x4FFFCloudTimelapseInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCloudTimelapseInfoTraitPresentValueStructureRVWO

CloseUpTrackingEnable Trait(特写跟踪使能)​

启用或禁用摄像机的特写跟踪能力。开启后,检测到目标时可自动变焦放大目标区域。

Trait IDCode
0x50CACloseUpTrackingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

RelatedEventRecordEnable Trait(关联事件录像使能)​

启用或禁用关联事件(如来自其他 Zigbee/Thread 传感器)发生时的本地录像。允许由门窗传感器等外部设备触发录像。

Trait IDCode
0x4FC0RelatedEventRecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

TimelapseEnable Trait(延时摄影使能)​

启用或禁用延时摄影功能。启用后,设备按固定间隔(单独配置)拍摄图像序列并合成为视频。

Trait IDCode
0x4FC7TimelapseEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

TimelapseTimePeriod Trait(延时摄影时段)​

定义延时摄影录像生效时段的定时计划。 定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FC8TimelapseTimePeriod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTimelapseTimePeriodTraitPresentValueStructureRVWO

TimelapsePushEnable Trait(延时摄影推送使能)​

延时摄影推送使能。控制延时摄影内容是否推送。0 = 关闭,1 = 打开。

Trait IDCode
0x517ETimelapsePushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

Command IDNameConformance
0x9D3ACameraActiveToggleO

CameraActiveToggle Command​

该 Command 用于执行「摄像机休眠切换命令」操作。

参数​

CameraActiveToggle Command Structure

Playback(回放)​

交互流程​

下载本地录像索引文件​

本节描述App 通过webrtc DataChannel下载本地录像索引文件流程。 索引的粒度是天,一天最多一条。一次查询可以跨多天,响应成员 LocalRecordIndex 是这些天的列表。天数不多时 MaxCount / Cursor 通常用不上。

  • Command:LocalRecordQuery,QueryLocalRecordType=LocalRecordIndex,参数在成员 LocalRecordIndex。经 InvokeCommand 在 label aqara.control 上收发,请求 OpCode 0x008D,响应 OpCode 0x038D。
  • 响应:该 Command 的 ComplexACK。成员 0 为 Status,成员 LocalRecordIndex 为 LocalRecordIndexEntryStructure 列表。

要查一段时间就传整段区间,设备按天逐条放进响应成员 LocalRecordIndex。文件传输用的是该条的 FileDescriptor,写入 initRequest。Date 不进入传输。label aqara.download 上一次只传一个 FileDescriptor,前一个结束前不得再发 initRequest。块的交互不在本图展开。

下载本地录像文件​

本节描述App 通过webrtc DataChannel下载本地录像索引流程。 App 先下载本地录像索引文件,从索引文件中读出要取的 timestamp,再查询本地录像文件描述。

  • Command:同一条 LocalRecordQuery,QueryLocalRecordType=LocalRecordSegment,参数在成员 LocalRecordSegment,其中 Timestamps 来自索引。经 InvokeCommand 在 label aqara.control 上收发。
  • 响应:该 Command 的 ComplexACK。成员 LocalRecordSegment 与 Timestamps 等长且顺序相同,每条都是 FileDescriptorStructure。

label aqara.download 上一次只传一个 FileDescriptor,前一个结束前不得再发 initRequest。某一条 fileSize 为 0 时,跳过该条,不对它发 initRequest。块的交互不在本图展开。列表超出单条消息时,由 App 拆成多次请求。超时重发同一条查询是安全的,查询不改变设备状态。

简介​

管理录像回放与历史记录,包括云端小视频类型识别、本地录像下载能力,以及本地回放会话的状态与播放位置。回放会话由 WebRTCProvideOffer(StreamUsage=LocalPlayback)建立,暂停、继续、定位和倍速由 LocalPlaybackControl 承担。本地录像索引与录像文件描述由 LocalRecordQuery 查询。

Function 标识​

Function IDCode名称
0x010APlayback回放

Trait​

Trait IDCode名称Conformance
0x4FE9CloudClipRecordingType云端小视频录制类型O
0x4FC1SupportLocalVideoDownload是否支持本地录像下载O
0x5243LocalPlaybackStatus本地回放状态O

Command​

本 Function 的 Command 在回放会话的 aqara.control 上以 InvokeCommand 收发。

Command IDCodeConformance
0x9DB7LocalPlaybackControlO
0x9DB8LocalRecordQueryO

数据类型​

CloudClipRecordingTypeEnum8 Type​

该枚举定义 CloudClipRecordingType Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Default默认
0x01Recording录制
0x16AssociatedEvent关联事件
0x1BSecurityAssociated安防关联事件
LocalPlaybackStateEnum8 Type​
ValueNameDescription
0x00Idle未在播放
0x01Playing播放中
0x02Paused已暂停,PeerConnection 保持
0x03Eof已播到文件末尾
0x04Stopped设备侧已停止
0x05StorageUnavailableSD 卡拔出或不可读
LocalPlaybackStatusStructure Type​
结构体成员序号字段名类型必须说明
0StateLocalPlaybackStateEnum8M当前状态
1SessionIduint16OCOIP 上报或读取时携带。DataChannel 上报省略,会话由该通道确定
LocalRecordTypeEnum Type​

该枚举是按天子索引文件里每条记录的 type。App 从下载的索引文件里读取,查询响应不再带回。

ValueNameDescription
0FullRecording全时录像
1EventTriggered事件触发
2AlarmRecord告警记录
LocalPlaybackControlOpEnum8 Type​
ValueNameDescription
0x00Pause暂停。停止读帧,PeerConnection 保持
0x01Play继续播放
0x02Seek定位。Timestamp 有效
0x03Speed倍速。Speed 有效
LocalPlaybackControl Command Structure Type​

LocalPlaybackControl 的请求结构。

结构体成员序号字段名类型必须说明
0OpLocalPlaybackControlOpEnum8M操作
1Speeduint8COp=Speed 时取 1 / 2 / 4;其他 Op SHALL 省略
2Timestampuint32COp=Seek 时的目标 UTC 时间戳(秒),与索引条目里的 timestamp 对齐;其他 Op SHALL 省略
3SessionIduint16OCOIP 携带,指定要控制的回放会话。DataChannel 省略,会话由该通道确定
LocalPlaybackControlResponse Command Structure Type​

LocalPlaybackControl 的响应结构。

结构体成员序号字段名类型必须说明
0StatusStatusCodeEnum8M命令执行结果,取值见命令定义
1CurrentTimestampuint32M执行后设备端当前播放位置(秒)
录像查询​

查询只分 LocalRecordIndex 与 LocalRecordSegment。QueryLocalRecordType 指明是哪一种,请求和响应里只出现它指向的那一个成员。文件描述用 FileDescriptorStructure,由设备填写。App SHALL 把它原样写入 initRequest,SHALL NOT 用日期或时间戳自行拼接 fileDesignator。

ContentType 仍是业务约定,查询和文件传输都不携带。

LocalRecordIndex 与 LocalRecordSegment 是两级。索引列出有哪些天;段解析不负责列段。

回答对应设备上的东西
LocalRecordIndex按查询条件有哪些天的索引文件按天的子索引文件。下载后,文件里每条记录给出一段录像的 timestamp、时长和类型
LocalRecordSegment这些 timestamp 对应的录像文件设备用 timestamp 定位录像文件,回 FileDescriptorStructure

索引条目在 FileDescriptorStructure 之外另带 UTC 日期,只用于显示,不进入 initRequest。段解析的响应就是 FileDescriptorStructure。

QueryLocalRecordTypeEnum8 Type​

LocalRecordQuery 用它选定本次查询的参数和结果。与索引文件内的 LocalRecordTypeEnum 不是同一个枚举。

ValueNameDescription
0x00LocalRecordIndex查询哪些天有索引文件。参数与结果用成员 LocalRecordIndex
0x01LocalRecordSegment把索引中的 timestamp 解析成录像文件描述。参数与结果用成员 LocalRecordSegment
LocalRecordQuery Command Structure Type​

QueryLocalRecordType 决定哪一个条件成员出现。出现的成员与取值不一致,或两个条件成员都出现、都不出现,响应 Status 为 INVALID_COMMAND。Cursor 与 MaxCount 只在 QueryLocalRecordType=LocalRecordIndex 时出现。

结构体成员序号字段名类型必须说明
0TypeQueryLocalRecordTypeEnum8M本次查询种类
1IndexLocalRecordIndexQueryParamsStructureCQueryLocalRecordType=LocalRecordIndex 时出现
2SegmentLocalRecordSegmentQueryParamsStructureCQueryLocalRecordType=LocalRecordSegment 时出现
3Cursoruint16O仅 LocalRecordIndex。匹配结果中的条目序号,从 0 起。取自上一次响应的 NextCursor;省略或 0 表示从第一条开始
4MaxCountuint16O仅 LocalRecordIndex。期望的最大条目数;省略或 0 表示由设备决定
LocalRecordIndexQueryParamsStructure Type​
结构体成员序号字段名类型必须说明
0StartTimestampuint32O区间起点(UTC,秒);省略表示不限下界
1EndTimestampuint32O区间终点(UTC,秒);省略表示不限上界

两个字段都是 Unix 秒时间戳,与规范全局字段名 timestamp 同义;设备负责把它落到对应的 UTC 日。要一天就传 [当天 00:00, 次日 00:00) 这两个值。返回条目里的日期是 YYYYMMDD,取文件用的是同条里的 FileDescriptor。

FileDescriptorStructure Type​

文件传输业务交互协议 在 initRequest 之前要求取得的文件描述。字段含义以该协议的依赖一节为准。

结构体成员序号字段名类型必须说明
0fileDesignatorcharacterStringM文件引用。UTF-8 不超过 256 字节,绑定授权身份与固定版本,不得为本地绝对路径。写入 initRequest 成员 0。在 LocalRecordIndex 与 LocalRecordSegment 各自的结果里标识一个文件
1fileSizeuint64M完整长度,单位字节。为 0 时条目仍可返回,但不得对该项发 initRequest。取整个文件时作为 initRequest 的 length
2fileVersionuint32M文件版本,范围 0..4294967295。写入 initRequest 成员 1
LocalRecordIndexEntryStructure Type​
结构体成员序号字段名类型必须说明
0FileDescriptorFileDescriptorStructureM该天索引文件。取字节时写入 initRequest
1DatecharacterStringM该索引对应的 UTC 日期 YYYYMMDD,例如 &quot;20261013&quot;。只用于显示,不进入 initRequest
LocalRecordSegmentQueryParamsStructure Type​

输入来自已经下载的索引文件,不是时间窗。

结构体成员序号字段名类型必须说明
0Timestampslist[uint32]M索引条目中的 timestamp,一条或多条。空列表为非法参数

响应的 LocalRecordSegment SHALL 与请求的 Timestamps 等长,顺序一致。每一条都是 FileDescriptorStructure。

LocalRecordQuery Response Command Structure Type​

QueryLocalRecordType 回显请求中的值,并决定结果列表出现在哪一个成员。

结构体成员序号字段名类型必须说明
0StatusStatusCodeEnum8MSUCCESS 查询成功,结果列表可以为空。INVALID_COMMAND 参数不合法。INVALID_IN_STATE 存储不可用。DYNAMIC_CONSTRAINT_ERROR 游标已失效
1TypeQueryLocalRecordTypeEnum8M回显请求中的值
2Indexlist[LocalRecordIndexEntryStructure]CQueryLocalRecordType=LocalRecordIndex 时出现
3Segmentlist[FileDescriptorStructure]CQueryLocalRecordType=LocalRecordSegment 时出现。与 Timestamps 逐条对应
4NextCursoruint16O仅索引查询。下一页第一条的条目序号;省略表示已查完
5TotalCountuint16M两种查询都返回。索引查询是时间区间内的匹配条数,不受 Cursor、MaxCount 影响;段查询是本次 Timestamps 的条数

Trait 定义​

Trait IDNameConformance
0x4FE9CloudClipRecordingTypeO
0x4FC1SupportLocalVideoDownloadO
0x5243LocalPlaybackStatusO

CloudClipRecordingType Trait(云端小视频录制类型)​

指示触发的云端短视频(片段)录像类型。值 0 = 默认(未指定),1 = 录像(一般事件),22 = 关联事件(由其他传感器/设备触发),27 = 安防关联事件(例如看家报警)。该特征可被设备读取、写入并主动上报。

Trait IDCode
0x4FE9CloudClipRecordingType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCloudClipRecordingTypeEnum80RVWO
0x0006Supported Valuelist[CloudClipRecordingTypeEnum8]RO
0x0007Default Valueuint80RWO

SupportLocalVideoDownload Trait(是否支持本地录像下载)​

指示设备是否支持通过 App 从 SD 卡下载本地视频。

Trait IDCode
0x4FC1SupportLocalVideoDownload
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

LocalPlaybackStatus Trait(本地回放状态)​

回放状态与播放位置。

Trait IDCode
0x5243LocalPlaybackStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLocalPlaybackStatusStructureRVM

上报时机:状态发生变化时。在 aqara.control 上上报时省略 SessionId;经 COIP 上报或读取时携带 SessionId。

Command 定义​

Command IDNameConformance
0x9DB7LocalPlaybackControlO
0x9DB8LocalRecordQueryO

LocalPlaybackControl Command​

本地 SD 卡回放会话(StreamUsage=LocalPlayback)的播放控制。

参数​

LocalPlaybackControl Command Structure

响应​

LocalPlaybackControlResponse Command Structure,Status 取值:

Status含义
SUCCESS命令已接受
INVALID_IN_STATE会话不是回放会话
INVALID_COMMANDOp 无效或参数缺失。从 COIP 到达时未携带 SessionId 也取此值
NOT_FOUNDSessionId 不是活跃会话,或 Timestamp 无法映射到录像位置。DataChannel 上携带了与该通道不一致的 SessionId 也取此值
处理​
  • 从 aqara.control 到达时省略 SessionId,会话是该通道所属回放会话。携带了不一致的 SessionId -> 回 NOT_FOUND。从 COIP 到达时 SHALL 携带 SessionId,省略 -> 回 INVALID_COMMAND。
  • Pause 与 Play 归为一类,同类只保留最后一条;Seek 一类;Speed 一类。被覆盖的命令不再上报,但每条命令都有各自的响应。
  • Op=Seek 生效后 SHALL 从新位置送出关键帧。

LocalRecordQuery Command​

查询本地录像索引,并把索引里的 timestamp 解析成录像文件描述。本 Command 属于 Playback Function,经 InvokeCommand 在回放会话的 aqara.control 上收发。

  • 请求 OpCode 0x008D。objectIdentifier 填承载 Playback Function 的对象。propertyIdentifier 为本 Command 的 Command ID。propertyValue 为 LocalRecordQuery Command Structure。source 与其它命令相同。
  • 响应 OpCode 0x038D。propertyValue 为 LocalRecordQuery Response Command Structure,成员 0 为 Status。参数不合法、存储不可用、游标失效都留在这条 ComplexACK 里。

QueryLocalRecordType=LocalRecordIndex 时走成员 LocalRecordIndex,有界(MaxCount + Cursor),一问一答,没有过程通知。QueryLocalRecordType=LocalRecordSegment 时走成员 LocalRecordSegment,没有游标:请求给出哪些 timestamp,响应就按同样顺序回哪些文件描述。两种查询都返回 TotalCount。

参数​

LocalRecordQuery Command Structure

响应​

LocalRecordQuery Response Command Structure

流程见 下载录像索引文件 与 下载录像文件。

分页规则​

分页只用于 LocalRecordIndex。LocalRecordSegment 的范围就是请求里的 Timestamps。

维度参数回答
范围LocalRecordIndex 的时间戳区间(StartTimestamp / EndTimestamp)要哪些天的索引
分页MaxCount / Cursor这一次响应装多少条索引。TotalCount 是整个区间的条数
  • Cursor 与 NextCursor 是匹配结果中的条目序号,从 0 起,不是时间。App SHALL 只回传上一次响应里的 NextCursor,SHALL NOT 用 Date 或时间戳自行计算。
  • TotalCount 两种查询都返回。索引查询是该时间区间的匹配条数;段查询是本次 Timestamps 的条数。循环覆盖时,索引查询后一页的值可以与前一页不同。是否查完看 NextCursor。
  • 一次响应 SHALL NOT 超过承载单条消息的上限。设备在给定 MaxCount 之外 SHALL 继续按这个上限收敛。
  • NextCursor 省略表示查询已结束;LocalRecordIndex 为空且带 NextCursor 是合法的(该页被过滤条件排空)。
  • 游标失效时 SHALL 回 Status = DYNAMIC_CONSTRAINT_ERROR,App 从头重查。
  • 跨页期间循环录像可能已覆盖旧数据,条目可能重复或缺失。设备 SHOULD 在游标生存期内保证结果一致;做不到时由 App 按 fileDesignator 去重。
  • 空洞重取式的重复查询 SHOULD 遵守最小间隔(现网对索引查询取 500 ms)。

CloudRecording(云录像)​

简介​

控制云端录像总开关,决定是否将视频内容上传至云存储。

Function 标识​

Function IDCode名称
0x010BCloudRecording云录像

Trait​

Trait IDCode名称Conformance
0x5026CloudRecordingEnable录制云端视频总使能O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x5026CloudRecordingEnableO

CloudRecordingEnable Trait(录制云端视频总使能)​

启用或禁用事件云端录像的总开关。

Trait IDCode
0x5026CloudRecordingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

CameraSettings(更多设置)​

简介​

提供摄像机扩展配置,如定时上传图片、RTSP 流媒体及高级功能开关。

Function 标识​

Function IDCode名称
0x010CCameraSettings更多设置

Trait​

Trait IDCode名称Conformance
0x5028PeriodicSnapshotUploadEnable定时上传图片使能O
0x5249PeriodicSnapshotInterval定时抓拍时间间隔O
0x4F91CameraRTSPEnable摄像机RTSP使能O
0x4F90CameraRTSPURL摄像头RTSP地址O
0x5171ClientKeepAliveReq客户端保活请求O
0x5180VideoAutoBrightSupport支持视频亮度自动调节O
0x5181IrcutThresholdIR‑Cut 切换阈值O

Command​

本 Function 不包含 Command。

数据类型​

PeriodicSnapshotIntervalEnum8 Type​

该枚举定义 PeriodicSnapshotInterval Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Auto自动
0x01Minutes1010 分钟
0x02Minutes3030 分钟
0x03Minutes6060 分钟
0x04Minutes120120 分钟
0x05Minutes240240 分钟

ClientKeepAliveReqEnum8 Type​

该枚举定义 ClientKeepAliveReq Trait 的 Present Value 有效取值。

ValueKey中文名称Description
0x01KeepAlive保活请求客户端保活请求。

Trait 定义​

Trait IDNameConformance
0x5028PeriodicSnapshotUploadEnableO
0x5249PeriodicSnapshotIntervalO
0x4F91CameraRTSPEnableO
0x4F90CameraRTSPURLO
0x5171ClientKeepAliveReqO
0x5180VideoAutoBrightSupportO
0x5181IrcutThresholdO

PeriodicSnapshotUploadEnable Trait(定时上传图片使能)​

启用或禁用定期快照上传至云端。实现 PeriodicSnapshotInterval 时,抓拍间隔由该 Trait 配置;未实现时保持每 10 分钟上传一帧的行为。

Trait IDCode
0x5028PeriodicSnapshotUploadEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

PeriodicSnapshotInterval Trait(定时抓拍时间间隔)​

设备侧定时抓拍时间间隔。启用 PeriodicSnapshotUploadEnable 后可配置并生效,替代固定每 10 分钟抓拍一帧的间隔。0 表示由设备自动决定间隔,非零值按枚举指定的间隔执行。默认值为 0,可读、可写、可上报。

Trait IDCode
0x5249PeriodicSnapshotInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePeriodicSnapshotIntervalEnum80RVWO
0x0006Supported Valuelist[PeriodicSnapshotIntervalEnum8]RO
0x0007Default ValuePeriodicSnapshotIntervalEnum80RWO

CameraRTSPEnable Trait(摄像机RTSP使能)​

指示摄像头 RTSP(Real Time Streaming Protocol)启用开关配置。启用时允许通过 RTSP 协议访问实时视频流;禁用时禁止 RTSP 访问。

Trait IDCode
0x4F91CameraRTSPEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CameraRTSPURL Trait(摄像头RTSP地址)​

指示摄像头的 RTSP(Real Time Streaming Protocol)URL,用于通过 RTSP 协议访问实时视频流。该属性返回 JSON 对象,键为分辨率标识(如 "360p"、"720p"、"1080p"、"4mp"),值为对应完整 RTSP URL 字符串。示例格式如下:{"360p": "rtsp://192.168.1.109:8554/360p","720p": "rtsp://192.168.1.109:8554/720p","1080p": "rtsp://192.168.1.109:8554/1080p","4mp": "rtsp://192.168.1.109:8554/4mp"}

Trait IDCode
0x4F90CameraRTSPURL
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVO

ClientKeepAliveReq Trait(客户端保活请求)​

客户端(APP)向低功耗设备发送的保活请求,用于防止设备在设置过程中休眠。设备收到后应重置休眠计时器。

Trait IDCode
0x5171ClientKeepAliveReq
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueClientKeepAliveReqEnum8RVWO
0x0007Default ValueClientKeepAliveReqEnum81RWO

VideoAutoBrightSupport Trait(支持视频亮度自动调节)​

支持视频亮度自动调节。用于标识设备是否支持自动调节视频亮度。0 = 不支持,1 = 支持。

Trait IDCode
0x5180VideoAutoBrightSupport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVO
0x0007Default Valueboolean1RWO

IrcutThreshold Trait(IR‑Cut 切换阈值)​

IR-Cut 切换阈值。用于控制红外滤光片的切换。

Trait IDCode
0x5181IrcutThreshold
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint850RVWO
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint80RO
0x0007Default Valueuint850RWO

Command 定义​

本 Function 不包含 Command。

AIDetection(AI 侦测)​

简介​

执行 AI 驱动的图像与音频分析,实现事件检测、内容识别及智能告警。

Function 标识​

Function IDCode名称
0x010DAIDetectionAI 侦测

Trait​

Trait IDCode名称Conformance
0x507CLensObstructionDetected镜头遮挡侦测事件O
0x4FE0LensObstructionPushEnable镜头遮挡推送使能O
0x4FDFLensObstructionTimePeriod镜头遮挡侦测时段O
0x4FDELensObstructionEnable镜头遮挡使能O
0x4FFCLensObstructionRecordEnable镜头遮挡录像使能O
0x4FFDLensObstructionInterval镜头遮挡侦测间隔O
0x4FFBLensObstructionSensitivity镜头遮挡侦测灵敏度O
0x5191LensObstructionBitmaskRegion镜头遮挡区域设置O
0x4FC3AIVideoSummaryEnableAI视频摘要使能O
0x4FC2AIVideoSearchEnableAI视频搜索使能O

Command​

本 Function 不包含 Command。

数据类型​

LensObstructionDetectedEnum8 Type​

该枚举定义 LensObstructionDetected Trait 的 Present Value 有效取值。

ValueNameDescription
0x01Detected侦测到镜头遮挡
LensObstructionTimePeriodTraitPresentValueStructure Type​

该结构体定义 LensObstructionTimePeriod Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0starttimecharacterStringM开始时间,格式为 HH:MM(24 小时制)。
1endtimecharacterStringM结束时间,格式为 HH:MM(24 小时制)。
2repeatarray[uint32]M长度固定为 7 的星期重复标志,顺序为 Sunday 到 Saturday;1 表示生效,0 表示不生效。
LensObstructionBitmaskRegionTraitPresentValueStructure Type​

该结构体定义 LensObstructionBitmaskRegion Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0detect_regioncharacterStringM十六进制字符串形式的位掩码,每一位对应一个网格单元。
1effective_bitsint32M位掩码中的有效 bit 数,超过该数量的 bit 应被忽略。
LensObstructionSensitivityEnum8 Type​

该枚举定义 LensObstructionSensitivity Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Lowest最低
0x01Low低
0x02Medium中
0x03High高
0x04Highest最高

Trait 定义​

Trait IDNameConformance
0x507CLensObstructionDetectedO
0x4FE0LensObstructionPushEnableO
0x4FDFLensObstructionTimePeriodO
0x4FDELensObstructionEnableO
0x4FFCLensObstructionRecordEnableO
0x4FFDLensObstructionIntervalO
0x4FFBLensObstructionSensitivityO
0x5191LensObstructionBitmaskRegionO
0x4FC3AIVideoSummaryEnableO
0x4FC2AIVideoSearchEnableO

LensObstructionDetected Trait(镜头遮挡侦测事件)​

表示摄像头镜头被遮挡(部分或完全)的事件 Trait。设备检测到镜头被遮挡时,以值 1 上报该 Trait。

Trait IDCode
0x507CLensObstructionDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLensObstructionDetectedEnum81VO
0x0006Supported Valuelist[LensObstructionDetectedEnum8]RO

LensObstructionPushEnable Trait(镜头遮挡推送使能)​

启用或禁用镜头遮挡事件的推送通知。启用后,镜头被遮挡时用户将收到告警。

Trait IDCode
0x4FE0LensObstructionPushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

LensObstructionTimePeriod Trait(镜头遮挡侦测时段)​

定义镜头遮挡检测生效的时间段。计划配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式字符串(24 小时制),范围 "00:00" 至 "23:59",定义生效时段的起止时间。若两者相等,则全天有效。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日 starttime 开始至次日 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次为周日、周一、周二、周三、周四、周五、周六。值为 1 表示该星期几生效,0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FDFLensObstructionTimePeriod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLensObstructionTimePeriodTraitPresentValueStructureRVWO

LensObstructionEnable Trait(镜头遮挡使能)​

启用或禁用镜头遮挡检测功能。启用后,摄像头监测镜头是否部分或完全遮挡,并可相应触发事件、录像或通知。

Trait IDCode
0x4FDELensObstructionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

LensObstructionRecordEnable Trait(镜头遮挡录像使能)​

启用或禁用检测到镜头遮挡时的本地录像。

Trait IDCode
0x4FFCLensObstructionRecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

LensObstructionInterval Trait(镜头遮挡侦测间隔)​

连续镜头遮挡检测触发之间的时间间隔(秒)。

Trait IDCode
0x4FFDLensObstructionInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint16180RVWO
0x0002Maximum Valueuint1665535RO
0x0003Minimum Valueuint160RO
0x0005Step Valueuint321RO
0x0007Default Valueuint16180RWO

LensObstructionSensitivity Trait(镜头遮挡侦测灵敏度)​

该trait用于配置镜头遮挡检测的灵敏度等级。有效取值为 0、1、2、3、4,分别对应最低、低、中、高和最高灵敏度。较高灵敏度使功能对触发条件更敏感(如更易检测弱信号或小目标);较低灵敏度需更明显的触发才会响应。

Trait IDCode
0x4FFBLensObstructionSensitivity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLensObstructionSensitivityEnum81RVWO
0x0006Supported Valuelist[LensObstructionSensitivityEnum8]RO
0x0007Default Valueuint81RWO

LensObstructionBitmaskRegion Trait(镜头遮挡区域设置)​

表示镜头遮挡侦测区域的设置。基于网格掩码定义区域配置。包含两个字段:detect_region(十六进制字符串)和 effective_bits(整数)。十六进制字符串中的每一位对应一个网格单元(例如将画面划分为 24 个单元)。位值为 1 表示对应单元启用检测或识别功能,0 表示禁用。位的排列遵循预定义顺序(例如从左到右或从最高位到最低位)。effective_bits 字段指定十六进制字符串中实际有效的位数,使字符串可保持固定长度而仅前 N 位有意义。例如 "FF" 表示连续 8 位均为 1。若 effective_bits 为 32,则全部 32 位有效;若为 24,则仅前 24 位有效。

Trait IDCode
0x5191LensObstructionBitmaskRegion
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLensObstructionBitmaskRegionTraitPresentValueStructureRVWO

AIVideoSummaryEnable Trait(AI视频摘要使能)​

启用或禁用 AI 视频摘要生成。AI 提取关键时刻(事件)并合成为短视频摘要。

Trait IDCode
0x4FC3AIVideoSummaryEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AIVideoSearchEnable Trait(AI视频搜索使能)​

启用或禁用 AI 视频搜索功能。启用后,用户可按对象类型(如人、车辆、包裹)搜索录像。

Trait IDCode
0x4FC2AIVideoSearchEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

VideoSettings(视频设置)​

简介​

管理图像处理与画面呈现,包括画质、水印、隐私遮挡、夜视及补光灯联动。

Function 标识​

Function IDCode名称
0x010EVideoSettings视频设置

Trait​

Trait IDCode名称Conformance
0x5019AIDetectionBoxEnable显示识别框使能O
0x5000HdrEnableHDR使能O
0x4FD0VideoCorrectionEnable视频矫正使能O
0x4FCEOSDTimeFormatSetting时间水印格式设置O
0x4FCFImageFlipMode画面翻转O
0x4FCBOSDWatermarkEnableOSD时间水印使能O
0x4FCAInfraredNightVisionSetting夜视设置O
0x5018PrivacyMaskRegions隐私遮挡区域O
0x5017PowerFrequency电源频率O
0x4FB0LogoWatermarkEnableLogo水印使能O
0x4FDBWhiteLightDuration白光灯持续时长O
0x4FDAEventLightingMode事件触发亮灯模式O
0x4FBFLightingTimePeriod亮灯时段O
0x4FBELightUpWhenEventDetected侦测到事件时亮灯O
0x5014WhiteLightOnOff白光补光灯开关O
0x5016WhiteLightBrightness白光灯设置亮度O
0x50E0VideoBrightnessRange视频亮度范围设置O

Command​

Command IDCode名称Conformance
0x9D3EWhiteLightToggle白光灯状态切换控制O

数据类型​

ImageFlipModeEnum8 Type​

该枚举定义 ImageFlipMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01HorizontalFlip水平翻转
0x02VerticalFlip垂直翻转
0x03HorizontalVerticalFlip水平垂直翻转
InfraredNightVisionSettingEnum8 Type​

该枚举定义 InfraredNightVisionSetting Trait 的 Present Value 有效取值。

ValueNameDescription
0x00AlwaysOff一直关闭
0x01AlwaysOn一直开启
0x02Auto自动切换
0x03WarmColorFullColor暖光全彩
PowerFrequencyEnum8 Type​

该枚举定义 PowerFrequency Trait 的 Present Value 有效取值。

ValueNameDescription
0x0050Hz50Hz
0x0160Hz60Hz
EventLightingModeEnum8 Type​

该枚举定义 EventLightingMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Steady常亮
0x01Blink闪烁
VideoBrightnessRangeTraitPresentValueStructure Type​

该结构体定义 VideoBrightnessRange Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0Modeuint8M亮度调节模式:0=自动,1=手动。
1ColorBrightnessuint16O彩色视频亮度百分比,范围 1-100;在手动模式下应提供。
2MonoBrightnessuint16O黑白视频亮度百分比,范围 1-100;在手动模式下应提供。
WhiteLightToggle Command Structure Type​

WhiteLightToggle Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M命令类型。

Trait 定义​

Trait IDNameConformance
0x5019AIDetectionBoxEnableO
0x5000HdrEnableO
0x4FD0VideoCorrectionEnableO
0x4FCEOSDTimeFormatSettingO
0x4FCFImageFlipModeO
0x4FCBOSDWatermarkEnableO
0x4FCAInfraredNightVisionSettingO
0x5018PrivacyMaskRegionsO
0x5017PowerFrequencyO
0x4FB0LogoWatermarkEnableO
0x4FDBWhiteLightDurationO
0x4FDAEventLightingModeO
0x4FBFLightingTimePeriodO
0x4FBELightUpWhenEventDetectedO
0x5014WhiteLightOnOffO
0x5016WhiteLightBrightnessO
0x50E0VideoBrightnessRangeO

AIDetectionBoxEnable Trait(显示识别框使能)​

启用或禁用在实时预览中绘制 AI 检测边界框(如人、宠物)。

Trait IDCode
0x5019AIDetectionBoxEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

HdrEnable Trait(HDR使能)​

启用或禁用 HDR(High Dynamic Range,高动态范围)功能。启用后,设备在逆光或高对比度场景中改善画质,保留亮部和暗部细节,画面更清晰自然。

Trait IDCode
0x5000HdrEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

VideoCorrectionEnable Trait(视频矫正使能)​

开启/关闭镜头畸变校正。启用时,设备应用变形校正以拉直广角镜头造成的弯曲边缘(改善图像几何形状但可能裁切视场)。

Trait IDCode
0x4FD0VideoCorrectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

OSDTimeFormatSetting Trait(时间水印格式设置)​

指定 OSD 水印中显示日期和时间的格式字符串。采用与 strftime 兼容的格式说明符(例如 %Y 表示年,%m 表示月,%d 表示日,%H 表示时,%M 表示分,%S 表示秒)。

Trait IDCode
0x4FCEOSDTimeFormatSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

ImageFlipMode Trait(画面翻转)​

控制视频画面是否垂直翻转(180 deg 旋转)。设置为 Flip (1) 时,画面上下颠倒,适用于吊顶或倒装场景;设置为 Normal (0) 时,画面方向为标准方向。

Trait IDCode
0x4FCFImageFlipMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueImageFlipModeEnum80RVWO
0x0006Supported Valuelist[ImageFlipModeEnum8]RO
0x0007Default Valueuint80RWO

OSDWatermarkEnable Trait(OSD时间水印使能)​

控制是否在实时预览和录像中叠加时间戳。启用后,当前日期和时间将显示在视频画面的指定位置,便于查看者准确识别事件发生时间。

Trait IDCode
0x4FCBOSDWatermarkEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

InfraredNightVisionSetting Trait(夜视设置)​

设置摄像头夜视模式。AlwaysOff:IR cut 和照明器关闭;AlwaysOn:IR cut 开启(黑白)且 IR LED 开启;Auto:根据光照切换;WarmColorFullColor:使用暖白光实现全彩夜视。

Trait IDCode
0x4FCAInfraredNightVisionSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueInfraredNightVisionSettingEnum82RVWO
0x0006Supported Valuelist[InfraredNightVisionSettingEnum8]RO
0x0007Default Valueuint82RWO

PrivacyMaskRegions Trait(隐私遮挡区域)​

定义视频帧中用于保护隐私的遮罩区域。其值为包含 visible 和 regions 两个字段的结构体。visible 为布尔值或整数(0 或 1),表示是否在实时预览中显示遮罩区域轮廓(用于调试或确认,不影响实际遮罩效果)。regions 为最多 4 个遮罩对象的数组。每个遮罩对象包含 color 和 rect。color 为整数(十进制),表示遮罩块的 RGB 颜色(例如 0xRRGGBB 的十进制形式,高字节为红、中字节为绿、低字节为蓝)。rect 为四个整数组成的数组,指定边界矩形:左坐标、上坐标、宽度、高度。坐标原点在图像左上角,X 轴向右递增,Y 轴向下递增。该配置同时适用于实时视频和录像流,遮罩在设备端执行,以确保隐私敏感内容不被还原。

Trait IDCode
0x5018PrivacyMaskRegions
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePrivacyMaskRegionsTraitPresentValueStructureRVWO

PowerFrequency Trait(电源频率)​

设置电源线频率以避免闪烁(50Hz 或 60Hz)。

Trait IDCode
0x5017PowerFrequency
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePowerFrequencyEnum80RVWO
0x0006Supported Valuelist[PowerFrequencyEnum8]RO
0x0007Default Valueuint80RWO

LogoWatermarkEnable Trait(Logo水印使能)​

启用或禁用视频品牌 Logo 水印叠加。启用后,设备将在视频文件中嵌入固定 Logo 图像。

Trait IDCode
0x4FB0LogoWatermarkEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

WhiteLightDuration Trait(白光灯持续时长)​

设置白光(补光灯)触发后保持点亮的持续时间。值为 0 表示持续点亮(常亮)。1 至 1800 表示自动关闭前保持的秒数。

Trait IDCode
0x4FDBWhiteLightDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVWO
0x0002Maximum Valueuint321800RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint3230RWO

EventLightingMode Trait(事件触发亮灯模式)​

定义设备检测到事件时指示灯/照明灯的行为。Steady:灯持续常亮;Blink:灯反复闪烁。

Trait IDCode
0x4FDAEventLightingMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueEventLightingModeEnum80RVWO
0x0006Supported Valuelist[EventLightingModeEnum8]RO
0x0007Default Valueuint80RWO

LightingTimePeriod Trait(亮灯时段)​

定义事件触发照明功能生效时段的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x4FBFLightingTimePeriod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueLightingTimePeriodTraitPresentValueStructureRVWO
0x0007Default ValueLightingTimePeriodTraitPresentValueStructure若按照 JSON方式来表示默认值,则默认值取值为:{"0":"00:00","1":"23:59","2":[1,1,1,1,1,1,1]}RWO

LightUpWhenEventDetected Trait(侦测到事件时亮灯)​

在计划时段内检测到事件(如移动、人形检测)时,启用白光灯亮 20 秒。用作视觉威慑或照明。

Trait IDCode
0x4FBELightUpWhenEventDetected
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean0RWO

WhiteLightOnOff Trait(白光补光灯开关)​

控制白色补光灯的总开关。切换可改变当前状态。

Trait IDCode
0x5014WhiteLightOnOff
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

WhiteLightBrightness Trait(白光灯设置亮度)​

设置白光亮度等级,范围 1% 至 100%。

Trait IDCode
0x5016WhiteLightBrightness
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat1.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

VideoBrightnessRange Trait(视频亮度范围设置)​

配置彩色(日间)和黑白(夜间)视频亮度参数,并支持自动/手动两种调节模式。

Trait IDCode
0x50E0VideoBrightnessRange
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVideoBrightnessRangeTraitPresentValueStructureRVWO

Command 定义​

Command IDNameConformance
0x9D3EWhiteLightToggleO

WhiteLightToggle Command​

该 Command 用于执行「白光灯状态切换控制」操作。

参数​

WhiteLightToggle Command Structure

CameraWorkMode(摄像机工作模式)​

简介​

定义摄像机功耗策略与工作模式,适配不同电源类型与使用场景。

Function 标识​

Function IDCode名称
0x010FCameraWorkMode摄像机工作模式

Trait​

Trait IDCode名称Conformance
0x4FD9ActiveWakeupInterval主动唤醒间隔O
0x4FD8CamWorkMode摄像机工作模式O
0x4FD6AOVRecordingEnableAOV录像使能O
0x4FD3RangeTestMode进入测距测试模式O

Command​

本 Function 不包含 Command。

数据类型​

CamWorkModeEnum8 Type​

该枚举定义 CamWorkMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00PowerSaving省电模式
0x01SuperPowerSaving超级省电模式
0x02MainsPower常电模式
0x03AOV智能监护模式(AOV)

Trait 定义​

Trait IDNameConformance
0x4FD9ActiveWakeupIntervalO
0x4FD8CamWorkModeO
0x4FD6AOVRecordingEnableO
0x4FD3RangeTestModeO

ActiveWakeupInterval Trait(主动唤醒间隔)​

配置在AOV (始终在线视频)智能监控模式下操作时电池供电摄像头的主动唤醒间隔。设备以此间隔(以秒为单位)定期唤醒以捕获帧以进行事件检测。例如,设置为3意味着相机每3秒唤醒一次,以检查运动或事件。

Trait IDCode
0x4FD9ActiveWakeupInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint323RVWO
0x0002Maximum Valueuint3265535RO
0x0003Minimum Valueuint321RO
0x0005Step Valueuint321RO
0x0007Default Valueuint323RWO

CamWorkMode Trait(摄像机工作模式)​

定义摄像头在功耗与功能方面的工作模式。PowerSaving:降低性能以延长电池续航;SuperPowerSaving:最大省电,功能受限;MainsPower:常供电(AC/DC)下全性能运行;AOV:Always-On Video 低功耗智能监控模式。

Trait IDCode
0x4FD8CamWorkMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCamWorkModeEnum80RVWO
0x0006Supported Valuelist[CamWorkModeEnum8]RO
0x0007Default Valueuint80RWO

AOVRecordingEnable Trait(AOV录像使能)​

启用或禁用 AOV(Always-On Video)录像功能。启用后,设备持续录像以确保不遗漏关键时刻。

Trait IDCode
0x4FD6AOVRecordingEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

RangeTestMode Trait(进入测距测试模式)​

启用摄像头检测距离配置的测距测试模式。该模式下,检测到目标时设备发出提示(如白光灯闪三次),指示当前距离设置的有效范围。

Trait IDCode
0x4FD3RangeTestMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

AudioSettings(声音设置)​

简介​

控制音频采集与输出,调节录制静音及系统提示音量等参数。

Function 标识​

Function IDCode名称
0x0110AudioSettings声音设置

Trait​

Trait IDCode名称Conformance
0x4FD1RecordingMuteEnable无声录制使能O
0x80C0Volume音量O
0x5182QuickReplyTotalCapacity自定义快捷回复总容量O
0x5183QuickReplyPresetVoice快捷回复预设语音O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x4FD1RecordingMuteEnableO
0x80C0VolumeO
0x5182QuickReplyTotalCapacityO
0x5183QuickReplyPresetVoiceO

RecordingMuteEnable Trait(无声录制使能)​

确定录像时是否同时录制音频。设置为 1(静音)时,录像文件不保存音频;为 0 时包含音频。

Trait IDCode
0x4FD1RecordingMuteEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Volume Trait(音量)​

指示或设置摄像头设备扬声器音量(如双向语音)。值通常为百分比(0 至 100)或设备定义的数值范围。

Trait IDCode
0x80C0Volume
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

QuickReplyTotalCapacity Trait(自定义快捷回复总容量)​

自定义快捷回复总容量。用于记录自定义快捷回复/自定义铃声中用户保存到设备的所有音频文件总容量上限,单位 MB。

Trait IDCode
0x5182QuickReplyTotalCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint86RVWO
0x0002Maximum Valueuint8100RO
0x0003Minimum Valueuint80RO
0x0007Default Valueuint86RWO

QuickReplyPresetVoice Trait(快捷回复预设语音)​

快捷回复预设语音。用于标识预设快捷回复语音的语言和索引。

Trait IDCode
0x5183QuickReplyPresetVoice
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

Command 定义​

本 Function 不包含 Command。

CameraPrivacySecurity(摄像机隐私与安全)​

简介​

聚焦摄像机隐私策略,包括定时休眠等低功耗安防隐私保护能力。

Function 标识​

Function IDCode名称
0x0111CameraPrivacySecurity摄像机隐私与安全

Trait​

Trait IDCode名称Conformance
0x501BScheduledSleepTimePeriod定时休眠时段O
0x501AScheduledSleepEnable定时休眠使能O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x501BScheduledSleepTimePeriodO
0x501AScheduledSleepEnableO

ScheduledSleepTimePeriod Trait(定时休眠时段)​

定义设备应进入睡眠模式的时段定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x501BScheduledSleepTimePeriod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueScheduledSleepTimePeriodTraitPresentValueStructureRVWO

ScheduledSleepEnable Trait(定时休眠使能)​

启用或禁用计划睡眠模式。

Trait IDCode
0x501AScheduledSleepEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

CameraNotifications(摄像机通知)​

简介​

管理事件通知策略,支持通知类型、计划时段、过滤规则及重要等级设置。

Function 标识​

Function IDCode名称
0x0112CameraNotifications摄像机通知

Trait​

Trait IDCode名称Conformance
0x4FC9CameraAdvancedEventNotificationSettings摄像机高级事件通知设置O
0x5012CameraAdvancedEventNotificationEnable摄像机高级事件通知使能O
0x5010CameraNotificationSchedulePeriods摄像机通知计划-时段O
0x5011CameraFilterUnimportantNotifications摄像机过滤不重要的通知使能O
0x500FCameraNotificationScheduleEnable摄像机通知计划使能O
0x500ECameraNotificationType摄像机通知类型O
0x5013CameraEventImportanceLevel摄像机事件重要等级级别O
0x516APicturePushEnable图片推送使能O

Command​

本 Function 不包含 Command。

数据类型​

CameraNotificationTypeEnum8 Type​

该枚举定义 CameraNotificationType Trait 的 Present Value 有效取值。

ValueNameDescription
0x01EventNotification事件通知
0x02AIVideoSummaryAI视频摘要通知

Trait 定义​

Trait IDNameConformance
0x4FC9CameraAdvancedEventNotificationSettingsO
0x5012CameraAdvancedEventNotificationEnableO
0x5010CameraNotificationSchedulePeriodsO
0x5011CameraFilterUnimportantNotificationsO
0x500FCameraNotificationScheduleEnableO
0x500ECameraNotificationTypeO
0x5013CameraEventImportanceLevelO
0x516APicturePushEnableO

CameraAdvancedEventNotificationSettings Trait(摄像机高级事件通知设置)​

配置摄像机发送通知的高级事件集。该值是一个由事件类型编号组成的字符串,由垂直条(|)分隔,例如"39 | 40 | 111 | 108"。每个数字对应于以下列出的特定事件类型。只有数字包含在字符串中的事件才会触发通知。Value Event Description (英文) 1 运动检测 2 人形 3 有猫或狗在场 4 人类游荡 5 按下门铃 6 篡改警报 7 家庭成员认可 8 陌生人认出 9 异常哭泣 10 哭泣 11 咳嗽 12 报警声音 13 狗叫声 14 镜头被挡住 15 检测到包裹 16个 包裹消失 17 车辆存在 32 婴儿床 33 婴儿推车 38 玩具车 39 面罩/口罩 40 口鼻遮盖 46 拿着手机 48 人fallen 50 人攀岩 53 人吸烟 56 戴帽子 58 狗 59 猫 60 饮用水 61 进食 62 使用马桶 63 动物 64 宠物 65 鸟 66 熊 67 棕熊 68 松鼠 69 兔子 70 鹿 71 驯鹿

Trait IDCode
0x4FC9CameraAdvancedEventNotificationSettings
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

CameraAdvancedEventNotificationEnable Trait(摄像机高级事件通知使能)​

启用或禁用高级事件通知(如详细 AI 事件告警)。

Trait IDCode
0x5012CameraAdvancedEventNotificationEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CameraNotificationSchedulePeriods Trait(摄像机通知计划-时段)​

定义允许通知时段的定时计划。定时配置结构包含三个字段:starttime、endtime 和 repeat。starttime 和 endtime 为 "HH:MM" 格式(24 小时制)的字符串,范围从 "00:00" 到 "23:59",定义生效时段的起止时间。若两者相等,则时段覆盖全天。当 starttime 小于 endtime 时,时段在同一天内;当 starttime 大于 endtime 时,时段跨越午夜,从生效日的 starttime 开始至次日的 endtime 结束。repeat 为长度为 7 的无符号 8 位整数数组,索引顺序依次对应周日、周一、周二、周三、周四、周五、周六。值为 1 表示该工作日生效,为 0 表示不生效。所有时间基于设备当前时区。

Trait IDCode
0x5010CameraNotificationSchedulePeriods
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCameraNotificationSchedulePeriodsTraitPresentValueStructureRVWO

CameraFilterUnimportantNotifications Trait(摄像机过滤不重要的通知使能)​

启用或禁用不重要通知过滤,以减少干扰。

Trait IDCode
0x5011CameraFilterUnimportantNotifications
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CameraNotificationScheduleEnable Trait(摄像机通知计划使能)​

启用或禁用通知计划功能。

Trait IDCode
0x500FCameraNotificationScheduleEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

CameraNotificationType Trait(摄像机通知类型)​

指定要接收的通知类型:事件通知或 AI 视频摘要通知。

Trait IDCode
0x500ECameraNotificationType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueCameraNotificationTypeEnum81RVWO
0x0006Supported Valuelist[CameraNotificationTypeEnum8]RO
0x0007Default ValueCameraNotificationTypeEnum81RWO

CameraEventImportanceLevel Trait(摄像机事件重要等级级别)​

设置事件通知的最低重要级别。仅 level >= 该值的事件触发通知。

Trait IDCode
0x5013CameraEventImportanceLevel
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint82RVWO
0x0002Maximum Valueuint85RO
0x0003Minimum Valueuint81RO
0x0005Step Valueuint321RO
0x0007Default Valueuint82RWO

PicturePushEnable Trait(图片推送使能)​

图片推送使能。控制报警消息中是否附带抓拍图片推送。当设置为 1(开启)时,设备在触发报警时会将当前抓拍图片随报警消息一起推送给用户;当设置为 0(关闭)时,报警消息不附带图片。默认值为 0。

Trait IDCode
0x516APicturePushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

NASStorage(NAS 存储)​

简介​

与网络附加存储(NAS)集成,提供绑定、策略配置、传输间隔及状态管理。

Function 标识​

Function IDCode名称
0x0113NASStorageNAS 存储

Trait​

Trait IDCode名称Conformance
0x507BNASServerBindingStatusNAS服务器绑定状态O
0x4FE4NASLastWriteTimestampNAS最后写入时间戳O
0x5025SetNASSharedFolder设置共享文件夹O
0x5024NASSharedFoldersList获取共享文件夹列表O
0x5023NASServersList获取NAS服务器列表O
0x502CNASStorageDurationNAS存储时长O
0x502BNASTransferIntervalNAS传输间隔O
0x5021NASStorageEnableNAS存储使能O
0x5022NASWorkModeNAS工作模式O
0x5020NASVerificationResultNAS验证结果O
0x501ESetNASServers设置NAS服务器O
0x501FNASStatusNAS状态O

Command​

Command IDCode名称Conformance
0x9D45DeleteNASServer删除NAS服务器O
0x9D3CNASClearHistoryVideos清除NAS历史视频O

数据类型​

NASServerBindingStatusEnum8 Type​

该枚举定义 NASServerBindingStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Unbound解绑
0x01Bound绑定成功
NASWorkModeEnum8 Type​

该枚举定义 NASWorkMode Trait 的 Present Value 有效取值。

ValueNameDescription
0x00TranscodeFromSD从本地存储卡转存
0x01DirectUpload直接上传NAS
NASVerificationResultEnum8 Type​

该枚举定义 NASVerificationResult Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Failed验证失败
0x01Success验证成功
NASStatusEnum8 Type​

该枚举定义 NASStatus Trait 的 Present Value 有效取值。

ValueNameDescription
0x00Normal正常
0x01Transferring传输中
0x02Paused暂停传输
0x03Clearing清除视频中
0x04Error出错
DeleteNASServer Command Structure Type​

DeleteNASServer Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Statusenum8M状态;默认值为 0。
NASClearHistoryVideos Command Structure Type​

NASClearHistoryVideos Command 的参数结构体。

结构体成员序号字段名类型必须说明
0Typeenum8M命令类型。

Trait 定义​

Trait IDNameConformance
0x507BNASServerBindingStatusO
0x4FE4NASLastWriteTimestampO
0x5025SetNASSharedFolderO
0x5024NASSharedFoldersListO
0x5023NASServersListO
0x502CNASStorageDurationO
0x502BNASTransferIntervalO
0x5021NASStorageEnableO
0x5022NASWorkModeO
0x5020NASVerificationResultO
0x501ESetNASServersO
0x501FNASStatusO

NASServerBindingStatus Trait(NAS服务器绑定状态)​

指示设备与 NAS 服务器的绑定状态。值 0 表示未绑定(未连接或未配置),值 1 表示已绑定(已成功连接并认证)。

Trait IDCode
0x507BNASServerBindingStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNASServerBindingStatusEnum80RVO
0x0006Supported Valuelist[NASServerBindingStatusEnum8]RO
0x0007Default Valueuint80RWO

NASLastWriteTimestamp Trait(NAS最后写入时间戳)​

指示最后一次成功写入 NAS 存储的 Unix 时间戳(毫秒,不含时区)。设备完成向 NAS 写入视频文件或任何数据时记录该时间戳。

Trait IDCode
0x4FE4NASLastWriteTimestamp
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640RVO
0x0002Maximum Valueuint6418446744073709551615RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint321RO
0x0007Default Valueuint640RWO

SetNASSharedFolder Trait(设置共享文件夹)​

设置用于 NAS 存储的共享文件夹路径。

Trait IDCode
0x5025SetNASSharedFolder
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterStringRVWO

NASSharedFoldersList Trait(获取共享文件夹列表)​

以 JSON 数组形式检索 NAS 上的共享文件夹列表。

Trait IDCode
0x5024NASSharedFoldersList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuearrayRVO

NASServersList Trait(获取NAS服务器列表)​

以数组形式检索已配置的 NAS 服务器列表。

Trait IDCode
0x5023NASServersList
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuearrayRVO

NASStorageDuration Trait(NAS存储时长)​

NAS 上视频保留时长(秒)。

Trait IDCode
0x502CNASStorageDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint322592000RVWO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint322592000RWO

NASTransferInterval Trait(NAS传输间隔)​

视频传输至 NAS 的时间间隔(秒)。

Trait IDCode
0x502BNASTransferInterval
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint3286400RVWO
0x0002Maximum Valueuint3286400RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint3260RWO

NASStorageEnable Trait(NAS存储使能)​

启用或禁用 NAS 视频存储。

Trait IDCode
0x5021NASStorageEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

NASWorkMode Trait(NAS工作模式)​

指定 NAS 存储模式:从 SD 卡转存或直接上传。

Trait IDCode
0x5022NASWorkMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNASWorkModeEnum80RVWO
0x0006Supported Valuelist[NASWorkModeEnum8]RO
0x0007Default ValueNASWorkModeEnum80RWO

NASVerificationResult Trait(NAS验证结果)​

上次 NAS 连接验证的结果。

Trait IDCode
0x5020NASVerificationResult
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNASVerificationResultEnum81RVO
0x0006Supported Valuelist[NASVerificationResultEnum8]RO

SetNASServers Trait(设置NAS服务器)​

配置设备连接到NAS服务器所需的参数。它包含三个参数:主机(characterString, NAS服务器的地址,可以是IP地址、主机名或UNC路径)、用户(characterString,用于NAS身份验证的用户名)和密码(characterString,与用户名对应的密码)。收到此命令后,设备将尝试使用提供的凭据连接到指定的NAS服务器,并返回连接结果(成功或失败)。

Trait IDCode
0x501ESetNASServers
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSetNASServersTraitPresentValueStructureRVWO

NASStatus Trait(NAS状态)​

NAS 视频存储的当前状态。

Trait IDCode
0x501FNASStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueNASStatusEnum80RVO
0x0006Supported Valuelist[NASStatusEnum8]RO

Command 定义​

Command IDNameConformance
0x9D45DeleteNASServerO
0x9D3CNASClearHistoryVideosO

DeleteNASServer Command​

表示解绑 NAS 服务器的操作。

参数​

DeleteNASServer Command Structure

NASClearHistoryVideos Command​

该 Command 用于执行「清除NAS历史视频」操作。

参数​

NASClearHistoryVideos Command Structure

Repeater(Wi-Fi 中继器)​

简介​

管理 Wi-Fi 中继能力,包括保活、中继链路信息、网络诊断及与网关的连接状态。

Function 标识​

Function IDCode名称
0x0114RepeaterWi-Fi 中继器

Trait​

Trait IDCode名称Conformance
0x5069KeepAliveRepeaterInfo保活与中继链路信息O
0x4F55SupportedHubCapability支持的中枢网关能力集O

Command​

本 Function 不包含 Command。

数据类型​

KeepAliveRepeaterInfoTraitPresentValueStructure Type​

该结构体定义 KeepAliveRepeaterInfo Trait 的 Present Value 字段布局。

结构体成员序号字段名类型必须说明
0InfocharacterStringMJSON 字符串,包含 alive 主机/端口、热点凭据(SSID、passphrase)及链路类型等信息。

Trait 定义​

Trait IDNameConformance
0x5069KeepAliveRepeaterInfoO
0x4F55SupportedHubCapabilityO

KeepAliveRepeaterInfo Trait(保活与中继链路信息)​

提供低功耗设备(例如电池摄像头)与其基站/网关之间的 keep‑alive 和中继链路信息。值为 JSON 字符串,包含 alive 主机和端口、热点凭据(SSID 和 passphrase)及链路类型等详情。

Trait IDCode
0x5069KeepAliveRepeaterInfo
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueKeepAliveRepeaterInfoTraitPresentValueStructureRVO

SupportedHubCapability Trait(支持的中枢网关能力集)​

该属性以位掩码形式上报网关作为智能家居中枢所具备的核心功能特性。每一位代表一项特定能力(如本地自动化、数据存储、AI 支持)。上层应用据此发现并适配设备高级功能,实现差异化体验。 bit 0:支持网关基础功能(支持创建网关集群等) bit 1:具备本地自动化模块 ha_driven bit 2:支持网关本地数据存储功能 NAS bit 3:支持 SAAS bit 4:支持本地 AI bit 5:支持局域网 APP 控制 bit 6:支持运行 Aqara Studio bit 7:支持 Aqara Studio 逻辑功能块 bit 8 至 31:保留

Trait IDCode
0x4F55SupportedHubCapability
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

Command 定义​

本 Function 不包含 Command。

TamperProtection(防拆防护)​

简介​

提供物理安全防护,检测并响应非法拆卸、强拆等篡改行为,支持告警与录像联动。

Function 标识​

Function IDCode名称
0x0115TamperProtection防拆防护

Trait​

Trait IDCode名称Conformance
0x50DAAntiTamperAlertEvent强拆报警事件O
0x50DBAntiTamperAlertEnable强拆报警使能O
0x50DCAntiTamperAlertPushEnable强拆报警推送使能O
0x50DDAntiTamperAlertRecordEnable强拆报警录像使能O

Command​

本 Function 不包含 Command。

数据类型​

AntiTamperAlertEventEnum8 Type​

该枚举定义 AntiTamperAlertEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x01TamperDetected拆开报警

Trait 定义​

Trait IDNameConformance
0x50DAAntiTamperAlertEventO
0x50DBAntiTamperAlertEnableO
0x50DCAntiTamperAlertPushEnableO
0x50DDAntiTamperAlertRecordEnableO

AntiTamperAlertEvent Trait(强拆报警事件)​

当设备检测到被非法拆卸或从安装位置移除时上报该事件。

Trait IDCode
0x50DAAntiTamperAlertEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAntiTamperAlertEventEnum8VO
0x0006Supported Valuelist[AntiTamperAlertEventEnum8]RO

AntiTamperAlertEnable Trait(强拆报警使能)​

开启或关闭防拆报警功能。

Trait IDCode
0x50DBAntiTamperAlertEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

AntiTamperAlertPushEnable Trait(强拆报警推送使能)​

开启或关闭强拆报警的推送通知。

Trait IDCode
0x50DCAntiTamperAlertPushEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

AntiTamperAlertRecordEnable Trait(强拆报警录像使能)​

开启或关闭强拆报警触发时的自动录像。

Trait IDCode
0x50DDAntiTamperAlertRecordEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean1RVWO
0x0007Default Valueboolean1RWO

Command 定义​

本 Function 不包含 Command。

SmileDetection(笑脸识别)​

简介​

识别画面中的笑脸并上报事件,支持对笑脸识别能力进行启停控制。

Function 标识​

Function IDCode名称
0x0116SmileDetection笑脸识别

Trait​

Trait IDCode名称Conformance
0x50CDSmileDetectionEvent笑脸识别事件M
0x50CESmileDetectionEnable笑脸识别使能O

Command​

本 Function 不包含 Command。

数据类型​

SmileDetectionEventEnum32 Type​

该枚举定义 SmileDetectionEvent Trait 的 Present Value 有效取值。

ValueNameDescription
0x01HappyMoment检测到开心瞬间

Trait 定义​

Trait IDNameConformance
0x50CDSmileDetectionEventM
0x50CESmileDetectionEnableO

SmileDetectionEvent Trait(笑脸识别事件)​

表示摄像机检测到的笑脸事件。识别到笑脸时,设备将上报对应事件值。

Trait IDCode
0x50CDSmileDetectionEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSmileDetectionEventEnum32VM
0x0006Supported Valuelist[SmileDetectionEventEnum32]RO

SmileDetectionEnable Trait(笑脸识别使能)​

启用或禁用摄像机的笑脸识别能力。启用后会分析视频流并上报笑脸事件。

Trait IDCode
0x50CESmileDetectionEnable
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueboolean0RVWO
0x0007Default Valueboolean0RWO

Command 定义​

本 Function 不包含 Command。

CameraAVStreamManagement(摄像头音视频流管理)​

简介​

Camera AV Stream Management 功能定义了 Aqara 摄像头音视频流管理能力,支撑 WebRTC 直播及本地 SD 卡录像回放所需的流分配与能力查询。

Function 标识​

Function IDCode名称
0x0126CameraAVStreamManagement摄像头音视频流管理

Trait​

Trait IDCode名称Conformance
0x511DCAVSMMaxConcurrentEncodersM
0x511ECAVSMMaxEncodedPixelRateM
0x511FCAVSMVideoSensorParamsM
0x5120CAVSMRateDistortionTradeOffPointsO
0x5121CAVSMMicrophoneCapabilitiesO
0x5122CAVSMTwoWayTalkSupportO
0x5123CAVSMMaxNetworkBandwidthO
0x5125CAVSMSupportedStreamUsagesM
0x5126CAVSMAllocatedVideoStreamsO
0x5127CAVSMAllocatedAudioStreamsO
0x5128CAVSMStreamUsagePrioritiesM

Command​

Command IDCode名称Conformance
0x9D8ACAVSMVideoStreamAllocateO
0x9D8BCAVSMVideoStreamDeallocateO
0x9D8CCAVSMAudioStreamAllocateO
0x9D8DCAVSMAudioStreamDeallocateO
0x9D8ECAVSMSetStreamPrioritiesO

数据类型​

VideoCodecEnum8 Type​

该枚举定义视频编解码器有效取值。

ValueNameDescription
0x00H264Advanced Video Coding (H.264)
0x01HEVCHigh Efficiency Video Coding (H.265)
0x02VVCVersatile Video Coding (H.266)
0x03AV1AOMedia Video 1
AudioCodecEnum8 Type​

该枚举定义音频编解码器有效取值。

ValueNameDescription
0x00OPUSOpen source IETF standard codec
0x01AAC-LCAdvanced Audio Coding-Low Complexity
TwoWayTalkSupportTypeEnum8 Type​

该枚举定义双向对讲支持类型有效取值。

ValueNameDescription
0x00NotSupported不支持双向对讲
0x01HalfDuplex半双工
0x02FullDuplex全双工
StreamUsageEnum8 Type​

该枚举定义音视频流用途有效取值。

ValueNameDescription
0x00Internal内部用途,不可用于 WebRTC 分配
0x01Recording录制用途(云端 clip / Push 等,非 SD 卡回放)
0x02Analysis分析用途
0x03LiveView直播用途
0xF0LocalPlayback回放设备唯一的本地 SD 卡录像文件

注意: 0x04-0xEF 预留给 Matter 未来标准扩展。LocalPlayback 表示回放编码通道用途;设备仅一份本地录像文件,无需 App 指定片源。

StatusCodeEnum8 Type​

该枚举定义 CameraAVStreamManagement Function 的 Command 响应状态码有效取值。

ValueNameDescription
0x00SUCCESS成功
0x01NOT_FOUND未找到
0x02INVALID_IN_STATE状态无效
0x03INVALID_COMMAND命令无效
0x04DYNAMIC_CONSTRAINT_ERROR动态约束错误
0x05RESOURCE_EXHAUSTED资源耗尽
0x06ALREADY_EXISTS已存在
VideoResolutionStructure Type​

该结构体定义视频分辨率字段布局。

结构体成员序号字段名类型必须说明
0Widthuint16M宽度(像素)。
1Heightuint16M高度(像素)。
VideoSensorParamsStructure Type​

该结构体定义视频传感器参数字段布局。

结构体成员序号字段名类型必须说明
0SensorWidthuint16M传感器宽度(像素)。
1SensorHeightuint16M传感器高度(像素)。
2MaxFPSuint16M最大帧率(fps)。
RateDistortionTradeOffPointsStructure Type​

该结构体定义码率失真权衡参考点字段布局。

结构体成员序号字段名类型必须说明
0CodecVideoCodecEnum8M视频编解码器。
1ResolutionVideoResolutionStructureM分辨率。
2MinBitRateuint32M该点最低码率(bps)。
AudioCapabilitiesStructure Type​

该结构体定义麦克风能力字段布局。

结构体成员序号字段名类型必须说明
0MaxNumberOfChannelsuint8M最大通道数。
1SupportedCodecslist[AudioCodecEnum8]M支持的音频编解码器。
2SupportedSampleRateslist[uint32]M采样率(Hz)。
3SupportedBitDepthslist[uint8]M位深。
VideoStreamStructure Type​

该结构体定义已分配视频流字段布局。

结构体成员序号字段名类型必须说明
0VideoStreamIDuint16M视频流 ID;WebRTC VideoStreams 引用。
1StreamUsageStreamUsageEnum8M流用途。
2VideoCodecVideoCodecEnum8M编解码器。
3MinFrameRateuint16M最小帧率(fps)。
4MaxFrameRateuint16M最大帧率(fps)。
5MinResolutionVideoResolutionStructureM最小分辨率。
6MaxResolutionVideoResolutionStructureM最大分辨率。
7MinBitRateuint32M最小码率(bps)。
8MaxBitRateuint32M最大码率(bps)。
9KeyFrameIntervaluint16M关键帧间隔(ms)。
10ReferenceCountuint8M当前引用数;>0 时不可 Deallocate。
AudioStreamStructure Type​

该结构体定义已分配音频流字段布局。

结构体成员序号字段名类型必须说明
0AudioStreamIDuint16M音频流 ID;WebRTC AudioStreams 引用。
1StreamUsageStreamUsageEnum8M流用途。
2AudioCodecAudioCodecEnum8M编解码器。
3ChannelCountuint8M通道数。
4SampleRateuint32M采样率(Hz)。
5BitRateuint32M码率(bps)。
6BitDepthuint8M8/16/24/32。
7ReferenceCountuint8M当前引用数。
CAVSMVideoStreamAllocate Command Structure Type​

CAVSMVideoStreamAllocate Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0StreamUsageStreamUsageEnum8M流用途(Recording, Analysis, LiveView, LocalPlayback)。
1VideoCodecVideoCodecEnum8M视频编解码器。
2MinFrameRateuint16M最小帧率(fps)。
3MaxFrameRateuint16M最大帧率(fps)。
4MinResolutionVideoResolutionStructureM最小分辨率。
5MaxResolutionVideoResolutionStructureM最大分辨率。
6MinBitRateuint32M最小码率(bps)。
7MaxBitRateuint32M最大码率(bps)。
8KeyFrameIntervaluint16M关键帧间隔(ms)。
CAVSMVideoStreamAllocateResponse Command Structure Type​

CAVSMVideoStreamAllocate Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusStatusCodeEnum8M处理状态。
1VideoStreamIDuint16M分配的视频流 ID。
CAVSMVideoStreamDeallocate Command Structure Type​

CAVSMVideoStreamDeallocate Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0VideoStreamIDuint16M待释放的视频流 ID。
CAVSMVideoStreamDeallocateResponse Command Structure Type​

CAVSMVideoStreamDeallocate Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusStatusCodeEnum8M处理状态。
CAVSMAudioStreamAllocate Command Structure Type​

CAVSMAudioStreamAllocate Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0StreamUsageStreamUsageEnum8M流用途(Recording, Analysis, LiveView, LocalPlayback)。
1AudioCodecAudioCodecEnum8M音频编解码器。
2ChannelCountuint8M通道数。
3SampleRateuint32M采样率(Hz)。
4BitRateuint32M码率(bps)。
5BitDepthuint8M位深(8/16/24/32)。
CAVSMAudioStreamAllocateResponse Command Structure Type​

CAVSMAudioStreamAllocate Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusStatusCodeEnum8M处理状态。
1AudioStreamIDuint16M分配的音频流 ID。
CAVSMAudioStreamDeallocate Command Structure Type​

CAVSMAudioStreamDeallocate Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0AudioStreamIDuint16M待释放的音频流 ID。
CAVSMAudioStreamDeallocateResponse Command Structure Type​

CAVSMAudioStreamDeallocate Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusStatusCodeEnum8M处理状态。
CAVSMSetStreamPriorities Command Structure Type​

CAVSMSetStreamPriorities Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0StreamPrioritieslist[StreamUsageEnum8]M降序优先级列表;仅含 CAVSMSupportedStreamUsages 中的值。
CAVSMSetStreamPrioritiesResponse Command Structure Type​

CAVSMSetStreamPriorities Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusStatusCodeEnum8M处理状态。

Trait 定义​

CAVSMMaxConcurrentEncoders Trait​

最大并发硬件视频编码器数量。

Trait IDCode
0x511DCAVSMMaxConcurrentEncoders
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint84RVM
0x0002Maximum Valueuint8255RO
0x0003Minimum Valueuint81RO

CAVSMMaxEncodedPixelRate Trait​

最大编码像素率(像素/秒)。

Trait IDCode
0x511ECAVSMMaxEncodedPixelRate
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint3260RVM
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint321RO
0x0005Step Valueuint321RO

CAVSMVideoSensorParams Trait​

传感器尺寸与帧率能力。

Trait IDCode
0x511FCAVSMVideoSensorParams
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueVideoSensorParamsStructureRVM

CAVSMRateDistortionTradeOffPoints Trait​

各编解码器/分辨率最低码率参考点。

Trait IDCode
0x5120CAVSMRateDistortionTradeOffPoints
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[RateDistortionTradeOffPointsStructure]RVO

CAVSMMicrophoneCapabilities Trait​

麦克风能力。

Trait IDCode
0x5121CAVSMMicrophoneCapabilities
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueAudioCapabilitiesStructureRVO

CAVSMTwoWayTalkSupport Trait​

双向对讲模式。

Trait IDCode
0x5122CAVSMTwoWayTalkSupport
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueTwoWayTalkSupportTypeEnum80RVO

CAVSMMaxNetworkBandwidth Trait​

媒体流合计最大网络带宽(bps)。

Trait IDCode
0x5123CAVSMMaxNetworkBandwidth
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint32100RVO
0x0002Maximum Valueuint324294967295RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

CAVSMSupportedStreamUsages Trait​

设备支持的 Stream Usage 列表。

Trait IDCode
0x5125CAVSMSupportedStreamUsages
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[StreamUsageEnum8]RVM

CAVSMAllocatedVideoStreams Trait​

已分配视频流列表。

Trait IDCode
0x5126CAVSMAllocatedVideoStreams
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[VideoStreamStructure]RVO

CAVSMAllocatedAudioStreams Trait​

已分配音频流列表。

Trait IDCode
0x5127CAVSMAllocatedAudioStreams
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[AudioStreamStructure]RVO

CAVSMStreamUsagePriorities Trait​

Stream Usage 优先级(Index 0 最高)。

Trait IDCode
0x5128CAVSMStreamUsagePriorities
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[StreamUsageEnum8]RVM

Command 定义​

CAVSMVideoStreamAllocate Command​

分配视频编码流。成功后设备 SHALL Report 更新后的 CAVSMAllocatedVideoStreams。

参数​

CAVSMVideoStreamAllocate Command Structure

响应​

CAVSMVideoStreamAllocateResponse Command Structure

备注

收到本 Command 后,SHALL 按下列规则校验请求参数并处理。

参数校验

参数校验规则失败 Status
StreamUsageSHALL 为 Recording、Analysis、LiveView 或 LocalPlayback;SHALL 存在于 CAVSMStreamUsagePriorities 及 CAVSMSupportedStreamUsagesINVALID_IN_STATE
VideoCodecSHALL 为设备支持的编解码器DYNAMIC_CONSTRAINT_ERROR
MinFrameRateSHALL 满足 1 <= MinFrameRate <= MaxFrameRateDYNAMIC_CONSTRAINT_ERROR
MaxFrameRateSHALL >= 1;LiveView/Recording/Analysis 时 SHALL <= CAVSMVideoSensorParams.MaxFPS;LocalPlayback 时 MAY 按本地录像文件帧率能力校验DYNAMIC_CONSTRAINT_ERROR
MinResolutionWidth、Height SHALL >= 1;SHALL <= MaxResolution;SHALL 不超过传感器能力DYNAMIC_CONSTRAINT_ERROR
MaxResolutionWidth、Height SHALL >= 1;SHALL <= CAVSMVideoSensorParams 宽高DYNAMIC_CONSTRAINT_ERROR
MinBitRateSHALL 满足 1 <= MinBitRate <= MaxBitRateDYNAMIC_CONSTRAINT_ERROR
MaxBitRateSHALL >= 1;MAY 参考 CAVSMRateDistortionTradeOffPoints 对应 Codec/Resolution 的最低码率DYNAMIC_CONSTRAINT_ERROR
KeyFrameIntervalSHALL 满足 0 <= KeyFrameInterval <= 65500DYNAMIC_CONSTRAINT_ERROR
  • StreamUsage 不在 CAVSMStreamUsagePriorities -> 返回 INVALID_IN_STATE。
  • 任一参数超出上表或设备能力 -> 返回 DYNAMIC_CONSTRAINT_ERROR。
  • CAVSMAllocatedVideoStreams 中已有完全匹配流 -> 返回已有 VideoStreamID(SUCCESS)。
  • 编码器数量、编码像素率或网络带宽等资源不足(参考 CAVSMMaxConcurrentEncoders、CAVSMMaxEncodedPixelRate、CAVSMMaxNetworkBandwidth)-> 返回 RESOURCE_EXHAUSTED。
  • 校验通过 -> 分配新 VideoStreamID,追加至 CAVSMAllocatedVideoStreams 并 Report。

CAVSMVideoStreamDeallocate Command​

释放视频编码流。成功后设备 SHALL Report 更新后的 CAVSMAllocatedVideoStreams。

参数​

CAVSMVideoStreamDeallocate Command Structure

响应​

CAVSMVideoStreamDeallocateResponse Command Structure

备注

收到本 Command 后,SHALL 按下列规则校验 VideoStreamID 并处理。

参数校验

参数校验规则失败 Status
VideoStreamIDSHALL 存在于 CAVSMAllocatedVideoStreamsNOT_FOUND
VideoStreamID对应流 ReferenceCount SHALL 为 0INVALID_IN_STATE
VideoStreamID对应流 StreamUsage SHALL 不为 InternalDYNAMIC_CONSTRAINT_ERROR
  • VideoStreamID 不存在 -> 返回 NOT_FOUND。
  • ReferenceCount > 0(仍有 WebRTC 会话等引用)-> 返回 INVALID_IN_STATE。
  • StreamUsage=Internal -> 返回 DYNAMIC_CONSTRAINT_ERROR。
  • 校验通过 -> 释放该视频流,从 CAVSMAllocatedVideoStreams 移除并 Report。

CAVSMAudioStreamAllocate Command​

分配音频编码流。成功后设备 SHALL Report 更新后的 CAVSMAllocatedAudioStreams。

参数​

CAVSMAudioStreamAllocate Command Structure

响应​

CAVSMAudioStreamAllocateResponse Command Structure

备注

收到本 Command 后,SHALL 按下列规则校验请求参数并处理。

参数校验

参数校验规则失败 Status
StreamUsageSHALL 为 Recording、Analysis、LiveView 或 LocalPlayback;SHALL 存在于 CAVSMStreamUsagePriorities 及 CAVSMSupportedStreamUsagesINVALID_IN_STATE
AudioCodecLiveView/Recording/Analysis 时 SHALL 为 CAVSMMicrophoneCapabilities.SupportedCodecs 中的值;LocalPlayback 时 MAY 按本地录像文件编码校验DYNAMIC_CONSTRAINT_ERROR
ChannelCountSHALL 满足 1 <= ChannelCount <= 8,且 <= CAVSMMicrophoneCapabilities.MaxNumberOfChannelsDYNAMIC_CONSTRAINT_ERROR
SampleRateSHALL >= 1,且属于 CAVSMMicrophoneCapabilities.SupportedSampleRatesDYNAMIC_CONSTRAINT_ERROR
BitRateSHALL >= 1DYNAMIC_CONSTRAINT_ERROR
BitDepthSHALL 为 8、16、24 或 32,且属于 CAVSMMicrophoneCapabilities.SupportedBitDepthsDYNAMIC_CONSTRAINT_ERROR
  • StreamUsage 不在 CAVSMStreamUsagePriorities -> 返回 INVALID_IN_STATE。
  • 任一音频参数不在 CAVSMMicrophoneCapabilities 支持范围内 -> 返回 DYNAMIC_CONSTRAINT_ERROR。
  • CAVSMAllocatedAudioStreams 中已有完全匹配流 -> 返回已有 AudioStreamID(SUCCESS)。
  • 资源不足 -> 返回 RESOURCE_EXHAUSTED。
  • 校验通过 -> 分配新 AudioStreamID,追加至 CAVSMAllocatedAudioStreams 并 Report。

CAVSMAudioStreamDeallocate Command​

释放音频编码流。成功后设备 SHALL Report 更新后的 CAVSMAllocatedAudioStreams。

参数​

CAVSMAudioStreamDeallocate Command Structure

响应​

CAVSMAudioStreamDeallocateResponse Command Structure

备注

收到本 Command 后,SHALL 按下列规则校验 AudioStreamID 并处理。

参数校验

参数校验规则失败 Status
AudioStreamIDSHALL 存在于 CAVSMAllocatedAudioStreamsNOT_FOUND
AudioStreamID对应流 ReferenceCount SHALL 为 0INVALID_IN_STATE
AudioStreamID对应流 StreamUsage SHALL 不为 InternalDYNAMIC_CONSTRAINT_ERROR
  • AudioStreamID 不存在 -> 返回 NOT_FOUND。
  • ReferenceCount > 0 -> 返回 INVALID_IN_STATE。
  • StreamUsage=Internal -> 返回 DYNAMIC_CONSTRAINT_ERROR。
  • 校验通过 -> 释放该音频流,从 CAVSMAllocatedAudioStreams 移除并 Report。

CAVSMSetStreamPriorities Command​

设置 Stream Usage 优先级。成功后设备 SHALL Report CAVSMStreamUsagePriorities。

参数​

CAVSMSetStreamPriorities Command Structure

响应​

CAVSMSetStreamPrioritiesResponse Command Structure

备注

收到本 Command 后,SHALL 按下列规则校验 StreamPriorities 并处理。

参数校验

参数校验规则失败 Status
StreamPrioritiesCAVSMAllocatedVideoStreams 与 CAVSMAllocatedAudioStreams SHALL 均为空INVALID_IN_STATE
StreamPriorities列表中每个值 SHALL 存在于 CAVSMSupportedStreamUsagesDYNAMIC_CONSTRAINT_ERROR
StreamPriorities列表 SHALL 无重复项;Index 0 为最高优先级ALREADY_EXISTS
  • 存在任一已分配音视频流 -> 返回 INVALID_IN_STATE。
  • 列表含 CAVSMSupportedStreamUsages 之外的值 -> 返回 DYNAMIC_CONSTRAINT_ERROR。
  • 列表存在重复 StreamUsage -> 返回 ALREADY_EXISTS。
  • 校验通过 -> 更新 CAVSMStreamUsagePriorities 并 Report。

WebRTC(WebRTC 传输)​

简介​

WebRTC Transport 功能定义了 Client 与 Server 之间的 WebRTC 信令接口,涵盖实时直播(LiveView)及本地 SD 卡录像回放(LocalPlayback)会话。Client 通过 Aqara Spec Command 向 Server 提交信令,Server 通过 Response 与 Report 返回处理结果及信令事件;双方通过 WebRTC 传输双向媒体(P2P/TURN)。本地回放假定 Server 仅有一份本地录像文件,可直接回放该文件,无需指定片源 ID。

依赖​

WebRTC 会话依赖 CameraAVStreamManagement 提供已分配的音视频流。Client SHALL 在发起 WebRTCProvideOffer 新建会话或 WebRTCSolicitOffer 前,取得本次会话所需的 VideoStreamID 和 AudioStreamID;WebRTC 信令协商不代替流分配。

  1. Client SHALL 查询 CAVSMMicrophoneCapabilities、CAVSMVideoSensorParams、CAVSMRateDistortionTradeOffPoints、CAVSMAllocatedAudioStreams 与 CAVSMAllocatedVideoStreams,取得音视频能力和已分配流列表。
  2. Client SHALL 根据上述能力及本次会话需求,确定音视频流参数。音频参数包括 AudioCodec、ChannelCount、SampleRate、BitDepth 和 BitRate;其中编解码器、通道数、采样率和位深 SHALL 满足麦克风能力约束。视频参数包括 VideoCodec、帧率、分辨率范围、码率范围及关键帧间隔;分辨率和帧率 SHALL 满足 CAVSMVideoSensorParams 的约束,VideoCodec 与分辨率档位 SHALL 根据 CAVSMRateDistortionTradeOffPoints 的 Codec、Resolution 选择,码率 MAY 参考对应档位的 MinBitRate。固定分辨率时,MinResolution 与 MaxResolution 均设为所选档位;需要多档切换时,两者分别设为所需档位范围的下限与上限。
  3. Client SHALL 根据本次会话的 StreamUsage 和已确定的音视频参数,分别判断列表中是否已有可复用的音频流和视频流;已有匹配流时,复用其 ID,跳过对应 Allocate 步骤。
  4. 没有匹配的视频流时,Client SHALL 使用已确定的视频参数调用 CAVSMVideoStreamAllocate;没有匹配的音频流时,Client SHALL 使用已确定的音频参数调用 CAVSMAudioStreamAllocate。
  5. Client SHALL 等待所需流分配成功并取得响应中的流 ID,再发起 WebRTC 会话;任一所需流分配失败时,SHALL NOT 使用该次失败分配的结果继续建连。
  6. Client SHALL 将已取得的视频流 ID 填入 VideoStreams,音频流 ID 填入 AudioStreams。所引用的流 SHALL 已在 Server 分配,且其 StreamUsage SHALL 与本次会话一致;仅使用一种媒体时,只需准备并携带对应类型的流 ID。

以下前置交互适用于 LiveView 与 LocalPlayback;仅使用一种媒体时,跳过另一种媒体的能力查询、参数选择、列表查询及匹配与分配步骤。

交互流程​

交互角色​

本节统一使用 Client 和 Server 描述交互,不区分具体接入拓扑。

  • Client:请求、接收媒体并发起控制的一侧,合并表示 App 与云端。
  • Server:提供媒体并处理请求的一侧,合并表示网关与摄像头。

Client 与 Server 通过 Aqara Spec Command / Response / Report 完成信令交互,通过 WebRTC 传输双向媒体(P2P/TURN)。各侧内部的转发与协议转换不在流程图中展开。

WebRTCProvideOffer 流程​

Client 先完成 CameraAVStreamManagement 前置交互,再生成并提交 SDP Offer;Server 返回 Answer。

WebRTCSolicitOffer 流程​

Client 先完成 CameraAVStreamManagement 前置交互。本流程适用于待机唤醒等场景;Server 延迟下发 Offer,Client 再提交 Answer。

分辨率切换​

Client SHALL 使用 WebRTCSetResolution Command,将本会话已绑定的一路 VideoStreamID 切到目标分辨率。

切换条件​
  • VideoStreamID SHALL 为本会话已绑定的 StreamUsage=LiveView 流,且该流的 MinResolution SHALL 小于 MaxResolution。
  • 目标 Resolution SHALL 落在该流的 MinResolution-MaxResolution 之间,且 SHALL 是 CAVSMRateDistortionTradeOffPoints 中的一档。
  • StreamUsage=LocalPlayback 的回放会话不支持分辨率切换。
切换流程与结果​

本流程以 WebRTC 会话已建立并绑定可切换分辨率的视频流为前提,适用于 WebRTCProvideOffer 流程 与 WebRTCSolicitOffer 流程 两种建连方式。

分辨率切换:

  1. Client 下发 WebRTCSetResolution,携带 VideoStreamID 和目标 Resolution。
  2. Server 按 WebRTCSetResolution Command 定义校验请求并返回成功或失败响应。
  3. 返回 SUCCESS 后,Server SHALL 将目标流切换到指定分辨率,保持 VideoStreamID 和 SSRC 不变;新分辨率从新的 IDR 开始,IDR 携带新的 SPS。新档 IDR 送出后,通过 WebRTCStreamResolution 上报该会话各视频流当前正在发送的分辨率,目标流 SHALL 为指定分辨率。
  4. 请求失败时,Server SHALL 返回相应的非 SUCCESS 状态并保持原分辨率;SHALL NOT 返回 SUCCESS 后以未等到目标档 IDR 为由保持原档。

若目标即当前分辨率且无进行中的切换,Server SHALL 返回 SUCCESS 并立即上报一次 WebRTCStreamResolution。

每次 WebRTCStreamResolution 上报 SHALL 携带该会话的整份视频流分辨率列表,未受影响的其它路保持原值。Client SHALL 根据上报值确认实际分辨率。

本地 SD 卡录像回放​

本节仅定义回放会话的建立。Server 仅维护一份本地录像文件,Client 发起 LocalPlayback 会话即回放该文件,无需携带片源标识。播放控制与录像查询在 Playback。

回放会话建立流程​

注意: StreamUsage=LocalPlayback 时 SHALL 设 MetadataEnabled=true,以便在这条 PeerConnection 上打开 DataChannel。会话内的分辨率、回放控制和录像查询走 aqara.control 上的 InvokeCommand;录像文件字节走 aqara.download 上的 文件传输业务交互协议。播放控制、录像索引与录像文件下载的定义见 Playback。承载见 DataChannel。

Function 标识​

处理逻辑

Function IDCode名称
0x001DWebRTCWebRTC 传输

Trait​

Server 上报使用下面的 Trait。

Trait IDCode名称Conformance
0x5129WebRTCCurrentSessionsM
0x512AWebRTCSignalingEventM
0x512BWebRTCSessionStatusO
0x5244WebRTCStreamResolutionO

Command​

Client 请求使用下面的 Command。

Command IDCode名称Conformance
0x9D8FWebRTCSolicitOfferO
0x9D90WebRTCProvideOfferO
0x9D91WebRTCProvideAnswerO
0x9D92WebRTCProvideICECandidatesO
0x9D93WebRTCEndSessionO
0x9D94WebRTCLocalPlaybackSeekO
0x9DB9WebRTCSetResolutionO
0x9DBAWebRTCTalkO

数据类型​

WebRTCStatusCodeEnum8 Type​

该枚举定义 WebRTC Function 的 Command 响应状态码有效取值;独立于其他 Function 的状态码定义。

ValueNameDescription
0x00SUCCESS成功
0x01NOT_FOUND未找到
0x02INVALID_IN_STATE状态无效
0x03INVALID_COMMAND命令无效
0x04DYNAMIC_CONSTRAINT_ERROR动态约束错误
0x05RESOURCE_EXHAUSTED资源耗尽
0x06ALREADY_EXISTS已存在
SignalingEventTypeEnum8 Type​

该枚举定义 WebRTCSignalingEvent Trait 中信令事件类型有效取值。

ValueNameDescription
0x00OfferWebRTCSolicitOffer 之后(尤其 DeferredOffer)
0x01AnswerWebRTCProvideOffer 之后
0x02ICETrickle ICE
0x03EndServer 结束会话
WebRTCEndReasonEnum8 Type​

该枚举定义 WebRTC 会话结束原因有效取值。

ValueNameDescription
0x00ICEFailed无法建立媒体连接
0x01ICETimeoutICE 超时
0x02UserHangup用户挂断
0x03UserBusy远端忙
0x04Replaced被替换
0x05NoUserMedia无本地媒体 Server
0x06InviteTimeoutOffer/Answer 超时
0x07AnsweredElsewhere其他 Server 接听
0x08OutOfResources资源不足
0x09MediaTimeout媒体超时
0x0ALowPower低电量
0x0BPrivacyMode隐私模式
0x0CUnknownReason未知
MediaTransportEnum8 Type​

该枚举定义实际媒体传输方式有效取值。

ValueNameDescription
0x00Unknown未知或未确定
0x01P2P端到端直连
0x02TURN经 TURN 中继
SessionStatusEventEnum8 Type​

该枚举定义 WebRTCSessionStatus Trait 中状态事件类型有效取值。

ValueNameDescription
0x00MediaConnected媒体通道已建立;上报实际拉流方式
0x01SessionEnded会话结束;上报拉流统计与断开原因
ICEServerStructure Type​

该结构体定义 ICE 服务器配置字段布局。

结构体成员序号字段名类型必须说明
0URLslist[characterString]Mstun:/turn:/stuns:/turns: URL 列表。
1UsernamecharacterStringOTURN 用户名。
2CredentialcharacterStringOTURN 凭据。
3CAIDuint16Oturns/stuns TLS 根证书 ID。
ICECandidateStructure Type​

该结构体定义 ICE 候选字段布局。

结构体成员序号字段名类型必须说明
0CandidatecharacterStringMRFC 8839 candidate-attribute。
1SDPMidcharacterStringMsdpMid。
2SDPMLineIndexuint16Mm= 行索引。
ExtensionOptionsStructure Type​

扩展选项,用于配置 WebRTC 建连各阶段的超时时间及其他扩展参数。Struct 整体及各字段均为可选;未携带字段时 Server SHALL 使用实现默认值。扩展选项由 Server 解释并执行。

结构体成员序号字段名类型必须说明
0ICECollectionTimeoutuint32OICE 候选收集超时(ms)。
1TLSConnectTimeoutuint32OTLS 连接超时(ms);适用于 TURN/TURNS。
2InviteTimeoutuint32OOffer/Answer 信令交换超时(ms)。
3DeferredOfferTimeoutuint32O延迟 Offer 等待超时(ms);适用于 WebRTCSolicitOffer。
4ICENegotiationTimeoutuint32OICE 连通性检查超时(ms)。
5MediaTimeoutuint32O媒体通道建立超时(ms)。
SessionStructure Type​

该结构体定义 WebRTC 会话字段布局。

结构体成员序号字段名类型必须说明
0SessionIduint16M对应 WebRTC SessionID。
1StreamUsageStreamUsageEnum8M流用途;定义见 CameraAVStreamManagement。
2MetadataEnabledbooleanM元数据 DataChannel 开关。
3VideoStreamslist[uint16]MVideoStreamID 列表。
4AudioStreamslist[uint16]MAudioStreamID 列表。
SignalingEventStructure Type​

该结构体定义信令事件字段布局。

结构体成员序号字段名类型必须说明
0SessionIduint16MWebRTC SessionID。
1EventTypeSignalingEventTypeEnum8M信令事件类型。
2SDPcharacterStringOOffer/Answer SDP。
3ICECandidateslist[ICECandidateStructure]OICE 候选列表。
4ReasonWebRTCEndReasonEnum8O会话结束原因。
SessionStatusStructure Type​

会话状态上报结构。Server 根据 WebRTC 媒体栈选路结果及会话生命周期 Report。

结构体成员序号字段名类型必须说明
0SessionIduint16MWebRTC SessionID。
1EventTypeSessionStatusEventEnum8M状态事件类型。
2MediaTransportMediaTransportEnum8M实际拉流方式(P2P / TURN)。
3DurationMsuint32O拉流时长(ms)。
4VideoFrameCountuint32O接收的视频帧总数。
5DisconnectReasonWebRTCEndReasonEnum8O断开原因。
6SignalingDurationMsuint32O信令交互时长(ms);自会话发起至媒体通道建立。

注意: EventType=MediaConnected 时 SHALL 携带 MediaTransport 及 SignalingDurationMs;EventType=SessionEnded 时 SHALL 携带 DurationMs、MediaTransport、VideoFrameCount 及 DisconnectReason,MAY 携带 SignalingDurationMs。

WebRTCSolicitOffer Command Structure Type​

WebRTCSolicitOffer Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0InitiatorDatacharacterStringO发起者数据;SessionId 产生前用于关联请求与回复;最大 32 字节。
1StreamUsageStreamUsageEnum8M流用途。
2ICEServerslist[ICEServerStructure]OICE 服务器列表(最多 10 个)。
3ICETransportPolicycharacterStringOICE 策略(all 或 relay)。
4MetadataEnabledbooleanO元数据 DataChannel 开关。
5VideoStreamslist[uint16]OVideoStreamID 列表(1 至 16);使用视频时 SHALL 携带,且 SHALL 引用已按本次 StreamUsage 分配的流,见 前置依赖。
6AudioStreamslist[uint16]OAudioStreamID 列表(1 至 16);使用音频时 SHALL 携带,且 SHALL 引用已按本次 StreamUsage 分配的流,见 前置依赖。
7ExtensionOptionsExtensionOptionsStructureO扩展选项。
WebRTCSolicitOfferResponse Command Structure Type​

WebRTCSolicitOffer Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusWebRTCStatusCodeEnum8M处理状态;定义见 WebRTCStatusCodeEnum8。
1InitiatorDatacharacterStringO原样回显请求中的 InitiatorData。
2SessionIduint16OStatus=SUCCESS 时 SHALL 携带分配的会话 ID;失败时 SHALL 省略。
3DeferredOfferbooleanO是否延迟下发 Offer;Status=SUCCESS 时 SHALL 携带;失败时 SHALL 省略。
WebRTCProvideOffer Command Structure Type​

WebRTCProvideOffer Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0InitiatorDatacharacterStringO发起者数据;SessionId 产生前用于关联请求与回复;最大 32 字节。
1SessionIduint16O会话 ID;未携带本字段为新建,携带字段为 re-offer。
2SDPcharacterStringMSDP Offer。
3StreamUsageStreamUsageEnum8O流用途;新建会话时必填。
4ICEServerslist[ICEServerStructure]OICE 服务器列表(最多 10 个)。
5ICETransportPolicycharacterStringOICE 策略。
6MetadataEnabledbooleanO元数据 DataChannel 开关。
7VideoStreamslist[uint16]OVideoStreamID 列表(1 至 16);使用视频时 SHALL 携带,且 SHALL 引用已按本次 StreamUsage 分配的流,见 前置依赖。
8AudioStreamslist[uint16]OAudioStreamID 列表(1 至 16);使用音频时 SHALL 携带,且 SHALL 引用已按本次 StreamUsage 分配的流,见 前置依赖。
9ExtensionOptionsExtensionOptionsStructureO扩展选项。
WebRTCProvideOfferResponse Command Structure Type​

WebRTCProvideOffer Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusWebRTCStatusCodeEnum8M处理状态。
1InitiatorDatacharacterStringO原样回显请求中的 InitiatorData。
2SessionIduint16OStatus=SUCCESS 时 SHALL 携带新建或更新的会话 ID;失败时 SHALL 省略。
WebRTCProvideAnswer Command Structure Type​

WebRTCProvideAnswer Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0SessionIduint16M会话 ID。
1SDPcharacterStringMSDP Answer。
WebRTCProvideAnswerResponse Command Structure Type​

WebRTCProvideAnswer Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusWebRTCStatusCodeEnum8M处理状态。
1SessionIduint16M会话 ID。
WebRTCProvideICECandidates Command Structure Type​

WebRTCProvideICECandidates Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0SessionIduint16M会话 ID。
1ICECandidateslist[ICECandidateStructure]M本地 ICE 候选列表。
WebRTCProvideICECandidatesResponse Command Structure Type​

WebRTCProvideICECandidates Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusWebRTCStatusCodeEnum8M处理状态。
1SessionIduint16M会话 ID。
WebRTCEndSession Command Structure Type​

WebRTCEndSession Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0SessionIduint16M会话 ID。
1ReasonWebRTCEndReasonEnum8M结束原因。
WebRTCTalk Command Structure Type​

WebRTCTalk Command 的请求参数结构体。

结构体成员序号字段名类型必须说明
0EnabledbooleanMtrue 打开并占用;false 关闭并释放
1SessionIduint16OCOIP 携带,指定要控制的会话。DataChannel 省略,会话由该通道确定
WebRTCTalk Response Command Structure Type​

WebRTCTalk Command 的响应参数结构体。

结构体成员序号字段名类型必须说明
0StatusWebRTCStatusCodeEnum8M命令执行结果,取值见命令定义
WebRTCSetResolution Command Structure Type​

WebRTCSetResolution 的请求结构。

结构体成员序号字段名类型必须说明
0VideoStreamIDuint16M本会话已绑定的视频流 ID
1ResolutionVideoResolutionStructureM目标分辨率
2SessionIduint16OCOIP 携带,指定要控制的会话。DataChannel 省略,会话由该通道确定
WebRTCSetResolutionResponse Command Structure Type​

WebRTCSetResolution 的响应结构。该命令没有其它响应参数。

结构体成员序号字段名类型必须说明
0StatusWebRTCStatusCodeEnum8M命令执行结果,取值见命令定义
StreamResolutionStructure Type​

一条记录对应一个会话;会话里绑了几路 VideoStreamID,列表里就有几项。

结构体成员序号字段名类型必须说明
0SessionIduint16MWebRTC 会话 ID,见 SessionStructure。同一个 VideoStreamID 被多个会话引用时各自汇报
1VideoStreamslist[VideoStreamResolutionStructure]M该会话下每一路当前正在发送的分辨率,顺序与 WebRTCProvideOffer 里 VideoStreams 的顺序一致
VideoStreamResolutionStructure Type​
结构体成员序号字段名类型必须说明
0VideoStreamIDuint16M该路视频流 ID
1ResolutionVideoResolutionStructureM该路当前正在发送的分辨率

Trait 定义​

WebRTCCurrentSessions Trait​

当前活跃 WebRTC 会话列表。

Trait IDCode
0x5129WebRTCCurrentSessions
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[SessionStructure]RVM

WebRTCSignalingEvent Trait​

Server 产生的信令事件。

Trait IDCode
0x512AWebRTCSignalingEvent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSignalingEventStructureRVM

WebRTCSessionStatus Trait​

会话状态与拉流统计。

Trait IDCode
0x512BWebRTCSessionStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueSessionStatusStructureRVO
备注

Server SHALL 在以下时机 Report 本 Trait:

  • 媒体通道建立且选路完成(EventType=MediaConnected):上报 SessionId、实际 MediaTransport(P2P 或 TURN)及 SignalingDurationMs。
  • 会话结束(EventType=SessionEnded):上报 DurationMs、MediaTransport、VideoFrameCount 及 DisconnectReason。

WebRTCStreamResolution Trait​

上报各会话各视频流当前正在发送的分辨率。

Trait IDCode
0x5244WebRTCStreamResolution
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[StreamResolutionStructure]RVM

上报时机:每次上报携带该会话的整份列表,不是只报变化的那一路。

  • 某一路新分辨率的 IDR 已送出 -> 该路在新列表里是新档。
  • 请求失败 -> 保持原分辨率,不因该次失败请求触发分辨率变更上报。
  • 目标即当前分辨率且无进行中的切换 -> 返回 SUCCESS,并立即上报当前分辨率。
  • 同一会话里没受影响的其它路,照原值出现在同一份列表里。

通路:Server SHALL 在会话的 aqara.control 上以 ProtocolID 0x00、OpCode 0x018A(UnconfirmedCOVNotificationMultiple)发送;Trait 的 Present Value SHALL 同步更新,MAY 另经 Report 通路上报。

Command 定义​

WebRTCSolicitOffer Command​

Client SHALL 先完成 CameraAVStreamManagement 前置交互,再请求 Server 发起 WebRTC Offer。DeferredOffer=true 时,后续 Offer 经 Report WebRTCSignalingEvent 下发,Client 再发 WebRTCProvideAnswer。

参数​

WebRTCSolicitOffer Command Structure

响应​

WebRTCSolicitOfferResponse Command Structure

WebRTCProvideOffer Command​

提交 SDP Offer 建立或更新 WebRTC 会话。新建会话前 Client SHALL 完成 CameraAVStreamManagement 前置交互。成功后 Server 通过 Report WebRTCSignalingEvent(Answer) 返回 Answer。

参数​

WebRTCProvideOffer Command Structure

响应​

WebRTCProvideOfferResponse Command Structure

备注

StreamUsage=LocalPlayback 时:

  • SHALL 设 MetadataEnabled=true。
  • VideoStreams / AudioStreams SHALL 为 StreamUsage=LocalPlayback 的 CAVSM 已分配流 ID。
  • Server SHALL 存在可读的本地录像文件;否则返回 INVALID_IN_STATE 或 NOT_FOUND。
  • Server SHALL 回放唯一的本地录像文件,从文件起点或当前实现定义的续播位置开始。

WebRTCProvideAnswer Command​

提交 SDP Answer 完成 WebRTC 信令协商。

参数​

WebRTCProvideAnswer Command Structure

响应​

WebRTCProvideAnswerResponse Command Structure

WebRTCProvideICECandidates Command​

提交本地 Trickle ICE 候选。

参数​

WebRTCProvideICECandidates Command Structure

响应​

WebRTCProvideICECandidatesResponse Command Structure

WebRTCEndSession Command​

结束 WebRTC 会话。

参数​

WebRTCEndSession Command Structure

WebRTCTalk Command​

会话级对讲开关。Server 同时只允许一个会话打开对讲。COIP 转发的 InvokeCommand 与该会话 aqara.control 上的 InvokeCommand 使用同一份 WebRTCTalk Command Structure。请求 OpCode 0x008D,响应 OpCode 0x038D。

参数​

WebRTCTalk Command Structure

响应​

WebRTCTalk Response Command Structure,Status 取值:

Status含义
SUCCESS该 SessionId 已打开并占用,或已关闭并释放。本会话已经是目标状态时同样成功
NOT_FOUNDSessionId 不是活跃会话。从 DataChannel 到达时,与该通道所属会话不一致也取此值
INVALID_IN_STATEServer 不支持对讲,或该会话不是 LiveView
INVALID_COMMANDEnabled 缺失。从 COIP 到达时未携带 SessionId 也取此值
RESOURCE_EXHAUSTED对讲已被其它会话占用,该 SessionId 不能打开
处理​
  • 从 aqara.control 到达时省略 SessionId,会话是该通道所属会话。携带了不一致的 SessionId -> 回 NOT_FOUND。从 COIP 到达时 SHALL 携带 SessionId,省略 -> 回 INVALID_COMMAND。
  • Enabled=true 且尚无占用 -> 本会话占用,回 SUCCESS。
  • 本会话已经占用时再次打开 -> 回 SUCCESS,不构成第二次占用。
  • 其它会话已经占用时再打开 -> 回 RESOURCE_EXHAUSTED。本会话保持关闭,不抢占。
  • 占用方下发 Enabled=false -> 释放,回 SUCCESS。
  • 非占用方下发 Enabled=false -> 回 SUCCESS,不释放占用方。
  • 占用方 WebRTCEndSession、其 DataChannel 关闭或 PeerConnection 结束 -> 释放占用。

WebRTCSetResolution Command​

把本会话已绑定的一路 VideoStreamID 切到目标分辨率。切换不换 SSRC;新分辨率从该路新的 IDR 开始,IDR 携带新的 SPS。返回 SUCCESS 后 SHALL 完成指定分辨率的切换,实际分辨率由 WebRTCStreamResolution 上报;请求失败时返回非 SUCCESS 状态并保持原分辨率。

参数​

WebRTCSetResolution Command Structure

响应​

WebRTCSetResolutionResponse Command Structure,Status 取值:

Status含义
SUCCESS请求成功,Server SHALL 切换到指定分辨率;目标已为当前分辨率时保持并立即上报
NOT_FOUNDSessionId 不是活跃会话,或目标 ID 不在该会话。DataChannel 上携带了与该通道不一致的 SessionId 也取此值
INVALID_IN_STATE该路不可切(MinResolution = MaxResolution、非 LiveView、回放会话)
INVALID_COMMAND目标分辨率超出该 ID 的 Min/Max,或不是能力集中的一档。从 COIP 到达时未携带 SessionId 也取此值
RESOURCE_EXHAUSTED命令队列已满
校验与处理​
  • 从 aqara.control 到达时省略 SessionId,会话是该通道所属会话。携带了不一致的 SessionId -> 回 NOT_FOUND。从 COIP 到达时 SHALL 携带 SessionId,省略 -> 回 INVALID_COMMAND。
  • VideoStreamID SHALL 为本会话已绑定的 StreamUsage=LiveView 流;该 ID 的 MinResolution SHALL 小于 MaxResolution。
  • 目标分辨率 SHALL 落在该 ID 的 MinResolution-MaxResolution 之间,且 SHALL 是 CAVSMRateDistortionTradeOffPoints 中的一档。
  • 目标即当前分辨率且无进行中的切换 -> 回 SUCCESS,并立即上报一次 WebRTCStreamResolution。
  • 请求可执行 -> 回 SUCCESS;Server SHALL 完成切换,在指定分辨率的新 IDR 送出后上报 WebRTCStreamResolution。
  • 请求无法执行 -> 回相应的非 SUCCESS 状态,保持原分辨率。
  • 同一路的请求 SHALL 按顺序处理;SHALL NOT 覆盖已返回 SUCCESS 但尚未完成的切换。命令队列已满时返回 RESOURCE_EXHAUSTED。

DataChannel​

会话内 DataChannel 的传输、通道、报文与文件传输绑定见 DataChannel。

DataChannel​

概述​

本节定义 WebRTC 会话内 DataChannel 上的 Trait、Command 与承载。这些 Trait 与 Command 仍属于 WebRTC Function,Command ID 与云端信令同一张表。会话内命令与状态是 ProtocolID 0x00 的 InvokeCommand 与 UnconfirmedCOVNotificationMultiple,在 aqara.control 上收发,不经云端中转。文件字节使用 文件传输业务交互协议(ProtocolID 0x02)。字段、OpCode 与交互以该协议为准,本节不另写一套。

传输​

WebRTC DataChannel(RFC 8831)的传输栈是 SCTP over DTLS over ICE。一条 m=application 是一条 SCTP association。这条 association 上有两个 Data Channel。每个 Data Channel 双向,进出方向各一条 SCTP stream,两条 stream 使用同一个 stream id。

层作用对本绑定的意义
ICE打洞或中继(P2P / TURN)与音视频共用一对候选与一条连接
DTLS加密与身份与音视频共用同一张证书;a=setup 决定 active / passive
SCTP可靠、有序、面向消息(RFC 4960)本绑定直接依赖它
DCEP(RFC 8832)在 association 上开通道label、Channel Type 与 Priority 在这里,不进 SDP

可靠与顺序由 SCTP 保证。文件传输复用这条交付,不另做确认、重传或整文件校验。完整性由 DTLS 承担。CoAP Type 与 Message ID 不承担确认。块的请求次序见 blockRequest。取消只有 Requestor 能发,见 abortRequest。

通道​

一条 WebRTC 会话最多一条 m=application。这一行媒体描述承载一条 SCTP association,association 跑在同一条 DTLS 上。association 上有两个 Data Channel(RFC 8831)。每个 Data Channel 双向,进出方向各一条 SCTP stream,stream id 相同,名字是 DCEP 的 Label:

label用途Channel TypePriorityContent-Format
aqara.control业务命令与响应、设备状态通知。录像查询与切档、回放同在这个 Data Channel0x00 可靠有序102450(JSON)
aqara.download按 文件传输业务交互协议 取文件字节0x00 可靠有序12860(CBOR)

会话内按消息属于哪一个已分配的业务协议来选 ProtocolID,不按 Data Channel 另起一套协议:

ProtocolID业务协议族本会话内承载
0x00Aqara 物模型业务交互协议InvokeCommand(含录像查询)与 UnconfirmedCOVNotificationMultiple
0x02文件传输业务交互协议只承载文件获取

0x00 的 OpCode 沿用物模型:高字节是 PDU Type,低字节是 Service Choice。本绑定不新增这类 OpCode。

OpCodePDU Type服务名称说明
0x008DConfirmed-RequestInvokeCommand会话内业务命令。propertyIdentifier 为 Command ID,propertyValue 为命令请求参数
0x038DComplexACKInvokeCommand命令响应。propertyValue 为命令响应结构,成员 0 为 Status
0x018AUnconfirmed-RequestUnconfirmedCOVNotificationMultiple设备主动上报 WebRTCStreamResolution 与 LocalPlaybackStatus

0x02 使用文件传输协议自己的功能编号。字段与交互见下表所链的定义,本节不另写一套。

OpCode功能名说明
0x0000 / 0x0001initRequest / initResponse建立传输
0x0002 / 0x0003blockRequest / blockResponse按范围批量拉取,每块响应携带 blockCounter 与 data
0x0004 / 0x0005EOFRequest / EOFResponse请求方确认末块已处理
0x0006 / 0x0007abortRequest / abortResponse请求方取消
0x0008errorResponse业务失败。不使用物模型 Error PDU
label承载OpCode方向典型消息
aqara.controlInvokeCommand(ProtocolID 0x00)0x008D / 0x038DApp -> 设备 / 回WebRTCSetResolution、WebRTCTalk、LocalPlaybackControl、LocalRecordQuery
aqara.controlUnconfirmedCOVNotificationMultiple(ProtocolID 0x00)0x018A设备 -> AppWebRTCStreamResolution、LocalPlaybackStatus
aqara.download文件传输(ProtocolID 0x02)0x0000-0x0008App 请求,设备响应init、block、EOF、abort、error

上表规定哪类消息使用哪个 label:

  • 同一条 CoAP 消息 SHALL NOT 出现在两个 label 上。
  • 两个 Data Channel 各自有序,互不排队,控制消息不会排在文件块后面。它们共用这一条 SCTP association、同一条 DTLS / ICE 与同一个拥塞窗口,SHALL NOT 各开 m=。
  • App 在 WebRTCProvideOffer 之后按 label 创建(negotiated=false)。设备在 onDataChannel 中按 label 收纳,label 不匹配的 SHALL 被忽略。某个 label 的 DATA_CHANNEL_OPEN 尚未完成前,App SHALL NOT 在该 label 上发消息。
  • App 是 Offer 方时,label aqara.control 的 stream id 为 0,label aqara.download 为 2。
  • 两个 Data Channel 的 Channel Type 都是 0x00(DATA_CHANNEL_RELIABLE),Reliability Parameter SHALL 为 0。SHALL NOT 使用其它 Channel Type。
  • label aqara.control 的 Content-Format SHALL 为 50。label aqara.download SHALL 为 60。文件块是 octetString,SHALL NOT 用 JSON 把它编成 Base64。
  • 录像查询是 label aqara.control 上的 LocalRecordQuery。索引文件和录像文件的字节走 label aqara.download。

报文​

一个 SCTP 用户消息(PPID = 53)SHALL 恰好承载一条完整 CoAP 消息。本绑定把 CoAP 头固定为 Type=NON、Message ID=0。文件传输协议正文里的报文图按带 Length 的可靠传输书写;OpCode 与 Payload 相同,见 文件传输业务交互协议。

SCTP User Message (PPID = 53)
└─ CoAP Message
├─ Version: 1
├─ Type: NON
├─ Code: 0.02 POST / 允许的响应类 Code
├─ Message ID: 0
├─ Token
├─ Options
├─ Payload Marker: 0xFF
└─ Payload
  • Type SHALL 为 NON。CON、ACK、RST SHALL NOT 使用。
  • Message ID SHALL 为 0。收发双方 SHALL 忽略它,SHALL NOT 用它做去重或关联。
  • 请求与响应 SHALL 通过 Token 关联。Token 长度 SHALL 为 1-8 字节,同一连接同一时刻 SHALL NOT 重复。
  • 不需要响应的消息 SHALL 使用空 Token。
  • 一条 SCTP 用户消息 SHALL NOT 承载多条 CoAP 消息;一条 CoAP 消息 SHALL NOT 跨多条 SCTP 用户消息。
名称Option ID出现性本绑定取值
Uri-Path11M两个 Option,值依次为 coip、interaction
Content-Format12Maqara.control 为 50;aqara.download 为 60
Accept17C带负载的请求 SHALL 携带。aqara.download 的取值见 文件传输编码规则
InteractionVersion2048M0
SourceDeviceID2052OSHALL 省略
DestinationDeviceID2056OSHALL 省略
ProtocolID2064M0x00 或 0x02
OpCode2072M见 通道 的 OpCode 表,SHALL 使用最短 uint 编码
PayloadEncryption2076M0
场景发送方接收方
业务命令(含录像查询)Code 0.02,非空 Token2.04 Changed,回显同一 Token
文件传输Code 0.02,非空 Token2.04 Changed,回显同一 Token。交互见 OpCode 总表
分辨率与回放状态上报Code 0.02,空 Token,OpCode 0x018A不返回 CoAP 响应
物模型命令的业务失败-留在 InvokeCommand 的 ComplexACK 里,成员 0 为 Status
文件传输的业务失败-errorResponse,不是 StatusCodeEnum8

aqara.control 的结构体编码为 JSON Object,成员键为成员序号的十进制字符串。aqara.download 的编码见 文件传输编码规则。标记为必须、但语义上可空的 JSON 成员无值时编码为 null,不省略该键。LocalRecordQuery 的 QueryLocalRecordType 指明种类。LocalRecordIndex 与 LocalRecordSegment 只出现它指向的那一个。

SDP 与 DCEP​

m=application 在 Offer 与 Answer 里都只有下面几行。ICE 候选、a=setup 与指纹和音视频共用。这条 m= 的 mid 放进会话级的 a=group:BUNDLE。

Offer(App):

m=application 9 UDP/DTLS/SCTP webrtc-datachannel
c=IN IP4 0.0.0.0
a=mid:2
a=sctp-port:5000
a=setup:actpass
a=ice-ufrag:offerufrag
a=ice-pwd:offericepwd0123456789abcd
a=fingerprint:sha-256 AA:BB:CC:DD

Answer(设备):

m=application 9 UDP/DTLS/SCTP webrtc-datachannel
c=IN IP4 0.0.0.0
a=mid:2
a=sctp-port:5000
a=setup:passive
a=ice-ufrag:answerufrag
a=ice-pwd:answericepwd0123456789abcd
a=fingerprint:sha-256 EE:FF:00:11

设备不接受这条 m= 时,端口写 0 并加 a=inactive。会话照常建立,只是没有 DataChannel。切档、查询与文件传输都不可用,媒体仍按开播分辨率发送。

label、Channel Type 与 Priority 不写进 SDP,由 RFC 8832(WebRTC Data Channel Establishment Protocol)在 association 上打开。App 是 Offer 方时 stream id 取偶。

DATA_CHANNEL_OPEN 的格式见 RFC 8832 第 5.1 节:

 0                   1                   2                   3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Message Type | Channel Type | Priority |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Reliability Parameter |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Label Length | Protocol Length |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
\ /
| Label |
/ \
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
\ /
| Protocol |
/ \
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

DATA_CHANNEL_ACK 的格式见 RFC 8832 第 5.2 节:

 0                   1                   2                   3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| Message Type |
+-+-+-+-+-+-+-+-+

App 为每个 Data Channel 发一条 DATA_CHANNEL_OPEN。表的第一列是 Label 字段的取值:

labelPrioritystream id报文(十六进制)
aqara.control1024003 00 04 00 00 00 00 00 00 0D 00 00 + 61 71 61 72 61 2E 63 6F 6E 74 72 6F 6C
aqara.download128203 00 00 80 00 00 00 00 00 0E 00 00 + 61 71 61 72 61 2E 64 6F 77 6E 6C 6F 61 64

本绑定的取值:Message Type 0x03,Channel Type 0x00(DATA_CHANNEL_RELIABLE),Reliability Parameter 为 0,Protocol Length 为 0,Protocol 为空。Priority、Label Length 与 Label 见上表。DATA_CHANNEL_ACK 的 Message Type 为 0x02。a=max-message-size 不写,缺省单条 SCTP 用户消息 65536 字节。stream id 不在 OPEN 报文体里。App 把这条 OPEN 发在该 Data Channel 的 stream id 上,进出方向使用同一个 stream id。

设备收到某个 label 的 DATA_CHANNEL_OPEN 并回 DATA_CHANNEL_ACK 之后,才认为该 label 可用。在此之前,App SHALL NOT 在该 label 上发消息。m=application、DTLS 与 SCTP association 不随 label 再建立一次。消息按 label 隔离,见 通道。

通道上报 Trait​

通道命令 Command​

当前 label aqara.control 上支持的 Command。规格见 WebRTC 的 DataChannel 通道命令表与对应 Command 定义。

文件传输绑定​

App 是 Requestor,设备是 Provider。LocalRecordQuery 的条目给出 FileDescriptorStructure。字段含义见 文件传输业务交互协议 的依赖一节,并原样写入 initRequest。编码见 文件传输编码规则。

  • label aqara.download 只承载 ProtocolID 0x02。设备不在该 label 上主动下发字节,当前只有请求方拉取。
  • 该 label 上同时只有一个未结束的 transferId。第二个 initRequest 回 Busy(errorResponse)。
  • 块的请求次序、末块与取消遵循 blockRequest、EOFRequest 与 abortRequest。
  • 本绑定把「安全会话」定为这一条 PeerConnection 的 DTLS 会话。transferId 在该会话内唯一、非零。WebRTCEndSession、DataChannel 关闭或 DTLS 结束时,未完成的传输作废,双方释放资源。
  • 拔卡、循环覆盖或读失败不由设备另发取消。当前批次或下一次请求上的结果见 errorResponse。
  • 媒体类型不在文件传输协议里。mp4 与索引原格式由业务对象决定。
  • 协商 maxBlockSize 时,为 CoAP 封装和 CBOR 开销预留空间,见文件传输协议的文件块报文。blockResponse 的 CBOR Map 还包含当前块号 blockCounter,封装开销随块号和 data 长度的 CBOR 编码宽度变化,不再按固定 25 字节计算。示例取 maxBlockSize 为 32768。

SO2(二氧化硫)​

简介​

表示对空气中二氧化硫的监测功能域,包括但不限于 SO2 浓度测量、是否检测到 SO2、超标报警、传感器状态等能力。

Function 标识​

Function IDCode名称
0x0128SO2二氧化硫

Trait​

Trait IDCode名称Conformance
0x519FSO2Density二氧化硫浓度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x519FSO2DensityM

SO2Density Trait(二氧化硫浓度)​

表示空气中二氧化硫浓度,用于评估刺激性气体污染水平,并辅助进行环境安全监测和告警判断。单位:ug/m^3。

Trait IDCode
0x519FSO2Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat9999.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

NO2(二氧化氮)​

简介​

表示对空气中二氧化氮的监测功能域,包括但不限于 NO2 浓度测量、是否检测到 NO2、超标报警、传感器状态等能力。

Function 标识​

Function IDCode名称
0x0129NO2二氧化氮

Trait​

Trait IDCode名称Conformance
0x51A0NO2Density二氧化氮M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51A0NO2DensityM

NO2Density Trait(二氧化氮)​

表示空气中二氧化氮浓度,可用于评估燃烧或尾气相关污染水平以及空气质量风险。单位:ug/m^3。

Trait IDCode
0x51A0NO2Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat9999.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

O3(臭氧)​

简介​

表示对空气中臭氧的监测功能域,包括但不限于 O3 浓度测量、是否检测到 O3、超标报警、传感器状态等能力。

Function 标识​

Function IDCode名称
0x012AO3臭氧

Trait​

Trait IDCode名称Conformance
0x51A1O3Density臭氧浓度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51A1O3DensityM

O3Density Trait(臭氧浓度)​

表示空气中臭氧浓度,用于评估氧化性污染水平,并辅助判断空气暴露风险和净化需求。单位:ug/m^3。

Trait IDCode
0x51A1O3Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat9999.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

Formaldehyde(甲醛)​

简介​

表示对空气中甲醛的监测功能域,包括但不限于 HCHO 浓度测量、是否检测到甲醛、超标报警、传感器状态等能力。

Function 标识​

Function IDCode名称
0x012BFormaldehyde甲醛

Trait​

Trait IDCode名称Conformance
0x51A3HCHODensity甲醛浓度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51A3HCHODensityM

HCHODensity Trait(甲醛浓度)​

表示空气中甲醛浓度,用于监测装修污染风险,并辅助判断是否需要持续通风或净化处理。单位:ug/m^3。

Trait IDCode
0x51A3HCHODensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat9999.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

O2(氧气)​

简介​

表示对环境中氧气的监测功能域,包括但不限于 O2 浓度测量、缺氧/富氧判定、传感器状态等能力。

Function 标识​

Function IDCode名称
0x012CO2氧气

Trait​

Trait IDCode名称Conformance
0x51A4O2Density氧气M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51A4O2DensityM

O2Density Trait(氧气)​

表示空气中氧气体积分数,用于判断环境供氧水平,并辅助评估密闭空间或特殊场景下的安全性。单位:%vol。

Trait IDCode
0x51A4O2Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat21RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat21RWO

Command 定义​

本 Function 不包含 Command。

Chlorine(氯气)​

简介​

表示对空气中氯气的监测功能域,包括但不限于 Cl2 浓度测量、是否检测到氯气、超标报警、传感器状态等能力。

Function 标识​

Function IDCode名称
0x012DChlorine氯气

Trait​

Trait IDCode名称Conformance
0x51A5Cl2Density氯气浓度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51A5Cl2DensityM

Cl2Density Trait(氯气浓度)​

表示空气中氯气浓度,用于监测强刺激性气体泄漏风险,并支持安全告警。单位:mg/m^3。

Trait IDCode
0x51A5Cl2Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat1000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

HydrochloricAcid(盐酸)​

简介​

表示对空气中盐酸气体的监测功能域,包括但不限于 HCl 浓度测量、是否检测到盐酸气体、超标报警、传感器状态等能力。

Function 标识​

Function IDCode名称
0x012EHydrochloricAcid盐酸

Trait​

Trait IDCode名称Conformance
0x51A6HClDensity盐酸浓度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51A6HClDensityM

HClDensity Trait(盐酸浓度)​

表示空气中盐酸浓度,可用于监测酸性刺激气体污染情况和环境安全风险。单位:mg/m^3。

Trait IDCode
0x51A6HClDensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat1000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

HydrogenSulfide(硫化氢)​

简介​

表示对空气中硫化氢的监测功能域,包括但不限于 H2S 浓度测量、是否检测到硫化氢、超标报警、传感器状态等能力。

Function 标识​

Function IDCode名称
0x012FHydrogenSulfide硫化氢

Trait​

Trait IDCode名称Conformance
0x51A7H2SDensity硫化氢浓度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51A7H2SDensityM

H2SDensity Trait(硫化氢浓度)​

表示空气中硫化氢浓度,用于监测有毒有害气体风险,并辅助进行通风与告警联动。单位:ug/m^3。

Trait IDCode
0x51A7H2SDensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat9999.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

Ammonia(氨气)​

简介​

表示对空气中氨气的监测功能域,包括但不限于 NH3 浓度测量、是否检测到氨气、超标报警、传感器状态等能力。

Function 标识​

Function IDCode名称
0x0130Ammonia氨气

Trait​

Trait IDCode名称Conformance
0x51A8NH3Density氨气浓度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51A8NH3DensityM

NH3Density Trait(氨气浓度)​

表示空气中氨气浓度,用于评估刺激性气体污染水平,并辅助判断泄漏或环境异常。单位:ug/m^3。

Trait IDCode
0x51A8NH3Density
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat9999.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

WaterQuality(水质)​

简介​

表示对水质的监测功能域,涵盖但不限于水的硬度、浊度、pH、TDS(溶解性总固体)、余氯、溶解氧等水质参数的测量与状态判定,以及传感器状态、超标报警等能力。

Function 标识​

Function IDCode名称
0x0131WaterQuality水质

Trait​

Trait IDCode名称Conformance
0x51ABWaterHardness水质硬度M
0x51ACWaterTurbidity水质浊度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51ABWaterHardnessM
0x51ACWaterTurbidityM

WaterHardness Trait(水质硬度)​

表示水质硬度水平,通常反映水中钙镁离子含量,可用于判断结垢风险和水处理需求。单位:ppm。

Trait IDCode
0x51ABWaterHardness
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

WaterTurbidity Trait(水质浊度)​

表示水体浑浊程度,可用于判断悬浮颗粒杂质水平和水体清洁度。单位:NTU。

Trait IDCode
0x51ACWaterTurbidity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat4000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

NitrogenOxides(氮氧化物)​

简介​

表示对空气中氮氧化物的监测功能域,包括但不限于 NOx 浓度测量、是否检测到氮氧化物、超标报警、传感器状态等能力。

Function 标识​

Function IDCode名称
0x0132NitrogenOxides氮氧化物

Trait​

Trait IDCode名称Conformance
0x51AFNOxDensity氮氧化物浓度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51AFNOxDensityM

NOxDensity Trait(氮氧化物浓度)​

表示空气中氮氧化物浓度,用于评估燃烧污染水平和空气质量风险。单位:mg/m^3。

Trait IDCode
0x51AFNOxDensity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat1000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

LiquidLevel(液位)​

简介​

表示对容器或管路内液体液位的监测功能域,包括但不限于液位高度测量、储液量判断、补排液需求分析、高低液位风险预警等能力。

Function 标识​

Function IDCode名称
0x0133LiquidLevel液位

Trait​

Trait IDCode名称Conformance
0x51ECLiquidLevelHeight液位高度M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51ECLiquidLevelHeightM

LiquidLevelHeight Trait(液位高度)​

表示容器或管路内液体表面的实际高度,用于判断储液量、补排液需求以及高低液位风险。单位:m。

Trait IDCode
0x51ECLiquidLevelHeight
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

Noise(噪声)​

简介​

表示对环境噪声的监测功能域,包括但不限于噪声级测量、噪声是否超标判定、峰值噪声、平均噪声等能力。

Function 标识​

Function IDCode名称
0x0134Noise噪声

Trait​

本 Function 不包含 Trait。

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

本 Function 不包含 Trait。

Command 定义​

本 Function 不包含 Command。

HeatMeter(热量计量)​

简介​

表示对供热/供冷系统中冷热量计量功能的综合管理,涵盖瞬时热流量、瞬时冷流量、热量累计值、冷量累计值及其小数部分等参数的测量与上报,用于能耗计量、能效分析和费用结算。

Function 标识​

Function IDCode名称
0x0135HeatMeter热量计量

Trait​

Trait IDCode名称Conformance
0x51BDInstantaneousColdFlow瞬时冷流量M
0x51C1InstantaneousHeatFlow瞬时热流量M

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51BDInstantaneousColdFlowM
0x51C1InstantaneousHeatFlowM

InstantaneousColdFlow Trait(瞬时冷流量)​

表示当前时刻传递的冷量流率,可用于判断系统实时供冷能力和冷负荷变化。单位:m^3/s。

Trait IDCode
0x51BDInstantaneousColdFlow
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

InstantaneousHeatFlow Trait(瞬时热流量)​

表示当前时刻传递的热量流率,可用于判断系统实时供热强度和负荷变化。单位:GJ/h。

Trait IDCode
0x51C1InstantaneousHeatFlow
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat100000000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

Command 定义​

本 Function 不包含 Command。

Boiler(锅炉)​

简介​

表示对锅炉设备运行状态的监测与控制功能域,涵盖排烟温度、火力调节、负荷输出、燃烧计时、点火次数等参数的测量、设定与上报,用于锅炉的燃烧控制、能效分析和安全监控。

Function 标识​

Function IDCode名称
0x0136Boiler锅炉

Trait​

Trait IDCode名称Conformance
0x51E1SupplyWaterPressure供水压力M
0x51E2ReturnWaterPressure回水压力M
0x51E3SupplyWaterTemperature供水温度M
0x51E4ReturnWaterTemperature回水温度M
0x51E5ExhaustTemperature排烟温度值M
0x51E6TargetTemperatureDifferential目标温差值O
0x51E7MinimumFireRate最小火力O
0x51E8MaximumFireRate最大火力O
0x51E9TimeToMaximumLoadSetting到最大负荷时间设定O
0x51EAAccumulatedCombustionTime燃烧累计计时O
0x51EBIgnitionCount点火次数O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51E1SupplyWaterPressureM
0x51E2ReturnWaterPressureM
0x51E3SupplyWaterTemperatureM
0x51E4ReturnWaterTemperatureM
0x51E5ExhaustTemperatureM
0x51E6TargetTemperatureDifferentialO
0x51E7MinimumFireRateO
0x51E8MaximumFireRateO
0x51E9TimeToMaximumLoadSettingO
0x51EAAccumulatedCombustionTimeO
0x51EBIgnitionCountO

SupplyWaterPressure Trait(供水压力)​

表示锅炉供水侧管路压力,用于判断供水回路是否稳定以及是否存在压力异常。单位:MPa。

Trait IDCode
0x51E1SupplyWaterPressure
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat10.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

ReturnWaterPressure Trait(回水压力)​

表示锅炉回水侧管路压力,用于判断回水回路运行状态及系统压差变化。单位:MPa。

Trait IDCode
0x51E2ReturnWaterPressure
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat10.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat0RWO

SupplyWaterTemperature Trait(供水温度)​

表示锅炉供水回路输出介质温度,用于判断供热输出水平和当前供水工况。单位: degC。

Trait IDCode
0x51E3SupplyWaterTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

ReturnWaterTemperature Trait(回水温度)​

表示锅炉回水回路返回介质温度,用于分析回水工况和系统换热效果。单位: degC。

Trait IDCode
0x51E4ReturnWaterTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

ExhaustTemperature Trait(排烟温度值)​

表示锅炉排烟温度,用于判断燃烧换热效果、排烟损失以及是否存在异常热工状态。单位: degC。

Trait IDCode
0x51E5ExhaustTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

TargetTemperatureDifferential Trait(目标温差值)​

表示锅炉控制目标采用的供回水温差设定,用于指导负荷调节和热工平衡控制。单位: degC。

Trait IDCode
0x51E6TargetTemperatureDifferential
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVWO
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

MinimumFireRate Trait(最小火力)​

表示锅炉允许运行的最小燃烧输出边界,用于限制低负荷运行下的稳定燃烧范围。单位:%。

Trait IDCode
0x51E7MinimumFireRate
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

MaximumFireRate Trait(最大火力)​

表示锅炉允许运行的最大燃烧输出边界,用于限制高负荷运行下的输出上限。单位:%。

Trait IDCode
0x51E8MaximumFireRate
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

TimeToMaximumLoadSetting Trait(到最大负荷时间设定)​

表示锅炉从当前状态升至最大负荷所允许的设定时间,用于控制升载速度和热冲击。单位:h。

Trait IDCode
0x51E9TimeToMaximumLoadSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVWO
0x0002Maximum Valuefloat1000000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

AccumulatedCombustionTime Trait(燃烧累计计时)​

表示锅炉累计燃烧运行时长,可用于维护保养、寿命评估和运行统计分析。单位:h。

Trait IDCode
0x51EAAccumulatedCombustionTime
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat240000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

IgnitionCount Trait(点火次数)​

表示锅炉累计点火次数,用于分析启停频率、燃烧器使用强度和维护需求。

Trait IDCode
0x51EBIgnitionCount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320RVO
0x0002Maximum Valueuint321000000RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO
0x0007Default Valueuint320RWO

Command 定义​

本 Function 不包含 Command。

ControlCabinet(控制柜)​

简介​

表示对控制柜设备的监测与控制功能域,涵盖频率反馈、冷却水温度实际值与设定值、温差设置、手动频率给定等参数的测量、设定与上报,用于冷却水系统控制、频率调节和运行监控。

Function 标识​

Function IDCode名称
0x0137ControlCabinet控制柜

Trait​

Trait IDCode名称Conformance
0x51DAFrequencyFeedback频率反馈M
0x51DBCoolingWaterActualTemperature冷却水温度实际值M
0x51DCCoolingWaterTemperatureSetpoint冷却水温度设定值O
0x51DDTemperatureDifferentialSetting设置温差O
0x51DEManualFrequencySetpoint手动频率给定O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51DAFrequencyFeedbackM
0x51DBCoolingWaterActualTemperatureM
0x51DCCoolingWaterTemperatureSetpointO
0x51DDTemperatureDifferentialSettingO
0x51DEManualFrequencySetpointO

FrequencyFeedback Trait(频率反馈)​

表示设备采集到的变频运行反馈频率。单位:Hz。

Trait IDCode
0x51DAFrequencyFeedback
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat50RWO

CoolingWaterActualTemperature Trait(冷却水温度实际值)​

表示控制柜监测到的冷却水实际温度,用于判断冷却回路当前工况和温控效果。单位: degC。

Trait IDCode
0x51DBCoolingWaterActualTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

CoolingWaterTemperatureSetpoint Trait(冷却水温度设定值)​

表示控制柜用于温控调节的冷却水目标温度,用于决定冷却回路的控制目标和启停策略。单位: degC。

Trait IDCode
0x51DCCoolingWaterTemperatureSetpoint
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat26RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat26RWO

TemperatureDifferentialSetting Trait(设置温差)​

表示控制柜温控策略采用的温差阈值,用于决定达到多大温差后执行调节、启停或联动动作。单位: degC。

Trait IDCode
0x51DDTemperatureDifferentialSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVWO
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

ManualFrequencySetpoint Trait(手动频率给定)​

表示手动模式下下发给控制柜的目标运行频率,用于人工指定变频输出水平。单位:Hz。

Trait IDCode
0x51DEManualFrequencySetpoint
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat50RWO

Command 定义​

本 Function 不包含 Command。

Compressor(压缩机)​

简介​

表示对压缩机设备运行状态的监测与控制功能域,涵盖温度、压力、电流、电压、功率、湿度、转速、开度、运行时间、制冷量等参数的测量、设定与上报,用于制冷系统控制、能效分析和安全监控。

Function 标识​

Function IDCode名称
0x0138Compressor压缩机

Trait​

Trait IDCode名称Conformance
0x51C2CoolingCapacityPercentage制冷量百分比M
0x51C3AverageLineCurrent平均线电流M
0x51C4ChilledWaterInletTemperature冷冻水进水温度M
0x51C5ChilledWaterOutletTemperature冷冻水出水温度M
0x51C6EvaporatorRefrigerantTemperature蒸发器冷媒温度M
0x51C7ChilledEvaporatorRefrigerantPressure冷蒸发器冷媒压力M
0x51C8CoolingWaterInletTemperature冷却水进水温度M
0x51C9CoolingWaterOutletTemperature冷却水出水温度M
0x51CACondenserRefrigerantTemperature冷凝器冷媒温度M
0x51CBCondenserRefrigerantPressure冷凝器冷媒压力M
0x51CCVFDCoolingRefrigerantFlowPercentage变频器冷却用制冷剂流量百分比O
0x51CDVFDSpeedPercentage变频器转速百分比O
0x51CEGuideVaneOpeningPercentage导叶开度百分比O
0x51CFRectifierTemperature整流器温度O
0x51D0CompressorOilTemperature压缩机油温O
0x51D1CompressorOilPressure压缩机油压O
0x51D2DischargeTemperature排气温度O
0x51D3CompressorBearingTemperature压缩机轴承温度O
0x51D4MotorCoilTemperature电机线圈温度O
0x51D5AverageLineVoltage平均线电压O
0x51D6LinePower线功率O
0x51D7VFDDeviceHumidity变频器装置湿度O
0x51D8InverterTemperature逆变器温度O
0x51D9OutletWaterTemperatureSetpoint出水温度设定O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51C2CoolingCapacityPercentageM
0x51C3AverageLineCurrentM
0x51C4ChilledWaterInletTemperatureM
0x51C5ChilledWaterOutletTemperatureM
0x51C6EvaporatorRefrigerantTemperatureM
0x51C7ChilledEvaporatorRefrigerantPressureM
0x51C8CoolingWaterInletTemperatureM
0x51C9CoolingWaterOutletTemperatureM
0x51CACondenserRefrigerantTemperatureM
0x51CBCondenserRefrigerantPressureM
0x51CCVFDCoolingRefrigerantFlowPercentageO
0x51CDVFDSpeedPercentageO
0x51CEGuideVaneOpeningPercentageO
0x51CFRectifierTemperatureO
0x51D0CompressorOilTemperatureO
0x51D1CompressorOilPressureO
0x51D2DischargeTemperatureO
0x51D3CompressorBearingTemperatureO
0x51D4MotorCoilTemperatureO
0x51D5AverageLineVoltageO
0x51D6LinePowerO
0x51D7VFDDeviceHumidityO
0x51D8InverterTemperatureO
0x51D9OutletWaterTemperatureSetpointO

CoolingCapacityPercentage Trait(制冷量百分比)​

表示压缩机当前制冷输出相对额定能力的百分比,用于判断设备负载水平和容量调节状态。

Trait IDCode
0x51C2CoolingCapacityPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

AverageLineCurrent Trait(平均线电流)​

表示压缩机三相线路的平均工作电流,用于评估电气负载水平和运行负荷变化。单位:A。

Trait IDCode
0x51C3AverageLineCurrent
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat10000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.001RO
0x0007Default Valuefloat0RWO

ChilledWaterInletTemperature Trait(冷冻水进水温度)​

表示进入压缩机冷冻水回路的水温,用于判断蒸发侧负荷和进水工况。单位: degC。

Trait IDCode
0x51C4ChilledWaterInletTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

ChilledWaterOutletTemperature Trait(冷冻水出水温度)​

表示离开压缩机冷冻水回路的水温,用于判断制冷输出效果和出水工况。单位: degC。

Trait IDCode
0x51C5ChilledWaterOutletTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

EvaporatorRefrigerantTemperature Trait(蒸发器冷媒温度)​

表示蒸发器内制冷剂温度,用于判断蒸发换热状态和制冷循环运行情况。单位: degC。

Trait IDCode
0x51C6EvaporatorRefrigerantTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

ChilledEvaporatorRefrigerantPressure Trait(冷蒸发器冷媒压力)​

表示蒸发侧制冷剂压力,用于判断蒸发工况、制冷剂状态和系统运行是否正常。单位:kPa。

Trait IDCode
0x51C7ChilledEvaporatorRefrigerantPressure
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat5000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

CoolingWaterInletTemperature Trait(冷却水进水温度)​

表示进入压缩机冷却水回路的水温,用于判断冷凝侧散热条件和进水工况。单位: degC。

Trait IDCode
0x51C8CoolingWaterInletTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

CoolingWaterOutletTemperature Trait(冷却水出水温度)​

表示离开压缩机冷却水回路的水温,用于判断冷凝侧散热效果和出水工况。单位: degC。

Trait IDCode
0x51C9CoolingWaterOutletTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

CondenserRefrigerantTemperature Trait(冷凝器冷媒温度)​

表示冷凝器内制冷剂温度,用于判断冷凝换热状态和制冷循环效率。单位: degC。

Trait IDCode
0x51CACondenserRefrigerantTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVM
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

CondenserRefrigerantPressure Trait(冷凝器冷媒压力)​

表示冷凝侧制冷剂压力,用于判断高压侧工况、散热状态和运行风险。单位:kPa。

Trait IDCode
0x51CBCondenserRefrigerantPressure
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVM
0x0002Maximum Valuefloat5000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

VFDCoolingRefrigerantFlowPercentage Trait(变频器冷却用制冷剂流量百分比)​

表示变频器冷却回路中制冷剂流量相对设计值的比例,用于判断变频器冷却能力是否充足。单位:%。

Trait IDCode
0x51CCVFDCoolingRefrigerantFlowPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

VFDSpeedPercentage Trait(变频器转速百分比)​

表示变频器当前转速相对额定转速的比例,可用于判断压缩机调速输出水平以及变频运行负载状态。单位:%。

Trait IDCode
0x51CDVFDSpeedPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

GuideVaneOpeningPercentage Trait(导叶开度百分比)​

表示压缩机导叶当前开启程度的比例,可用于判断容量调节幅度以及进气控制状态。单位:%。

Trait IDCode
0x51CEGuideVaneOpeningPercentage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

RectifierTemperature Trait(整流器温度)​

表示整流器工作温度,用于监测功率电子部件的热状态并辅助判断散热是否正常。单位: degC。

Trait IDCode
0x51CFRectifierTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVO
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

CompressorOilTemperature Trait(压缩机油温)​

表示压缩机润滑油当前温度,用于判断润滑与散热状况,油温异常时可能影响设备寿命和运行安全。单位: degC。

Trait IDCode
0x51D0CompressorOilTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVO
0x0002Maximum Valuefloat150.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

CompressorOilPressure Trait(压缩机油压)​

表示压缩机润滑油压力,用于判断润滑系统是否正常建立油膜并维持安全运行。单位:kPa。

Trait IDCode
0x51D1CompressorOilPressure
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat5000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat0RWO

DischargeTemperature Trait(排气温度)​

表示压缩机排气端的气体温度,用于判断压缩过程热状态和是否存在过热风险。单位: degC。

Trait IDCode
0x51D2DischargeTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVO
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

CompressorBearingTemperature Trait(压缩机轴承温度)​

表示压缩机轴承工作温度,用于监测机械摩擦、润滑效果和轴承健康状态。单位: degC。

Trait IDCode
0x51D3CompressorBearingTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVO
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

MotorCoilTemperature Trait(电机线圈温度)​

表示压缩机驱动电机线圈温度,用于判断电机热负荷和绝缘运行风险。单位: degC。

Trait IDCode
0x51D4MotorCoilTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVO
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

AverageLineVoltage Trait(平均线电压)​

表示压缩机三相线路的平均工作电压,用于评估供电质量和电压稳定性。单位:V。

Trait IDCode
0x51D5AverageLineVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat220RVO
0x0002Maximum Valuefloat500.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.01RO
0x0007Default Valuefloat220RWO

LinePower Trait(线功率)​

表示压缩机当前线路输入功率,可用于评估设备耗电水平和运行负载变化。单位:W。

Trait IDCode
0x51D6LinePower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0RVO
0x0002Maximum Valuefloat5000000.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat0RWO

VFDDeviceHumidity Trait(变频器装置湿度)​

表示变频器装置周边环境湿度,用于判断电气环境是否存在结露、受潮或绝缘风险。单位:%。

Trait IDCode
0x51D7VFDDeviceHumidity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat1.0RO
0x0007Default Valuefloat50RWO

InverterTemperature Trait(逆变器温度)​

表示逆变器工作温度,用于监测功率器件热状态并辅助判断散热和负载情况。单位: degC。

Trait IDCode
0x51D8InverterTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat25RVO
0x0002Maximum Valuefloat300.0RO
0x0003Minimum Valuefloat-50.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat25RWO

OutletWaterTemperatureSetpoint Trait(出水温度设定)​

表示给压缩机的出水温度设定目标,用于调整冷冻水出水控制目标并影响制冷调节策略。单位: degC。

Trait IDCode
0x51D9OutletWaterTemperatureSetpoint
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat26RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat26RWO

Command 定义​

本 Function 不包含 Command。

CoolingPump(冷却泵)​

简介​

表示对冷却泵设备的监测与控制功能域,涵盖频率反馈、手动频率给定、频率上下限、运行时间等参数的测量、设定与上报,用于冷却水循环系统的频率调节、运行监控和能耗管理。

Function 标识​

Function IDCode名称
0x0139CoolingPump冷却泵

Trait​

Trait IDCode名称Conformance
0x51DAFrequencyFeedback频率反馈M
0x51E0ManualFrequencySetting手动给定频率O

Command​

本 Function 不包含 Command。

数据类型​

本 Function 无自定义数据类型。

Trait 定义​

Trait IDNameConformance
0x51DAFrequencyFeedbackM
0x51E0ManualFrequencySettingO

FrequencyFeedback Trait(频率反馈)​

表示设备采集到的变频运行反馈频率。单位:Hz。

Trait IDCode
0x51DAFrequencyFeedback
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVM
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat50RWO

ManualFrequencySetting Trait(手动给定频率)​

表示冷却泵在手动模式下设定的目标运行频率,用于人工指定电机转速和流量水平。单位:Hz。

Trait IDCode
0x51E0ManualFrequencySetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat50RVWO
0x0002Maximum Valuefloat100.0RO
0x0003Minimum Valuefloat0.0RO
0x0005Step Valuefloat0.1RO
0x0007Default Valuefloat50RWO

Command 定义​

本 Function 不包含 Command。

Buzzer(蜂鸣器)​

简介​

表示设备蜂鸣器的控制功能域,用于播放或停止蜂鸣器声音,支持设置播放音量和播放时长,适用于门铃提示、报警提醒、操作反馈等场景。

Function 标识​

Function IDCode名称
0x013ABuzzer蜂鸣器

Trait​

Trait IDCodeConformance
0x5163BuzzerVolumeO

Command​

Command IDCodeConformance
0x9DB4PlayBuzzerM

数据类型​

BuzzerPlayStatusEnum8 Type​

该枚举定义 PlayBuzzer Command 的播放状态。

ValueNameDescription
0x00Stopped停止
0x01Playing播放
BuzzerPlayVolumeEnum8 Type​

该枚举定义 PlayBuzzer Command 的播放音量。

ValueNameDescription
0x01Low低音量
0x02Medium中音量
0x03High高音量
PlayBuzzer Command Structure Type​

PlayBuzzer Command 的参数结构体。

结构体成员序号字段名类型必须说明
0PlayStatusBuzzerPlayStatusEnum8M播放状态;默认值为 0。Stopped 表示停止当前正在播放的蜂鸣器声音;Playing 表示开始播放。
1PlayVolumeBuzzerPlayVolumeEnum8O播放音量;默认值为 2。
2PlayDurationuint32O播放时长(秒),取值范围为 1 至 4294967295,步长为 1;默认值为 5。

Trait 定义​

Trait IDNameConformance
0x5163BuzzerVolumeO

Command 定义​

Command IDNameConformance
0x9DB4PlayBuzzerM

PlayBuzzer Command​

控制设备播放或停止蜂鸣器声音。PlayStatus 为必填项,用于指定播放状态:PLAYING(Playing)表示开始播放,STOPPED(Stopped)表示停止播放。播放时可通过 PlayVolume 设置音量,通过 PlayDuration 设置播放时长;PlayDuration 大于 0 时表示播放指定秒数。PlayStatus 为 STOPPED 时,应省略 PlayVolume、PlayDuration 及其他所有可选参数,设备将停止当前正在播放的蜂鸣器声音。

参数​

PlayBuzzer Command Structure

GasMetering(燃气计量)​

简介​

燃气计量(GasMetering)用于提供燃气计量相关能力,包括燃气热值及工况体积到标准体积的换算系数,以支持燃气用量的能量折算和标准化换算。

Function 标识​

Function IDCode名称
0x013BGasMetering燃气计量

Trait​

Trait IDCodeConformance
0x51F5GasCalorificValueO
0x51F6GasVolumeFactorO

Command​

本 Function 不包含 Command。

数据类型​

GasCalorificValueTraitPresentValueStructure Type​

该结构体定义 GasCalorificValue Trait 的 Present Value 字段布局。

成员序号字段名类型必须最小值最大值步长默认值说明(单位)
0CalorificValuefloatM01000.0138.5标准体积燃气的热值,由气源/服务器端配置。单位:MJ/m^3(兆焦每标准立方米)。
1ReferenceTemperaturefloatO-50500.115.0热值所对应的燃烧参比温度。单位:deg C。
2ReferencePressurefloatO501500.001101.325热值所对应的参比压力。单位:kPa。

Trait 定义​

Trait IDNameConformance
0x51F5GasCalorificValueO
0x51F6GasVolumeFactorO

GasCalorificValue Trait​

燃气热值表示单位体积燃气所含的热量(能量),用于将燃气的体积消耗量换算为能量消耗量。通常以高位热值形式提供,即在标准参比条件下,单位标准体积燃气完全燃烧后所释放的热量。该值为燃气气质参数,受气源组分及参比温度、压力影响,通常由燃气公司或云端配置,燃气表据此完成体积到能量的转换。

Trait IDCode
0x51F5GasCalorificValue
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueGasCalorificValueTraitPresentValueStructure{&quot;0&quot;: 38.5, &quot;1&quot;: 15.0, &quot;2&quot;: 101.325}RVM

GasVolumeFactor Trait​

燃气体积换算系数表示将燃气表在工况条件(实际温度、压力)下测得的燃气体积,换算为标准参比条件下体积的系数(Volume Conversion Factor,VCF)。其定义为标准参比条件下的体积除以工况条件下的体积。该系数综合了温度、压力、压缩因子等因素的修正,通常由体积修正仪或云端计算后下发,燃气表据此完成体积标准化换算。

Trait IDCode
0x51F6GasVolumeFactor
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat1.0RVM
0x0002Maximum Valuefloat2RO
0x0003Minimum Valuefloat0.5RO
0x0005Step Valuefloat0.00001RO

Command 定义​

本 Function 不包含 Command。

EnergyStorage(储能)​

简介​

储能(EnergyStorage)用于描述电池储能系统的专属状态和能量计量能力,包括电池侧荷电状态、容量、充放电功率、累计充放电量和电池健康状态。SOC(State of Charge,荷电状态)由 BMS(Battery Management System,电池管理系统)测量或估算。设备自身用于维持控制器运行的备用电池不属于此 Function,应使用 PowerSource。

本 Function 中的充放电功率和电量以电池直流端为计量边界。PCS(Power Conversion System,储能变流器)交流侧功率/电量及电网并网点进口/出口数据属于 EnergyManagement 或 ElectricityMetering,受功率变换损耗影响,不应与电池侧计量值直接等同。

额定容量、可用容量、SOC 允许范围、最大充放电功率和 SOH 均为可选能力,不要求每个储能设备都提供。只有同时存在可信、有效且时效足够的 StateOfCharge 和当前 UsableEnergyCapacity 时,消费者才可估算当前可用电量;RatedEnergyCapacity、SOH 或功率限值不能替代其中任何一项。计算规则见 EnergyManagement。

Function 标识​

Function IDCode名称
0x013CEnergyStorage储能

Trait​

Trait IDCodeConformance
0x51F9StateOfChargeM
0x51FARatedEnergyCapacityO
0x51FBUsableEnergyCapacityO
0x51FCCumulativeChargeEnergyO
0x51FDCumulativeDischargeEnergyO
0x51FEChargePowerO
0x51FFDischargePowerO
0x5200StateOfHealthO
0x520AStoredEnergyO
0x520BACChargeCapacityO
0x520CACDischargeCapacityO
0x520DACChargeableCapacityO
0x520EACDischargeableCapacityO
0x520FACChargeableEnergyO
0x5210ACDischargeableEnergyO
0x5211ACCumulativeChargeEnergyO
0x5212ACCumulativeDischargeEnergyO
0x5213ACRatedEnergyO
0x5214StorageRatedVoltageO
0x5215StorageChargeDischargePowerO
0x5216ACChargingAmountSettingO
0x5217ACDischargingAmountSettingO
0x5218BatteryTypeO
0x522EStorageOperationModeO
0x522FWorkingStorageOperationModeO

Command​

本 Function 不包含 Command。

Trait 定义​

Trait IDNameConformance
0x51F9StateOfChargeM
0x51FARatedEnergyCapacityO
0x51FBUsableEnergyCapacityO
0x51FCCumulativeChargeEnergyO
0x51FDCumulativeDischargeEnergyO
0x51FEChargePowerO
0x51FFDischargePowerO
0x5200StateOfHealthO
0x520AStoredEnergyO
0x520BACChargeCapacityO
0x520CACDischargeCapacityO
0x520DACChargeableCapacityO
0x520EACDischargeableCapacityO
0x520FACChargeableEnergyO
0x5210ACDischargeableEnergyO
0x5211ACCumulativeChargeEnergyO
0x5212ACCumulativeDischargeEnergyO
0x5213ACRatedEnergyO
0x5214StorageRatedVoltageO
0x5215StorageChargeDischargePowerO
0x5216ACChargingAmountSettingO
0x5217ACDischargingAmountSettingO
0x5218BatteryTypeO
0x522EStorageOperationModeO
0x522FWorkingStorageOperationModeO
StorageOperationModeEnum8 Type​

该枚举定义储能设备的运行模式。

ValueNameDescription
0x00RapidCharging快速充电
0x01Charging充电
0x02Discharging放电
0x03Standby待机
0x04Test测试
0x05Automatic自动
0x06Restart重启
0x07EffectiveCapacityRecalculation有效容量重新计算
0x08Other其他

StateOfCharge Trait​

荷电状态(SOC)表示储能电池当前可用电量相对于当前可用满充电量的百分比估算,由 BMS 测量或估算。SOC 为 0% 表示达到 BMS 配置的放电下限,100% 表示达到 BMS 配置的充电上限;它不表示电芯的绝对化学空/满状态,也不直接代表剩余可供负载使用的 kWh。设备报告的 SOC 必须符合此定义;无法确认其含义、有效性或时效时,不得将其作为可信 SOC 用于推算。单位 %,精度 0.1%。用于能源管理界面展示、充放电策略和低电量判断。设备暂时无法确定 SOC 时应将值标记为不可用,而不是伪报为 0%。

Trait IDCode
0x51F9StateOfCharge
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-100 %无固定默认值;报告当前 BMS 值RVM
0x0002Maximum Valuefloat无固定默认值;可选报告设备允许的 SOC 上限RO
0x0003Minimum Valuefloat无固定默认值;可选报告设备允许的 SOC 下限RO
0x0005Step Valuefloat0.1RO

StoredEnergy Trait​

剩余储能量表示电池当前储存的能量,单位 kWh;它是绝对能量值,不是荷电百分比或可用容量。设备直接报告时应使用设备的有效测量值。消费者只有在 StateOfCharge 可信且 UsableEnergyCapacity 为当前有效值时,才可按 UsableEnergyCapacity × StateOfCharge / 100 估算;不得用额定容量代替可用容量,也不得将缺失或无效输入当作 0。

Trait IDCode
0x520AStoredEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000 kWh无固定默认值;报告当前值RVO
0x0002Maximum Valuefloat1000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.001RO

ACChargeCapacity Trait​

交流充电有效容量表示按设备定义的交流侧计量边界可用于充电的有效能量容量,单位 W·h;不得与电池直流侧额定容量或可用容量混用。

Trait IDCode
0x520BACChargeCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h无固定默认值;报告设备值RVO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ACDischargeCapacity Trait​

交流放电有效容量表示按设备定义的交流侧计量边界可用于放电的有效能量容量,单位 W·h;不等同于电池侧可用容量。

Trait IDCode
0x520CACDischargeCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h无固定默认值;报告设备值RVO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ACChargeableCapacity Trait​

交流可充电容量表示当前交流侧计量边界下仍可充入的能量容量,单位 W·h。

Trait IDCode
0x520DACChargeableCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h无固定默认值;报告设备值RVO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ACDischargeableCapacity Trait​

交流可放电容量表示当前交流侧计量边界下仍可放出的能量容量,单位 W·h。

Trait IDCode
0x520EACDischargeableCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h无固定默认值;报告设备值RVO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ACChargeableEnergy Trait​

交流可充入电量表示当前条件下设备允许新增的充电能量,单位 W·h。

Trait IDCode
0x520FACChargeableEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h无固定默认值;报告设备值RVO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ACDischargeableEnergy Trait​

交流可放出电量表示当前条件下设备允许新增的放电能量,单位 W·h。

Trait IDCode
0x5210ACDischargeableEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h无固定默认值;报告设备值RVO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ACCumulativeChargeEnergy Trait​

交流侧累计充电量表示当前计数器代际内的非负累计值,单位 W·h;该量的计量边界由储能设备定义,不得与电池直流侧的 CumulativeChargeEnergy 混用。计数器代际规则见 EnergyManagement。

Trait IDCode
0x5211ACCumulativeChargeEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ACCumulativeDischargeEnergy Trait​

交流侧累计放电量表示当前计数器代际内的非负累计值,单位 W·h;该量的计量边界由储能设备定义,不得与电池直流侧的 CumulativeDischargeEnergy 混用。计数器代际规则见 EnergyManagement。

Trait IDCode
0x5212ACCumulativeDischargeEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ACRatedEnergy Trait​

交流额定电能表示设备交流侧标称能量容量,单位 W·h;其与电池直流侧额定容量的换算关系由设备规格确定。

Trait IDCode
0x5213ACRatedEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h无固定默认值;由产品规格确定RVO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

StorageRatedVoltage Trait​

储能额定电压表示储能设备标称工作电压,单位 V。

Trait IDCode
0x5214StorageRatedVoltage
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000 V无固定默认值;由产品规格确定RVO
0x0002Maximum Valuefloat1000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

StorageChargeDischargePower Trait​

瞬时充放电功率以单一带符号值表示,单位 W;正值表示充电,负值表示放电,零表示无功率流。与分别报告的电池侧 ChargePower 和 DischargePower 不应在同一边界上重复计量。

Trait IDCode
0x5215StorageChargeDischargePower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat-5000000-5000000 W0RVO
0x0002Maximum Valuefloat5000000RO
0x0003Minimum Valuefloat-5000000RO
0x0005Step Valuefloat0.1RO

ACChargingAmountSetting Trait​

交流充电量设定表示设备允许的交流侧目标充电电量,单位 W·h。

Trait IDCode
0x5216ACChargingAmountSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320-999999999 W·h无固定默认值;报告当前设定RVWO
0x0002Maximum Valueuint32999999999RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

ACDischargingAmountSetting Trait​

交流放电量设定表示设备允许的交流侧目标放电电量,单位 W·h。

Trait IDCode
0x5217ACDischargingAmountSetting
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint320-999999999 W·h无固定默认值;报告当前设定RVWO
0x0002Maximum Valueuint32999999999RO
0x0003Minimum Valueuint320RO
0x0005Step Valueuint321RO

BatteryType Trait​

电池类型表示设备上报的电池种类标识,采用文本值保留设备给出的类别名称;不用于表示电池状态。

Trait IDCode
0x5218BatteryType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuecharacterString设备定义的类别名称无固定默认值RVO

StorageOperationMode Trait​

储能运行模式表示设备设定的运行模式,可读写。

Trait IDCode
0x522EStorageOperationMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStorageOperationModeEnum80-8无固定默认值RVWO
0x0006Supported Valuelist[StorageOperationModeEnum8]RO

WorkingStorageOperationMode Trait​

实际储能运行模式表示设备当前正在执行的运行模式;其枚举值与设定模式使用相同定义。

Trait IDCode
0x522FWorkingStorageOperationMode
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueStorageOperationModeEnum80-8无固定默认值RVO

RatedEnergyCapacity Trait​

额定容量表示制造商标称的电池能量容量,单位 kWh。该值是产品规格参数,通常在电池额定测试条件下给出;它不是当前 SOC 对应的剩余能量,也不等于扣除 BMS 保护范围后当前可用的容量。用于设备规格展示和系统容量规划。

Trait IDCode
0x51FARatedEnergyCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0.001-1000000 kWh无固定默认值;由产品规格确定RVM
0x0002Maximum Valuefloat1000000RO
0x0003Minimum Valuefloat0.001RO
0x0005Step Valuefloat0.001RO

UsableEnergyCapacity Trait​

可用容量表示按当前 BMS 运行边界可供充放电使用的能量容量,单位 kWh。该值可能随温度、SOH、保护策略或运行条件变化;实现应采用设备可用容量的当前估算值,并不得将其与制造商标称的 RatedEnergyCapacity 混用。用于计划充放电和估算可调度能量。

Trait IDCode
0x51FBUsableEnergyCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000 kWh无固定默认值;报告当前 BMS 值RVO
0x0002Maximum Valuefloat1000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.001RO

CumulativeChargeEnergy Trait​

累计充电量表示当前计数器代际内流入电池的累计电能,计量边界为电池直流端。该值为非负累计值,单位 W·h,不与放电量抵消。用于分析电池充电过程和循环能量吞吐;如需计算往返效率,应确保充电量、放电量覆盖相同的电池侧边界和统计周期。设备重启不得清零读数或代际;复位、无法补偿的回卷及计量器更换须递增 Counter Generation。

Trait IDCode
0x51FCCumulativeChargeEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

CumulativeDischargeEnergy Trait​

累计放电量表示当前计数器代际内从电池流出的累计电能,计量边界为电池直流端。该值为非负累计值,单位 W·h,独立于累计充电量。用于分析电池放电过程、能量利用和循环统计;设备重启不得清零读数或代际;复位、无法补偿的回卷及计量器更换须递增 Counter Generation。

Trait IDCode
0x51FDCumulativeDischargeEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

ChargePower Trait​

充电功率表示当前流入电池的有功功率,计量边界为电池直流端,单位 W。该值始终为非负值;无充电时报告 0。与 DischargePower 分开报告,避免通过单个带符号值导致充电和放电含义因厂商而异。用于实时监控和充电功率调度。

Trait IDCode
0x51FEChargePower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-5000000 W0RVO
0x0002Maximum Valuefloat无固定默认值;可选报告设备支持的最大充电功率RO
0x0003Minimum Valuefloat无固定默认值;可选报告设备支持的最小充电功率RO
0x0005Step Valuefloat0.1RO

DischargePower Trait​

放电功率表示当前从电池流出的有功功率,计量边界为电池直流端,单位 W。该值始终为非负值;无放电时报告 0。与 ChargePower 分开报告。用于实时监控和可调度放电功率计算。

Trait IDCode
0x51FFDischargePower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-5000000 W0RVO
0x0002Maximum Valuefloat无固定默认值;可选报告设备支持的最大放电功率RO
0x0003Minimum Valuefloat无固定默认值;可选报告设备支持的最小放电功率RO
0x0005Step Valuefloat0.1RO

StateOfHealth Trait​

电池健康度(SOH)表示电池健康状态,范围 0-100%。为提高互操作性,定义为当前可用能量容量相对于制造商定义的初始可用能量容量的百分比;100% 表示与该基准相同,数值降低表示可用容量衰减。若设备按其他算法计算,必须在产品文档中说明,不能将不同算法的 SOH 直接比较。用于评估电池衰减和维护状态。单位 %,精度 0.1%。

Trait IDCode
0x5200StateOfHealth
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-100 %无固定默认值;报告当前 BMS 值RVO
0x0002Maximum Valuefloat100RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

Command 定义​

本 Function 不包含 Command。

ElectricityMetering(电能计量)​

简介​

电能计量(ElectricityMetering)用于描述电能表和并网点(Point of Common Coupling,PCC)的计量能力,包括测量点、带方向的实时有功功率、需量和分时累计电量。该 Function 补充 EnergyManagement 的通用电气测量能力;用于电网结算或家庭能源管理的电表应同时实现 EnergyManagement,以报告进口/出口累计有功电能等通用电气数据。

本 Function 面向电网连接点(PCC)计量。PCC 的进口方向为电网到用户侧,出口方向为用户侧到电网。功率可用正负号表示方向,进口和出口电量及分时电量则分别以非负计数器累计。分时寄存器的费率编号由电表/费率计划定义,Peak、OffPeak 等类别仅作通用分类,不能替代具体费率计划。

Function 标识​

Function IDCode名称
0x013DElectricityMetering电能计量

Trait​

Trait IDCodeConformance
0x51B3CurrentForwardTotalActiveEnergyM
0x51B4CurrentReverseTotalActiveEnergyO
0x5201GridActivePowerM
0x5202MeteringPointTypeM
0x5203DemandIntervalDurationO
0x5204CurrentDemandO
0x5205MaximumDemandO
0x5206MaximumDemandTimestampO
0x5207DemandPeriodStartTimestampO
0x5208TariffEnergyRegistersO
0x5209DemandCalculationMethodO
0x523FBranchCircuitMeasurementsO

若 CurrentDemand 或 MaximumDemand 存在,DemandIntervalDuration 和 DemandCalculationMethod 也必须存在;若 MaximumDemand 存在,MaximumDemandTimestamp 和 DemandPeriodStartTimestamp 必须存在。这样消费者可以确定需量平均窗口、计算方法及最大值所属计费周期。

Command​

本 Function 不包含 Command。最大需量计费周期由电表或其费率配置确定;本 Function 提供周期起始时间和最大需量区间结束时间,不定义远程复位需量计数器的命令。

数据类型​

MeteringPointTypeEnum8 Type​

该枚举标识电能表的计量位置。当前定义 PCC,以便区分用户侧进口/出口和发电侧计量。

ValueNameDescription
0x00Unknown未知或未配置
0x01GridConnectionPoint电网与用户能源系统之间的并网点(PCC)
TariffCategoryEnum8 Type​

该枚举为分时寄存器提供通用费率时段分类。实际费率编号及其适用时间由电表/费率计划决定;枚举类别仅用于展示和粗粒度聚合。

ValueNameDescription
0x00Unspecified未指定类别
0x01OffPeak谷时段或低费率时段
0x02Shoulder平时段或中间费率时段
0x03Peak峰时段或高费率时段
0x04CriticalPeak尖峰或特殊高费率时段
DemandCalculationMethodEnum8 Type​

该枚举标识需量积分区间的计算方式。设备必须在上报需量时提供此项,且不得将 Unknown 与有效的需量结果同时上报,避免消费者将固定区间和滑动区间结果混为一谈。

ValueNameDescription
0x00Unknown未知或未配置
0x01FixedBlock固定区间;按连续且不重叠的区间计算平均功率
0x02RollingWindow滑动区间;按持续移动的时间窗口计算平均功率
TariffEnergyRegisterStructure Type​

该结构体描述一个费率寄存器的身份和进口/出口累计有功电能。未被设备测量的方向可省略;同一费率寄存器 ID 在一个电表端点内必须唯一且保持稳定。

成员序号字段名类型必须最小值最大值步长单位默认值说明
0TariffRegisterIduint8M1161无无费率寄存器标识,在本电表端点内唯一。具体时段含义由电表的费率计划确定。
1TariffCategoryTariffCategoryEnum8O041无0通用费率类别。没有可对应的通用类别时使用 Unspecified。
2ImportedActiveEnergyfloatO010000000000000.1W·h无该费率寄存器下从电网进口的累计有功电能,非负累计值;若实现无法保证逻辑累计值连续且要求精确差值,须与 ImportedCounterGeneration 一同提供。
3ExportedActiveEnergyfloatO010000000000000.1W·h无该费率寄存器下向电网出口的累计有功电能,非负累计值;若实现无法保证逻辑累计值连续且要求精确差值,须与 ExportedCounterGeneration 一同提供。
4ImportedCounterGenerationuint32O042949672951无0在实现无法保证逻辑累计值连续且要求精确差值时,若存在 ImportedActiveEnergy 则必须提供;计数器代际规则见 EnergyManagement。
5ExportedCounterGenerationuint32O042949672951无0在实现无法保证逻辑累计值连续且要求精确差值时,若存在 ExportedActiveEnergy 则必须提供;计数器代际规则见 EnergyManagement。

每个结构体至少包含 ImportedActiveEnergy 或 ExportedActiveEnergy 之一。数据类型为最多包含 16 个 TariffEnergyRegisterStructure 的列表;空列表表示设备当前没有提供分时寄存器数据。

Trait 定义​

Trait IDNameConformance
0x51B3CurrentForwardTotalActiveEnergyM
0x51B4CurrentReverseTotalActiveEnergyO
0x5201GridActivePowerM
0x5202MeteringPointTypeM
0x5203DemandIntervalDurationO
0x5204CurrentDemandO
0x5205MaximumDemandO
0x5206MaximumDemandTimestampO
0x5207DemandPeriodStartTimestampO
0x5208TariffEnergyRegistersO
0x5209DemandCalculationMethodO
0x523FBranchCircuitMeasurementsO

GridActivePower Trait​

并网有功功率表示 PCC 处当前净有功功率,单位 W,采用带符号值:正值表示从电网进口(购电),负值表示向电网出口(送电),零表示当前净功率接近零。该值是进口功率与出口功率的净值,不表示两个方向各自的瞬时功率;方向累计量应使用 EnergyManagement 中的 CurrentForwardTotalActiveEnergy 和 CurrentReverseTotalActiveEnergy。用于能源流向展示、光伏自用/上网状态判断及能源管理策略。

Trait IDCode
0x5201GridActivePower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat-5000000-5000000 W0RVO
0x0002Maximum Valuefloat5000000RO
0x0003Minimum Valuefloat-5000000RO
0x0005Step Valuefloat0.1RO

MeteringPointType Trait​

计量点类型表示电能表的测量边界。设置为 GridConnectionPoint 时,本 Function 的进口/出口和有功功率符号按 PCC 方向定义。计量位置未知时报告 Unknown,不得根据设备型号推断边界。用于阻止将并网点电量与发电机或电池侧电量错误比较。

Trait IDCode
0x5202MeteringPointType
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueMeteringPointTypeEnum80-11RVO

DemandIntervalDuration Trait​

需量周期表示用于计算当前需量和最大需量的积分区间长度,单位秒。需量是该区间内进口有功功率的平均值;本字段描述平均窗口长度,不是上报间隔。15 分钟(900 秒)是常见默认积分周期,电表仍可按当地计费规则配置其他周期。用于解释需量数据并进行跨设备比较。

Trait IDCode
0x5203DemandIntervalDuration
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint3260-3600 s900RVO
0x0002Maximum Valueuint323600RO
0x0003Minimum Valueuint3260RO
0x0005Step Valueuint321RO

CurrentDemand Trait​

当前需量表示当前需量积分区间的进口有功功率平均值,单位 W,非负。区间未完成时,设备可上报截至当前时刻的区间平均值,但必须以一致的方式计算;消费者应通过 DemandIntervalDuration 理解其时间窗口。出口功率不计入进口需量。用于实时观察计费需量增长趋势,不等同于 GridActivePower 瞬时净功率。

Trait IDCode
0x5204CurrentDemand
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-5000000 W0RVO
0x0002Maximum Valuefloat5000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

MaximumDemand Trait​

最大需量表示当前计费周期内,所有需量积分区间进口有功功率平均值的最大值,单位 W,非负。它不是瞬时功率峰值,也不包含出口需量。计费周期由电表/费率计划决定,其起始时刻通过 DemandPeriodStartTimestamp 报告;新计费周期开始时最大值重新累计。达到最大值的区间结束时间通过 MaximumDemandTimestamp 报告。用于需量电费评估和计费周期内峰值负荷分析。

Trait IDCode
0x5205MaximumDemand
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-5000000 W0RVO
0x0002Maximum Valuefloat5000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

MaximumDemandTimestamp Trait​

最大需量时刻表示 MaximumDemand 当前记录的最大需量区间结束时刻,采用 UTC(Coordinated Universal Time,协调世界时)Unix epoch(自 1970-01-01T00:00:00Z 起算)毫秒时间戳。值为 0 表示设备尚未记录有效最大需量时间。该时刻与 DemandIntervalDuration 共同标识产生最大需量的完整积分区间,用于账单核验和负荷事件分析。

Trait IDCode
0x5206MaximumDemandTimestamp
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640-253402300799999 ms0RVO
0x0002Maximum Valueuint64253402300799999RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint641RO

DemandPeriodStartTimestamp Trait​

计费周期起始时刻表示当前 MaximumDemand 所属计费周期的起始时刻,采用 UTC(Coordinated Universal Time,协调世界时)Unix epoch(自 1970-01-01T00:00:00Z 起算)毫秒时间戳。计费周期边界由电表的计费日历或费率计划确定;周期开始时最大需量应重新统计。值为 0 表示设备未提供周期起始时间。用于判断最大需量的统计范围,避免将不同账期的值直接比较。

Trait IDCode
0x5207DemandPeriodStartTimestamp
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640-253402300799999 ms0RVO
0x0002Maximum Valueuint64253402300799999RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint641RO

TariffEnergyRegisters Trait​

分时电量寄存器表示电表按费率寄存器分别累计的进口和/或出口有功电能。每个寄存器具有稳定且唯一的 TariffRegisterId;寄存器的具体费率时间表、季节和节假日规则由电表或外部费率计划配置,本 Trait 不传输费率日历。类别枚举只提供粗粒度标签,不可用于替代费率 ID 或据此计算费用。每个电量值均为非负累计值,单位 W·h;设备重启不得导致逻辑累计值回退。当实现无法保证逻辑累计值连续且要求精确差值时,须为每个方向提供对应的代际字段。计数器代际规则见 EnergyManagement。用于尖峰平谷统计、分时账单和需求侧能源分析。

Trait IDCode
0x5208TariffEnergyRegisters
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[TariffEnergyRegisterStructure]最多 16 个寄存器[]RVO

DemandCalculationMethod Trait​

需量计算方式表示电表计算需量所采用的窗口方式。FixedBlock 将连续时间划分为互不重叠的固定区间;RollingWindow 使用持续滑动的窗口。该方法必须与 DemandIntervalDuration 一起解释 CurrentDemand 和 MaximumDemand,单位不适用。用于确保不同电表的需量计算口径明确。

Trait IDCode
0x5209DemandCalculationMethod
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValueDemandCalculationMethodEnum80-20RVO
BranchCircuitMeasurementStructure Type​

该结构体表示一个配电回路的计量数据。通道标识在设备内唯一且稳定;设备未提供的计量方向或瞬时功率字段可省略。

结构体成员序号字段名类型必须说明
0ChannelIduint16M配电回路通道号,在同一设备内唯一且稳定。
1ImportedActiveEnergyfloatO回路正向累计电能,非负值,单位 W·h;需要代际时与字段 ImportedCounterGeneration 一同提供。
2ExportedActiveEnergyfloatO回路反向累计电能,非负值,单位 W·h;需要代际时与字段 ExportedCounterGeneration 一同提供。
3ActivePowerfloatO回路瞬时有功功率,单位 W;正值表示进口/耗电,负值表示出口/反向潮流。
4ImportedCounterGenerationuint32O当无法保证逻辑累计值连续且要求精确差值时,若提供 ImportedActiveEnergy 则必须提供。规则见 EnergyManagement。
5ExportedCounterGenerationuint32O当无法保证逻辑累计值连续且要求精确差值时,若提供 ExportedActiveEnergy 则必须提供。规则见 EnergyManagement。

BranchCircuitMeasurements Trait​

分路计量数据表示配电盘各回路的累计进口/出口电能及瞬时有功功率。Present Value 为 BranchCircuitMeasurementStructure 列表;通道号必须在设备内唯一且稳定,每个列表项至少包含一项计量值。若 ECHONET Lite 以设备累计电能单位提供原始计数,转换时应先按设备单位换算为 W·h,再写入对应结构字段。

Trait IDCode
0x523FBranchCircuitMeasurements
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuelist[BranchCircuitMeasurementStructure]按设备支持的回路数[]RVO

Command 定义​

本 Function 不包含 Command。

PowerGeneration(发电)​

简介​

发电(PowerGeneration)用于表示发电设备的额定输出能力和发电运行状态,并为燃料电池和燃气热电联产设备提供燃气消耗、负载侧用电及热回收数据。并网状态由 EnergyManagement/SystemInterconnectionStatus 表示。瞬时发电功率和累计发电量复用 EnergyManagement/GeneratedActivePower 与 EnergyManagement/CumulativeGeneratedActiveEnergy;本 Function 不改变其计量边界约定。

Function 标识​

Function IDCode名称
0x013EPowerGeneration发电

Trait​

Trait IDCodeConformance
0x5230RatedGenerationPowerO
0x5231PowerGenerationStatusO
0x5233CumulativeGasConsumptionO
0x5236RecoveredWaterTemperatureO
0x5237RemainingHotWaterAmountO
0x5238HotWaterTankCapacityO
0x5239CumulativeSoldEnergyO
0x523EPowerGenerationRequestTimestampO

Command​

本 Function 不包含 Command。发电设定及预定发电状态的取值语义明确前,不定义对应的控制接口。

数据类型​

PowerGenerationStatusEnum8 Type​

该枚举定义发电设备的当前运行状态。

ValueNameDescription
0x00Stopped停止
0x01Starting启动中
0x02Generating发电中
0x03Stopping停止中
0x04Idling待机

Trait 定义​

Trait IDNameConformance
0x5230RatedGenerationPowerO
0x5231PowerGenerationStatusO
0x5233CumulativeGasConsumptionO
0x5236RecoveredWaterTemperatureO
0x5237RemainingHotWaterAmountO
0x5238HotWaterTankCapacityO
0x5239CumulativeSoldEnergyO
0x523EPowerGenerationRequestTimestampO

RatedGenerationPower Trait​

额定发电功率表示发电设备的标称最大输出功率,单位 W。

Trait IDCode
0x5230RatedGenerationPower
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-5000000 W无固定默认值;由产品规格确定RVO
0x0002Maximum Valuefloat5000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

PowerGenerationStatus Trait​

发电状态表示发电设备当前所处的运行阶段。

Trait IDCode
0x5231PowerGenerationStatus
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present ValuePowerGenerationStatusEnum80-4无固定默认值RVO

CumulativeGasConsumption Trait​

累计燃气消耗量表示当前计数器代际内消耗的燃气体积,单位 m^3;设备重启不得清零读数或代际,计数器复位、无法补偿的回卷或计量器更换须递增 Counter Generation。计数器代际规则见 EnergyManagement。

Trait IDCode
0x5233CumulativeGasConsumption
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 m^30RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.001RO

RecoveredWaterTemperature Trait​

热回收水温表示发电设备热回收系统中的水温,单位 deg C。

Trait IDCode
0x5236RecoveredWaterTemperature
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat-50-150 deg C无固定默认值;报告当前值RVO
0x0002Maximum Valuefloat150RO
0x0003Minimum Valuefloat-50RO
0x0005Step Valuefloat0.1RO

RemainingHotWaterAmount Trait​

剩余热水量表示热水储存设备当前可用的热水体积,单位 L。

Trait IDCode
0x5237RemainingHotWaterAmount
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000 L无固定默认值;报告当前值RVO
0x0002Maximum Valuefloat1000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

HotWaterTankCapacity Trait​

储热水箱容量表示水箱的标称储水体积,单位 L。

Trait IDCode
0x5238HotWaterTankCapacity
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000 L无固定默认值;由产品规格确定RVO
0x0002Maximum Valuefloat1000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO

PowerGenerationRequestTimestamp Trait​

发电请求时间表示发电设备记录的发电请求时刻,采用 UTC Unix epoch 毫秒时间戳;0 表示设备未提供有效时刻。将外部时间表示转换为该格式时,应依据其时区语义;无法确定时间或时区时不得猜测。

Trait IDCode
0x523EPowerGenerationRequestTimestamp
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valueuint640-253402300799999 ms无固定默认值;报告设备记录值RVO
0x0002Maximum Valueuint64253402300799999RO
0x0003Minimum Valueuint640RO
0x0005Step Valueuint641RO

CumulativeSoldEnergy Trait​

累计卖电量表示发电设备向外部售出的累计有功电能,单位 W·h。其计量边界由发电设备的售电计量点决定,不等同于设备总发电量;当实现无法保证逻辑累计值连续且要求精确差值时,应同时上报 Counter Generation,代际变化规则见 EnergyManagement。

Trait IDCode
0x5239CumulativeSoldEnergy
参数​
Parameter IDNameTypeConstraintDefaultAccessConformance
0x0001Present Valuefloat0-1000000000000 W·h0RVO
0x0010Counter Generationuint320-42949672950RO
0x0002Maximum Valuefloat1000000000000RO
0x0003Minimum Valuefloat0RO
0x0005Step Valuefloat0.1RO