命令代码
APIUnbindWiFiSubdevice
WiFi 子设备解绑成功上报。设备向云端上报 WiFi 子设备已成功从本设备或其桥接管理中解绑(移除)。
参数
该 Command 无参数。
APICheckCarDataConsistency
车辆识别数据一致性校验请求。设备将本地存储的车辆识别特征库摘要信息上报至云端,请求比对并接收差异(需添加或删除的车辆数据),以维持车辆数据库同步。
参数
该 Command 无参数。
APIBindWiFiSubdevice
WiFi 子设备绑定成功上报。设备向云端上报 WiFi 子设备(如 WiFi 摄像机、智能插座)已通过本设备或其桥接功能成功绑定至家庭网络和用户账号。
参数
该 Command 无参数。
APIOperateBridgedDevice
桥接设备操作命令。云通过网关向充当桥接器的设备(例如,多功能网关、中继器)发送命令,指示其对其连接或管理的子设备执行特定操作(例如,开/关、配置)。
参数
该 Command 无参数。
APIDeviceCameraCall
设备(如 Camera)发起呼叫请求。摄像头或其他设备在检测到特定事件(如门铃按下、移动检测)时主动向云端发起音视频呼叫或推送通知请求,供用户接听或查看。
参数
该 Command 无参数。
APIOperateCameraUp
摄像头上游操作请求。设备主动向云端发起针对摄像头的特殊操作请求,如请求云端AI分析视频片段、申请临时云端存储配额提升、上报自检异常等。
参数
该 Command 无参数。
APIIssueTokenForWebRTCCall
WebRTC 设备通话令牌签发请求。当支持 WebRTC 的视频设备(如摄像机)需建立点对点音视频通话或流媒体时,设备请求云端代为签发临时安全令牌,用于认证与会话建立。
参数
该 Command 无参数。
APIOperateCameraDown
摄像头下游操作命令。云向摄像头设备发送特定的控制命令,如云台控制、添加/调用预设、人脸数据库管理、巡航设置等。
参数
该 Command 无参数。
APIGetSignallingServerAddress
信令服务器地址获取请求。设备向云端查询当前可用的信令服务器地址列表,以支持采用 WebRTC 等实时通信协议的设备进行 P2P 连接协商。
参数
该 Command 无参数。
APIReportCameraExtEvents
相机扩展业务事件报告。该设备将摄像头生成的超出基本状态变化的扩展事件(例如,智能识别结果、异常行为警报、场景分析事件)报告给云,用于高级应用程序和人工智能分析。
参数
该 Command 无参数。
APICheckFaceDataConsistency
人脸识别数据一致性校验请求。设备向云端上报本地存储的人脸识别特征库摘要信息,请求比对并接收差异(需添加或删除的人脸数据),以保持人脸库同步。
参数
该 Command 无参数。
APIUnbindHubDown
Hub 下行解绑 Command。云端命令 Hub 执行与当前用户账户的解绑流程,通常包括重置网络配置、清除用户数据并为新用户绑定做准备。
参数
该 Command 无参数。
APIUploadDeviceInfo
设备信息更新上报。设备上报自身或所管理子设备属性信息变更(如名称修改、位置调整、图标更新),请求云端同步更新设备档案。
参数
该 Command 无参数。
APIReportDeviceResponse
设备 Command 执行响应上报。设备在执行云端下发的控制或查询 Command 后,上报设备返回的具体响应结果(含成功、失败及详细数据),完成 Command 交互闭环。
参数
该 Command 无参数。
APIGetSubdeviceConfig
子设备详细配置查询请求。网关向云端查询指定子设备的详细配置信息。
参数
该 Command 无参数。
APICheckHubDataConsistency
Hub 数据一致性校验 Command。云端主动请求 Hub 将其存储数据摘要与云端进行比对。
参数
该 Command 无参数。
APICheckHubLocalSync
Hub 本地信息双向同步校验请求。Hub 主动向云端发起校验请求,比对本地信息摘要与云端,检测并修正不一致,确保数据完整性。
参数
该 Command 无参数。
APIGetLoginRandomCode
设备登录随机数(Nonce)获取请求。在设备登录或认证过程中,向云端请求随机数(Nonce),用于构造防重放攻击的安全凭证。
参数
该 Command 无参数。
APIGetRandomJoinCode
五元组子设备入网随机码获取请求。在五元组安全框架下,网关为准备入网的新子设备向云端请求一次性随机加入码,确保入网过程的安全性与唯一性。
参数
该 Command 无参数。
APIClearHubConfig
Hub 系统配置清除 Command。云端命令 Hub 清除指定系统配置,恢复为出厂默认或空状态。
参数
该 Command 无参数。
APISyncDataCloudToHub
云到集线器批处理数据同步命令。云端向集线器发送数据包,对用户配置、设备关系、场景规则等非实时业务数据进行批量同步,确保集线器在离线或初始化后能够恢复完整的服务状态。
参数
该 Command 无参数。
APIReportSubdeviceModel
子设备物模型信息上报。在发现新子设备或子设备固件升级后,网关将其完整支持的物模型定义(功能、属性、命令、事件)上报至云端,用于更新设备能力库及动态 UI 生成。
参数
该 Command 无参数。
APIClearLocalData
Hub 本地数据清除 Command。云端命令 Hub 清除从云端同步并本地存储的特定类型或全部用户数据与配置(如场景、设备绑定),通常用于账户切换或数据重置。
参数
该 Command 无参数。
APINotifyConfigChange
Hub 配置变更通知 Command。云端通知 Hub 其部分配置已在云端变更,要求 Hub 主动拉取最新配置或准备应用新配置,实现变更主动推送。
参数
该 Command 无参数。
APIGetVoiceFileUrl
语音提示文件 URL 获取请求。网关向云端请求语音提示文件(如告警音、欢迎语)的下载 URL 或配置信息,用于本地播放。
参数
该 Command 无参数。
APIDisableSubdeviceJoining
子设备入网模式禁用命令。云端命令网关立即退出新子设备的配对/发现模式并恢复正常运行。
参数
该 Command 无参数。
APIAskOtherHubToken
请求其他网关安全 Token。在需要跨网关协作或访问的场景中,网关向云端请求另一指定网关的安全 token,以与其建立安全直连或间接通信。
参数
该 Command 无参数。
APISubdeviceKeepAlive
子设备在线心跳上报。网关定期或在子设备状态变化时,将其管理的子设备在线状态(心跳)上报至云端,供云端监测设备存活状态并更新设备列表中的在线标识。
参数
该 Command 无参数。
APIBindBleDeviceToHub
蓝牙设备绑定到ZigBee集线器命令。
参数
该 Command 无参数。
APIReportHeartbeat
Hub 自身在线心跳上报。Hub 定期向云端发送心跳信号,表明自身(非子设备)在线且运行正常,供云端监测 Hub 存活状态。
参数
该 Command 无参数。
APIGetInstallCode
五元组 Install Code 获取请求。采用五元组安全模型的设备向云端请求其唯一的“Install Code”,用于安全入网过程中的身份验证。
参数
该 Command 无参数。
APIReportPropertyExamination
调试与诊断信息上报。设备在系统运行期间向云端上报调试日志、诊断事件、网络环境参数等非业务信息,用于远程排障、系统优化和数据分析。
参数
该 Command 无参数。
APIBindSubdeviceWithSecurityCode
基于安全码的五元组模型子设备绑定请求。新网关(采用五元组认证模型)绑定子设备时,向云端上报子设备信息和预共享安全码,请求云端验证安全码合法性以完成安全绑定。
参数
该 Command 无参数。
APIStartHubProvisioning
Hub 入网配置信息下发 Command。新 Hub 首次上电或重置后,云端向其下发入网所需的引导信息,如可连接服务器地址、配置 Token 或初始配置,引导其完成初始化。
参数
该 Command 无参数。
APIReportHubLocalInfo
设备本地综合信息上报。设备主动向云端上报本地信息,用于整体状态感知和数据备份。
参数
该 Command 无参数。
APIUnsubscribeDeviceResource
设备发起的资源取消订阅请求。设备(或代表它的网关)请求云端停止推送一个或多个此前已订阅设备资源的更新。
参数
该 Command 无参数。
APIReportHubLocalConfig
Hub 详细本地配置上报。Hub 主动向云端上报其详细本地系统配置。
参数
该 Command 无参数。
APICheckHubConfig
Hub 系统配置校验 Command。云端下发命令要求 Hub 对当前系统级配置进行自检并上报校验结果或配置摘要。
参数
该 Command 无参数。
APIPushHubConfig
Hub 系统配置下发 Command。云端向 Hub 下发系统级配置参数或策略文件,以更新或初始化其运行环境、功能模块参数或连接策略。
参数
该 Command 无参数。
APIQueryDeviceResMultiExtGbk
设备资源多值扩展查询请求(GBK 编码)。请求与响应文本数据采用 GBK 字符编码,以兼容需要该编码格式的系统或设备。
参数
该 Command 无参数。
APIReportExceptionLog
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 无参数。
APINotifySubdeviceReadResult
子设备数据主动读取结果异步上报。响应云端的 APITriggerSubdeviceRead 命令,在完成对目标子设备的数据读取后,网关异步将读取结果(或超时/失败状态)上报至云端,完成此次按需查询的闭环。
参数
该 Command 无参数。
APISubscribeDeviceResource
设备发起的资源订阅请求。设备(或代表它的网关)请求云端开始订阅一个或多个设备资源的变更。资源值变更时,云端将主动推送更新。
参数
该 Command 无参数。
APIReportCommandExecResult
云预定义指令执行结果报告。在通过APIRunFunctionInstruction执行云交付的预定义函数指令后,集线器将指令执行的成功/失败结果、输出数据或错误详细信息报告给云。
参数
该 Command 无参数。
APIGetWeatherData
天气数据获取请求。设备向云端请求指定位置的当前天气、预报及其他气象信息,用于智能场景触发或界面显示。
参数
该 Command 无参数。
APIConnectHub
Hub 入网请求。Hub 使用新版入网协议与流程(版本 V1.0)向云端发起入网请求,提交设备凭证与网络信息以完成身份注册和网络接入。
参数
该 Command 无参数。
APIUnbindHubUp
Hub 上行解绑请求。Hub 主动向云端发起与当前用户账户的解绑请求,通常由用户触发。
参数
该 Command 无参数。
APISyncTokenDown
设备 Token 同步下行 Command。云端将用户或设备的最新授权 Token 或其他安全凭证下发至设备,更新设备与云端或其他服务通信时使用的认证信息。
参数
该 Command 无参数。
APIRefreshHubToken
五元组网关 Token 刷新请求。采用五元组认证模型的网关在其当前安全 token 即将过期时,向云端请求新的有效 token,以维持与云端的安全通信。
参数
该 Command 无参数。
APIRpcDebugCommand
网关远程过程调用(RPC)调试 Command。云端向网关发送通用 RPC 调试 Command,用于远程执行诊断、获取内部状态、测试特定功能或修改调试参数。是开发与运维的重要工具。
参数
该 Command 无参数。
APISyncSubdeviceList
Hub 子设备列表批量同步。Hub 向云端上报其所管理全部子设备的完整列表及基本信息(ID、类型、状态),刷新云端记录并确保设备清单准确。
参数
该 Command 无参数。
APIRegisterDirectDevice
直连设备重新入网注册请求。直连设备(如通过 Wi-Fi Direct)向云端请求恢复网络连接和服务。
参数
该 Command 无参数。
APINotifyNoSubdevice
无子设备状态通知命令。云端通知网关,根据云端记录,当前账号下未绑定任何子设备。
参数
该 Command 无参数。
APIExecuteSubstituteCommand
Hub 请求云端代执行 Command。Hub 因权限、能力或网络限制无法直接执行 Command 时,请求云端代理向目标设备或服务下发 Command 并将结果返回 Hub。
参数
该 Command 无参数。
APIRunFunctionInstruction
云预定义函数指令执行请求。云将预定义的函数指令代码或脚本标识符发送到集线器,要求其在本地解释和执行相应的复杂逻辑或一系列操作。
参数
该 Command 无参数。
APIUnbindSubdeviceDown
子设备下行解绑命令。云端向网关发送命令,将指定子设备从其管理列表中移除(解绑)。网关将执行本地解绑流程并停止与其通信。
参数
该 Command 无参数。
APIUnbindSubdeviceUp
子设备上行解绑通知。网关主动向云端上报其已在本地移除(解绑)某子设备,请求云端更新设备关系并清理相关数据。
参数
该 Command 无参数。
APIEnableSubdeviceJoining
子设备入网模式启用命令。云端命令网关进入配对/发现模式,允许新子设备(Zigbee、蓝牙等)在指定时长内或直至收到停止命令前加入网络。
参数
该 Command 无参数。
APIUploadLogFileEvent
日志文件上传事件通知。设备通知云端已完成日志文件上传,触发云端日志处理流程。
参数
该 Command 无参数。
APIGetSubdeviceServiceConfig
子设备服务配置查询请求。网关向云端查询特定子设备所需或推荐的服务配置参数,如连接策略、数据上报频率、功能启用建议等。
参数
该 Command 无参数。
APIQueryDeviceResMultiExt
设备资源多值扩展查询请求。网关请求云端同时查询多个设备或单个设备的多个资源(属性)当前值,支持扩展查询选项以实现高效批量数据获取。
参数
该 Command 无参数。
APITriggerSubdeviceRead
子设备数据主动读取触发命令。云端命令网关立即向指定子设备发起主动数据读取请求(如查询最新传感器值),并异步将读取结果上报至云端,以按需获取设备状态。
参数
该 Command 无参数。
APIBindSubdeviceNoAuth
无需身份验证的子设备绑定请求。在特定模式(例如,本地调试、受信任的网络)中,集线器请求云绑定子设备,声明绕过严格的安全认证(例如,五重验证)。
参数
该 Command 无参数。
APISetSubdeviceMixing
子设备组合与集成配置命令。云端命令网关将多个独立的物理子设备在逻辑上组合或集成为虚拟复合设备,以实现统一控制或复杂场景。
参数
该 Command 无参数。
APICheckLocalSceneSync
本地场景信息同步校验请求。设备向云端上报所有本地存储场景的摘要信息(例如 ID、版本),请求比对并接收需更新或删除的场景列表,以保持双向同步。
参数
该 Command 无参数。
APIDownloadLocalScene
场景配置本地化同步命令。云端将用户创建的自动化场景的完整定义(触发条件、执行动作)下发至设备。设备本地存储并负责后续执行,使场景可离线可用。
参数
该 Command 无参数。
APIRunScene
场景执行命令(通用)。云端向设备发送命令,立即执行指定的预配置场景。设备负责解析场景动作并控制本地或子设备执行相应操作。
参数
该 Command 无参数。
APIDeleteLocalScene
本地化场景删除命令。云端命令设备从其本地存储中删除一个或多个指定同步场景,通常用于用户在云端删除场景后的同步清理。
参数
该 Command 无参数。
APIRunLocalScene
云触发的本地场景执行命令。云触发已经存储并在设备上本地运行的自动化场景(而不是云虚拟化场景)。收到后,设备直接执行本地场景逻辑进行低延迟响应。
参数
该 Command 无参数。
APIDownloadCentralScene
中央场景配置本地化同步命令。对于支持多网关集线器/边缘计算的系统,云将涉及跨网关协作的“中心场景”配置发送到充当集线器的网关,以实现本地化存储和分布式协调执行。
参数
该 Command 无参数。
APIGetWakeupUrl
设备远程唤醒服务地址获取请求。设备向云端查询支持远程唤醒的子设备(如低功耗设备)的唤醒服务器地址或访问 Token,以便按需激活。
参数
该 Command 无参数。
APIInquiryCentralBroker
中央消息代理信息查询请求。充当中央集线器的集线器向云查询其应连接的消息代理服务器的信息(用于设备间通信、事件分发)。
参数
该 Command 无参数。
APIInquiryCentralEnableState Command
Central函数启用状态查询请求。集线器向云端查询其自身“中央集线器功能”的当前启用状态(开启或关闭) ,以进行状态同步或界面显示。
参数
该 Command 无参数。
APIHubPassthroughDataDown
Hub 数据透传下行通道。云端通过该通用透传接口向 Hub 发送无需 Hub 业务层解析的原始数据包,Hub 直接转发至其所连接的特定终端设备或服务。
参数
该 Command 无参数。
APIEnableCentralHubFunction
Hub 中央网关核心功能启用 Command。云端命令 Hub 激活其作为“智能家居中央网关”的核心能力,如本地自动化引擎、跨协议协调、设备管理、边缘计算,将其从普通网关升级为家庭控制中心。
参数
该 Command 无参数。
APIHubPassthroughDataUp
Hub 数据透传上行通道。Hub 通过该通用透传接口将所连接设备收到的原始数据包直接上报至云端或指定外部服务,不经业务层解析。
参数
该 Command 无参数。
APIDeleteSecurityLocal
家庭安防本地配置删除 Command。云端命令网关删除本地存储的特定家庭安防配置(如安防场景或设备绑定),通常用于配置清理或重置。
参数
该 Command 无参数。
APISyncSecurityLanInfo
家庭安防 LAN 状态同步 Command。云端向设备下发最新家庭安防相关配置、设备状态或场景信息,确保网关本地安防逻辑与云端配置一致。
参数
该 Command 无参数。
APICheckSecurityEnableConsistency
家庭安防启用状态一致性校验请求。设备向云端查询并校验家庭安防功能记录的“总开关”状态(开/关)在双方是否一致。
参数
该 Command 无参数。
APIConfirmSecurityAlert
家庭安防告警确认 Command。用户通过云端 App 确认设备上报的家庭安防告警(如入侵检测)后,云端向设备下发该确认 Command。设备随后停止推送该告警并可能更新本地状态。
参数
该 Command 无参数。
APICheckSecurityConfigConsistency
家庭安防配置一致性校验请求。设备主动请求云端比对双方存储的详细家庭安防配置(如布防模式、联动规则)是否完全一致,并返回比对结果。
参数
该 Command 无参数。
APIEnableSecurity
家庭安防功能启用/禁用 Command。云端下发命令以启用或禁用设备上的家庭安防子系统整体功能。
参数
该 Command 无参数。
APIRepairSecurityEnable
家庭安防启用状态修复 Command。云端检测到设备本地安防启用状态与云端记录不一致时,下发该 Command 强制设备本地启用状态与云端指定状态同步,用于修复状态漂移。
参数
该 Command 无参数。
APIReportOtaDeviceListState
OTA 升级设备列表状态上报。网关向云端上报当前正在升级、等待升级或升级失败的所有设备的汇总状态列表,供云端集中监控升级批次。
参数
该 Command 无参数。
APIReportOtaResult
OTA 升级最终结果上报。子设备固件升级任务完成后(成功或失败),网关向云端上报最终结果及详情(例如成功版本号、失败错误码)。
参数
该 Command 无参数。
APIReportOtaProgress
OTA 升级进度上报。网关实时向云端上报子设备固件升级的当前进度(例如下载百分比、刷写状态),供前端界面展示。
参数
该 Command 无参数。
APICancelOtaUpgrade
设备 OTA 升级取消 Command。云端向网关下发命令,取消指定设备正在进行的固件升级任务。
参数
该 Command 无参数。
APIInquiryFirmwareInfo
网关固件信息查询请求。网关主动向云端查询是否有适用于自身的新固件版本及相关元数据(如版本号、更新日志、文件大小),用于触发网关自身的 OTA 升级检查。
参数
该 Command 无参数。
APIUpgradeDeviceFirmware
子设备固件升级命令下发。云端向网关下发指定子设备(Zigbee、蓝牙等)的空中(OTA)固件升级命令,包含固件版本及下载地址信息。
参数
该 Command 无参数。
APILockPassthroughUpstream
外部应用透传上行信息上报(专用通道)。
参数
该 Command 无参数。
APILockPassthroughDownstream
外部应用透传下行 Command(专用通道)。云端通过为特定外部应用预留的专用透传通道发送绕过业务层解析的原始 Command 或数据,直接转发至指定子设备(如智能锁)。
参数
该 Command 无参数。
APIAssistDeviceCrypto
设备数据加解密协助请求。因安全策略或能力限制,网关请求云端使用指定设备的密钥对特定字符串数据进行加密或解密并返回结果。
参数
该 Command 无参数。
APIReportLockExtEvents
智能门锁扩展业务事件上报。设备将智能门锁在基础状态变化之外产生的扩展事件(如特定用户开锁记录、胁迫告警、低电量警告、防拆告警等)上报至云端。
参数
该 Command 无参数。
Reboot
控制或上报设备重启状态,可用于监控或触发设备重启。
参数
APIDownloadMusic
设备音乐文件下载 Command。云端下发命令,指示设备从指定地址下载音频文件(如铃声、提示音)至本地存储,供后续播放。
参数
该 Command 无参数。
APICheckLocalMusicSync
本地音乐文件信息同步校验请求。设备向云端上报本地存储的音乐文件列表(例如文件名、MD5),请求比对并接收需同步(下载或删除)的文件列表,以保持云端与本地音乐库一致。
参数
该 Command 无参数。
APIDeleteMusic
设备本地音乐文件删除 Command。云端命令设备从本地存储删除一个或多个指定音频文件。
参数
该 Command 无参数。
APIPushMatterBindInfo
Matter 设备入网/绑定信息下发。云端向网关发送新 Matter 设备的入网许可、网络凭据或配置信息,引导并授权设备加入本地 Matter 网络。
参数
该 Command 无参数。
APIUnbindMatterDeviceDown
Matter 设备解绑命令(下行)。云端向网关发送命令,将指定 Matter 设备从家庭网络中移除(解绑)。网关执行本地解绑流程并更新网络拓扑。
参数
该 Command 无参数。
APIReportDeviceAqaraSpecModel
Aqara Spec设备Thing模型详细信息报告。在设备入门过程中,网关将新发现的Aqara Spec设备支持的完整事物模型定义(功能、属性、命令等)报告给云,用于设备功能注册和动态UI生成。
参数
该 Command 无参数。
APISyncAqaraSpecDataToCloud
Aqara Spec设备资源数据云同步。网关将本地Aqara Spec设备的所有当前状态数据(例如,所有属性值)批量同步到云。这通常用于初始设备启用或网络恢复后的全状态恢复。
参数
该 Command 无参数。
APIGenNextMatterNodeId
Matter 网络 Node ID 生成请求。在准备为新 Matter 设备分配网络身份时,网关请求云端生成全局唯一且符合规范的 Node ID。
参数
该 Command 无参数。
APIGenHomeMatterNoc
家庭 Matter NOC 证书生成请求。建立或管理 Matter Fabric 时,网关请求云端为当前用户家庭生成或更新 Matter Network Operation Certificate(NOC),用于安全认证。
参数
该 Command 无参数。
APIStartBindMatterDeviceToHub
Aqara Spec设备绑定开始。网关将新Aqara Spec设备的发现报告给云,并请求启动绑定过程。这是多步骤设备入门流程的第一步。
参数
该 Command 无参数。
APIUnbindMatterDeviceUP
Matter 设备解绑状态上报(上行)。网关向云端上报本地触发的 Matter 设备解绑事件的结果或状态,确保云端设备列表与本地网络状态同步。
参数
该 Command 无参数。
APIQueryMatterJoinLimit
Matter 设备入网限制策略查询。在允许新设备加入 Matter 网络之前,网关向云端查询当前家庭或网关是否已达设备上限,或是否存在其他入网限制策略。
参数
该 Command 无参数。
APICloudToPanelDownstream
云到面板下游通用命令通道。云使用此通用接口向场景面板发送各种控制、查询或配置命令。
参数
该 Command 无参数。
APIPanelUpstreamRequest
面板到云端上行通用请求通道。使用该通用接口向云端发起各类请求,例如获取天气、执行复杂场景或上报面板事件。
参数
该 Command 无参数。
APICheckPanelConfigConsistency
场景面板配置一致性校验请求。设备向云端上报其管理的所有场景面板的当前配置摘要,请求比对并接收差异,以确保云端与本地面板配置同步。
参数
该 Command 无参数。
APISyncPositionDown
设备位置信息下行同步 Command。云端将用户分配的房间、区域等位置信息下发至设备,确保设备本地设备-位置映射与云端设置一致。
参数
该 Command 无参数。
APIPushPanelConfig
智能场景面板配置下发命令。云端将智能场景面板(实体或虚拟)相关配置下发至设备,包括按钮图标、背光颜色及关联的场景或设备控制逻辑。
参数
该 Command 无参数。
APIReportLinkConsuming
网络链路时延探测结果上报。执行链路探测后,设备向云端上报测得的网络时延及其他结果,用于网络性能分析与统计。
参数
该 Command 无参数。
APICheckLinkConsuming
网络链路时延探测命令。云端向设备发送探测命令,测量云端与设备之间的往返时延(RTT),通常用于网络质量监测与诊断。
参数
该 Command 无参数。
APIUnsubscribeIftttResChange
本地自动化规则取消订阅云端资源变更请求。网关请求云端停止推送先前已订阅的特定资源的变更通知。
参数
该 Command 无参数。
APIEnableAutomation
本地自动化规则总开关控制命令。云端发送命令以全局启用或禁用网关上本地存储并执行的所有自动化规则(IFTTT 场景),使其暂时生效或失效。
参数
该 Command 无参数。
APIDeleteIftttLocal
云端命令网关从其本地存储中删除指定的 IFTTT 自动化规则。
参数
该 Command 无参数。
APIPushCentralAutomation
中央级自动化规则交付命令。云提供复杂的自动化规则配置,这些配置需要跨多个集线器进行协调,或由集线器将处理集中到充当中心集线器的集线器。
参数
该 Command 无参数。
APIRunCloudAction
本地自动化触发云端动作执行请求。当网关上本地自动化规则的条件满足时,通过该接口请求云端执行仅能在云端完成的动作(例如发送通知、调用互联网 API、更新云端数据库)。
参数
该 Command 无参数。
APIGetSunriseSunsetByLatLon
基于经纬度的日出日落时间查询请求。设备根据其经纬度坐标向云端查询当日具体的日出和日落时间,以实现与自然光相关的智能自动化场景(如“日落时开灯”)。
参数
该 Command 无参数。
APIEnableCentralAutomation
中央级自动化规则启用命令。云端控制中央集线器集线器是否启用存储在其中的中央级自动化规则。
参数
该 Command 无参数。
APIDeleteCentralAutomation
中央级自动化规则删除命令。云命令充当中央枢纽的枢纽从其存储中删除指定的中央级自动化规则。
参数
该 Command 无参数。
APIQueryIftttRes
与自动化相关的资源值查询请求。在评估规则条件时,集线器的本地自动化引擎向云查询指定资源的当前值(例如,另一个家庭的设备状态、天气数据、用户模式)。
参数
该 Command 无参数。
APISubscribeIftttResChange
本地自动化规则订阅云端资源变更请求。网关代表本地自动化规则订阅云端一个或多个资源的变更。当这些资源在云端发生变化时,云端将通知网关。
参数
该 Command 无参数。
APIEnableIfttt
云端向网关发送专用命令,控制其 IFTTT(If This Then That)自动化功能的整体启用状态。
参数
该 Command 无参数。
APIQueryHolidayList
设备向云端查询指定年份和地区的节假日列表。
参数
该 Command 无参数。
APIPublishResourceChange
资源变更事件发布命令。当云端某资源值发生变化时,主动向已订阅该资源的本地网关“发布”此变更事件,以触发其本地自动化规则。
参数
该 Command 无参数。
APICheckLocalIftttSync
本地自动化规则信息同步校验请求。网关向云端上报本地存储的所有 IFTTT 自动化规则摘要信息,请求比对并接收差异,以保持云端与本地规则库一致。
参数
该 Command 无参数。
APIDownloadIftttLocal
云端将用户创建的 IFTTT 自动化规则同步至网关本地存储,使其可在本地(离线)条件下触发和执行。
参数
该 Command 无参数。
Identify
写入时,启动或停止设备自识别。
参数
APIPushLightBoxConfig
灯箱设备配置信息下发命令。云端将智能灯箱设备的特定配置(例如灯光效果、配色方案、定时计划)下发至网关,网关随后转发或应用到目标灯箱设备。
参数
该 Command 无参数。
APIGetIrCode
IR 码原始数据获取请求。设备向云端请求指定 IR 码的原始或波形数据,用于本地发送或校验。
参数
该 Command 无参数。
APISaveLearnedIrKey
已学习 IR 码按键绑定保存命令。IR 码学习成功后,云端发送命令将已学习的 IR 码绑定到用户定义的虚拟按键(或场景动作),并在设备存储中持久化该绑定。
参数
该 Command 无参数。
APIQueryIrLearningCode
已学习 IR 码信息查询请求。设备请求云端检索本地存储的所有用户自定义已学习 IR 码的列表及元数据(例如绑定的电器名称、按键名称)。
参数
该 Command 无参数。
APIStartIrCodeLearning
IR 码学习模式启动 Command。云端命令设备进入 IR 学习模式,准备接收用户物理 IR 遥控器信号并将其编码为可存储、可重发的数字格式。
参数
该 Command 无参数。
APIGetIrCodeTarget
IR 码目标家电信息请求。设备向云端请求与特定 IR 码关联的目标家电详细信息(如品牌、型号、功能),以丰富用户界面展示。
参数
该 Command 无参数。
APIQueryIrCodeLibrary
IR 码云库查询请求。设备向云端查询特定品牌型号家电的预置 IR 码库是否存在,使用户无需手动学习即可添加并控制常见家电。
参数
该 Command 无参数。
APIGetIrCodeDownloadUrl
IR 码数据库下载 URL 请求。设备向云端请求用于下载完整或增量 IR 码数据库文件的 URL,以更新或初始化离线码库。
参数
该 Command 无参数。
APIDeleteLearnedIrCode
已学习 IR 码删除命令。云端命令设备从其本地存储中删除一条或多条先前学习并保存的 IR 遥控码。
参数
该 Command 无参数。
APISendIrButtonPress
IR 码单次发送 Command。云端命令设备通过 IR 发射器向目标家电(如空调、电视)单次发送特定已学习或预置 IR 码,模拟遥控器单次按键。
参数
该 Command 无参数。
APISyncIrLearningCodes
IR 学习码双向同步请求。设备向云端上报本地存储的全部 IR 学习码摘要信息,请求比对并接收差异列表(需添加或删除的码),以实现云端与设备 IR 码库最终一致。
参数
该 Command 无参数。
AddOrUpdateZigbeeNetwork
该 Command 用于执行「加入或者更新Zigbee网络命令」操作。
参数
AddOrUpdateZigbeeNetwork Command Structure
AddOrUpdateZigbeeNetworkResponse
该 Command 用于执行「加入或者更新Zigbee网络反馈」操作。
参数
AddOrUpdateZigbeeNetworkResponse Command Structure
ConfigStaticIPAddr
ConfigStaticIPAddr Command 表示配置设备网络地址信息。可选参数 AddressingMode:当取值为 0 时切换为 DHCP 获取 IP(忽略 IPAddress、SubnetMask、PrimaryDNS、DefaultGateway、SecondaryDNS);当取值为 1 时切换为静态 IP 模式并应用上述参数;若该字段不存在,默认采用静态 IP 模式。可选参数 InterfaceName(示例:eth0)用于指定目标接口;未传该参数时表示应用于所有网络接口。
参数
ConfigStaticIPAddr Command Structure
ConnectToHomeStation
表示 WiFi Endpoint 连接到 Home Station 命令。
参数
ConnectToHomeStation Command Structure
ConnectToHomeStationResponse
连接家庭基站反馈
参数
ConnectToHomeStationResponse Command Structure
AddOrUpdateThreadNetwork
该 Command 用于执行「加入或者更新Thread网络命令」操作。
参数
AddOrUpdateThreadNetwork Command Structure
AddOrUpdateThreadNetworkResponse
该 Command 用于执行「加入或者更新Thread网络命令反馈」操作。
参数
AddOrUpdateThreadNetworkResponse Command Structure
TriggerZigbeeNetworkInfoUpload
触发网关上报 Zigbee 网络信息以供后续操作,例如基于 Zigbee 网络信息启用 Zigbee 设备快速配对。
参数
TriggerZigbeeNetworkInfoUpload Command Structure
ScanWiFiNetworks
该 Command 用于执行「扫描WiFi网络命令」操作。
参数
该 Command 无参数。
ScanWiFiNetworksResponse
该 Command 用于执行「扫描WiFi网络命令反馈」操作。
参数
该 Command 无参数。
AddOrUpdateWiFiNetwork
该 Command 用于执行「加入或者更新WiFi网络命令」操作。
参数
AddOrUpdateWiFiNetwork Command Structure
AddOrUpdateWiFiNetworkResponse
该 Command 用于执行「加入或者更新WiFi网络命令反馈」操作。
参数
AddOrUpdateWiFiNetworkResponse Command Structure
APISyncConfiguration
通用功能配置双向同步请求。设备向云端上报本地存储的通用功能配置摘要,请求比对并接收差异列表(需推送或删除的配置),以实现云端与设备最终一致。
参数
该 Command 无参数。
APIWriteFunctionResource
通用功能资源组播控制 Command。云端通过组播向一个或多个设备发送对特定通用功能资源(如虚拟开关、计数器)的写操作 Command(如设值、触发动作),实现批量控制。
参数
该 Command 无参数。
APIPushSubscribedResource
设备订阅资源下发 Command。根据设备或其子设备订阅的资源类型,云端向设备下发对应资源配置、状态更新或数据流,用于实时数据推送或配置更新。
参数
该 Command 无参数。
APIReportConfiguration
通用功能资源组播上报。设备通过组播或批量上报向云端报告本地存储的某类通用功能资源(如配置、状态缓存)的当前值或摘要信息,用于集中监控与同步。
参数
该 Command 无参数。
APIReportThingModelDetail
Aqara新设备Thing模型详细信息报告。对于支持Aqara设备Thing模型协议的集线器或设备,将详细的Thing模型(对象、属性、服务)报告给云。
参数
该 Command 无参数。
APIGetConfiguration
通用功能配置获取请求。设备向云端请求指定功能模块(如特定传感器数据处理逻辑、设备行为规则)的最新配置参数或策略文件。
参数
该 Command 无参数。
APIDeleteConfiguration
通用功能配置组播删除 Command。云端下发命令要求设备删除一种或多种指定类型的通用配置。该 Command 可通过组播发送,同时影响多个符合条件的网关或设备。
参数
该 Command 无参数。
APIPushConfiguration
通用功能配置组播下发 Command。云端向一个或多个设备下发通用功能配置(如设备行为规则、数据处理策略)。该 Command 可通过组播发送,高效同步一批设备的配置。
参数
该 Command 无参数。
APIRequestCloudStorageResource
云存储业务资源配置请求。设备(通常表示相机等设备)从云中请求与云视频存储服务相关的资源配置信息,例如存储配额、上传凭据、录制计划等。
参数
该 Command 无参数。
APIGetStudioBackupUploadUrl
Studio 备份文件上传 URL 请求。在创建本地 Studio(开发/配置环境)备份后,网关向云端请求临时、安全的文件上传 URL,以将备份文件传输至云存储。
参数
该 Command 无参数。
APILoginByAuthCode
验证码登录请求。
参数
该 Command 无参数。
APIGetAuthCode
用户认证码获取请求。
参数
该 Command 无参数。
APIDeleteStudioBackup
Studio 云端备份删除请求。网关请求云端删除指定的历史 Studio 备份文件,以释放存储空间或清理旧数据。
参数
该 Command 无参数。
APIGetPositionByDeviceId
按设备 ID 查询房间。当网关需要组织设备列表或执行房间级控制时,向云端查询指定设备 ID 当前所属的房间名称或房间 ID。
参数
该 Command 无参数。
APIGetStudioBackupInfo
Studio 云端备份信息查询请求。网关向云端查询当前用户或网关已有的 Studio 备份文件列表及其元数据(如备份时间、大小、描述),用于恢复或备份管理。
参数
该 Command 无参数。
APIGetUserDeviceList
用户设备列表获取请求。网关向云端请求当前登录用户账号下所有已绑定设备的列表,包括设备 ID、名称、类型及基本状态,通常在初始化、刷新或管理界面操作时发起。
参数
该 Command 无参数。
APILoginByGuardCode
账号密码登录请求。
参数
该 Command 无参数。
APIReportStudioInfo
Studio 运行信息上报。网关主动向云端上报本地运行的 Aqara Studio 实例的运行状态、版本及配置摘要等信息,用于监控与统计分析。
参数
该 Command 无参数。
APIConfirmStudioBackupSuccess
Studio 云端备份上传成功确认。备份文件成功上传至云端后,网关向云端发送确认通知,提示云端将备份文件标记为可用并完成存储流程。
参数
该 Command 无参数。
APIGetProxyServerInfo
代理服务器连接信息查询请求。网关(或其 Studio 环境)向云端请求可用的代理服务器地址和配置信息,以建立特定网络连接(例如远程调试、外部服务访问)。
参数
该 Command 无参数。
ChangeTemperatureLevel
允许用户将温度调节至预设档位。Parameter Supported Values 表示支持的温度档位列表。
参数
ChangeTemperatureLevel Command Structure
ChangeTemperature
ChangeTemperature允许用户指定和调整设备或系统的目标温度。
参数
ChangeTemperature Command Structure
ResetPresence
ResetPresence 命令用于重置设备或空间的当前存在检测状态。
参数
该 Command 无参数。
GoToMaxPositionPercentage
该命令应请求设备移动到最大开合百分比位置(通常对应完全打开或设备定义的最大端点)。
参数
该 Command 无参数。
AutoControl
该命令应请求设备执行产品定义的自动控制动作(如在预设目标间切换)。
具体策略由设备实现定义,客户端可结合当前状态与配置进行触发。
参数
该 Command 无参数。
GoToPositionPercentage
该 Command 用于执行「至指定开合比」操作。
参数
GoToPositionPercentage Command Structure
GoToMinPositionPercentage
该命令应请求设备移动到最小开合百分比位置(通常对应完全关闭或设备定义的最小端点)。
参数
该 Command 无参数。
StopMotion
该 Command 用于执行「停止」操作。
参数
该 Command 无参数。
Toggle
该 Command 用于执行「开/关」操作。
参数
该 Command 无参数。
On
该 Command 用于执行「打开」操作。
参数
该 Command 无参数。
Off
该 Command 用于执行「关闭」操作。
参数
该 Command 无参数。
SendIRCode
该 Command 用于执行「发送红外指令」操作。
参数
ClearActivePreset
该 Command 用于执行「清除主动预设」操作。
参数
该 Command 无参数。
SetActivePreset
该 Command 用于执行「设置主动预设」操作。
参数
SetActivePreset Command Structure
Pause
该 Command 用于执行「暂停」操作。
参数
该 Command 无参数。
Stop
该命令应请求设备停止当前操作。
参数
该 Command 无参数。
Play
该 Command 用于执行「播放」操作。
参数
该 Command 无参数。
PlaySpecificList
该 Command 用于执行「播放列表」操作。
参数
该 Command 无参数。
Rewind
该 Command 用于执行「回退」操作。
参数
该 Command 无参数。
FastForward
该 Command 用于执行「快进」操作。
参数
该 Command 无参数。
MediaPlaybackCommand
MediaPlaybackCommand表示媒体播放命令,适用于多种类型的媒体(音乐、视频、有声书、电台等)播放操作
参数
MediaPlaybackCommand Command Structure
Next
该 Command 用于执行「下一个」操作。
参数
该 Command 无参数。
Previous
该 Command 用于执行「上一个」操作。
参数
该 Command 无参数。
StartOver
该 Command 用于执行「重播」操作。
参数
该 Command 无参数。
SelectInput
该 Command 用于执行「选择播放源」操作。
参数
ChangeToMode
ChangeToMode用于设置设备的模式。
参数
ChangeToMode Command Structure
ResetCondition
ResetCondition表示重置滤芯。
参数
该 Command 无参数。
UnboltDoor
开门——收起方舌和斜舌
参数
SetWeekDaySchedule
该 Command 用于执行「设置周日程」操作。
参数
SetWeekDaySchedule Command Structure
QuietUnlockDoor
该 Command 用于执行「静音开锁」操作。
参数
该 Command 无参数。
GetYearDaySchedule
该 Command 用于执行「获取年日程」操作。
参数
GetYearDaySchedule Command Structure
ClearWeekDaySchedule
该 Command 用于执行「清除周日程」操作。
参数
ClearWeekDaySchedule Command Structure
GetUser
该 Command 用于执行「获取用户」操作。
参数
该 Command 无参数。
UnlockDoor
该 Command 用于执行「解锁」操作。
参数
SetYearDaySchedule
该 Command 用于执行「设置年日程」操作。
参数
SetYearDaySchedule Command Structure
GetWeekDaySchedule
该 Command 用于执行「获取周日程」操作。
参数
GetWeekDaySchedule Command Structure
LockDoor
该 Command 用于执行「上锁」操作。
参数
ClearYearDaySchedule
该 Command 用于执行「清除年日程」操作。
参数
ClearYearDaySchedule Command Structure
QuietLockDoor
该 Command 用于执行「静音上锁」操作。
参数
该 Command 无参数。
GoHome
Vacuum GoHome 命令用于指示扫地机器人返回充电座或基站。
参数
该 Command 无参数。
Start
启动
参数
该 Command 无参数。
Resume
恢复
参数
该 Command 无参数。
Open
打开命令。
参数
该 Command 无参数。
Close
关闭命令
参数
该 Command 无参数。
StartCleaning
该 Command 用于执行「开始清扫」操作。
参数
该 Command 无参数。
PauseCleaning
该 Command 用于执行「暂停清扫」操作。
参数
该 Command 无参数。
ContinueCleaning
该 Command 用于执行「继续清扫」操作。
参数
该 Command 无参数。
StopCleaning
该 Command 用于执行「停止清扫」操作。
参数
该 Command 无参数。
EnableCharging
EnableCharging Command(启用充电命令)。
参数
该 Command 无参数。
DisableCharging
DisableCharging Command(禁用充电命令)。
参数
该 Command 无参数。
SelfTestRequest
SelfTestRequest表示报警器自检。
参数
该 Command 无参数。
PreviewEffect
该命令应请求设备使用提供的 EffectData 预览场景而不保存。用户可在添加或更新用户自定义场景前预览该场景。
接收后行为(Effect on Receipt)
设备接收该命令后,应校验 EffectData 编码合法性与动作类型支持情况。
- 校验通过时:设备应进入预览状态并执行对应场景效果,且不应写入持久化存储。
- 校验失败时:设备应返回参数或数据格式错误语义状态。
预览过程中,EffectOperationState 应反映为 Previewing,结束后应恢复为空闲或实现定义状态。
参数
PreviewEffect Command Structure
UpdateUserDefinedEffect
该命令应请求设备更新现有的用户自定义场景。仅 UserDefined 类型场景可更新。
接收后行为(Effect on Receipt)
设备接收该命令后,应先校验 EffectID 与数据内容合法性。
- 校验通过时:设备应更新对应场景数据,并保持场景 ID 不变。
- 若
EffectID不存在:应返回“场景不存在”语义错误。 - 若目标为 BuiltIn 场景:应返回“非用户自定义场景不可更新”语义错误。
参数
UpdateUserDefinedEffect Command Structure
RemoveUserDefinedEffect
该命令应请求设备移除现有的用户自定义场景。仅 UserDefined 类型场景可移除,BuiltIn 场景不可移除。
接收后行为(Effect on Receipt)
设备接收该命令后,应校验 EffectID 是否存在且属于 UserDefined 范围。
- 校验通过时:设备应删除该场景记录,并更新 UserDefinedEffects 列表。
- 若
EffectID不存在:应返回“场景不存在”语义错误。 - 若目标为 BuiltIn 场景:应返回“非用户自定义场景不可删除”语义错误。
参数
RemoveUserDefinedEffect Command Structure
GetEffectData
该命令应请求设备返回指定 EffectID 的场景数据。客户端可用于读取已存储的场景数据(如显示、备份或编辑)。
接收后行为(Effect on Receipt)
设备接收该命令后,应校验 EffectID 是否存在于 BuiltIn 或 UserDefined 列表。
- 校验通过时:设备应返回对应
EffectData。 - 校验失败时:应返回“无效场景 ID”或“场景不存在”语义错误。
参数
GetEffectData Command Structure
StartEffect
该命令应请求设备启动指定的灯光效果。
目标 EffectID 应存在于 BuiltInEffects 或 UserDefinedEffects 列表中。
参数
AddUserDefinedEffect
该命令应请求设备添加新的用户自定义场景。新场景类型为 UserDefined。
接收后行为(Effect on Receipt)
设备接收该命令后,应校验 EffectName 长度与 EffectData 格式。
- 校验通过且容量未满时:设备应分配新的 UserDefined
EffectID,写入场景并更新 UserDefinedEffects。 - 若当前数量达到 MaxUserDefinedEffects:应返回“场景数量已达上限”语义错误。
- 若名称或数据不合法:应返回参数错误语义状态。
参数
AddUserDefinedEffect Command Structure
StopPreview
该命令应请求设备停止当前运行的场景预览并恢复正常窗饰运行。
接收后行为(Effect on Receipt)
设备接收该命令后,应停止当前预览场景并恢复至常规控制状态。
- 若当前存在预览场景:应终止预览并将 EffectOperationState 切回空闲或设备定义的稳定状态。
- 若当前无预览场景:设备可返回“无活动预览”语义状态,或按实现返回成功空操作。
该 Command 无参数。
PreviewTransition
该命令应请求设备使用所提供参数预览过渡效果。用户可在提交前查看灯光在指定时序与曲线设置下的开关过渡表现。
该命令用于预演 On/Off 过渡时间、调光曲线与初始亮度对视觉效果的综合影响。
参数
PreviewTransition Command Structure
StepBrightness
该命令用于执行亮度步进调节,不改变灯的开关状态。
接收后行为(Effect on Receipt)
当 Size = 0 时,命令无效果,应返回 INVALID_COMMAND。
当 Size ≠ 0 时,设备应按步进方向执行亮度变化:
Up:CurrentLevel 增加Size,或在达到设备最大级时停止;若提前触达边界,过渡时长应按比例缩短。Down:CurrentLevel 减少Size,或在达到设备最小级时停止;若提前触达边界,过渡时长应按比例缩短。
参数
StepBrightness Command Structure
SetBrightness
该命令用于设置目标亮度,不改变灯的开关状态。
接收后行为(Effect on Receipt)
设备接收该命令后,应从当前亮度连续过渡到 Level 指定目标值。
- 过渡时长优先使用命令中的
Time。 - 当
Time为空时,应使用设备过渡时长配置;若无可用配置,则应以设备可实现的最快速度完成过渡。
若设备不支持可变速率过渡,可忽略过渡时长字段。
参数
SetBrightness Command Structure
StepBrightnessWithOnOff
该命令用于执行带开关联动的亮度步进调节。
当亮度降至最小级附近时,设备可按联动语义同步更新开关状态。
接收后行为(Effect on Receipt)
设备接收该命令后,应先按 StepBrightness 的语义执行亮度步进:
- 当
Size = 0时,命令无效果,应返回INVALID_COMMAND。 - 当
Size ≠ 0时,按步进方向与步进量更新 CurrentLevel;若到达设备允许的最小/最大边界,应在边界处停止,并按比例缩短实际过渡时长。
在上述行为基础上,本命令还应执行与开关联动:
- 若命令效果会使 CurrentLevel 高于设备最小级,则同端点 OnOff 应置为
TRUE(On)。 - 若命令效果会使 CurrentLevel 到达设备最小级,则同端点 OnOff 应置为
FALSE(Off)。
参数
StepBrightnessWithOnOff Command Structure
SetBrightnessWithOnOff
该命令用于执行带开关联动的目标亮度设置。
与 SetBrightness 相比,本命令支持在设置亮度时同时影响开关状态。
接收后行为(Effect on Receipt)
设备接收该命令后,应先按 SetBrightness 的语义,从当前亮度连续过渡到目标亮度。
- 过渡时长优先使用命令中的
Time。 - 当
Time为空时,应使用设备过渡时长配置;若无可用配置,则应以设备可实现的最快速度完成过渡。
在上述行为基础上,本命令还应执行与开关联动:
- 若命令效果会使 CurrentLevel 高于设备最小级,则同端点 OnOff 应置为
TRUE(On)。 - 若命令效果会使 CurrentLevel 到达设备最小级,则同端点 OnOff 应置为
FALSE(Off)。
参数
SetBrightnessWithOnOff Command Structure
MoveToXYColor
该命令用于设置 XY 颜色。
执行后设备应将 ColorMode 切换为 XY 模式。
接收后行为(Effect on Receipt)
设备接收该命令后,应将 ColorMode(若实现)设置为 XY 模式,并从当前颜色连续过渡到 ColorX/ColorY 指定的目标颜色。
过渡时长应与 TransitionTime 字段一致。颜色空间过渡路径未强制规定,建议采用 CIE xyY 空间中的最短路径(可视为“直线”路径)。
参数
MoveToXYColor Command Structure
MoveToHueSaturationBrightness
该命令用于同时设置 Hue/Saturation 与亮度。
通常等效为组合下发 MoveToHueAndSaturation 与 MoveToLevelWithOnOff。
接收后行为(Effect on Receipt)
设备接收该命令后,应先将 ColorMode 切换为 HSV,并按连续过渡方式从当前 Hue/Saturation 过渡到目标值;同时按 MoveToLevelWithOnOff 语义执行亮度与开关联动。
参数
MoveToHueSaturationBrightness Command Structure
MoveToHueAndSaturation
该命令用于设置 Hue 与 Saturation。
执行后设备应将 ColorMode 切换为 HSV 模式。
接收后行为(Effect on Receipt)
设备接收该命令后,应将 ColorMode 切换为 HSV 模式,并从当前 Hue/Saturation 连续过渡到目标 Hue/Saturation。
过渡时长应与 TransitionTime 字段一致。过渡路径未强制规定,建议采用颜色空间中的最短路径。
参数
MoveToHueAndSaturation Command Structure
MoveToColorTemperatureBrightness
该命令用于同时设置色温与亮度。
通常等效为组合下发 MoveToColorTemperature 与 MoveToLevelWithOnOff。
接收后行为(Effect on Receipt)
设备接收该命令后,应先按 MoveToColorTemperature 的语义执行色温过渡(ColorMode 切换为 ColorTemperature),并按 MoveToLevelWithOnOff 的语义执行亮度与开关联动。
若目标色温超出设备物理能力范围,应按设备可达最小/最大色温进行截断。
参数
MoveToColorTemperatureBrightness Command Structure
MoveToXYColorBrightness
该命令用于同时设置 XY 颜色与亮度。
通常等效为组合下发 MoveToColor 与 MoveToLevelWithOnOff。
接收后行为(Effect on Receipt)
设备接收该命令后,应先按 MoveToXYColor 的语义设置目标 XY 颜色(ColorMode 切换为 XY),并按过渡时间连续移动到目标颜色;同时按 MoveToLevelWithOnOff 的语义设置目标亮度并处理开关联动。
颜色过渡路径未强制规定,建议采用 CIE xyY 空间中的最短路径。
参数
MoveToXYColorBrightness Command Structure
MoveToColorTemperature
该命令用于设置色温。
执行后设备应将 ColorMode 切换为 ColorTemperature 模式。
接收后行为(Effect on Receipt)
设备接收该命令后,应将 ColorMode(若实现)设置为 ColorTemperature 模式,并从当前色温连续过渡到目标色温。
过渡时长应与 TransitionTime 字段一致。按该模式定义,色温过渡路径沿黑体轨迹(Black Body Line)变化。
若目标值小于设备物理最小色温(Mired)或大于设备物理最大色温(Mired),应分别截断到物理最小/最大值作为最终目标。
参数
MoveToColorTemperature Command Structure
StepColorTemperature
该命令用于按步长执行色温增量调节。
接收后行为(Effect on Receipt)
当 StepSize = 0 时,命令不产生效果,并应返回 INVALID_COMMAND。
当 StepSize > 0 时,设备应将 ColorMode(及对应增强模式,若实现)设置为 ColorTemperature 模式,并按 StepMode 指定方向执行一步色温变化:
Up:增加 Mired(即降低开尔文色温)。Down:减少 Mired(即升高开尔文色温)。
当达到设备允许边界(配置边界或物理边界)时,步进操作应停止。
参数
StepColorTemperature Command Structure
PanTiltDirectionControl
该 Command 用于执行「云台方向控制」操作。
参数
PanTiltDirectionControl Command Structure
StopMotion
该 Command 用于执行「停止」操作。
参数
该 Command 无参数。
RotationControl
该命令应请求设备按指定方向执行旋转控制。
设备应结合当前角度边界、分辨率与机械约束执行旋转,必要时在边界处停止。
参数
RotationControl Command Structure
GoToPositionRotationPercentage
GoToPositionRotationPercentage 命令用于将窗饰设备的目标俯仰位置设置为命令中指定的百分比值。TargetPositionRotationPercentage 应设置为 RotationPercentage;完成后,CurrentPositionRotationPercentage 将设置为命令中指定的百分比值。
接收后行为(Effect on Receipt)
设备接收该命令后,应将 RotationPercentage 约束在设备支持范围内,并写入 TargetPositionRotationPercentage。
设备应驱动执行俯仰移动;到达目标后应更新 CurrentPositionRotationPercentage。若受机械边界限制无法完全到达,应在可达边界停止并上报实际位置。
参数
GoToPositionRotationPercentage Command Structure
StepPosition
该命令应请求设备执行相对位置步进。
步进方向由 Size 的符号决定;设备应在可控范围内裁剪目标值并按可用分辨率执行。
接收后行为(Effect on Receipt)
设备接收该命令后,应按 Size 计算相对目标位置。
- 当
Size > 0:按打开方向步进。 - 当
Size < 0:按关闭方向步进。 - 当
Size = 0:设备可按实现返回无动作成功,或返回参数无效语义错误。
若提供 Time,设备应按该时长执行过渡;若未提供则按设备默认策略执行。计算结果超出边界时,应裁剪到最小/最大可达位置。
参数
StepPosition Command Structure
GoToPositionPercentage
该 Command 用于执行「至指定开合比」操作。
参数
GoToPositionPercentage Command Structure
GoToMinPositionPercentage
该命令应请求设备移动到最小开合百分比位置(通常对应完全关闭或设备定义的最小端点)。
参数
该 Command 无参数。
GoToMaxPositionPercentage
该命令应请求设备移动到最大开合百分比位置(通常对应完全打开或设备定义的最大端点)。
参数
该 Command 无参数。
AutoControl
该命令应请求设备执行产品定义的自动控制动作(如在预设目标间切换)。
具体策略由设备实现定义,客户端可结合当前状态与配置进行触发。
参数
该 Command 无参数。
TriggerWarning
该 Command 用于执行「触发报警」操作。
参数
TriggerWarning Command Structure
SelfTestRequest
SelfTestRequest表示报警器自检。
参数
该 Command 无参数。
RemoveOneMatterManufacturer
该 Command 用于执行「Matter Bridge移除某个Matter生态平台」操作。
参数
该 Command 无参数。
RemoveAllMatterManufacturer
该 Command 用于执行「Matter Bridge移除所有Matter生态平台」操作。
参数
该 Command 无参数。
Toggle
该 Command 用于执行「开/关」操作。
参数
该 Command 无参数。