Function Codes
Overview
| functionCode | Description |
|---|---|
| Descriptor | Describes the composition and capability structure of device endpoints, including endpoint lists, device types, and Server/Client clusters. |
| BasicInformation | Provides basic device information, including the manufacturer, product model, firmware version, serial number, online status, and other core attributes. |
| EndpointLabel | Manages endpoint visibility and presentation information, such as names, rooms, icons, and tags, for frontend display and organization. |
| CameraCoordination | Handles complex camera workflows, including WebRTC calls, pan-tilt-zoom control, recognition-data synchronization, and extension events. |
| GeneralConfiguration | Provides common device configuration options, such as sensitivity, delays, default parameters, and other device-level settings. |
| EcosystemInformation | Describes the ecosystems to which a device is connected, including binding status for HomeKit, Matter fabrics, and more. |
| EnergyManagement | Manages device battery and energy-consumption information, including battery percentage, power-consumption statistics, and low-battery alerts. |
| HubCoordination | Serves as the gateway coordination core, managing child-device commissioning, configuration, heartbeats, tokens, and various proxy services. |
| SceneCoordination | Manages the lifecycle of smart scenes (automation rules), including synchronization, deletion, triggered execution, and consistency validation. |
| PowerSource | Describes a device’s power source and battery status, including charge level, charging status, battery type, and related information. |
| WakeupCoordination | Obtains a wake-up service address or token for low-power devices that support remote wake-up. |
| CentralHubCoordination | Manages advanced central-hub gateway capabilities, including hub enablement, broker information, and data passthrough channels. |
| SecurityGuardCoordination | Manages home-security arming capabilities, including arming and disarming, alarm acknowledgment, and local/cloud configuration synchronization. |
| OTACoordination | Manages the OTA firmware-upgrade coordination workflow, including task delivery, progress reporting, result feedback, and version queries. |
| LockCoordination | Handles extended smart-lock functions, including dedicated passthrough channels, encryption/decryption assistance, and extension-event reporting. |
| DeviceAnomalyMonitoring | Continuously monitors device operating parameters to promptly detect and report abnormal or fault conditions. |
| GeneralDiagnostics | Provides general diagnostic information, including uptime, reboot count, network interfaces, and hardware faults. |
| RingtoneCoordination | Manages local gateway ringtone and music files, including downloads, deletion, and consistency validation against the cloud library. |
| ZigbeeNetworkDiagnostics | Provides Zigbee network diagnostics, including channel, PAN, neighbor, and routing information. |
| MatterCoordination | Centralizes coordination operations related to Matter, including commissioning, binding, data synchronization, and certificate management. |
| ScreenCoordination | Manages smart-scene panel interactions, including configuration delivery, status queries, and bidirectional cloud/panel passthrough. |
| CommLinkCoordination | Monitors the quality of communication links between the gateway and cloud, performs latency checks, and reports results. |
| IftttCoordination | Serves as the automation-rule coordination center, managing synchronization, subscriptions, and execution for IFTTT and local automation rules. |
| NetworkManagement | Serves as the core control module for device network connectivity and access policies, managing remote proxies and access addresses. |
| Identify | Provides device-identification capabilities that help users locate physical devices through indicator flashes, sounds, and similar methods. |
| LightBoxCoordination | Manages configuration delivery for smart light-box devices and controls displayed content and effects. |
| IRCoordination | Manages gateway infrared learning and transmission, including code-library synchronization, virtual remote creation, and button control. |
| NetworkCommissioning | Provides network commissioning capabilities, including scanning, connecting to, and configuring Wi-Fi, Thread, and other networks. |
| ConfigurationCoordination | Manages common-function configuration, resource subscriptions, and location-information synchronization through multicast or batch operations. |
| CloudStorageCoordination | Manages cloud recording and storage service resources, obtaining storage quotas, upload credentials, and related information. |
| StudioCoordination | Manages integration between gateways and the Aqara Studio development environment, including account authentication, project backups, and device synchronization. |
| Temperature | Measures and reports ambient temperature, providing attributes such as the current temperature and valid measurement range. |
| TemperatureControl | Provides temperature-setting and adjustment capabilities for target-temperature control on thermostatic devices. |
| PackageRecognition | Automatically recognizes packages in a video frame and can send reminders and record events when packages are delivered or removed. |
| FaceRecognition | Captures facial features, compares them with a local library, and reports facial-recognition results and match information. |
| HumanPresence | Detects human presence in a space and supports advanced sensing capabilities such as people counting, trajectories, and identity association. |
| HumanRecognition | Uses vision and other algorithms to detect human figures in real time, distinguish people from other objects, and report events. |
| AirQuality | Monitors and reports air-quality indicators, such as AQI or an overall air-quality level. |
| AttitudeDetection | Detects changes in device orientation or tilt angle and reports orientation anomalies or angle information. |
| Lifter | Provides travel control for lifting devices, supporting target-position settings, stopping, and status queries. |
| Binding | Represents a persistent binding relationship between an endpoint and one or more other local or remote endpoints. |
| PetFeeder | Provides pet-feeding controls, including portion counts, feeding schedules, and remaining-food status. |
| Button | Describes event reporting for button input devices, including recognition of single clicks, long presses, and multiple clicks. |
| Output | Provides switched-output control, supporting reading and controlling the on/off state of a load. |
| IRControl | Provides infrared-transmission control for conventional infrared appliances such as air conditioners and televisions. |
| HeaterCooler | Provides cooling and heating control, including HVAC parameters such as target temperature, operating mode, and fan speed. |
| Vibration | Detects vibration or motion-state changes and reports events such as movement, tilting, and dropping. |
| Cube | Describes gesture recognition for cube controllers, including flips, rotations, shakes, and face recognition. |
| Knob | Describes rotation-angle, press, and combined-action events for knob input devices. |
| BinaryOutputObject | Drives binary actuator outputs, such as relays, contactors, solenoid valves, or sirens. |
| AnalogInputObject | Acquires continuously varying analog inputs in read-only mode, such as voltage and simulated temperature signals. |
| MediaPlayback | Provides media-playback control, including play, pause, track changes, volume, and playback-state management. |
| MediaInput | Describes media input-source management and switching, supporting selection of the current playback source and input list. |
| FlameDetection | Detects visible flames through image or sensor algorithms and immediately reports fire events for early warning. |
| OperationalState | Describes the device’s current operational state, such as idle, running, paused, or faulted. |
| RefrigeratorState | Describes refrigerator operational states, including idle, cooling, defrosting, and faults. |
| Mode | Provides a device feature-mode interface that supports switching among multiple predefined modes. |
| BridgedConfiguration | Describes configuration information for bridged child devices in Matter/Zigbee bridging scenarios. |
| MultiStateInputObject | Acquires multi-state discrete inputs that represent one of N states. |
| MARSConfiguration | Provides smart-load (MARS) configuration for load identification and intelligent power-distribution management. |
| ScreenUserInterface | Manages screen-side user-interface configuration, including page layouts, cards, themes, and displayed data. |
| CustomizedConfiguration | Provides read and write access to manufacturer- or user-defined extension configuration items. |
| HEPAFilterMonitoring | Monitors HEPA filter use, remaining life, and replacement reminders. |
| ActivatedCarbonFilterMonitoring | Monitors activated-carbon filter use, remaining life, and replacement reminders. |
| FanControl | Provides fan-speed and mode control, supporting speed-level adjustment and operating-state reading. |
| HeartMonitoring | Uses sensors to continuously or periodically measure user heart rate and record and analyze heart-health data. |
| Pressure | Measures and reports atmospheric or system pressure values. |
| MultiStateOutputObject | Outputs multi-state discrete control commands, such as HVAC mode or lighting-scene changes. |
| Contact | Detects binary contact or door-sensor states and reports open/closed states and optional angle information. |
| Doorbell | Provides doorbell capabilities, including call-event reporting and integration with indoor chimes or relays. |
| WaterFreezeDetector | Detects freezing risk in pipes or the environment and reports water-freezing events when thresholds are reached. |
| Speaker | Describes device speaker output capabilities, including audio-output attributes such as volume control and mute. |
| DoorLock | Provides core smart-lock capabilities, including lock status, user/credential management, unlocking/locking, and alarm events. |
| CO2 | Measures and reports ambient carbon-dioxide concentration. |
| VacuumOperationalState | Describes the current operational state of a robot vacuum, such as cleaning, returning to charge, or charging. |
| ValveControl | Provides automatic or manual valve control for precise adjustment of water or gas flow. |
| ScreenDisplay | Manages screen-display hardware attributes, such as resolution, brightness, backlight, and display state. |
| Illuminance | Measures and reports ambient illuminance (lux). |
| Camera | Manages core camera capabilities, including device status, mode switching, image encryption, and cloud-related functions. |
| Gas | Detects combustible or harmful gas leaks and reports alarm events. |
| GestureRecognition | Analyzes hand gestures in real time and converts predefined gestures into control commands. |
| BreathingMonitoring | Uses sensors to continuously or periodically measure user breathing rate and patterns for health monitoring. |
| CharacterStringValueObject | Defines data objects represented as strings and their externally visible characteristics. |
| Sweeper | Provides basic robot-vacuum controls, including starting cleaning, pausing, returning to charge, and status feedback. |
| EVSE | Provides electric vehicle supply equipment (EVSE) control, including starting and stopping charging, current limits, and charging status. |
| CO | Provides carbon-monoxide concentration monitoring and alarm capabilities to detect ambient carbon-monoxide leaks and issue timely alerts. |
| Lighting | This Function provides the ability to activate and control dynamic lighting effects.The server provides a list of effects driven by different sources, from which clients can select and trigger effects. Dynamic lighting effects can be used both with luminaires that support the Color Control Function and with luminaires that support only the Level Control Function (for example, dimmable lights). The specific implementation of effects is manufacturer-defined.Even when devices from different manufacturers use the same EffectID, they are not guaranteed to represent the same effect; a manufacturer may reuse an EffectID across devices to represent a consistent implementation. |
| LevelControl | Provides brightness-level adjustment, supporting setting and reading the current brightness, step dimming, and dimming control coupled with or decoupled from on/off control. |
| ColorControl | Provides color control, supporting adjustment of lighting color through HSV, XY, and color-temperature modes, including combined delivery with brightness commands. This Function provides an interface for adjusting lighting color.Color definitions follow the CIE 1931 color space, with x and y chromaticity coordinates as the primary control method (corresponding to ColorXY / CurrentX / CurrentY). Additionally, color can be controlled through ColorTemperature (color temperature) or Hue + Saturation; Hue and Saturation are recommended to be interpreted using the HSV (HSB) model. RGB/W primary-point capabilities can extend the range of color expression. This Function does not control brightness; brightness is provided by the LevelControl Function. When used together, the brightness value in LevelControl should be interpreted as a proportion of the maximum achievable light intensity for the current color. |
| PanTilt | Provides pan/tilt/zoom control, including presets, calibration, and relative or absolute movement. |
| WindowCovering | This Function provides open/close control, tilt control, target-position management, and operating-state feedback for window coverings such as curtains, roller shades, and blinds. In addition to standard open/close and tilt control, this Function includes Aqara extensions: scene management (starting, reading, previewing, adding, deleting, and editing built-in/custom scenes), manual calibration, remote pairing, motor-mapping exchange, and enhanced-mode status. Clients should use Traits such as TravelConfigured, MotorControllability, MotorOperationStatus, and EnhanceMode to determine the device’s current controllability and operation phase, avoiding invalid commands when requirements are not met. |
| Flow | Measures and reports the flow rate of liquids or gases. |
| OccupancySensing | Detects whether people are present in a space and reports occupied/vacant status and parameters such as hold time. |
| RainSensor | Detects rainfall status and reports whether it is raining and related precipitation information. |
| Smoke | Detects smoke and reports alarm events, supporting related configuration such as sensitivity, self-test, and mute. |
| FreshAirControl | Provides fresh-air system control, supporting outdoor-air intake and adjustment of airflow, mode, and other settings. |
| AnalogOutputObject | Provides writable continuous analog output control signals. |
| Location | Provides location-information reporting and query capabilities for devices or targets. |
| PetRecognition | Recognizes pets such as cats and dogs in a video frame and reports pet appearances or related recognition events. |
| ParticulateMatter | Monitors and reports particulate-matter concentrations, such as PM2.5 and PM10. |
| OnOffSensor | Detects binary switch-input states and reports discrete states such as on/off or triggered/not triggered. |
| SoundDetection | Captures ambient sounds through a microphone, recognizes specific sound types (such as breaking glass or a crying baby), and raises alerts. |
| Ringtone | Provides ringtone and music-playback control, supporting track selection, volume/duration adjustment, and playback-state monitoring. |
| BridgeConfiguration | Manages gateway bridging configuration and describes child-device access, bridging capabilities, and network-topology information. |
| MatterBridgeCommissioning | Manages the ability of a Matter Bridge to share bridged devices with third-party Matter ecosystems. |
| GarageDoorOpener | Provides garage-door control and status feedback, including open, close, stop, and position status. |
| RelativeHumidity | Measures and reports ambient relative humidity, providing attributes such as the current humidity and valid measurement range. |
| Sleep | Monitors sleep-related states and reports metrics such as sleep stage, duration, and quality. |
| BinaryInputObject | Acquires binary state inputs, such as door sensors and switches, represented as true/false or active/inactive values. |
| WaterLeak | Detects water-leak events and promptly reports an alarm when a leak is detected. |
| VehicleDetection | Detects vehicles appearing in a monitored area and reports vehicle-presence events for security or automation use. |
Descriptor
Describes the composition and capability structure of device endpoints, including endpoint lists, device types, and Server/Client clusters.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Descriptor | SupportedEndpointDynamic | Trait |
| EndpointCount | Trait | |
| EndpointStructure | Trait | |
| EndpointDeviceTypes | Trait | |
| EndpointDynamicCount | Trait | |
| EndpointArrayDynamic | Trait | |
| EndpointArray | Trait | |
| EndpointFunctions | Trait | |
| SelectedEndpointDynamic | Trait |
BasicInformation
Provides basic device information, including the manufacturer, product model, firmware version, serial number, online status, and other core attributes.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| BasicInformation | ProductName | Trait |
| PartNumber | Trait | |
| BLVersion | Trait | |
| ManufacturerChipID | Trait | |
| SupportedMatterRoles | Trait | |
| HardwareVersionString | Trait | |
| HubConnectionStatus | Trait | |
| DeviceXCode | Trait | |
| MatterSpecificationVersion | Trait | |
| VendorName | Trait | |
| FirmwareRevisionString | Trait | |
| DeviceID | Trait | |
| VendorID | Trait | |
| MCUVersion | Trait | |
| ProductID | Trait | |
| ConfigurationFlag | Trait | |
| ModelValue | Trait | |
| HardwareVersion | Trait | |
| Mac | Trait | |
| RadarVersion | Trait | |
| SerialNumber | Trait | |
| ConfigurationVersion | Trait | |
| Reachable | Trait | |
| FirmwareRevision | Trait | |
| ChipTemperature | Trait | |
| Location | Trait |
EndpointLabel
Manages endpoint visibility and presentation information, such as names, rooms, icons, and tags, for frontend display and organization.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| EndpointLabel | EndpointTag | Trait |
| EndpointName | Trait | |
| EndpointApplianceType | Trait | |
| EndpointRoom | Trait | |
| EndpointVisibility | Trait | |
| EndpointIcon | Trait | |
| EndpointStatistics | Trait | |
| EndpointRoomName | Trait |
CameraCoordination
Handles complex camera workflows, including WebRTC calls, pan-tilt-zoom control, recognition-data synchronization, and extension events.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| CameraCoordination | APIUnbindWiFiSubdevice | Command |
| APICheckCarDataConsistency | Command | |
| APIBindWiFiSubdevice | Command | |
| APIOperateBridgedDevice | Command | |
| APIDeviceCameraCall | Command | |
| APIOperateCameraUp | Command | |
| APIIssueTokenForWebRTCCall | Command | |
| APIOperateCameraDown | Command | |
| APIGetSignallingServerAddress | Command | |
| APIReportCameraExtEvents | Command | |
| APICheckFaceDataConsistency | Command |
GeneralConfiguration
Provides common device configuration options, such as sensitivity, delays, default parameters, and other device-level settings.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| GeneralConfiguration | VoiceLanguage | Trait |
| EnergySavingEnable | Trait | |
| CurrentSensitivityLevel | Trait | |
| TransmissionPowerSetting | Trait | |
| HubArkTechEnable | Trait | |
| BeepEnable | Trait | |
| NightLightMode | Trait | |
| OutputInterlockFlag | Trait | |
| ActivityDetectionModeSetting | Trait | |
| TimeZone | Trait | |
| NumberOfSensitivityLevelIsSupported | Trait | |
| PollingTime | Trait | |
| InstallationOrientationConfiguration | Trait | |
| DetectionModeSetting | Trait | |
| LightingModeSetting | Trait | |
| ResetMode | Trait |
EcosystemInformation
Describes the ecosystems to which a device is connected, including binding status for HomeKit, Matter fabrics, and more.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| EcosystemInformation | MagicPairPayload | Trait |
| SupportedEcosystem | Trait | |
| MatterPayload | Trait | |
| HomeKitPayload | Trait | |
| BoundEcosystem | Trait |
EnergyManagement
Manages device battery and energy-consumption information, including battery percentage, power-consumption statistics, and low-battery alerts.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| EnergyManagement | CurrentVoltage | Trait |
| CircuitCurrent | Trait | |
| CumulativeEnergyConsumption | Trait | |
| CurrentPower | Trait |
HubCoordination
Serves as the gateway coordination core, managing child-device commissioning, configuration, heartbeats, tokens, and various proxy services.
SceneCoordination
Manages the lifecycle of smart scenes (automation rules), including synchronization, deletion, triggered execution, and consistency validation.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| SceneCoordination | APICheckLocalSceneSync | Command |
| APIDownloadLocalScene | Command | |
| APIRunScene | Command | |
| APIDeleteLocalScene | Command | |
| APIRunLocalScene | Command | |
| APIDownloadCentralScene | Command |
PowerSource
Describes a device’s power source and battery status, including charge level, charging status, battery type, and related information.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| PowerSource | CurrentVoltage | Trait |
| BatReplacementDescription | Trait | |
| BatChargeState | Trait | |
| BatReplaceability | Trait | |
| PowerMode | Trait | |
| BatPercentRemaining | Trait | |
| WiredPresent | Trait | |
| Rechargeable | Trait | |
| StateOfLowBat | Trait | |
| BatReplacementNeeded | Trait | |
| BatQuantity | Trait |
WakeupCoordination
Obtains a wake-up service address or token for low-power devices that support remote wake-up.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| WakeupCoordination | APIGetWakeupUrl | Command |
CentralHubCoordination
Manages advanced central-hub gateway capabilities, including hub enablement, broker information, and data passthrough channels.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| CentralHubCoordination | APIInquiryCentralBroker | Command |
| APIHubPassthroughDataDown | Command | |
| APIEnableCentralHubFunction | Command | |
| APIHubPassthroughDataUp | Command | |
| APIInquiryCentralEnableState | Command |
SecurityGuardCoordination
Manages home-security arming capabilities, including arming and disarming, alarm acknowledgment, and local/cloud configuration synchronization.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| SecurityGuardCoordination | APIDeleteSecurityLocal | Command |
| APISyncSecurityLanInfo | Command | |
| APICheckSecurityEnableConsistency | Command | |
| APIConfirmSecurityAlert | Command | |
| APICheckSecurityConfigConsistency | Command | |
| APIEnableSecurity | Command | |
| APIRepairSecurityEnable | Command |
OTACoordination
Manages the OTA firmware-upgrade coordination workflow, including task delivery, progress reporting, result feedback, and version queries.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| OTACoordination | APIReportOtaDeviceListState | Command |
| APIReportOtaResult | Command | |
| APIReportOtaProgress | Command | |
| APICancelOtaUpgrade | Command | |
| APIInquiryFirmwareInfo | Command | |
| APIUpgradeDeviceFirmware | Command |
LockCoordination
Handles extended smart-lock functions, including dedicated passthrough channels, encryption/decryption assistance, and extension-event reporting.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| LockCoordination | APILockPassthroughUpstream | Command |
| APILockPassthroughDownstream | Command | |
| APIAssistDeviceCrypto | Command | |
| APIReportLockExtEvents | Command |
DeviceAnomalyMonitoring
Continuously monitors device operating parameters to promptly detect and report abnormal or fault conditions.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| DeviceAnomalyMonitoring | LoadSafetyManagement | Trait |
| VoltageSafetyManagement | Trait | |
| CurrentSafetyManagement | Trait | |
| OverCurrentResponseSetting | Trait | |
| TemperatureSafetyManagement | Trait |
GeneralDiagnostics
Provides general diagnostic information, including uptime, reboot count, network interfaces, and hardware faults.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| GeneralDiagnostics | RebootCount | Trait |
| RebootReason | Trait | |
| UpTime | Trait | |
| NetworkInterfaces | Trait | |
| AntiDeletionSetting | Trait | |
| AntiDeletionLevelSetting | Trait | |
| ActiveHardwareFaults | Trait | |
| DebugInfo | Trait | |
| FreeMemory | Trait | |
| AntiDeletionNotification | Trait | |
| Reboot | Command |
RingtoneCoordination
Manages local gateway ringtone and music files, including downloads, deletion, and consistency validation against the cloud library.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| RingtoneCoordination | APIDownloadMusic | Command |
| APICheckLocalMusicSync | Command | |
| APIDeleteMusic | Command |
ZigbeeNetworkDiagnostics
Provides Zigbee network diagnostics, including channel, PAN, neighbor, and routing information.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| ZigbeeNetworkDiagnostics | RoutingAgingCountThreshold | Trait |
| PreOperationMode | Trait | |
| NWKRetransmissionCount | Trait | |
| ZigbeeTotalMessageInOneHour | Trait | |
| ZigbeeCoordMac | Trait | |
| APSRetransmissionCount | Trait | |
| ZigbeeResentMessageInOneHour | Trait | |
| PANID | Trait | |
| ZigbeeExtendedPANID | Trait | |
| ZigbeeGeneralDiagnostics | Trait | |
| MessageTransmissionFailureCountThreshold | Trait | |
| EnableNWKACK | Trait | |
| RebootReason | Trait | |
| ZigbeeKeySeqNumber | Trait | |
| LQI | Trait | |
| ZigbeeFrameCounter | Trait | |
| Channel | Trait | |
| CCAMode | Trait | |
| ZigbeeNextHopMac | Trait | |
| EnableAPSACK | Trait | |
| MACRetransmissionCount | Trait | |
| ZigbeeFailedMessageInOneHour | Trait | |
| ZigbeeNeighborTableInfo | Trait | |
| curOperationMode | Trait | |
| ZigbeeAvgSuccessfulResendCount | Trait | |
| ZigbeeCoordNetworkKey | Trait |
MatterCoordination
Centralizes coordination operations related to Matter, including commissioning, binding, data synchronization, and certificate management.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| MatterCoordination | APIPushMatterBindInfo | Command |
| APIUnbindMatterDeviceDown | Command | |
| APIReportDeviceAqaraSpecModel | Command | |
| APISyncAqaraSpecDataToCloud | Command | |
| APIGenNextMatterNodeId | Command | |
| APIGenHomeMatterNoc | Command | |
| APIStartBindMatterDeviceToHub | Command | |
| APIUnbindMatterDeviceUP | Command | |
| APIQueryMatterJoinLimit | Command |
ScreenCoordination
Manages smart-scene panel interactions, including configuration delivery, status queries, and bidirectional cloud/panel passthrough.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| ScreenCoordination | APICloudToPanelDownstream | Command |
| APIPanelUpstreamRequest | Command | |
| APICheckPanelConfigConsistency | Command | |
| APISyncPositionDown | Command | |
| APIPushPanelConfig | Command |
CommLinkCoordination
Monitors the quality of communication links between the gateway and cloud, performs latency checks, and reports results.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| CommLinkCoordination | APIReportLinkConsuming | Command |
| APICheckLinkConsuming | Command |
IftttCoordination
Serves as the automation-rule coordination center, managing synchronization, subscriptions, and execution for IFTTT and local automation rules.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| IftttCoordination | APIUnsubscribeIftttResChange | Command |
| APIEnableAutomation | Command | |
| APIDeleteIftttLocal | Command | |
| APIPushCentralAutomation | Command | |
| APIRunCloudAction | Command | |
| APIGetSunriseSunsetByLatLon | Command | |
| APIEnableCentralAutomation | Command | |
| APIDeleteCentralAutomation | Command | |
| APIQueryIftttRes | Command | |
| APISubscribeIftttResChange | Command | |
| APIEnableIfttt | Command | |
| APIQueryHolidayList | Command | |
| APIPublishResourceChange | Command | |
| APICheckLocalIftttSync | Command | |
| APIDownloadIftttLocal | Command |
NetworkManagement
Serves as the core control module for device network connectivity and access policies, managing remote proxies and access addresses.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| NetworkManagement | LanAccessAddress | Trait |
| RemoteProxyAccessEnable | Trait | |
| InternetAccessAddress | Trait |
Identify
Provides device-identification capabilities that help users locate physical devices through indicator flashes, sounds, and similar methods.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Identify | IdentifyType | Trait |
| ReverseIdentify | Trait | |
| IdentifyTime | Trait | |
| Identify | Command |
LightBoxCoordination
Manages configuration delivery for smart light-box devices and controls displayed content and effects.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| LightBoxCoordination | APIPushLightBoxConfig | Command |
IRCoordination
Manages gateway infrared learning and transmission, including code-library synchronization, virtual remote creation, and button control.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| IRCoordination | APIGetIrCode | Command |
| APISaveLearnedIrKey | Command | |
| APIQueryIrLearningCode | Command | |
| APIStartIrCodeLearning | Command | |
| APIGetIrCodeTarget | Command | |
| APIQueryIrCodeLibrary | Command | |
| APIGetIrCodeDownloadUrl | Command | |
| APIDeleteLearnedIrCode | Command | |
| APISendIrButtonPress | Command | |
| APISyncIrLearningCodes | Command |
NetworkCommissioning
Provides network commissioning capabilities, including scanning, connecting to, and configuring Wi-Fi, Thread, and other networks.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| NetworkCommissioning | AddOrUpdateZigbeeNetwork | Command |
| AddOrUpdateZigbeeNetworkResponse | Command | |
| HomeStationCredentials | Trait | |
| ConfigStaticIPAddr | Command | |
| WiFiChannel | Trait | |
| ChildDeviceProvisioningState | Trait | |
| ZigbeeDiagnostics | Trait | |
| ZigbeeAuthRandcode | Trait | |
| ZigbeeAuthRandcodeResponse | Trait | |
| WiFiDiagnostics | Trait | |
| MagicPairKeychain | Trait | |
| ConnectToHomeStationResponse | Command | |
| SupportedNetwork | Trait | |
| AddOrUpdateThreadNetwork | Command | |
| AddOrUpdateThreadNetworkResponse | Command | |
| TriggerZigbeeNetworkInfoUpload | Command | |
| SlaveAddress | Trait | |
| ThreadDiagnostics | Trait | |
| ScanWiFiNetworks | Command | |
| ScanWiFiNetworksResponse | Command | |
| AddOrUpdateWiFiNetwork | Command | |
| AddOrUpdateWiFiNetworkResponse | Command | |
| ConnectToHomeStation | Command | |
| AuthenticationStatus | Trait | |
| WiFiRSSI | Trait |
ConfigurationCoordination
Manages common-function configuration, resource subscriptions, and location-information synchronization through multicast or batch operations.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| ConfigurationCoordination | APISyncConfiguration | Command |
| APIWriteFunctionResource | Command | |
| APIPushSubscribedResource | Command | |
| APIReportConfiguration | Command | |
| APIReportThingModelDetail | Command | |
| APIGetConfiguration | Command | |
| APIDeleteConfiguration | Command | |
| APIPushConfiguration | Command |
CloudStorageCoordination
Manages cloud recording and storage service resources, obtaining storage quotas, upload credentials, and related information.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| CloudStorageCoordination | APIRequestCloudStorageResource | Command |
StudioCoordination
Manages integration between gateways and the Aqara Studio development environment, including account authentication, project backups, and device synchronization.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| StudioCoordination | APIGetStudioBackupUploadUrl | Command |
| APILoginByAuthCode | Command | |
| APIGetAuthCode | Command | |
| APIDeleteStudioBackup | Command | |
| APIGetPositionByDeviceId | Command | |
| APIGetStudioBackupInfo | Command | |
| APIGetUserDeviceList | Command | |
| APILoginByGuardCode | Command | |
| APIReportStudioInfo | Command | |
| APIConfirmStudioBackupSuccess | Command | |
| APIGetProxyServerInfo | Command |
Temperature
Measures and reports ambient temperature, providing attributes such as the current temperature and valid measurement range.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Temperature | CurrentTemperature | Trait |
TemperatureControl
Provides temperature-setting and adjustment capabilities for target-temperature control on thermostatic devices.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| TemperatureControl | SetTemperatureLevel | Trait |
| SetTemperature | Trait | |
| ChangeTemperatureLevel | Command | |
| ChangeTemperature | Command |
PackageRecognition
Automatically recognizes packages in a video frame and can send reminders and record events when packages are delivered or removed.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| PackageRecognition | PackageRecognitionReport | Trait |
FaceRecognition
Captures facial features, compares them with a local library, and reports facial-recognition results and match information.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| FaceRecognition | FaceIDReport | Trait |
HumanPresence
Detects human presence in a space and supports advanced sensing capabilities such as people counting, trajectories, and identity association.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| HumanPresence | HoldTime | Trait |
| ResetPresence | Command | |
| ActivityDetected | Trait | |
| PresenceConfiguration | Trait | |
| Presence | Trait |
HumanRecognition
Uses vision and other algorithms to detect human figures in real time, distinguish people from other objects, and report events.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| HumanRecognition | HumanRecognitionReport | Trait |
AirQuality
Monitors and reports air-quality indicators, such as AQI or an overall air-quality level.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| AirQuality | VOCDensity | Trait |
| AirQuality | Trait | |
| VOCQuality | Trait |
AttitudeDetection
Detects changes in device orientation or tilt angle and reports orientation anomalies or angle information.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| AttitudeDetection | AttitudeDetected | Trait |
Lifter
Provides travel control for lifting devices, supporting target-position settings, stopping, and status queries.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Lifter | GoToMaxPositionPercentage | Command |
| AutoControl | Command | |
| GoToPositionPercentage | Command | |
| GoToMinPositionPercentage | Command | |
| TripTime | Trait | |
| TargetPositionPercentage | Trait | |
| CurrentPositionPercentage | Trait | |
| StopMotion | Command |
Binding
Represents a persistent binding relationship between an endpoint and one or more other local or remote endpoints.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Binding | Binding | Trait |
| SupportedBindingDeviceTypes | Trait | |
| SupportedBindingFunctions | Trait |
PetFeeder
Provides pet-feeding controls, including portion counts, feeding schedules, and remaining-food status.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| PetFeeder | Feed | Trait |
Button
Describes event reporting for button input devices, including recognition of single clicks, long presses, and multiple clicks.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Button | LocalControlDisabled | Trait |
| ButtonEvent | Trait |
Output
Provides switched-output control, supporting reading and controlling the on/off state of a load.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Output | Toggle | Command |
| OutputSwitchingType | Trait | |
| OnOff | Trait | |
| OutputInterlockFlag | Trait | |
| OutputNodeMode | Trait | |
| Off | Command | |
| StartUpOnOff | Trait | |
| On | Command |
IRControl
Provides infrared-transmission control for conventional infrared appliances such as air conditioners and televisions.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| IRControl | SendIRCode | Command |
| IRKey | Trait | |
| IRType | Trait |
HeaterCooler
Provides cooling and heating control, including HVAC parameters such as target temperature, operating mode, and fan speed.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| HeaterCooler | CoolingTemperature | Trait |
| CurrentHumidity | Trait | |
| ClearActivePreset | Command | |
| CurrentTemperature | Trait | |
| Preset | Trait | |
| SetActivePreset | Command | |
| SetBack | Trait | |
| PresetTypes | Trait | |
| HeaterCoolerMode | Trait | |
| ActivePresetHandle | Trait | |
| HeatingTemperature | Trait | |
| NumberOfPresets | Trait | |
| HeaterCoolerButtonEvent | Trait | |
| MinHeatCoolDeadBand | Trait | |
| CurrentTemperatureCalibration | Trait | |
| TemperatureUIDisplayMode | Trait | |
| AntiFreezeTemperature | Trait | |
| HeaterCoolerPolarity | Trait |
Vibration
Detects vibration or motion-state changes and reports events such as movement, tilting, and dropping.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Vibration | TiltAngleDeviation | Trait |
| StationaryState | Trait | |
| InitialTiltAngle | Trait | |
| EventReportInterval | Trait | |
| ObjectOrientationEnable | Trait | |
| StationaryTiltAngle | Trait | |
| PeakTiltAngle | Trait | |
| ObjectMotionDetectionEnable | Trait | |
| ObjectOrientationState | Trait | |
| VibrationEvent | Trait |
Cube
Describes gesture recognition for cube controllers, including flips, rotations, shakes, and face recognition.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Cube | CubeWorkModeSetting | Trait |
| TopFace | Trait | |
| CubeEvent | Trait | |
| TopFaceChanged | Trait |
Knob
Describes rotation-angle, press, and combined-action events for knob input devices.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Knob | HoldRotationInterval | Trait |
| RotationEvent | Trait | |
| RotationDirection | Trait | |
| InvertedRotationAngle | Trait | |
| RotationAngle | Trait | |
| RotationInterval | Trait | |
| HoldRotationAngle | Trait |
BinaryOutputObject
Drives binary actuator outputs, such as relays, contactors, solenoid valves, or sirens.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| BinaryOutputObject | BinaryOutputPV | Trait |
AnalogInputObject
Acquires continuously varying analog inputs in read-only mode, such as voltage and simulated temperature signals.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| AnalogInputObject | AnalogInputPV | Trait |
MediaPlayback
Provides media-playback control, including play, pause, track changes, volume, and playback-state management.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| MediaPlayback | Pause | Command |
| TargetPlaybackState | Trait | |
| Stop | Command | |
| MediaInformation | Trait | |
| PlaybackDuration | Trait | |
| MediaPlaybackCommand | Command | |
| CurrentPlaybackState | Trait | |
| PlaybackMode | Trait | |
| Rewind | Command | |
| SampledPosition | Trait | |
| Play | Command | |
| StartOver | Command | |
| PlaySpecificList | Command | |
| LoginState | Trait | |
| FastForward | Command | |
| Next | Command | |
| Previous | Command | |
| PlaybackSampledPosition | Trait | |
| SelectedMediaOutputSource | Trait | |
| SelectedSource | Trait |
MediaInput
Describes media input-source management and switching, supporting selection of the current playback source and input list.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| MediaInput | SelectInput | Command |
| MediaInput | Trait |
FlameDetection
Detects visible flames through image or sensor algorithms and immediately reports fire events for early warning.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| FlameDetection | FlameDetected | Trait |
OperationalState
Describes the device’s current operational state, such as idle, running, paused, or faulted.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| OperationalState | Pause | Command |
| OperationalError | Trait | |
| Start | Command | |
| Stop | Command | |
| OperationalState | Trait | |
| Resume | Command |
RefrigeratorState
Describes refrigerator operational states, including idle, cooling, defrosting, and faults.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| RefrigeratorState | RefrigeratorAlarm | Trait |
Mode
Provides a device feature-mode interface that supports switching among multiple predefined modes.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Mode | CurrentMode | Trait |
| ChangeToMode | Command | |
| ChangeToModeResponse | Trait |
BridgedConfiguration
Describes configuration information for bridged child devices in Matter/Zigbee bridging scenarios.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| BridgedConfiguration | BridgeDeviceID | Trait |
MultiStateInputObject
Acquires multi-state discrete inputs that represent one of N states.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| MultiStateInputObject | MultiStateInputPV | Trait |
MARSConfiguration
Provides smart-load (MARS) configuration for load identification and intelligent power-distribution management.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| MARSConfiguration | PulseDuration | Trait |
| LoadType | Trait |
ScreenUserInterface
Manages screen-side user-interface configuration, including page layouts, cards, themes, and displayed data.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| ScreenUserInterface | ThemeID | Trait |
| Allpages | Trait | |
| MaxPageNum | Trait | |
| ScreenWidth | Trait | |
| DataVersion | Trait | |
| ThemeVersion | Trait | |
| ScreenHeight | Trait |
CustomizedConfiguration
Provides read and write access to manufacturer- or user-defined extension configuration items.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| CustomizedConfiguration | EnableIndicator | Trait |
| StartUpOnOff | Trait |
HEPAFilterMonitoring
Monitors HEPA filter use, remaining life, and replacement reminders.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| HEPAFilterMonitoring | Condition | Trait |
| ChangeIndication | Trait | |
| ResetCondition | Command |
ActivatedCarbonFilterMonitoring
Monitors activated-carbon filter use, remaining life, and replacement reminders.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| ActivatedCarbonFilterMonitoring | Condition | Trait |
| ChangeIndication | Trait | |
| ResetCondition | Command |
FanControl
Provides fan-speed and mode control, supporting speed-level adjustment and operating-state reading.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| FanControl | WindSetting | Trait |
| AirflowDirection | Trait | |
| FanMode | Trait | |
| FanSpeed | Trait | |
| RockSetting | Trait |
HeartMonitoring
Uses sensors to continuously or periodically measure user heart rate and record and analyze heart-health data.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| HeartMonitoring | HeartRate | Trait |
Pressure
Measures and reports atmospheric or system pressure values.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Pressure | CurrentPressure | Trait |
MultiStateOutputObject
Outputs multi-state discrete control commands, such as HVAC mode or lighting-scene changes.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| MultiStateOutputObject | MultiStateOutputPV | Trait |
Contact
Detects binary contact or door-sensor states and reports open/closed states and optional angle information.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Contact | ContactSensorState | Trait |
| OpenAngle | Trait |
Doorbell
Provides doorbell capabilities, including call-event reporting and integration with indoor chimes or relays.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Doorbell | ButtonEvent | Trait |
| Volume | Trait |
WaterFreezeDetector
Detects freezing risk in pipes or the environment and reports water-freezing events when thresholds are reached.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| WaterFreezeDetector | BooleanState | Trait |
Speaker
Describes device speaker output capabilities, including audio-output attributes such as volume control and mute.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Speaker | StepValue | Trait |
| Volume | Trait | |
| Mute | Trait |
DoorLock
Provides core smart-lock capabilities, including lock status, user/credential management, unlocking/locking, and alarm events.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| DoorLock | LockOperation | Trait |
| UnboltDoor | Command | |
| SupportedRemoteFeatures | Trait | |
| SetWeekDaySchedule | Command | |
| QuietUnlockDoor | Command | |
| GetYearDaySchedule | Command | |
| NumberOfCredentialsSupportedPerUser | Trait | |
| LockOperationError | Trait | |
| NumberOfTotalUsersSupported | Trait | |
| DoorState | Trait | |
| NumberOfYearDaySchedulesSupportedPerUser | Trait | |
| LockState | Trait | |
| ClearWeekDaySchedule | Command | |
| GetUser | Command | |
| UnlockDoor | Command | |
| EnableRemoteControl | Trait | |
| NumberOfPINUsersSupported | Trait | |
| SetYearDaySchedule | Command | |
| GetWeekDaySchedule | Command | |
| LockUserChange | Trait | |
| RemoteControlWithAuthCode | Trait | |
| DoorLockAlarm | Trait | |
| RemoteUnlock | Trait | |
| NumberOfRFIDUsersSupported | Trait | |
| LockDoor | Command | |
| ClearYearDaySchedule | Command | |
| QuietLockDoor | Command | |
| NumberOfWeekDaySchedulesSupportedPerUser | Trait |
CO2
Measures and reports ambient carbon-dioxide concentration.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| CO2 | CO2Level | Trait |
| CO2Density | Trait |
VacuumOperationalState
Describes the current operational state of a robot vacuum, such as cleaning, returning to charge, or charging.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| VacuumOperationalState | GoHome | Command |
| VacuumOperationalError | Trait | |
| Pause | Command | |
| Start | Command | |
| Stop | Command | |
| VacuumOperationalState | Trait | |
| Resume | Command |
ValveControl
Provides automatic or manual valve control for precise adjustment of water or gas flow.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| ValveControl | CurrentValveState | Trait |
| DefaultOpenDuration | Trait | |
| Close | Command | |
| RemainingDuration | Trait | |
| Open | Command |
ScreenDisplay
Manages screen-display hardware attributes, such as resolution, brightness, backlight, and display state.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| ScreenDisplay | ScreenBrightness | Trait |
Illuminance
Measures and reports ambient illuminance (lux).
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Illuminance | SamplingInterval | Trait |
| CurrentIlluminance | Trait |
Camera
Manages core camera capabilities, including device status, mode switching, image encryption, and cloud-related functions.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Camera | CameraActiveStatus | Trait |
| CameraRTSPURL | Trait | |
| P2PCaptureStatus | Trait | |
| CameraRTSPEnable | Trait | |
| P2PCaptureEnabled | Trait |
Gas
Detects combustible or harmful gas leaks and reports alarm events.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Gas | CurrentSensitivityLevel | Trait |
| GasDensity | Trait | |
| SelfCheck | Trait | |
| Mute | Trait | |
| GasDetected | Trait |
GestureRecognition
Analyzes hand gestures in real time and converts predefined gestures into control commands.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| GestureRecognition | GestureRecognitionReport | Trait |
BreathingMonitoring
Uses sensors to continuously or periodically measure user breathing rate and patterns for health monitoring.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| BreathingMonitoring | BreathingRate | Trait |
CharacterStringValueObject
Defines data objects represented as strings and their externally visible characteristics.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| CharacterStringValueObject | CharStringValuePV | Trait |
Sweeper
Provides basic robot-vacuum controls, including starting cleaning, pausing, returning to charge, and status feedback.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Sweeper | ContinueCleaning | Command |
| SweeperState | Trait | |
| PauseCleaning | Command | |
| StartCleaning | Command | |
| StopCleaning | Command |
EVSE
Provides electric vehicle supply equipment (EVSE) control, including starting and stopping charging, current limits, and charging status.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| EVSE | EvseSupplyState | Trait |
| MinChargeCurrent | Trait | |
| EvseState | Trait | |
| ChargingEnabledUntil | Trait | |
| BatteryCapacity | Trait | |
| VehicleID | Trait | |
| EvseFaultState | Trait | |
| BatPercentRemaining | Trait | |
| EnableCharging | Command | |
| MaxChargeCurrent | Trait | |
| CurrentFlow | Trait | |
| DisableCharging | Command |
CO
Provides carbon-monoxide concentration monitoring and alarm capabilities to detect ambient carbon-monoxide leaks and issue timely alerts.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| CO | ExpressedState | Trait |
| CODetected | Trait | |
| SelfTestRequest | Command |
Lighting
This Function provides the ability to activate and control dynamic lighting effects.The server provides a list of effects driven by different sources, from which clients can select and trigger effects.
Dynamic lighting effects can be used both with luminaires that support the Color Control Function and with luminaires that support only the Level Control Function (for example, dimmable lights).
The specific implementation of effects is manufacturer-defined.Even when devices from different manufacturers use the same EffectID, they are not guaranteed to represent the same effect; a manufacturer may reuse an EffectID across devices to represent a consistent implementation.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Lighting | BuiltInEffects | Trait |
| PreviewEffect | Command | |
| MaxUserDefinedEffects | Trait | |
| CurrentEffectID | Trait | |
| UpdateUserDefinedEffect | Command | |
| RemoveUserDefinedEffect | Command | |
| GetEffectData | Command | |
| StartEffect | Command | |
| EffectInfo | Trait | |
| AddUserDefinedEffect | Command | |
| MaxEffectNameLength | Trait | |
| StopPreview | Command | |
| UserDefinedEffects | Trait | |
| PreviewTransition | Command |
LevelControl
Provides brightness-level adjustment, supporting setting and reading the current brightness, step dimming, and dimming control coupled with or decoupled from on/off control.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| LevelControl | StepBrightness | Command |
| OnTransitionTime | Trait | |
| SetBrightness | Command | |
| StepBrightnessWithOnOff | Command | |
| SetBrightnessWithOnOff | Command | |
| CurrentLevel | Trait | |
| OffTransitionTime | Trait |
ColorControl
Provides color control, supporting adjustment of lighting color through HSV, XY, and color-temperature modes, including combined delivery with brightness commands.
This Function provides an interface for adjusting lighting color.Color definitions follow the CIE 1931 color space, with x and y chromaticity coordinates as the primary control method (corresponding to ColorXY / CurrentX / CurrentY). Additionally, color can be controlled through ColorTemperature (color temperature) or Hue + Saturation; Hue and Saturation are recommended to be interpreted using the HSV (HSB) model. RGB/W primary-point capabilities can extend the range of color expression. This Function does not control brightness; brightness is provided by the LevelControl Function. When used together, the brightness value in LevelControl should be interpreted as a proportion of the maximum achievable light intensity for the current color.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| ColorControl | MoveToXYColor | Command |
| CurrentY | Trait | |
| ColorMode | Trait | |
| WhitePointXY | Trait | |
| ColorTemperature | Trait | |
| LEDICQuantity | Trait | |
| ColorRGB | Trait | |
| ColorXY | Trait | |
| Hue | Trait | |
| StartUpXYColor | Trait | |
| MoveToHueSaturationBrightness | Command | |
| LightingMusicSyncMode | Trait | |
| StartUpColorTemperature | Trait | |
| LightingDynamicSceneMode | Trait | |
| Saturation | Trait | |
| CurrentG | Trait | |
| MoveToHueAndSaturation | Command | |
| MoveToColorTemperatureBrightness | Command | |
| CurrentB | Trait | |
| LightingMusicSyncEnable | Trait | |
| MoveToXYColorBrightness | Command | |
| StepColorTemperature | Command | |
| MoveToColorTemperature | Command | |
| CurrentX | Trait | |
| ColorPointRGBXY | Trait | |
| LEDICProtocol | Trait | |
| LEDType | Trait | |
| CurrentR | Trait |
PanTilt
Provides pan/tilt/zoom control, including presets, calibration, and relative or absolute movement.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| PanTilt | PanTiltDirectionControl | Command |
WindowCovering
This Function provides open/close control, tilt control, target-position management, and operating-state feedback for window coverings such as curtains, roller shades, and blinds.
In addition to standard open/close and tilt control, this Function includes Aqara extensions: scene management (starting, reading, previewing, adding, deleting, and editing built-in/custom scenes), manual calibration, remote pairing, motor-mapping exchange, and enhanced-mode status.
Clients should use Traits such as TravelConfigured, MotorControllability, MotorOperationStatus, and EnhanceMode to determine the device’s current controllability and operation phase, avoiding invalid commands when requirements are not met.
Flow
Measures and reports the flow rate of liquids or gases.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Flow | CurrentFlow | Trait |
OccupancySensing
Detects whether people are present in a space and reports occupied/vacant status and parameters such as hold time.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| OccupancySensing | HoldTime | Trait |
| DurationOccupiedWithinOneWeek | Trait | |
| Occupancy | Trait | |
| DurationOccupiedWithinOneDay | Trait | |
| OccupancySensorType | Trait |
RainSensor
Detects rainfall status and reports whether it is raining and related precipitation information.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| RainSensor | BooleanState | Trait |
Smoke
Detects smoke and reports alarm events, supporting related configuration such as sensitivity, self-test, and mute.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Smoke | ExpressedState | Trait |
| FireProductIdentification | Trait | |
| SmokeDensitydB | Trait | |
| SmokeChamberContamination | Trait | |
| AlarmError | Trait | |
| SelfCheck | Trait | |
| SmokeState | Trait | |
| TriggerWarning | Command | |
| SelfTestRequest | Command | |
| AlarmsEnabled | Trait | |
| ContaminationState | Trait | |
| Mute | Trait | |
| SmokeDensity | Trait | |
| SmokeDetected | Trait | |
| EnableHeartbeatIndicator | Trait |
FreshAirControl
Provides fresh-air system control, supporting outdoor-air intake and adjustment of airflow, mode, and other settings.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| FreshAirControl | FreshAirMode | Trait |
AnalogOutputObject
Provides writable continuous analog output control signals.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| AnalogOutputObject | AnalogOutputPV | Trait |
Location
Provides location-information reporting and query capabilities for devices or targets.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Location | MotionDetected | Trait |
PetRecognition
Recognizes pets such as cats and dogs in a video frame and reports pet appearances or related recognition events.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| PetRecognition | PetRecognitionReport | Trait |
ParticulateMatter
Monitors and reports particulate-matter concentrations, such as PM2.5 and PM10.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| ParticulateMatter | PM1.0Density | Trait |
| PM2.5Density | Trait | |
| PM2.5Level | Trait | |
| PM10Density | Trait |
OnOffSensor
Detects binary switch-input states and reports discrete states such as on/off or triggered/not triggered.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| OnOffSensor | BooleanState | Trait |
SoundDetection
Captures ambient sounds through a microphone, recognizes specific sound types (such as breaking glass or a crying baby), and raises alerts.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| SoundDetection | AnomalySoundDetected | Trait |
Ringtone
Provides ringtone and music-playback control, supporting track selection, volume/duration adjustment, and playback-state monitoring.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Ringtone | RingtonePlayVolume | Trait |
| RingtonePlayIndex | Trait | |
| RingtonePlayStatus | Trait | |
| RingtonePlayDuration | Trait |
BridgeConfiguration
Manages gateway bridging configuration and describes child-device access, bridging capabilities, and network-topology information.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| BridgeConfiguration | BridgedNodeList | Trait |
| SupportedHubCapability | Trait |
MatterBridgeCommissioning
Manages the ability of a Matter Bridge to share bridged devices with third-party Matter ecosystems.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| MatterBridgeCommissioning | MatterBridgeSupported | Trait |
| MatterDACState | Trait | |
| MatterOnboardingPayload | Trait | |
| MatterManufacturerList | Trait | |
| RemoveOneMatterManufacturer | Command | |
| RemoveAllMatterManufacturer | Command | |
| MatterBindState | Trait | |
| MatterPairingState | Trait | |
| MatterPairingSwitch | Trait |
GarageDoorOpener
Provides garage-door control and status feedback, including open, close, stop, and position status.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| GarageDoorOpener | TargetGarageDoorState | Trait |
| Toggle | Command | |
| CurrentGarageDoorState | Trait |
RelativeHumidity
Measures and reports ambient relative humidity, providing attributes such as the current humidity and valid measurement range.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| RelativeHumidity | CurrentHumidity | Trait |
Sleep
Monitors sleep-related states and reports metrics such as sleep stage, duration, and quality.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| Sleep | SleepQuality | Trait |
| SleepStage | Trait | |
| SleepState | Trait | |
| OnBed | Trait |
BinaryInputObject
Acquires binary state inputs, such as door sensors and switches, represented as true/false or active/inactive values.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| BinaryInputObject | BinaryInputPV | Trait |
WaterLeak
Detects water-leak events and promptly reports an alarm when a leak is detected.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| WaterLeak | LeakState | Trait |
VehicleDetection
Detects vehicles appearing in a monitored area and reports vehicle-presence events for security or automation use.
| functionCode | trait/commandCode | Trait or Command? |
|---|---|---|
| VehicleDetection | VehicleDetected | Trait |