Trait Codes
The following table lists all trait codes supported by Aqara:
| trait_code | trait_name |
|---|---|
| CODetected | Carbon Monoxide Detection Status |
| ExpressedState | Alarm State |
| WindSetting | Wind Type |
| AirflowDirection | Airflow Direction |
| FanSpeed | Fan Speed |
| AirQuality | Air Quality Level |
| BooleanState | Boolean State |
| FreshAirMode | Fresh Air Mode |
| InvertedRotationAngle | Inverted Rotation Angle |
| ScreenBrightness | Screen Brightness |
| TemperatureUIDisplayMode | Temperature UI Display Mode |
| BatReplacementNeeded | Battery Replacement Needed |
| BatQuantity | Battery Quantity |
| Rechargeable | Rechargeable |
| CircuitCurrent | Circuit Current |
| P2PCaptureEnabled | P2P Capture Supported |
| MotorOperationStatus | Motor Operation Status |
| MotorDirectionReversed | Motor Direction Reversed |
| MotorControllability | Motor Controllability |
| CurrentValveState | Current Valve State |
| Condition | Filter Remaining Life |
| ChangeIndication | Filter Life Status |
| FilterType | Filter Type |
| OperationalState | Operational State |
| CurrentFlow | Current Flow |
| CurrentMode | Current Mode |
| ChangeToModeResponse | Mode Change Feedback |
| VacuumOperationalState | Vacuum Operational State |
| RefrigeratorAlarm | Refrigerator Alarm |
| EvseState | Charging Connector State |
| EvseSupplyState | Charging Station State |
| ChargingEnabledUntil | Charging Enabled Until |
| MaxChargeCurrent | Maximum Current |
| BatteryCapacity | Battery Capacity |
| MinChargeCurrent | Minimum Current |
| SetTemperature | Set Temperature |
| SetTemperatureLevel | Set Temperature Level |
| MediaInput | Playback Source |
| SetBack | Temperature Setback |
| OpenAngle | Opening Angle |
| BSSID | BSSID |
| CurrentTemperatureCalibration | Temperature Compensation |
| HeaterCoolerButtonEvent | Heater/Cooler Button Event |
| HeaterCoolerPolarity | Heater/Cooler Polarity Setting |
| SelfCheck | Alarm Self-Test |
| FirmwareRevision | Firmware Version |
| SerialNumber | Serial Number |
| VendorName | Vendor Name |
| VendorID | Vendor ID |
| ProductName | Product Name |
| Reachable | Connectivity State |
| HardwareVersion | Hardware Version |
| Mac | MAC Address |
| DeviceID | Device ID |
| EndpointName | Device or Card Name |
| OnOff | On/Off State |
| CurrentLevel | Current Level |
| CurrentX | X Value |
| CurrentY | Y Value |
| ColorTemperature | Color Temperature |
| ButtonEvent | Button Event |
| CameraActiveStatus | Camera Sleep State |
| CurrentPositionPercentage | Current Position Percentage |
| TargetPositionPercentage | Target Position Percentage |
| IRType | Infrared Type |
| IRBrand | Infrared Brand |
| CurrentVoltage | Voltage |
| CurrentPower | Power |
| CumulativeEnergyConsumption | Cumulative Energy Consumption |
| HeaterCoolerMode | Heating/Cooling Mode |
| HeatingTemperature | Heating Temperature |
| CoolingTemperature | Cooling Temperature |
| FanMode | Fan Mode |
| RockSetting | Oscillation |
| CurrentHumidity | Humidity |
| CurrentPlaybackState | Playback State |
| PlaybackDuration | Duration |
| SampledPosition | Playback Progress |
| PlaybackMode | Playback Mode |
| MediaInformation | Media Information |
| Volume | Volume |
| Mute | Mute |
| LockState | Lock State |
| DoorState | Door State |
| IRKey | Infrared Command |
| BatPercentRemaining | Battery Percentage |
| SweeperState | Sweeper State |
| VOCDensity | VOC Concentration |
| VOCQuality | VOC Level |
| CurrentPressure | Pressure |
| PM2.5Density | PM2.5 Concentration |
| PM2.5Level | PM2.5 Level |
| PM1.0Density | PM1.0 Concentration |
| PM10Density | PM10 Concentration |
| CO2Density | CO2 Concentration |
| CO2Level | CO2 Level |
| CurrentIlluminance | Illuminance |
| ContactSensorState | Contact State |
| SmokeDensity | Smoke Concentration |
| SmokeDetected | Smoke Detection Status |
| GasDensity | Gas Concentration |
| GasDetected | Gas Detection Status |
| SleepState | Sleep State |
| SleepQuality | Sleep Quality |
| OnBed | In-Bed State |
| SleepStage | Sleep Stage |
| LeakState | Leak State |
| Occupancy | Presence State |
| OccupancySensorType | Presence Sensor Type |
| MotionDetected | Motion Detection |
| RotationAngle | Rotation Angle |
| RotationDirection | Rotation Direction |
| RotationEvent | Rotation Event |
| CubeEvent | Cube Event |
| VibrationEvent | Vibration Sensor Event |
| SmokeDensitydB | Smoke Density (dB) |
| CurrentR | Red Value |
| CurrentG | Green Value |
| CurrentB | Blue Value |
| SupportedEndpointDynamic | Dynamic Mode Supported |
| EndpointArrayDynamic | Dynamic Endpoint Array |
| Feed | Feed |
| AttitudeDetected | Attitude Detection |
| TargetPlaybackState | Target Playback State |
| EnableRemoteControl | Enable Remote Control |
| HardwareVersionString | Specified Endpoint Hardware Version |
| FirmwareRevisionString | Firmware Version |
| ProductID | Product ID |
| MinPINCodeLength | Minimum PIN Code Length |
| MinRFIDCodeLength | Minimum RFID Length |
| OperatingMode | Operating Mode |
| ActuatorEnabled | Actuator Enabled |
| ReverseIdentify | Reverse Identification |
| Hue | Hue |
| Saturation | Saturation |
| MinHeatCoolDeadBand | Minimum Heating/Cooling Dead Band |
| Channel | Wireless Channel |
| ExtendedPANID | Network Extended PAN ID |
| WindowCoveringMotorsBinding | Window Covering Motors Binding |
| CurrentRotationAngle | Current Rotation Angle |
| TargetRotationAngle | Target Rotation Angle |
| CurrentGarageDoorState | Current Garage Door State |
| TargetGarageDoorState | Target Garage Door State |
| HoldRotationAngle | Hold Rotation Angle |
| ModeCount | Mode Count |
| PlaybackSampledPosition | Playback Sampled Position |
| SelectedMediaOutputSource | Selected Media Output Source |
| LockOperation | Lock Operation |
| DoorLockAlarm | Door Lock Alarm |
| LockUserChange | Lock User Change |
| ModelValue | Model Value |
| EndpointCount | Endpoint Count |
| EndpointStructure | Endpoint Structure |
| EndpointDeviceTypes | Endpoint Device Types |
| EndpointDynamicCount | Endpoint Dynamic Count |
| EndpointArray | Endpoint Array |
| EndpointFunctions | Endpoint Functions |
| SelectedEndpointDynamic | Selected Endpoint Dynamic |
| PartNumber | Part Number |
| BLVersion | BL Version |
| ManufacturerChipID | Manufacturer Chip ID |
| SupportedMatterRoles | Supported Matter Roles |
| HubConnectionStatus | Hub Connection Status |
| DeviceXCode | Device X Code |
| MatterSpecificationVersion | Matter Specification Version |
| MCUVersion | MCU Version |
| ConfigurationFlag | Configuration Flag |
| RadarVersion | Radar Version |
| ConfigurationVersion | Configuration Version |
| ChipTemperature | Chip Temperature |
| Location | Location |
| EndpointTag | Endpoint Tag |
| EndpointApplianceType | Endpoint Appliance Type |
| EndpointRoom | Endpoint Room |
| EndpointVisibility | Endpoint Visibility |
| EndpointIcon | Endpoint Icon |
| EndpointStatistics | Endpoint Statistics |
| EndpointRoomName | Endpoint Room Name |
| VoiceLanguage | Voice Language |
| EnergySavingEnable | Energy Saving Enable |
| CurrentSensitivityLevel | Current Sensitivity Level |
| TransmissionPowerSetting | Transmission Power Setting |
| HubArkTechEnable | Hub Ark Tech Enable |
| BeepEnable | Beep Enable |
| NightLightMode | Night Light Mode |
| OutputInterlockFlag | Output Interlock Flag |
| ActivityDetectionModeSetting | Activity Detection Mode Setting |
| TimeZone | Time Zone |
| NumberOfSensitivityLevelIsSupported | Number Of Sensitivity Level Is Supported |
| PollingTime | Polling Time |
| InstallationOrientationConfiguration | Installation Orientation Configuration |
| DetectionModeSetting | Detection Mode Setting |
| LightingModeSetting | Lighting Mode Setting |
| ResetMode | Reset Mode |
| MagicPairPayload | Magic Pair Payload |
| SupportedEcosystem | Supported Ecosystem |
| MatterPayload | Matter Payload |
| HomeKitPayload | Home Kit Payload |
| BoundEcosystem | Bound Ecosystem |
| BatReplacementDescription | Bat Replacement Description |
| BatChargeState | Bat Charge State |
| BatReplaceability | Bat Replaceability |
| PowerMode | Power Mode |
| WiredPresent | Wired Present |
| StateOfLowBat | State Of Low Bat |
| LoadSafetyManagement | Load Safety Management |
| VoltageSafetyManagement | Voltage Safety Management |
| CurrentSafetyManagement | Current Safety Management |
| OverCurrentResponseSetting | Over Current Response Setting |
| TemperatureSafetyManagement | Temperature Safety Management |
| RebootCount | Reboot Count |
| RebootReason | Reboot Reason |
| UpTime | Up Time |
| NetworkInterfaces | Network Interfaces |
| AntiDeletionSetting | Anti Deletion Setting |
| AntiDeletionLevelSetting | Anti Deletion Level Setting |
| ActiveHardwareFaults | Active Hardware Faults |
| DebugInfo | Debug Info |
| FreeMemory | Free Memory |
| AntiDeletionNotification | Anti Deletion Notification |
| RoutingAgingCountThreshold | Routing Aging Count Threshold |
| PreOperationMode | Pre Operation Mode |
| NWKRetransmissionCount | NWK Retransmission Count |
| ZigbeeTotalMessageInOneHour | Zigbee Total Message In One Hour |
| ZigbeeCoordMac | Zigbee Coord Mac |
| APSRetransmissionCount | APS Retransmission Count |
| ZigbeeResentMessageInOneHour | Zigbee Resent Message In One Hour |
| PANID | PANID |
| ZigbeeExtendedPANID | Zigbee Extended PANID |
| ZigbeeGeneralDiagnostics | Zigbee General Diagnostics |
| MessageTransmissionFailureCountThreshold | Message Transmission Failure Count Threshold |
| EnableNWKACK | Enable NWKACK |
| ZigbeeKeySeqNumber | Zigbee Key Seq Number |
| LQI | Link Quality Indicator |
| ZigbeeFrameCounter | Zigbee Frame Counter |
| CCAMode | CCA Mode |
| ZigbeeNextHopMac | Zigbee Next Hop Mac |
| EnableAPSACK | Enable APSACK |
| MACRetransmissionCount | MAC Retransmission Count |
| ZigbeeFailedMessageInOneHour | Zigbee Failed Message In One Hour |
| ZigbeeNeighborTableInfo | Zigbee Neighbor Table Info |
| CurOperationMode | Cur Operation Mode |
| ZigbeeAvgSuccessfulResendCount | Zigbee Avg Successful Resend Count |
| ZigbeeCoordNetworkKey | Zigbee Coord Network Key |
| LanAccessAddress | Lan Access Address |
| RemoteProxyAccessEnable | Remote Proxy Access Enable |
| InternetAccessAddress | Internet Access Address |
| IdentifyType | Identify Type |
| IdentifyTime | Identify Time |
| HomeStationCredentials | Home Station Credentials |
| WiFiChannel | Wi Fi Channel |
| ChildDeviceProvisioningState | Child Device Provisioning State |
| ZigbeeDiagnostics | Zigbee Diagnostics |
| ZigbeeAuthRandcode | Zigbee Auth Randcode |
| ZigbeeAuthRandcodeResponse | Zigbee Auth Randcode Response |
| WiFiDiagnostics | Wi Fi Diagnostics |
| MagicPairKeychain | Magic Pair Keychain |
| SupportedNetwork | Supported Network |
| SlaveAddress | Slave Address |
| ThreadDiagnostics | Thread Diagnostics |
| AuthenticationStatus | Authentication Status |
| WiFiRSSI | Wi Fi RSSI |
| CurrentTemperature | Current Temperature |
| PackageRecognitionReport | Package Recognition Report |
| FaceIDReport | Face ID Report |
| HoldTime | Hold Time |
| ActivityDetected | Activity Detected |
| PresenceConfiguration | Presence Configuration |
| Presence | Presence |
| HumanRecognitionReport | Human Recognition Report |
| TripTime | Trip Time |
| Binding | Binding |
| SupportedBindingDeviceTypes | Supported Binding Device Types |
| SupportedBindingFunctions | Supported Binding Functions |
| LocalControlDisabled | Local Control Disabled |
| OutputSwitchingType | Output Switching Type |
| OutputNodeMode | Output Node Mode |
| StartUpOnOff | Start Up On Off |
| Preset | Preset |
| PresetTypes | Preset Types |
| ActivePresetHandle | Active Preset Handle |
| NumberOfPresets | Number Of Presets |
| AntiFreezeTemperature | Anti Freeze Temperature |
| TiltAngleDeviation | Tilt Angle Deviation |
| StationaryState | Stationary State |
| InitialTiltAngle | Initial Tilt Angle |
| EventReportInterval | Event Report Interval |
| ObjectOrientationEnable | Object Orientation Enable |
| StationaryTiltAngle | Stationary Tilt Angle |
| PeakTiltAngle | Peak Tilt Angle |
| ObjectMotionDetectionEnable | Object Motion Detection Enable |
| ObjectOrientationState | Object Orientation State |
| CubeWorkModeSetting | Cube Work Mode Setting |
| TopFace | Top Face |
| TopFaceChanged | Top Face Changed |
| HoldRotationInterval | Hold Rotation Interval |
| RotationInterval | Rotation Interval |
| BinaryOutputPV | Binary Output Present Value |
| AnalogInputPV | Analog Input Present Value |
| LoginState | Login State |
| SelectedSource | Selected Source |
| FlameDetected | Flame Detected |
| OperationalError | Operational Error |
| BridgeDeviceID | Bridge Device ID |
| MultiStateInputPV | Multi State Input Present Value |
| PulseDuration | Pulse Duration |
| LoadType | Load Type |
| ThemeID | Theme ID |
| Allpages | Allpages |
| MaxPageNum | Max Page Num |
| ScreenWidth | Screen Width |
| DataVersion | Data Version |
| ThemeVersion | Theme Version |
| ScreenHeight | Screen Height |
| EnableIndicator | Enable Indicator |
| HeartRate | Heart Rate |
| MultiStateOutputPV | Multi State Output Present Value |
| WaterFreezeDetector | WaterFreezeDetector |
| StepValue | Step Value |
| LockOperationError | Lock Operation Error |
| SupportedRemoteFeatures | Supported Remote Features |
| NumberOfCredentialsSupportedPerUser | Number Of Credentials Supported Per User |
| NumberOfTotalUsersSupported | Number Of Total Users Supported |
| NumberOfYearDaySchedulesSupportedPerUser | Number Of Year Day Schedules Supported Per User |
| NumberOfPINUsersSupported | Number Of PIN Users Supported |
| RemoteControlWithAuthCode | Remote Control With Auth Code |
| RemoteUnlock | Remote Unlock |
| NumberOfRFIDUsersSupported | Number Of RFID Users Supported |
| NumberOfWeekDaySchedulesSupportedPerUser | Number Of Week Day Schedules Supported Per User |
| VacuumOperationalError | Vacuum Operational Error |
| DefaultOpenDuration | Default Open Duration |
| RemainingDuration | Remaining Duration |
| SamplingInterval | Sampling Interval |
| CameraRTSPURL | Camera RTSPURL |
| P2PCaptureStatus | P2 P Capture Status |
| CameraRTSPEnable | Camera RTSP Enable |
| GestureRecognitionReport | Gesture Recognition Report |
| BreathingMonitoring | BreathingMonitoring |
| BreathingRate | Breathing Rate |
| CharStringValuePV | Char String Value Present Value |
| VehicleID | Vehicle ID |
| EvseFaultState | Evse Fault State |
| BuiltInEffects | Built In Effects |
| MaxUserDefinedEffects | Max User Defined Effects |
| CurrentEffectID | Current Effect ID |
| EffectInfo | Effect Info |
| MaxEffectNameLength | Max Effect Name Length |
| UserDefinedEffects | User Defined Effects |
| OnTransitionTime | On Transition Time |
| OffTransitionTime | Off Transition Time |
| ColorMode | Color Mode |
| WhitePointXY | White Point XY |
| LEDICQuantity | LEDIC Quantity |
| ColorRGB | Color RGB |
| ColorXY | Color XY |
| StartUpXYColor | Start Up XY Color |
| LightingMusicSyncMode | Lighting Music Sync Mode |
| StartUpColorTemperature | Start Up Color Temperature |
| LightingDynamicSceneMode | Lighting Dynamic Scene Mode |
| LightingMusicSyncEnable | Lighting Music Sync Enable |
| ColorPointRGBXY | Color Point RGBXY |
| LEDICProtocol | LEDIC Protocol |
| LEDType | LED Type |
| MotorSpeedPercentage | Motor Speed Percentage |
| WindowCoveringCategory | Window Covering Category |
| UnconfiguredTravelControlPermission | Unconfigured Travel Control Permission |
| LimitPointSetting | Limit Point Setting |
| ObstacleLimitMarkingBlockTime | Obstacle Limit Marking Block Time |
| MotorSpeedSetting | Motor Speed Setting |
| ManualPullStartStopEnabled | Manual Pull Start Stop Enabled |
| ObstacleLimitSensitivity | Obstacle Limit Sensitivity |
| TravelConfigured | Travel Configured |
| WindowCoveringType | Window Covering Type |
| ObstacleLimitAutoReboundEnable | Obstacle Limit Auto Rebound Enable |
| ManualPullEvent | Manual Pull Event |
| WindowCoveringOpenOrientation | Window Covering Open Orientation |
| ManualPullStartEnabled | Manual Pull Start Enabled |
| LimitPointCount | Limit Point Count |
| TargetPositionRotationPercentage | TargetPositionRotationPercenta |
| CurrentPositionRotationPercentage | CurrentPositionRotationPercent |
| ManualPullStopEnabled | Manual Pull Stop Enabled |
| ObstacleLimitMarkingEnable | Obstacle Limit Marking Enable |
| ManualPullAdaptiveSpeedEnabled | Manual Pull Adaptive Speed Enabled |
| DurationOccupiedWithinOneWeek | Duration Occupied Within One Week |
| DurationOccupiedWithinOneDay | Duration Occupied Within One Day |
| FireProductIdentification | Fire Product Identification |
| SmokeChamberContamination | Smoke Chamber Contamination |
| AlarmError | Alarm Error |
| SmokeState | Smoke State |
| AlarmsEnabled | Alarms Enabled |
| ContaminationState | Contamination State |
| EnableHeartbeatIndicator | Enable Heartbeat Indicator |
| AnalogOutputPV | Analog Output Present Value |
| PetRecognitionReport | Pet Recognition Report |
| AnomalySoundDetected | Anomaly Sound Detected |
| RingtonePlayVolume | Ringtone Play Volume |
| RingtonePlayIndex | Ringtone Play Index |
| RingtonePlayStatus | Ringtone Play Status |
| RingtonePlayDuration | Ringtone Play Duration |
| BridgedNodeList | Bridged Node List |
| SupportedHubCapability | Supported Hub Capability |
| MatterBridgeSupported | Matter Bridge Supported |
| MatterDACState | Matter DAC State |
| MatterOnboardingPayload | Matter Onboarding Payload |
| MatterManufacturerList | Matter Manufacturer List |
| MatterBindState | Matter Bind State |
| MatterPairingState | Matter Pairing State |
| MatterPairingSwitch | Matter Pairing Switch |
| BinaryInputPV | Binary Input Present Value |
| VehicleDetected | Vehicle Detected |
SupportedEndpointDynamic
Indicates whether the current Device instance supports dynamic configuration.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
EndpointCount
Indicates the number of Endpoints contained in the current Device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int32 | ✔ | ✘ | ✔ | |
| Max | int32 | 65279.0 | ✔ | ✘ | ✘ |
| Min | int32 | 2.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
EndpointStructure
Describes the hierarchy (nesting relationships) of Endpoints in the configuration instance used by the current Device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | EndpointStructureTraitPresentValueStructure | ✔ | ✘ | ✔ |
EndpointDeviceTypes
Describes the Device Type of each Endpoint in all configuration instances of the current Device. Use with EndpointArray or EndpointArrayDynamic.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list | ✔ | ✘ | ✔ |
EndpointDynamicCount
Indicates the number of dynamic Endpoint configuration instances supported by the current Device. The default value is 1.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int32 | ✔ | ✘ | ✔ | |
| Max | int32 | 65279.0 | ✔ | ✘ | ✘ |
| Min | int32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
EndpointArrayDynamic
Describes the Endpoint combination used by the current Device instance. It is mutually exclusive with EndpointArray (only one can be active at a time).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list | ✔ | ✘ | ✔ |
EndpointArray
Describes all possible combinations of Endpoints contained in the current Device. Use with SupportedEndpointDynamic, EndpointDynamicCount, and SelectedEndpointDynamic.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list | ✔ | ✘ | ✔ |
EndpointFunctions
This Trait provides access to and reporting for Endpoint function data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list | ✔ | ✘ | ✔ |
SelectedEndpointDynamic
Represents the array index in EndpointArray and indicates the currently selected Device Endpoint configuration instance.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int32 | ✔ | ✔ | ✔ | |
| Max | int32 | 65279.0 | ✔ | ✘ | ✘ |
| Min | int32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ProductName
Specifies a human-readable (displayable) name for the Endpoint model, such as a manufacturer-assigned model name or other identifier.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
PartNumber
This Trait provides access to and reporting for part-number data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
BLVersion
Specifies the Bootloader version. The maximum length is 64 UTF-8 characters.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
ManufacturerChipID
Identifies the manufacturer chip ID.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✘ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
SupportedMatterRoles
Indicates the Matter roles supported by the device, such as Thread Border Router, Matter Controller, Matter Commissioner, and Matter Bridge. Each bit represents one role.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✔ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
HardwareVersionString
Specifies the version number of the Endpoint hardware. The meaning of its value and the versioning rules are defined by the manufacturer. This attribute provides a more user-friendly value than HardwareVersion.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
HubConnectionStatus
Indicates the connection status between the device and the central Hub, allowing determination of whether the device is currently connected to the central Hub.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | HubConnectionStatusEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[HubConnectionStatusEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
DeviceXCode
Represents the device type X code of the device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✘ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
MatterSpecificationVersion
This Trait provides access to and reporting for the Matter specification version.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
VendorName
This Trait provides access to and reporting for vendor-name data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
FirmwareRevisionString
This Trait provides access to and reporting for firmware-version data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
DeviceID
Represents the unique identifier of the device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
VendorID
This Trait provides access to and reporting for vendor-ID data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
MCUVersion
Specifies the MCU version. (Present Value: String(64), default: null.)
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
ProductID
Specifies the manufacturer-assigned numeric ID that uniquely identifies this specific Endpoint product.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✘ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ConfigurationFlag
Indicates the configuration status. When the flag is set to 1, the device must be configured before it can be used normally.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
ModelValue
AIOT model value, for example, lumi.gateway.cn01.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
HardwareVersion
Specifies the version number of the Endpoint hardware. The meaning of its value and the versioning rules are defined by the manufacturer.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
Mac
Specifies the MAC address of the device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
RadarVersion
Specifies the radar module version. (Present Value: String(64), default: null.)
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
SerialNumber
This Trait provides access to and reporting for serial-number data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
ConfigurationVersion
Stores the device ConfigurationVersion and data-model MD5. Each time the app directly connects to the device and builds a new data model, this Trait is compared with the cloud data model to determine whether to update the data model or report a new Trait value.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ConfigurationVersionTraitPresentValueStructure | ✔ | ✔ | ✔ |
Reachable
Indicates whether the device is reachable. 0: Offline; 1: Online.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
FirmwareRevision
Contains the current version number of the software running on this Endpoint.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
ChipTemperature
Indicates the current temperature measured by the device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 1000.0 | ✔ | ✘ | ✘ |
| Min | float | -50.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.01 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
Location
This Trait provides access to and reporting for region data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
EndpointTag
The Present Value of this attribute must be the ID of a semantic tag within the namespace. 0 represents the aggregate capability, and N (N > 0) specifies the capability of channel N.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✘ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
EndpointName
Describes the Endpoint name as a string with a maximum length of 32.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✔ | ✔ |
EndpointApplianceType
Describes the current appliance type, such as Light, Fan, or Air Conditioner. The available type list varies by Device Type.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✔ | ✔ | |
| Supported Values | list[characterString] | ✔ | ✘ | ✘ |
EndpointRoom
Describes the ID of the room where the Endpoint is located, as a string with a maximum length of 32 bytes.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✔ | ✔ |
EndpointVisibility
Describes the visibility of all Endpoints contained in the current Device. 0: Invisible; 1: Visible.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
EndpointIcon
Describes the current icon ID. The available icon list varies by Device Type and cannot be customized by manufacturers.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✔ | ✔ |
EndpointStatistics
Describes whether the device can be included in statistics.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
EndpointRoomName
Describes the name of the room where the Endpoint is located, as a string with a maximum length of 128 bytes.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✔ | ✔ |
VoiceLanguage
The language used for voice prompts and voice feedback.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | VoiceLanguageEnum8 | 1 | ✔ | ✔ | ✔ |
| Supported Values | list[VoiceLanguageEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 1 | ✔ | ✔ | ✘ |
EnergySavingEnable
Enables or disables energy-saving mode. When enabled, seat temperature, water temperature, and similar settings are maintained at their lowest levels to reduce power consumption.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
CurrentSensitivityLevel
Indicates the currently selected general-configuration sensitivity level.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✔ | ✔ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
TransmissionPowerSetting
A dedicated Trait for setting the device transmit power.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✔ | ✔ | |
| Max | float | 10.0 | ✔ | ✘ | ✘ |
| Min | float | -32.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
HubArkTechEnable
Enables or disables the local disaster-recovery capability of proxy Hubs under Aqara Ark Technology. When enabled, if a Hub fails or loses power and some Zigbee devices under that Hub can act as proxy Hubs, the proxy Hub performs certain basic local automations, scenes, and device groups.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✔ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
BeepEnable
Enables or disables audible feedback for device operations.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
NightLightMode
Sets night-light mode. In Auto mode, the device automatically turns the night light on or off based on ambient light.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | NightLightModeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[NightLightModeEnum8] | ✔ | ✘ | ✘ |
OutputInterlockFlag
When two attributes have the same value, the states corresponding to those attributes are interlocked.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 0 | ✔ | ✔ | ✔ |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
ActivityDetectionModeSetting
Specifies the device’s current operating mode for detecting and identifying specific activities or states, such as human presence, falls, sleep, or gestures.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ActivityDetectionModeSettingEnum32 | 1 | ✔ | ✔ | ✔ |
| Supported Values | list[ActivityDetectionModeSettingEnum32] | ✔ | ✘ | ✘ | |
| Default Value | uint32 | 1 | ✔ | ✔ | ✘ |
TimeZone
This attribute sets and reports the device time zone (for example, China Standard Time is "GMT+8"). Correct time-zone configuration ensures that the device system time, scheduled tasks (such as timers), and log timestamps match the user’s actual local time, which is fundamental to accurate operation of all time-related features.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✔ | ✔ |
NumberOfSensitivityLevelIsSupported
This Trait provides access to and reporting for the number of supported sensitivity levels.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✔ | ✔ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
PollingTime
Sets the polling interval for communication between the device and the network.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | 0 | ✔ | ✔ | ✔ |
| Max | uint32 | 250000.0 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 250.0 | ✔ | ✘ | ✘ |
| Default Value | uint32 | 0 | ✔ | ✔ | ✘ |
InstallationOrientationConfiguration
This Trait provides access to and reporting for installation-orientation configuration data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | InstallationOrientationConfigurationEnum16 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[InstallationOrientationConfigurationEnum16] | ✔ | ✘ | ✘ | |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
DetectionModeSetting
Indicates the current detection-mode setting, which determines the event or state types the device monitors and reports. This configurable parameter can be switched between detection scenarios.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | DetectionModeSettingEnum16 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[DetectionModeSettingEnum16] | ✔ | ✘ | ✘ | |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
LightingModeSetting
Defines the operating mode of the lighting device.
The LightingModeSetting Trait sets or queries the current operating mode of a lighting device. This mode determines the range of control capabilities available to the device, including on/off control, brightness adjustment, color-temperature adjustment, and color setting. Four modes are currently supported: monochrome (Level), color-temperature (ColorTemp), RGB, and RGBW. The data points and operations exposed by the device vary by mode.
Specifically, in monochrome mode, a light supports only on/off and brightness control; it does not support color-temperature control or color settings, so this mode is suitable for single-color-temperature dimmable lights. In color-temperature mode, the device also supports color-temperature adjustment, enabling smooth transitions from warm white to cool white, but it still does not support RGB or RGBW color settings; this mode is suitable for tunable-white lights. In RGB mode, the device supports full-color RGB settings in addition to on/off, brightness, and color-temperature control (color temperature can be simulated by mixing RGB channels), but does not support an independent white channel. In RGBW mode, an independent white channel is added to RGB mode. It supports four-channel RGBW color settings that can simultaneously provide vivid colors and pure white light for richer lighting scenarios.
Importantly, the operating mode is not an arbitrary software-level setting; it must usually be determined by the light’s physical wiring and actual deployment. For example, a light connected only to warm- and cool-white LEDs must not be set to RGB or RGBW mode, whereas a light with independent RGB+W pins can use RGBW mode. When the mode changes, the device data-model configuration is dynamically updated: data points unsupported in the new mode are automatically hidden, while supported data points are displayed as needed. This ensures that clients correctly identify the device’s current capabilities and avoid issuing invalid commands. Before changing this mode, confirm that the hardware supports the target mode. Make changes cautiously to avoid abnormal device control or a mismatch between the client UI and the actual capabilities.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LightingModeSettingEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[LightingModeSettingEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
ResetMode
Supports operations including factory reset and network-configuration reset.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ResetModeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[ResetModeEnum8] | ✔ | ✘ | ✘ |
MagicPairPayload
Provides the pairing information required to commission MagicPair. The value is a structure containing QRCode (the raw pairing QR-code string) and DigitalPairingCode (an 8-digit numeric pairing code). When the device is not bound, reading this payload may activate the MagicPair commissioning window for a period of time (10 minutes by default).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | MagicPairPayloadTraitPresentValueStructure | ✔ | ✘ | ✔ |
SupportedEcosystem
Indicates the ecosystems supported by the device (for example, Aqara Hub M3 supports Aqara Home, Apple HomeKit, and Matter). The value is a bitmask: bit 0 = Aqara Home, bit 1 = Apple HomeKit, bit 2 = Matter, bit 3 = Aqara Studio, and bits 4–7 are reserved.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✘ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
MatterPayload
Provides the pairing information required to commission Matter. The value is a structure containing QRCode (the raw pairing QR-code string) and DigitalPairingCode (an 11- or 21-digit numeric pairing code). When the device is not bound, reading this payload may activate the Matter commissioning window for a period of time (10 minutes by default).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | MatterPayloadTraitPresentValueStructure | ✔ | ✘ | ✔ |
HomeKitPayload
Provides the pairing information required to commission HomeKit. The value is a structure containing QRCode (the raw pairing QR-code string) and DigitalPairingCode (an 8-digit numeric pairing code). When the device is not bound, reading this payload may activate the HomeKit commissioning window for a period of time (10 minutes by default).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | HomeKitPayloadTraitPresentValueStructure | ✔ | ✘ | ✔ |
BoundEcosystem
Indicates the ecosystems to which the device is bound. The value is a bitmask: bit 0 = Aqara Home, bit 1 = Apple HomeKit, bit 2 = Matter, bit 3 = Aqara Studio, and bits 4–7 are reserved (and must be 0). For example, 0x03 indicates that the device is bound to both Aqara Home and HomeKit.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✘ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
CurrentVoltage
Indicates the currently measured supply voltage. Unit: volts (V).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 500.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.01 | ✔ | ✘ | ✘ |
CircuitCurrent
The current flowing through a specific circuit or part of a circuit, typically used to measure current load.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 10000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.001 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
CumulativeEnergyConsumption
This Trait provides access to and reporting for cumulative energy-consumption data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 1.0E8 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.1 | ✔ | ✘ | ✘ |
CurrentPower
Indicates the current real-time power consumption. Unit: watts (W).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 5000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.1 | ✔ | ✘ | ✘ |
BatReplacementDescription
This Trait must provide a user-facing battery description.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | string32 | ✔ | ✘ | ✔ | |
| Supported Values | list[characterString] | ✔ | ✘ | ✘ |
BatChargeState
Indicates the battery charging state. 0: Unknown; 1: Charging; 2: Full charge; 3: Not charging; 4: Not chargeable.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | BatChargeStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[BatChargeStateEnum8] | ✔ | ✘ | ✘ |
BatReplaceability
This Trait must indicate whether the battery is replaceable.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | BatReplaceabilityEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[BatReplaceabilityEnum8] | ✔ | ✘ | ✘ |
PowerMode
Indicates the device power-supply mode. 0: Unknown; 1: Mains power; 2: Battery; 3: DC power.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | PowerModeEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[PowerModeEnum8] | ✔ | ✘ | ✘ |
BatPercentRemaining
Indicates the percentage of battery capacity remaining.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.1 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
WiredPresent
Indicates whether wired power (a power adapter) is detected.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
Rechargeable
This Trait must indicate whether the battery is rechargeable.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
StateOfLowBat
Indicates whether the battery is in a low-battery state. 0: Normal; 1: Low battery; 2: Critically low.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | StateOfLowBatEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[StateOfLowBatEnum8] | ✔ | ✘ | ✘ |
BatReplacementNeeded
This Trait must indicate whether the battery needs to be replaced.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✘ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
BatQuantity
This Trait must indicate the number of individual battery cells or battery packs in a battery source that can be serviced by the user or factory.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✔ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
LoadSafetyManagement
A safety mechanism that monitors electrical or mechanical loads.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LoadSafetyManagementEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[LoadSafetyManagementEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
VoltageSafetyManagement
A safety mechanism that monitors supply voltage and provides protection during overvoltage or undervoltage conditions.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | VoltageSafetyManagementEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[VoltageSafetyManagementEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
CurrentSafetyManagement
A safety mechanism that monitors device current and triggers protection during overcurrent conditions.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | CurrentSafetyManagementEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[CurrentSafetyManagementEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
OverCurrentResponseSetting
This setting defines the scope of overcurrent protection.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | OverCurrentResponseSettingEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[OverCurrentResponseSettingEnum8] | ✔ | ✘ | ✘ |
TemperatureSafetyManagement
A safety mechanism that monitors device temperature and triggers protective measures when an overtemperature condition occurs.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | TemperatureSafetyManagementEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[TemperatureSafetyManagementEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
RebootCount
The Present Value must indicate, as accurately as possible, the number of times the device has rebooted. It must increment each time the device reboots, but not when the device wakes from a low-power or sleep state. It must reset to 0 only when the device is factory reset.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✘ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
RebootReason
The Present Value indicates the reason for the device's most recent startup.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | RebootReasonEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[RebootReasonEnum8] | ✔ | ✘ | ✘ |
UpTime
The UpTime trait should indicate, as accurately as possible, the time elapsed in seconds since the node was last restarted.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | 0 | ✔ | ✘ | ✔ |
| Max | uint32 | 4.2949673E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint32 | 0 | ✔ | ✔ | ✘ |
NetworkInterfaces
This trait describes the network interfaces supported by the device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list[NetworkInterfacesTraitPresentValueStructure] | ✔ | ✘ | ✔ |
AntiDeletionSetting
Used to configure protection against accidental deletion.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | AntiDeletionSettingEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[AntiDeletionSettingEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
AntiDeletionLevelSetting
The anti-deletion level setting controls permission for reset-network and factory-reset button operations while the device is running, preventing accidental data loss.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | AntiDeletionLevelSettingEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[AntiDeletionLevelSettingEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
ActiveHardwareFaults
Hardware faults.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ActiveHardwareFaultsEnum32 | 255 | ✔ | ✘ | ✔ |
| Supported Values | list[ActiveHardwareFaultsEnum32] | ✔ | ✘ | ✘ | |
| Default Value | uint32 | 255 | ✔ | ✔ | ✘ |
DebugInfo
Debug information generated while the device is running. The data type is a string with a maximum length of 1024 bytes.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✘ | ✘ | ✔ |
FreeMemory
Indicates the device's currently available memory, in kilobytes (KB).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✘ | ✔ | |
| Max | uint32 | 4.2949673E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
AntiDeletionNotification
After AntiDeletion is enabled for a child device on a hub, a notification report is triggered if the child device performs a reset or deletion operation.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | AntiDeletionNotificationEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[AntiDeletionNotificationEnum8] | ✔ | ✘ | ✘ |
RoutingAgingCountThreshold
Configures the aging-count threshold for device packet routing.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 5 | ✔ | ✔ | ✔ |
| Max | uint8 | 20.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 3.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 5 | ✔ | ✔ | ✘ |
PreOperationMode
Indicates the device's previous Zigbee network connection state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | PreOperationModeEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[PreOperationModeEnum8] | ✔ | ✘ | ✘ |
NWKRetransmissionCount
Indicates the number of network-layer retransmissions during packet transmission.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 3 | ✔ | ✔ | ✔ |
| Max | uint8 | 20.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 3.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 3 | ✔ | ✔ | ✘ |
ZigbeeTotalMessageInOneHour
Indicates the total number of Zigbee messages sent in one hour.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✘ | ✔ | |
| Max | uint32 | 4.2949673E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ZigbeeCoordMac
Represents the MAC address of the Zigbee coordinator.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
APSRetransmissionCount
The number of automatic retransmissions attempted by the Zigbee APS layer when a packet acknowledgement is not received.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 3 | ✔ | ✔ | ✔ |
| Max | uint8 | 20.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 3.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 3 | ✔ | ✔ | ✘ |
ZigbeeResentMessageInOneHour
Indicates the number of Zigbee messages retransmitted in one hour.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✘ | ✔ | |
| Max | uint32 | 4.2949673E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
PANID
The Present Value indicates the Zigbee network PAN ID.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✘ | ✔ | |
| Max | uint16 | 65534.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ZigbeeExtendedPANID
A string representing the 64-bit extended identifier of the Zigbee network. Together with the 16-bit PAN ID, it uniquely identifies the network and is typically represented as a 16-character hexadecimal string (for example, “00124B0001234567”).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
ZigbeeGeneralDiagnostics
A general reporting channel for child-device self-diagnostic information.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
MessageTransmissionFailureCountThreshold
Configures the threshold count for failed device packet transmissions.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 10 | ✔ | ✔ | ✔ |
| Max | uint8 | 20.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 3.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 10 | ✔ | ✔ | ✘ |
EnableNWKACK
Toggles the option to enable network-layer acknowledgements during network communication.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
RebootReason
The Present Value indicates the reason for the device's most recent startup.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | RebootReasonEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[RebootReasonEnum8] | ✔ | ✘ | ✘ |
ZigbeeKeySeqNumber
Represents the sequence number of the network key currently used by the Zigbee coordinator and identifies the key version. During Magic Pair network joining, the gateway reports this attribute to the cloud or app. The joining device must obtain and configure this sequence number locally to ensure secure communication using the same network key as the coordinator. The default value is 0.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 0 | ✔ | ✘ | ✔ |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
LQI
Indicates the Thread network Link Quality Indicator (LQI), which reflects RF link quality between Thread devices. Range: 0–255.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✔ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ZigbeeFrameCounter
The Zigbee frame counter is a unique incrementing value attached to each data frame to prevent replay attacks and ensure communication security.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✘ | ✔ | |
| Max | uint32 | 4.2949673E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
Channel
The Present Value indicates the Zigbee network channel number.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✘ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
CCAMode
Indicates the device's CCA state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | CCAModeEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[CCAModeEnum8] | ✔ | ✘ | ✘ |
ZigbeeNextHopMac
Defines the Zigbee MAC address of the next-hop device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
EnableAPSACK
Toggles the option to enable APS acknowledgements during network communication.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
MACRetransmissionCount
Indicates the number of MAC-layer retransmissions during packet transmission.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 3 | ✔ | ✔ | ✔ |
| Max | uint8 | 14.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 3.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 3 | ✔ | ✔ | ✘ |
ZigbeeFailedMessageInOneHour
Indicates the number of Zigbee messages that failed to send in one hour.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✘ | ✔ | |
| Max | uint32 | 4.2949673E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ZigbeeNeighborTableInfo
Provides network-topology information for Zigbee devices.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
CurOperationMode
Indicates the device's current Zigbee network connection state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | CurOperationModeEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[CurOperationModeEnum8] | ✔ | ✘ | ✘ |
ZigbeeAvgSuccessfulResendCount
Indicates the average number of successful Zigbee message retransmissions.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✘ | ✔ | |
| Max | uint32 | 4.2949673E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ZigbeeCoordNetworkKey
Represents the network key of the Zigbee coordinator.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
LanAccessAddress
The IP address assigned to the device by the router on the home local-area network (LAN), usually through DHCP. Other devices on the same network, such as a mobile app or computer, use this address to discover and communicate with it locally with low latency.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
RemoteProxyAccessEnable
Remote proxy access enable switch. This attribute enables or disables the device's ability to be accessed remotely through an Internet cloud proxy. When enabled, authorized users can remotely control the device through a secure cloud tunnel; when disabled, the device can be accessed only on the local-area network (LAN).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
InternetAccessAddress
The public access address assigned to the device by the cloud service platform, typically a domain name or NAT-mapped address. Remote management services use this address to locate and connect to the device; it reflects the device's logical location on the wide-area network (WAN).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
IdentifyType
Specifies how identification is presented to the user. Values: 0 = none, 1 = light, 2 = LED indicator, 3 = audible indication, 4 = display (visible on screen), 5 = actuator (such as curtain or relay operation), 6–255 = reserved.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | IdentifyTypeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[IdentifyTypeEnum8] | ✔ | ✘ | ✘ |
ReverseIdentify
When triggered through a local action on the device, such as a button press or touchscreen interaction, the device signals all connected client tools, such as a mobile app, web app, or desktop application, so they can locate and identify the corresponding device. Users can quickly find the device in the tool by interacting with it physically.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✘ | ✘ | ✔ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
IdentifyTime
Indicates the remaining duration, in seconds, for which the device will continue self-identification. The range is 0 to 10 seconds with a step of 0.1. When the value is 0, the default remaining duration is used.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 10.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.1 | ✔ | ✘ | ✘ |
HomeStationCredentials
Home Station Credentials information.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | HomeStationCredentialsTraitPresentValueStructure | ✔ | ✘ | ✔ |
WiFiChannel
Wi-Fi channel, such as channels 1–14 in the 2.4 GHz band or channels 149, 153, 157, 161, and 165 in the 5 GHz band.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✘ | ✔ | |
| Max | uint16 | 165.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ChildDeviceProvisioningState
Used by the gateway to report the network-commissioning window state for child devices, such as Zigbee or Matter devices. The gateway reports “entered commissioning state” when it opens the network for a type of child device, and “exited commissioning state” when it closes that type of commissioning window. Higher-level applications use this to determine in real time whether the gateway allows a given type of child device to be added, guiding the user or showing commissioning progress.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ChildDeviceProvisioningStateEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[ChildDeviceProvisioningStateEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
ZigbeeDiagnostics
Provides diagnostic information for the Zigbee network, including the radio channel, extended PAN ID, network key, network name, PAN ID, RSSI (when available), and LQI (link quality indicator).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ZigbeeDiagnosticsTraitPresentValueStructure | ✔ | ✘ | ✔ |
ZigbeeAuthRandcode
A random number issued by the cloud when a Zigbee 3.0 device connects to the cloud for authentication.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✘ | ✔ | ✘ |
ZigbeeAuthRandcodeResponse
The Confirm result returned when a Zigbee 3.0 device authenticates with the cloud.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✘ | ✘ | ✔ |
WiFiDiagnostics
Provides diagnostic information for the Wi-Fi network, including the BSSID, encryption type, Wi-Fi version, channel, RSSI, network name, IPv4 address, IPv6 address, subnet mask, gateway, DNS, and backup DNS (available fields vary).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | WiFiDiagnosticsTraitPresentValueStructure | ✔ | ✘ | ✔ |
MagicPairKeychain
Used for the MagicPair network commissioning keychain.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
SupportedNetwork
Indicates the network protocols supported by the device for MagicPair network joining. The value is a bit mask: bit0 = Wi-Fi, bit1 = Thread, bit2 = Ethernet, bit3 = Zigbee, bit4 = BLE, bit5 = BLE Endpoint, bit6 = Wi-Fi Endpoint, and bit7 = Wi-Fi Endpoint of a Limited Home Station. BLE used for pairing is not included.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✘ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
SlaveAddress
The address assigned to the device as a slave on a bus, used for master-slave communication addressing.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 255 | ✔ | ✔ | ✔ |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 255 | ✔ | ✔ | ✘ |
ThreadDiagnostics
Provides diagnostic information for the Thread network, including the channel, extended PAN ID, network key, network name, PAN ID, PSKc, active timestamp, security policy, operational dataset, RSSI, LQI, border agent ID, mesh-local prefix, commissioner credential, OpenThread version, and role (border router, leader, router, end device, sleepy end device, or router-eligible end device).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ThreadDiagnosticsTraitPresentValueStructure | ✔ | ✘ | ✔ |
AuthenticationStatus
Indicates the device authentication status, including whether authentication has passed and whether the certificate is valid.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | AuthenticationStatusEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[AuthenticationStatusEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
WiFiRSSI
A metric of Wi-Fi connection signal strength, measured in dBm, ranging from -100 dBm (very weak) to 0 dBm (strongest).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int8 | ✔ | ✘ | ✔ | |
| Max | int8 | 0.0 | ✔ | ✘ | ✘ |
| Min | int8 | -100.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
CurrentTemperature
Indicates the current temperature.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 26 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | -50.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.01 | ✔ | ✘ | ✘ |
| Default Value | float | 26 | ✔ | ✔ | ✘ |
SetTemperatureLevel
SetTemperatureLevel allows users to adjust the temperature to a preset level. The Supported Values parameter indicates the list of supported levels.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 0 | ✔ | ✔ | ✔ |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Supported Values | list[characterString] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
SetTemperature
SetTemperature allows users to specify and adjust the target temperature of a device or system.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 20 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 20 | ✔ | ✔ | ✘ |
PackageRecognitionReport
Automatically reports an event when a package is delivered, removed, or changes state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | PackageRecognitionReportEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[PackageRecognitionReportEnum8] | ✔ | ✘ | ✘ |
FaceIDReport
A unique identifier associated with a specific face, used for facial recognition or authentication.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint64 | ✘ | ✘ | ✔ | |
| Max | uint64 | 1.8446744E19 | ✔ | ✘ | ✘ |
| Min | uint64 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
HoldTime
Unoccupied-state determination delay.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 1 | ✔ | ✔ | ✔ |
| Min | uint16 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint16 | 1 | ✔ | ✔ | ✘ |
ActivityDetected
Indicates whether any human activity is detected while a space is occupied.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✘ | ✘ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
PresenceConfiguration
Used to configure occupancy and vacancy software-sensor settings.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | PresenceConfigurationTraitPresentValueStructure | ✔ | ✔ | ✔ |
Presence
Presence detects whether a person is in the monitored area.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | PresenceEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[PresenceEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
HumanRecognitionReport
Reports whether a human figure is detected in the defined detection area.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | HumanRecognitionReportEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[HumanRecognitionReportEnum8] | ✔ | ✘ | ✘ |
AirQuality
AirQuality indicates the air-quality level.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | AirQualityEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[AirQualityEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
VOCQuality
Indicates the volatile organic compound (VOC) air-quality level. Values: 0 = unknown, 1 = excellent, 2 = good, 3 = moderate, 4 = poor, 5 = very poor.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | VOCQualityEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[VOCQualityEnum8] | ✔ | ✘ | ✘ |
VOCDensity
This trait is used to access and report VOC concentration data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 1 | ✔ | ✘ | ✔ |
| Max | float | 9999.0 | ✔ | ✘ | ✘ |
| Min | float | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 1 | ✔ | ✔ | ✘ |
AttitudeDetected
This trait is used to access and report posture-detection data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | AttitudeDetectedEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[AttitudeDetectedEnum8] | ✔ | ✘ | ✘ |
TripTime
Indicates the motor travel time, in seconds, required to move from fully open to fully closed, or vice versa. The range is 1 to 300 seconds, with a default of 10 seconds.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 300.0 | ✔ | ✘ | ✘ |
| Min | float | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
TargetPositionPercentage
This trait is used to access and report target position percentage data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
CurrentPositionPercentage
Indicates the actual position as a percentage from 0% to 100%, with a default step of 1%.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
Binding
Binding represents a persistent relationship between an endpoint and one or more other local or remote endpoints.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list[BindingTraitPresentValueStructure] | ✔ | ✔ | ✔ |
SupportedBindingDeviceTypes
Indicates the list of device types to which this controller endpoint can bind.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list | ✔ | ✘ | ✔ |
SupportedBindingFunctions
Indicates the list of functions to which this controller endpoint can bind and control.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list | ✔ | ✘ | ✔ |
Feed
This trait is used to access and report feeding-related data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | FeedEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[FeedEnum8] | ✔ | ✘ | ✘ |
LocalControlDisabled
Describes whether the button disables its associated local device-control function, such as relay control. When disabled, pressing the button cannot turn the local actuator on or off.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
ButtonEvent
This trait is used to access and report button-event data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ButtonEventEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[ButtonEventEnum8] | ✔ | ✘ | ✘ |
OutputSwitchingType
Defines the type of external switch connected to the device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | OutputSwitchingTypeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[OutputSwitchingTypeEnum8] | ✔ | ✘ | ✘ |
OnOff
Writing turns the camera device on or off. Reading indicates the current power state. Values: false = off, true = on.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
OutputInterlockFlag
When the values of two attributes are the same, the states represented by those attributes are interlocked.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 0 | ✔ | ✔ | ✔ |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
OutputNodeMode
Defines the operating mode of the output node.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | OutputNodeModeEnum32 | ✔ | ✔ | ✔ | |
| Supported Values | list[OutputNodeModeEnum32] | ✔ | ✘ | ✘ |
StartUpOnOff
Defines the startup behavior of a set of custom configuration parameters when the device is powered on, such as restoring user-defined settings. It may override the default OnOff behavior.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | StartUpOnOffEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[StartUpOnOffEnum8] | ✔ | ✘ | ✘ |
IRKey
This trait is used to access and report infrared-command data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | IRKeyEnum32 | ✘ | ✔ | ✘ | |
| Supported Values | list[IRKeyEnum32] | ✔ | ✘ | ✘ |
IRType
Defines the device type of the IR remote control.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | IRTypeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[IRTypeEnum8] | ✔ | ✘ | ✘ |
CoolingTemperature
Indicates the cooling temperature.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 26 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 26 | ✔ | ✔ | ✘ |
CurrentHumidity
This trait is used to access and report humidity data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
CurrentTemperature
Indicates the current temperature.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 26 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | -50.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.01 | ✔ | ✘ | ✘ |
| Default Value | float | 26 | ✔ | ✔ | ✘ |
Preset
This trait is used to access and report preset data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list[PresetTraitPresentValueStructure] | ✔ | ✔ | ✔ |
SetBack
Indicates the thermostat temperature setback range.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✔ | ✔ | |
| Max | float | 25.5 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.1 | ✔ | ✘ | ✘ |
PresetTypes
This trait is used to access and report preset-type data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list | ✔ | ✔ | ✔ |
HeaterCoolerMode
This trait is used to access and report heating/cooling mode data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | HeaterCoolerModeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[HeaterCoolerModeEnum8] | ✔ | ✘ | ✘ |
ActivePresetHandle
This trait is used to access and report active preset handle data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | null | ✔ | ✔ | ✔ |
| Default Value | characterString | null | ✔ | ✔ | ✘ |
HeatingTemperature
Indicates the heating temperature.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 18 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 18 | ✔ | ✔ | ✘ |
NumberOfPresets
This trait is used to access and report preset-count data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 0 | ✔ | ✔ | ✔ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
HeaterCoolerButtonEvent
An event triggered by button interaction on a thermostat or climate-control device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | HeaterCoolerButtonEventEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[HeaterCoolerButtonEventEnum8] | ✔ | ✘ | ✘ |
MinHeatCoolDeadBand
Indicates the minimum difference between heating and cooling temperatures in automatic mode.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 2 | ✔ | ✔ | ✔ |
| Max | float | 2.5 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.1 | ✔ | ✘ | ✘ |
| Default Value | float | 2 | ✔ | ✔ | ✘ |
CurrentTemperatureCalibration
Used as a compensation/calibration offset for local temperature readings. Writing a positive or negative value corrects sensor deviation.
Specification mapping: corresponds to Matter LocalTemperatureCalibration; value = temperature in Celsius * 10. The current Function specification source (HeaterCooler) does not yet define an independent Trait ID, so the following parameters are organized according to the master table and mapping convention.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | number | ✔ | ✔ | ✔ |
TemperatureUIDisplayMode
This trait specifies the unit used to display temperature on the thermostat's built-in screen.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | TemperatureUIDisplayModeEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[TemperatureUIDisplayModeEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
AntiFreezeTemperature
The anti-freeze protection temperature setting usually specifies the threshold that triggers the anti-freeze mechanism, for example, 5 °C.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 5 | ✔ | ✔ | ✔ |
| Max | float | 15.0 | ✔ | ✘ | ✘ |
| Min | float | 5.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.5 | ✔ | ✘ | ✘ |
| Default Value | float | 5 | ✔ | ✔ | ✘ |
HeaterCoolerPolarity
Specifies the polarity configuration used to determine whether the system controls cooling or heating.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | HeaterCoolerPolarityEnum8 | 2 | ✔ | ✔ | ✔ |
| Supported Values | list[HeaterCoolerPolarityEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 2 | ✔ | ✔ | ✘ |
TiltAngleDeviation
Indicates the actual change (offset) in Tilt angle during the current movement.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 180.0 | ✔ | ✘ | ✘ |
| Min | float | -180.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.01 | ✔ | ✘ | ✘ |
StationaryState
The Present Value of this trait indicates as an enumeration whether the target is currently stationary. A value of 0 indicates that the target is moving; a value of 1 indicates that it is stationary.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | StationaryStateEnum8 | 1 | ✔ | ✘ | ✔ |
| Supported Values | list[StationaryStateEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 1 | ✔ | ✔ | ✘ |
InitialTiltAngle
Indicates the initial tilt angle established during device calibration, representing the angle between the calibration direction, such as upward, and the positive direction of the nearest axis.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 180.0 | ✔ | ✘ | ✘ |
| Min | float | -180.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.01 | ✔ | ✘ | ✘ |
EventReportInterval
Indicates the interval, in seconds, between consecutive event reports from the device. For example, a value of 60 means that the device reports an event every 60 seconds. This interval determines how often the device sends event data to the gateway or cloud.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | 60 | ✔ | ✔ | ✔ |
| Max | uint32 | 300.0 | ✔ | ✘ | ✘ |
| Min | uint32 | 5.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint32 | 60 | ✔ | ✔ | ✘ |
ObjectOrientationEnable
Enables or disables object-orientation monitoring. When set to True, the device actively monitors and reports object-orientation changes; when set to False, orientation monitoring is disabled.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✔ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
StationaryTiltAngle
Indicates the tilt angle when an object becomes stationary after moving.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 180.0 | ✔ | ✘ | ✘ |
| Min | float | -180.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.01 | ✔ | ✘ | ✘ |
PeakTiltAngle
Indicates the maximum tilt angle recorded between wake-up and becoming stationary.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 180.0 | ✔ | ✘ | ✘ |
| Min | float | -180.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.01 | ✔ | ✘ | ✘ |
ObjectMotionDetectionEnable
Enables or disables object-motion detection. True indicates enabled (object movement will be detected); False indicates disabled.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✔ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
ObjectOrientationState
Indicates the object's current spatial orientation detected by the device. The value is an enumeration representing the object's pose relative to the reference plane. Possible states are:
1 – Horizontal Up (the object faces up, for example, lying flat on a table with its front side up)
2 – Horizontal Down (the object faces down, for example, lying flat on a table with its front side down)
3 – Vertical (the object is upright, for example, perpendicular to the ground)
4 – Tilted (the object is inclined and is neither horizontal nor vertical)
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ObjectOrientationStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[ObjectOrientationStateEnum8] | ✔ | ✘ | ✘ |
VibrationEvent
This trait is used to access and report motion-sensor events.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | VibrationEventEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[VibrationEventEnum8] | ✔ | ✘ | ✘ |
CubeWorkModeSetting
Enables multiple operating-mode settings for Magic Cube devices to improve the user experience and interaction.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | CubeWorkModeSettingEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[CubeWorkModeSettingEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
TopFace
Indicates the face currently pointing upward on the cube controller, used to define the device state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | TopFaceEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[TopFaceEnum8] | ✔ | ✘ | ✘ |
CubeEvent
This trait is used to access and report cube-event data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | CubeEventEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[CubeEventEnum8] | ✔ | ✘ | ✘ |
TopFaceChanged
Indicates that the device's “top face” has changed. Triggered when the user flips the device, such as a cube controller.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | TopFaceChangedEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[TopFaceChangedEnum8] | ✔ | ✘ | ✘ |
HoldRotationInterval
The duration of a hold-to-rotate event, that is, the rotation interval.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✘ | ✘ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
RotationEvent
Describes the knob event type: Rotate, Hold to rotate, or Inverted rotate. Values: 0 = Rotate, 1 = Hold to rotate, 2 = Inverted Rotate.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | RotationEventEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[RotationEventEnum8] | ✔ | ✘ | ✘ |
RotationDirection
Describes the rotation direction. Values: 0 = Clockwise, 1 = Counterclockwise.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | RotationDirectionEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[RotationDirectionEnum8] | ✔ | ✘ | ✘ |
InvertedRotationAngle
The angle of inverted rotation.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✘ | ✘ | ✔ |
| Max | float | 3600.0 | ✔ | ✘ | ✘ |
| Min | float | -3600.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
RotationAngle
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✘ | ✘ | ✔ |
| Max | float | 3600.0 | ✔ | ✘ | ✘ |
| Min | float | -3600.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
RotationInterval
The duration of a rotation event, that is, the rotation interval.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✘ | ✘ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
HoldRotationAngle
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✘ | ✘ | ✔ |
| Max | float | 3600.0 | ✔ | ✘ | ✘ |
| Min | float | -3600.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
BinaryOutputPV
BinaryOutputPV stores the command or actual on/off state of a binary output.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
AnalogInputPV
AnalogInputPV conveys the real-time value of an analog input channel and its engineering metadata.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ |
TargetPlaybackState
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | TargetPlaybackStateEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[TargetPlaybackStateEnum8] | ✔ | ✘ | ✘ |
MediaInformation
Describes media information, such as the title and artist.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
PlaybackDuration
Indicates the playback duration in ms.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 7200000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
CurrentPlaybackState
Describes the current playback state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | CurrentPlaybackStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[CurrentPlaybackStateEnum8] | ✔ | ✘ | ✘ |
PlaybackMode
Describes the current playback mode.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | PlaybackModeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[PlaybackModeEnum8] | ✔ | ✘ | ✘ |
SampledPosition
Indicates or sets the current media playback position. The value is a time offset in milliseconds (ms), from 0 to the total playback duration. When written, the device seeks to this position.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 7200000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
LoginState
Describes the login state of the media service.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
PlaybackSampledPosition
Sets and queries the current playback position.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint64 | ✔ | ✔ | ✔ | |
| Max | uint64 | 4.294967295E9 | ✔ | ✘ | ✘ |
| Min | uint64 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
SelectedMediaOutputSource
Describes the selected media output source.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | SelectedMediaOutputSourceEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[SelectedMediaOutputSourceEnum8] | ✔ | ✘ | ✘ |
SelectedSource
Indicates or sets the currently selected media output source, such as the built-in speaker, Bluetooth, AUX, or HDMI. Values: 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.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | SelectedSourceEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[SelectedSourceEnum8] | ✔ | ✘ | ✘ |
MediaInput
MediaInput provides a list of available input sources and commands for selecting and renaming them.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | enum8 | ✔ | ✔ | ✔ |
FlameDetected
Enables the device to detect open flames or flame characteristics in the monitored area. When a suspected flame is detected, an event is automatically triggered and reported.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | FlameDetectedEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[FlameDetectedEnum8] | ✔ | ✘ | ✘ |
OperationalError
OperationalError indicates that the device or system cannot perform its intended function.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | OperationalErrorEnum16 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[OperationalErrorEnum16] | ✔ | ✘ | ✘ | |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
OperationalState
OperationalState indicates the current functional or operating state of the device, including whether it is active or idle.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | OperationalStateEnum16 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[OperationalStateEnum16] | ✔ | ✘ | ✘ | |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
RefrigeratorAlarm
RefrigeratorAlarm indicates the current refrigerator alarm state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list | ✔ | ✘ | ✔ |
CurrentMode
CurrentMode represents the device’s current operating state or setting; values come from a predefined set of options.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | enum8 | 0 | ✔ | ✘ | ✔ |
| Default Value | enum8 | 0 | ✔ | ✔ | ✘ |
ChangeToModeResponse
ChangeToModeResponse is a response message or status indicating the result of a request to switch the device to a specific mode.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ChangeToModeResponseEnum16 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[ChangeToModeResponseEnum16] | ✔ | ✘ | ✘ | |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
BridgeDeviceID
Represents the DeviceID of the Bridge device connected to this bridged node. String(32).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✔ | ✔ |
MultiStateInputPV
MultiStateInputPV provides the current enumerated state, a human-readable state label, and optional descriptive text.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✘ | ✔ |
PulseDuration
Defines the pulse duration for a pulsed load.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✔ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
LoadType
Describes the type of load connected to the switch. 0: General, 1: Linkable, 2: Pulsed.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LoadTypeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[LoadTypeEnum8] | ✔ | ✘ | ✘ |
ThemeID
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 1 | ✔ | ✘ | ✔ |
| Min | uint16 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint16 | 1 | ✔ | ✔ | ✘ |
Allpages
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list[AllpagesTraitPresentValueStructure] | ✔ | ✔ | ✔ |
MaxPageNum
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 1 | ✔ | ✘ | ✔ |
| Default Value | uint16 | 1 | ✔ | ✔ | ✘ |
ScreenWidth
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 240 | ✔ | ✘ | ✔ |
| Default Value | uint16 | 240 | ✔ | ✔ | ✘ |
DataVersion
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint64 | 0 | ✔ | ✘ | ✔ |
| Default Value | uint64 | 0 | ✔ | ✔ | ✘ |
ThemeVersion
Theme version.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 1 | ✔ | ✘ | ✔ |
| Max | uint16 | 99999.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint16 | 1 | ✔ | ✔ | ✘ |
ScreenHeight
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 240 | ✔ | ✘ | ✔ |
| Default Value | uint16 | 240 | ✔ | ✔ | ✘ |
EnableIndicator
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | tlv | ✔ | ✔ | ✔ |
StartUpOnOff
Defines the startup behavior of a set of custom configuration parameters when the device powers on, such as restoring user-defined settings. It may override the default OnOff behavior.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | StartUpOnOffEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[StartUpOnOffEnum8] | ✔ | ✘ | ✘ |
Condition
Represents the remaining filter life as a percentage.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 100 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 100 | ✔ | ✔ | ✘ |
ChangeIndication
ChangeIndication defines the filter-life status.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ChangeIndicationEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[ChangeIndicationEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
FilterType
FilterType defines the filter type.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | FilterTypeEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[FilterTypeEnum8] | ✔ | ✘ | ✘ |
WindSetting
WindSetting defines the airflow type.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | WindSettingEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[WindSettingEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
AirflowDirection
AirflowDirection defines the airflow direction.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | AirflowDirectionEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[AirflowDirectionEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
FanMode
FanMode defines the fan mode.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | FanModeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[FanModeEnum8] | ✔ | ✘ | ✘ |
FanSpeed
FanSpeed represents the fan speed as a percentage.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✔ | ✔ | |
| Max | uint8 | 100.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
RockSetting
Defines the oscillation mode.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | RockSettingEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[RockSettingEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
HeartRate
Measures heartbeats per minute in real time.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 300.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
CurrentPressure
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 101 | ✔ | ✘ | ✔ |
| Max | float | 200000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 101 | ✔ | ✔ | ✘ |
MultiStateOutputPV
MultiStateOutputPV contains the requested or currently active enumerated output state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✔ | ✔ |
ContactSensorState
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
OpenAngle
Door or window opening angle.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 360.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
Volume
Indicates or sets the camera device speaker volume, such as for two-way audio. The value is typically a percentage (0 to 100) or a device-defined numeric range.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
WaterFreezeDetector
Note:
WaterFreezeDetectoris a Function (water freeze detector) in the specification source, not an independent Trait. This Function contains only theBooleanStateTrait.
Used to detect the risk of freezing in pipes or the environment and report water-freeze-related events when a threshold is reached. The Boolean state is represented by BooleanState.
StepValue
Indicates or sets the step increment, such as for volume adjustment. When written, it defines the amount changed by a single step. Units and ranges vary by device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✔ | ✔ | |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 10.0 | ✔ | ✘ | ✘ |
Mute
Indicates the speaker mute state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
LockOperation
Records and reports a lock operation event when the device is successfully unlocked or locked by any supported method. It provides detailed context for the operation, including its source (such as the Matter ecosystem or a local method), the user identity, and the specific credential used.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LockOperationTraitPresentValueStructure | ✘ | ✘ | ✔ |
LockOperationError
When a door-lock operation fails for any reason, the lock emits a LockOperationError event.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LockOperationErrorTraitPresentValueStructure | ✘ | ✘ | ✔ |
SupportedRemoteFeatures
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✘ |
NumberOfCredentialsSupportedPerUser
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 0 | ✔ | ✘ | ✔ |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
NumberOfTotalUsersSupported
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 0 | ✔ | ✘ | ✔ |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
DoorState
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | DoorStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[DoorStateEnum8] | ✔ | ✘ | ✘ |
NumberOfYearDaySchedulesSupportedPerUser
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 0 | ✔ | ✘ | ✔ |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
LockState
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LockStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[LockStateEnum8] | ✔ | ✘ | ✘ |
EnableRemoteControl
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
NumberOfPINUsersSupported
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 0 | ✔ | ✘ | ✔ |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
LockUserChange
When a door-lock user, schedule, or credential changes, the lock emits a LockUserChange event.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LockUserChangeTraitPresentValueStructure | ✘ | ✘ | ✔ |
RemoteControlWithAuthCode
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✘ | ✔ | ✘ |
DoorLockAlarm
The door lock can send several alarms when critical conditions occur.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | DoorLockAlarmTraitPresentValueStructure | ✘ | ✘ | ✔ |
RemoteUnlock
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
NumberOfRFIDUsersSupported
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 0 | ✔ | ✘ | ✔ |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
NumberOfWeekDaySchedulesSupportedPerUser
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 0 | ✔ | ✘ | ✔ |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
CO2Level
Indicates the carbon dioxide concentration level using a qualitative index. Values: 0 = Excellent (normal/low CO2), 1 = Light Pollution (slightly elevated CO2), 2 = Heavy Pollution (high CO2 concentration).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | CO2LevelEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[CO2LevelEnum8] | ✔ | ✘ | ✘ |
CO2Density
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 9999.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
VacuumOperationalError
VacuumOperationalError indicates the specific error type encountered when the device or system cannot perform its intended function.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | VacuumOperationalErrorEnum16 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[VacuumOperationalErrorEnum16] | ✔ | ✘ | ✘ | |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
VacuumOperationalState
VacuumOperationalState indicates the current operating state or mode of the vacuum device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | VacuumOperationalStateEnum16 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[VacuumOperationalStateEnum16] | ✔ | ✘ | ✘ | |
| Default Value | uint16 | 0 | ✔ | ✔ | ✘ |
CurrentValveState
CurrentValveState represents the valve’s current operating state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | CurrentValveStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[CurrentValveStateEnum8] | ✔ | ✘ | ✘ |
DefaultOpenDuration
DefaultOpenDuration represents the default duration, in seconds, that the valve remains open when the OpenDuration field is not specified.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 1 | ✔ | ✔ | ✔ |
| Max | float | 100000.0 | ✔ | ✘ | ✘ |
| Min | float | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 1 | ✔ | ✔ | ✘ |
RemainingDuration
RemainingDuration indicates the time remaining before the valve automatically closes.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✔ | ✔ |
| Max | float | 100000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
| Is Null | boolean | False | ✔ | ✔ | ✔ |
ScreenBrightness
Controls the screen brightness level, with values from 1% to 100%.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
SamplingInterval
Defines the data sampling interval.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 5 | ✔ | ✔ | ✔ |
| Max | float | 3600.0 | ✔ | ✘ | ✘ |
| Min | float | 0.5 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.1 | ✔ | ✘ | ✘ |
| Default Value | float | 5 | ✔ | ✔ | ✘ |
CurrentIlluminance
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✘ | ✔ |
| Max | float | 100000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
CameraActiveStatus
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
CameraRTSPURL
Indicates the camera RTSP (Real Time Streaming Protocol) URL for accessing the live video stream through RTSP. This property returns a JSON object whose keys are resolution identifiers, such as "360p", "720p", "1080p", and "4mp", and whose values are the corresponding complete RTSP URL strings. Example: {"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"}
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
P2PCaptureStatus
P2P animated snapshot status switch.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
CameraRTSPEnable
Indicates the camera RTSP (Real Time Streaming Protocol) enable-switch configuration. When enabled, the live video stream can be accessed through RTSP; when disabled, RTSP access is blocked.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
P2PCaptureEnabled
Indicates whether the camera has P2P (peer-to-peer) snapshot capture enabled.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✘ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
CurrentSensitivityLevel
Indicates the currently selected general-configuration sensitivity level.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✔ | ✔ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
GasDensity
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
SelfCheck
Enables self-checks to verify that device functions are operating normally.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
Mute
Indicates the speaker mute state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
GasDetected
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
GestureRecognitionReport
Enables the device to recognize specific user gestures through visual sensors. When a predefined gesture is detected, the corresponding gesture event is automatically reported.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | GestureRecognitionReportEnum16 | ✘ | ✘ | ✔ | |
| Supported Values | list[GestureRecognitionReportEnum16] | ✔ | ✘ | ✘ |
BreathingMonitoring
Note:
BreathingMonitoringis a Function (breathing monitoring) in the specification source, not an independent Trait. This Function contains only theBreathingRateTrait.
Uses sensors to continuously or periodically measure the user’s breathing rate and pattern for health monitoring. See BreathingRate for the real-time breathing rate.
BreathingRate
Measures breaths per minute in real time.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 60.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
CharStringValuePV
Indicates the current value of the CharacterString Value Object.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✔ | ✔ |
SweeperState
This Trait provides access to and reporting for the associated data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | SweeperStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[SweeperStateEnum8] | ✔ | ✘ | ✘ |
EvseSupplyState
EvseSupplyState represents the current power supply state of the electric vehicle supply equipment (EVSE).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | EvseSupplyStateEnum32 | ✔ | ✘ | ✔ | |
| Supported Values | list[EvseSupplyStateEnum32] | ✔ | ✘ | ✘ |
MinChargeCurrent
MinChargeCurrent indicates the minimum current level at which the electric vehicle can charge.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 10000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.001 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
EvseState
EVSEState represents the current state of the electric vehicle supply equipment (EVSE).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | EvseStateEnum32 | ✔ | ✘ | ✔ | |
| Supported Values | list[EvseStateEnum32] | ✔ | ✘ | ✘ |
ChargingEnabledUntil
ChargingEnabledUntil indicates the time until which charging of the electric vehicle (EV) or device is allowed.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 6 | ✔ | ✘ | ✔ |
| Max | float | 10000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.001 | ✔ | ✘ | ✘ |
| Default Value | float | 6 | ✔ | ✔ | ✘ |
| Is Null | boolean | False | ✔ | ✘ | ✔ |
BatteryCapacity
BatteryCapacity is the total electrical energy that a battery can store, typically measured in kilowatt-hours.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 10000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.001 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
VehicleID
VehicleID is the unique identifier assigned to each electric vehicle (EV).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | string32 | ✔ | ✘ | ✔ |
EvseFaultState
EvseFaultState represents the current fault state of the electric vehicle supply equipment (EVSE).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | EvseFaultStateEnum32 | ✔ | ✘ | ✔ | |
| Supported Values | list[EvseFaultStateEnum32] | ✔ | ✘ | ✘ |
BatPercentRemaining
Indicates the remaining battery percentage.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.1 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
MaxChargeCurrent
MaxChargeCurrent indicates the maximum current level at which the electric vehicle can charge.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 10000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.001 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
CurrentFlow
CurrentFlow represents the current flow value in m³/h.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 65535.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.01 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
ExpressedState
ExpressedState defines the alarm state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ExpressedStateEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[ExpressedStateEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
CODetected
Indicates whether a carbon monoxide leak has been detected.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✘ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
BuiltInEffects
This Trait contains a list of all built-in effects supported by the device. Each item includes an EffectID (0x00-0x7F) and a BuiltInEffectLabelID.
An empty list indicates that there are currently no built-in effects; a null value indicates that this information is currently unavailable.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list[BuiltInEffectsTraitPresentValueStructure] | ✔ | ✘ | ✔ | |
| Is Null | boolean | False | ✔ | ✘ | ✔ |
MaxUserDefinedEffects
This Trait indicates the maximum number of user-defined effects supported by the device.
When the number of effects reaches the limit, attempts to add a user-defined effect should return a capacity-related error.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✔ | |
| Max | uint8 | 32.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
CurrentEffectID
This Trait indicates the EffectID of the currently active effect; a null value indicates that no effect is currently active.
This value can be used to highlight the active effect in the user interface and as context for subsequent query, switch, or stop operations.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✔ | |
| Is Null | boolean | False | ✔ | ✘ | ✔ |
EffectInfo
This Trait provides a list of effect information. Each item includes an EffectID, EffectData, and EffectName for maintaining, displaying, and synchronizing effect details.
This Trait is maintained in the cloud and is not reported by the device.
The encoding of EffectData should remain consistent with the effect write and preview commands so that clients can display, back up, or reuse it directly after reading it.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list[EffectInfoTraitPresentValueStructure] | ✔ | ✘ | ✔ |
MaxEffectNameLength
Indicates the maximum allowed byte length of the EffectName field in user-defined scenes for a window-covering device. This device-specific value ranges from 1 to 32.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✔ | |
| Max | uint8 | 32.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
UserDefinedEffects
This Trait contains a list of all user-defined effects currently stored on the device. Each item includes an EffectID (0x80-0xFE) and an EffectName.
An empty list indicates that there are currently no user-defined effects; a null value indicates that this information is currently unavailable, for example while the device is initializing or the data cannot yet be read.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | list[UserDefinedEffectsTraitPresentValueStructure] | ✔ | ✘ | ✔ |
OnTransitionTime
This Trait indicates the brightness transition duration when the On/Off Cluster on the same endpoint receives an On command.
The device should gradually transition CurrentLevel from the minimum brightness allowed by the device to the maximum brightness during this duration.
This value is measured in 0.1 s (one-tenth of a second). For example, a value of 10 represents a 1.0 s turn-on transition duration.
When this Trait is not implemented or Present Value is null, the device should fall back to the OnOffTransitionTime configuration.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int32 | 0 | ✔ | ✔ | ✔ |
| Max | int32 | 4.294967295E9 | ✔ | ✘ | ✘ |
| Min | int32 | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | int32 | 0 | ✔ | ✔ | ✘ |
CurrentLevel
This Trait represents the current brightness level and is the core state value of Level Control.
On the Matter side (lighting devices), levels typically range from 1 to 254. Aqara uses percentage semantics, with example mappings of 1% ≈ 1, 50% ≈ 127, and 100% ≈ 254.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
| Maximum Actual Value | float | ✔ | ✘ | ✘ | |
| Minimum Actual Value | float | ✔ | ✘ | ✘ |
OffTransitionTime
This Trait indicates the brightness transition duration when the On/Off Cluster on the same endpoint receives an Off command.
The device must gradually transition CurrentLevel from maximum brightness to the minimum brightness allowed by the device during this period (typically corresponding to the lights-off state).
This value is in units of 0.1 s (one tenth of a second). For example, a value of 10 represents a lights-off transition duration of 1.0 s.
When this Trait is not implemented or Present Value is null, the device must fall back to the OnOffTransitionTime configuration.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int32 | 0 | ✔ | ✔ | ✔ |
| Max | int32 | 4.294967295E9 | ✔ | ✘ | ✘ |
| Min | int32 | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | int32 | 0 | ✔ | ✔ | ✘ |
CurrentY
This Trait represents the y component of the CIE 1931 chromaticity coordinates.
The relationship is y = CurrentY / 65536, and the valid range of CurrentY is 0–65279.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✔ | ✔ | |
| Max | uint16 | 65279.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ColorMode
The ColorMode trait represents the color space currently used by a lighting device—the color encoding format or coordinate system the device uses to receive and report color data. It supports reading and reporting but not writing. It supports four values: Hue, XY, color temperature, and RGB. Hue describes color using hue, typically with saturation and brightness, and is suitable for intuitive color selection. XY provides an accurate, device-independent color description based on CIE 1931 chromaticity coordinates and is suitable for professional color management. Color temperature describes white light using a color-temperature value (in mireds, 1000000 / color temperature in Kelvin) to adjust its warmth or coolness. RGB describes colored light using red, green, and blue components, the most common full-color control method. ColorMode and LightingModeSetting are traits at different levels: LightingModeSetting determines the set of functions supported by the device (such as color-temperature or color support), which affects which data-model points are exposed, while ColorMode only determines the encoding format of current color data. They are independent but jointly affect the device's color-control behavior. In particular, when a light is a child device bridged through a gateway, the gateway automatically identifies its supported color spaces and updates its data model. Therefore, when an external system (such as an app or AI controller) controls a light's color, it should determine which color-control commands to send based on the traits and commands in the device data model (for example, whether color-temperature, RGB, or XY control commands are present). The gateway automatically adapts the color space and ultimately controls the child device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ColorModeEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[ColorModeEnum8] | ✔ | ✘ | ✘ |
WhitePointXY
Defines the X and Y coordinates of the white point in the CIE 1931 chromaticity space, used to describe the device white-point reference.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | WhitePointXYPresentValueStructure | ✔ | ✘ | ✔ |
ColorTemperature
This Trait is used to access and report the color-temperature value.
Implementations commonly convert between Kelvin and mireds: Mired = 1000000 / Kelvin.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | 270 | ✔ | ✔ | ✔ |
| Max | uint32 | 370.0 | ✔ | ✘ | ✘ |
| Min | uint32 | 153.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint32 | 270 | ✔ | ✔ | ✘ |
LEDICQuantity
Indicates the number of dimming-driver ICs.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✔ | ✔ | |
| Max | uint16 | 65535.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ColorRGB
ColorRGB represents an RGB color value in the RGB color space.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | 0 | ✔ | ✔ | ✔ |
| Max | uint32 | 1.6777215E7 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint32 | 0 | ✔ | ✔ | ✘ |
ColorXY
ColorXY represents x and y in the CIE 1931 color space.
The mapping is: the first two bytes correspond to CurrentX, and the last two bytes correspond to CurrentY; x = CurrentX / 65536 and y = CurrentY / 65536.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | 0 | ✔ | ✔ | ✔ |
| Max | uint32 | 4.2949673E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint32 | 0 | ✔ | ✔ | ✘ |
Hue
Contains the current hue value of the light source, in degrees (0–360).
The conversion to and from Matter CurrentHue is Hue(deg) = CurrentHue * 360 / 254.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✔ | ✔ | |
| Max | float | 360.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
StartUpXYColor
ColorXY represents x and y values in the CIE xyY color space and contains ColorX and ColorY elements, where x = ColorX / 65535 and y = ColorY / 65535.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | StartUpXYColorTraitPresentValueStructure | 0 | ✔ | ✔ | ✔ |
| Max | uint32 | 4.2949673E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | StartUpXYColorTraitPresentValueStructure | 0 | ✔ | ✔ | ✘ |
LightingMusicSyncMode
Determines how lighting responds to music when enabled, such as with random effects, breathing transitions, flowing rainbows, or water ripples.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LightingMusicSyncModeEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[LightingMusicSyncModeEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
StartUpColorTemperature
Sets the default color temperature applied when the device powers on and the light is on.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | 270 | ✔ | ✔ | ✔ |
| Max | uint32 | 370.0 | ✔ | ✘ | ✘ |
| Min | uint32 | 153.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint32 | 270 | ✔ | ✔ | ✘ |
LightingDynamicSceneMode
Supports dynamic lighting effects such as flowing rainbows, breathing fades, and flashing, and provides preset scenes such as “Forward Rainbow” and “Waterfall” for rich visual experiences.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LightingDynamicSceneModeEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[LightingDynamicSceneModeEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
Saturation
Contains the current saturation of the light source.
The conversion to and from Matter CurrentSaturation is Saturation(0~1) = CurrentSaturation / 254; it can be displayed as 0–100% in Aqara's percentage view.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
CurrentG
This Trait is used to access and report green-value data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int32 | ✔ | ✔ | ✔ | |
| Max | int32 | 255.0 | ✔ | ✘ | ✘ |
| Min | int32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
CurrentB
This Trait is used to access and report blue-value data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int32 | ✔ | ✔ | ✔ | |
| Max | int32 | 255.0 | ✔ | ✘ | ✘ |
| Min | int32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
LightingMusicSyncEnable
Synchronizes lighting color and brightness with the rhythm of music for dynamic audiovisual effects.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
CurrentX
This Trait represents the x component of the CIE 1931 chromaticity coordinates.
The relationship is x = CurrentX / 65536, and the valid range of CurrentX is 0–65279.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | ✔ | ✔ | ✔ | |
| Max | uint16 | 65279.0 | ✔ | ✘ | ✘ |
| Min | uint16 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ColorPointRGBXY
Defines the coordinate points of the RGB primaries in the CIE 1931 chromaticity space (each of R/G/B includes X and Y), used to describe the boundaries of the device color gamut.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ColorPointRGBXYPresentValueStructure | ✔ | ✘ | ✔ |
LEDICProtocol
Indicates the LED IC protocol.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LEDICProtocolEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[LEDICProtocolEnum8] | ✔ | ✘ | ✘ |
LEDType
Indicates the LED package type.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LEDTypeEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[LEDTypeEnum8] | ✔ | ✘ | ✘ |
CurrentR
This Trait is used to access and report red-value data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int32 | ✔ | ✔ | ✔ | |
| Max | int32 | 255.0 | ✔ | ✘ | ✘ |
| Min | int32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
MotorSpeedPercentage
Defines the motor operating-speed percentage, ranging from 1 (lowest speed) to 100 (highest speed).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
WindowCoveringCategory
Reported by curtain-type devices to classify window-covering devices into broad categories.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | WindowCoveringCategoryEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[WindowCoveringCategoryEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
WindowCoveringMotorsBinding
Indicates whether multiple motors in a curtain-type device are logically bound for unified control. Values: false = independent control; true = unified master control.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
UnconfiguredTravelControlPermission
Indicates whether control is allowed when the curtain motor device travel is not configured.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✘ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
LimitPointSetting
Used to configure curtain motor limit points, specifically the fully open or fully closed limit position.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | LimitPointSettingEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[LimitPointSettingEnum8] | ✔ | ✘ | ✘ |
ObstacleLimitMarkingBlockTime
The duration, in seconds, for which the obstacle limit-marking function is disabled.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 255 | ✔ | ✔ | ✔ |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 10.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 255 | ✔ | ✔ | ✘ |
MotorSpeedSetting
Defines the motor operating-speed level, ranging from 1 (lowest speed) to 2 (highest speed).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | MotorSpeedSettingEnum8 | 1 | ✔ | ✔ | ✔ |
| Supported Values | list[MotorSpeedSettingEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 1 | ✔ | ✔ | ✘ |
ManualPullStartStopEnabled
Enables users to manually start or stop curtain/window-covering movement by pulling.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✔ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
CurrentRotationAngle
Present Value indicates the current rotation angle of the window-covering device, ranging from -90 to 90 degrees.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 90.0 | ✔ | ✘ | ✘ |
| Min | float | -90.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ObstacleLimitSensitivity
The sensitivity setting when a curtain motor encounters an obstacle.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ObstacleLimitSensitivityEnum8 | 2 | ✔ | ✔ | ✔ |
| Supported Values | list[ObstacleLimitSensitivityEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 2 | ✔ | ✔ | ✘ |
TripTime
Indicates the motor travel time—the time in seconds required to move from fully open to fully closed, or vice versa. The range is 1 to 300 seconds, with a default of 10 seconds.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 300.0 | ✔ | ✘ | ✘ |
| Min | float | 1.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
TravelConfigured
Indicates whether the curtain motor travel (movement range) has been configured.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✘ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
CurrentPositionPercentage
Identifies the actual position as a percentage from 0% to 100%, with a default step of 1%.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
MotorControllability
Indicates whether the motor is currently controllable.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
MotorDirectionReversed
Specifies whether the motor operating direction is reversed, affecting how the window covering opens and closes.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
WindowCoveringType
Identifies the window-covering product type, such as roller shades, Venetian blinds, or curtains. The value is an enumeration defined in the supported-values list (0 = Roller Shade, 1 = Venetian Blind, …, 255 = Unknown).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | WindowCoveringTypeEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[WindowCoveringTypeEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
ObstacleLimitAutoReboundEnable
When enabled, the curtain motor reverses direction upon encountering an obstacle to prevent damage.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✔ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
ManualPullEvent
Tracks or emits events triggered by manual pull interactions with a window-covering device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ManualPullEventEnum32 | ✘ | ✘ | ✔ | |
| Supported Values | list[ManualPullEventEnum32] | ✔ | ✘ | ✘ |
TargetPositionPercentage
This Trait is used to access and report target-position percentage data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
TargetRotationAngle
Present Value specifies the target rotation angle of the window-covering device, ranging from -90 to 90 degrees.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✔ | ✔ | |
| Max | float | 90.0 | ✔ | ✘ | ✘ |
| Min | float | -90.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
WindowCoveringOpenOrientation
Identifies the actual window-covering opening direction for automatic control.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | WindowCoveringOpenOrientationEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[WindowCoveringOpenOrientationEnum8] | ✔ | ✘ | ✘ |
MotorOperationStatus
Indicates the motor's current operating state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | MotorOperationStatusEnum8 | 2 | ✔ | ✘ | ✔ |
| Supported Values | list[MotorOperationStatusEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 2 | ✔ | ✔ | ✘ |
ManualPullStartEnabled
Enables users to manually start curtain/window-covering movement by pulling.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✔ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
LimitPointCount
Represents the number of limit points (or travel limits) configured for the curtain-type motor.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | 0 | ✔ | ✘ | ✔ |
| Max | uint8 | 2.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
TargetPositionRotationPercentage
The Present Value of the TargetPositionRotationPercentage trait represents, as a percentage in 1% units, the target tilt position the window-covering device will reach or is moving toward.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
CurrentPositionRotationPercentage
The Present Value of the CurrentPositionRotationPercentage trait represents the actual tilt/rotation position as a percentage, ranging from 0% to 100% with a default step of 1%.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
ManualPullStopEnabled
Enables users to manually stop curtain/window-covering movement by pulling.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✔ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
ObstacleLimitMarkingEnable
Enables or disables marking a limit point (open or closed) when the motor encounters an obstacle.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✔ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
ManualPullAdaptiveSpeedEnabled
Allows adaptive speed adjustment during manual pulling, providing pull-force-based variable-speed response.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
HoldTime
Unoccupied determination delay.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint16 | 1 | ✔ | ✔ | ✔ |
| Min | uint16 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint16 | 1 | ✔ | ✔ | ✘ |
DurationOccupiedWithinOneWeek
Represents the total time, in milliseconds, that an occupancy sensor detects occupancy within a calendar week beginning Monday at 00:00:00.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 6.048E8 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
Occupancy
This Trait is used to access and report presence-status data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
DurationOccupiedWithinOneDay
Represents the total time, in milliseconds, that an occupancy sensor detects occupancy within one day.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✘ | ✔ | |
| Max | float | 8.64E7 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
OccupancySensorType
Specifies the occupancy-sensor type, such as PIR, ultrasonic, radar, or vision.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | OccupancySensorTypeEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[OccupancySensorTypeEnum8] | ✔ | ✘ | ✘ |
BooleanState
BooleanState describes how Boolean values are used in the device context, possibly in a smart-home system, to represent status information.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✘ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
ExpressedState
ExpressedState defines the state of an alarm device.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | ExpressedStateEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[ExpressedStateEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
FireProductIdentification
This Trait is used to access and report fire identification-code data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
SmokeDensitydB
This Trait is used to access and report smoke-density dB data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 10.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.001 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
SmokeChamberContamination
Indicates the contamination state of the smoke chamber. This Trait uses an enumeration to represent contamination levels caused by dust or particulate buildup obstructing the optical path. A nonzero value indicates maintenance is required, and higher values may indicate more severe contamination.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | SmokeChamberContaminationEnum8 | 0 | ✔ | ✘ | ✔ |
| Supported Values | list[SmokeChamberContaminationEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
AlarmError
This Trait is used to access and report alarm-error data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | AlarmErrorEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[AlarmErrorEnum8] | ✔ | ✘ | ✘ |
SelfCheck
Facilitates self-checks to verify that device functions operate correctly.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✔ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
SmokeState
This Trait is used to access and report smoke-state data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | SmokeStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[SmokeStateEnum8] | ✔ | ✘ | ✘ |
AlarmsEnabled
This Trait is used to access and report alarm-enable data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
ContaminationState
This Trait is used to access and report alarm-device contamination data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
Mute
Indicates the speaker mute state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
SmokeDensity
This Trait is used to access and report smoke-density data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 5.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 0.001 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
SmokeDetected
This Trait is used to access and report smoke-detection status data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
EnableHeartbeatIndicator
This Trait is used to access and report heartbeat-indicator control data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 1 | ✔ | ✔ | ✔ |
| Default Value | boolean | 1 | ✔ | ✔ | ✘ |
FreshAirMode
This trait defines the fresh-air mode.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | FreshAirModeEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[FreshAirModeEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
AnalogOutputPV
AnalogOutputPV carries the commanded or actual value of an analog-output object.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | ✔ | ✔ | ✔ |
MotionDetected
This Trait is used to access and report motion-detection data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | MotionDetectedEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[MotionDetectedEnum8] | ✔ | ✘ | ✘ |
PetRecognitionReport
Enables smart devices to accurately identify pet types. When a cat, dog, or both are detected, the specific type is reported automatically.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | PetRecognitionReportEnum16 | ✘ | ✘ | ✔ | |
| Supported Values | list[PetRecognitionReportEnum16] | ✔ | ✘ | ✘ |
PM1.0Density
This Trait is used to access and report PM1.0-density data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 65535.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
PM2.5Density
This Trait is used to access and report PM2.5-density data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 1000.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
PM2.5Level
This Trait is used to access and report PM2.5-level data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | PM2.5LevelEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[PM2.5LevelEnum8] | ✔ | ✘ | ✘ |
PM10Density
This Trait is used to access and report PM10-density data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 65535.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
AnomalySoundDetected
This function enables the device to intelligently identify anomalous sounds in its environment. For example, when an event matching the characteristics of a baby crying is detected, a crying event is reported.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | AnomalySoundDetectedEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[AnomalySoundDetectedEnum8] | ✔ | ✘ | ✘ |
RingtonePlayVolume
Indicates the volume level for playing a ringtone or music. The range is 0 (muted) to 100 (maximum volume).
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 50 | ✔ | ✔ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 50 | ✔ | ✔ | ✘ |
RingtonePlayIndex
Indicates the index of the ringtone or music to play. This trait allows a specific audio track to be selected from a predefined list, with each index corresponding to a unique ringtone or music identifier. The value is an enumeration mapped to an audio file.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | RingtonePlayIndexEnum32 | ✔ | ✔ | ✔ | |
| Supported Values | list[RingtonePlayIndexEnum32] | ✔ | ✘ | ✘ |
RingtonePlayStatus
Indicates the current playback state of a ringtone or music. A value of 0 typically indicates stopped or idle, and 1 indicates playing. It allows querying and controlling whether audio is currently playing.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | RingtonePlayStatusEnum8 | 0 | ✔ | ✔ | ✔ |
| Supported Values | list[RingtonePlayStatusEnum8] | ✔ | ✘ | ✘ | |
| Default Value | uint8 | 0 | ✔ | ✔ | ✘ |
RingtonePlayDuration
Indicates the playback duration of a ringtone or music. The value represents the playback time in seconds. A value of 0 means play once; a value greater than 0 means play for the specified number of seconds.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | 0 | ✔ | ✔ | ✔ |
| Max | uint32 | 4.294967295E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint32 | 0 | ✔ | ✔ | ✘ |
BridgedNodeList
Represents the list of bridged-node Device IDs added to this Bridge Node. It is an array of strings.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
SupportedHubCapability
This attribute reports, as a bitmask, the core capabilities of the gateway as a smart-home hub. Each bit represents a specific capability, such as local automation, data storage, or AI support. Higher-level applications use it to discover and adapt to advanced device features for differentiated experiences.
bit 0: Supports basic gateway functions, including creating gateway clusters.
bit 1: Includes the local automation module ha_driven.
bit 2: Supports gateway local data storage (NAS).
bit 3: Supports SaaS.
bit 4: Supports local AI.
bit 5: Supports LAN app control.
bit 6: Supports running Aqara Studio.
bit 7: Supports Aqara Studio logic blocks.
bits 8–31: Reserved.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | ✔ | ✘ | ✔ | |
| Max | uint32 | 4.294967295E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
MatterBridgeSupported
Indicates whether the current gateway version supports Matter Bridge. If true, the app can show the “Start Matter Journey” entry and the “Bind Matter” option in device details; if false, these entries are hidden. Values: false = unsupported; true = supported.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
MatterDACState
Indicates the readiness state of the Matter Device Attestation Certificate (DAC). 0: retrieving the DAC; 1: DAC retrieval failed; 2: DAC ready.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | MatterDACStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[MatterDACStateEnum8] | ✔ | ✘ | ✘ |
MatterOnboardingPayload
Provides the commissioning information required for Matter. The value is a JSON object containing an onboarding-payload string and a manual pairing code. Example: {"onboarding_payload":"MT:AR7A0OEP01C26Y2SQ10","manual_pairing_code":"0118-064-9202"}.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
MatterManufacturerList
Provides a list of Matter ecosystems (fabrics) to which the device is bound. The value is a JSON array; each object contains vendor_id (a decimal integer), Manufacturer (a display-name string), fabric (a shared trust-domain identifier), and node_id (a device-identifier string). Example format: {"list":[{"vendor_id":24582,"Manufacturer":"Google","fabric":"10001","node_id":"10001"}, ...]}.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
MatterBindState
Indicates the device's Matter binding state. 0: not bound to any Matter ecosystem; 1: successfully bound to at least one Matter ecosystem.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | MatterBindStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[MatterBindStateEnum8] | ✔ | ✘ | ✘ |
MatterPairingState
Indicates the current Matter pairing state or error reason. Possible values: 0x00 = not in pairing mode; 0x01 = standard pairing mode active; 0x02 = device binding limit exceeded (maximum 10), remove some ecosystems and try again; 0x03 = device certificate invalid, try again later; 0x04 = preparing, try again later.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | MatterPairingStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[MatterPairingStateEnum8] | ✔ | ✘ | ✘ |
MatterPairingSwitch
Writing true starts Matter pairing mode on the bridge; if not completed, pairing mode exits automatically after 10 minutes. Writing false immediately disables pairing. Reading indicates whether pairing mode is currently active. Values: true = enter pairing; false = turn off/disable pairing.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✔ | ✔ |
TargetGarageDoorState
This Trait is used to access and report target garage-door-state data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | TargetGarageDoorStateEnum8 | ✔ | ✔ | ✔ | |
| Supported Values | list[TargetGarageDoorStateEnum8] | ✔ | ✘ | ✘ |
CurrentGarageDoorState
Describes the current garage-door state. Values: 1 = Unknown, 2 = Open, 3 = Closed, 4 = Opening, 5 = Closing, 6 = Not Fully Open, 7 = Not Fully Closed.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | CurrentGarageDoorStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[CurrentGarageDoorStateEnum8] | ✔ | ✘ | ✘ |
SleepQuality
Defines sleep quality, with a range of 0 to 100.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | float | 0 | ✔ | ✘ | ✔ |
| Max | float | 100.0 | ✔ | ✘ | ✘ |
| Min | float | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | float | 0 | ✔ | ✔ | ✘ |
SleepStage
Defines the sleep stage.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | SleepStageEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[SleepStageEnum8] | ✔ | ✘ | ✘ |
SleepState
This Trait is used to access and report sleep-state data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | SleepStateEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[SleepStateEnum8] | ✔ | ✘ | ✘ |
OnBed
Defines the in-bed state.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
BinaryInputPV
BinaryInputPV reports the instantaneous logical state of a discrete input and can optionally describe polarity inversion.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | 0 | ✔ | ✘ | ✔ |
| Default Value | boolean | 0 | ✔ | ✔ | ✘ |
LeakState
This Trait is used to access and report leak-state data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
VehicleDetected
Enables the device to identify vehicles in the monitored area. When a vehicle is observed entering, moving, or parking, a vehicle-detection event is reported automatically.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | VehicleDetectedEnum8 | ✘ | ✘ | ✔ | |
| Supported Values | list[VehicleDetectedEnum8] | ✔ | ✘ | ✘ |
BSSID
BSSID indicates the BSSID of the Wi-Fi network to which the node is currently connected.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | characterString | ✔ | ✘ | ✔ |
IRBrand
Indicates the brand identifier of an infrared device, such as an air conditioner or television.
The corresponding Trait code in the specification source is IRBrandId.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint32 | 0 | ✔ | ✔ | ✔ |
| Max | uint32 | 4.294967295E9 | ✔ | ✘ | ✘ |
| Min | uint32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
| Default Value | uint32 | 0 | ✔ | ✔ | ✘ |
MinPINCodeLength
This Trait is used to access and report minimum PIN-code-length data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✔ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
MinRFIDCodeLength
This Trait is used to access and report minimum RFID-code-length data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint8 | ✔ | ✘ | ✔ | |
| Max | uint8 | 255.0 | ✔ | ✘ | ✘ |
| Min | uint8 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
OperatingMode
This Trait is used to access and report operating-mode data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | OperatingModeEnum8 | ✔ | ✘ | ✔ | |
| Supported Values | list[OperatingModeEnum8] | ✔ | ✘ | ✘ |
ActuatorEnabled
This Trait is used to access and report actuator-enable data.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | boolean | ✔ | ✘ | ✔ |
ExtendedPANID
Present Value is a 64-bit unique identifier used to identify a personal area network (PAN) in a Thread network. It is used with PANID to distinguish different networks. Each network has a unique ExtendedPANID, and all nodes joining that network must use the same ExtendedPANID to communicate with one another.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | uint64 | ✔ | ✘ | ✔ | |
| Max | uint64 | 1.8446744073709552E19 | ✔ | ✘ | ✘ |
| Min | uint64 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |
ModeCount
Describes the number of modes supported by the device. Format: int.
Parameters
| Name | Type | Default | Readable | Writable | Reportable |
|---|---|---|---|---|---|
| Present Value | int32 | ✔ | ✘ | ✔ | |
| Max | int32 | 4.294967295E9 | ✔ | ✘ | ✘ |
| Min | int32 | 0.0 | ✔ | ✘ | ✘ |
| Step | uint32 | 1.0 | ✔ | ✘ | ✘ |