Skip to main content

Trait Codes

The following table lists all trait codes supported by Aqara:

trait_codetrait_name
CODetectedCarbon Monoxide Detection Status
ExpressedStateAlarm State
WindSettingWind Type
AirflowDirectionAirflow Direction
FanSpeedFan Speed
AirQualityAir Quality Level
BooleanStateBoolean State
FreshAirModeFresh Air Mode
InvertedRotationAngleInverted Rotation Angle
ScreenBrightnessScreen Brightness
TemperatureUIDisplayModeTemperature UI Display Mode
BatReplacementNeededBattery Replacement Needed
BatQuantityBattery Quantity
RechargeableRechargeable
CircuitCurrentCircuit Current
P2PCaptureEnabledP2P Capture Supported
MotorOperationStatusMotor Operation Status
MotorDirectionReversedMotor Direction Reversed
MotorControllabilityMotor Controllability
CurrentValveStateCurrent Valve State
ConditionFilter Remaining Life
ChangeIndicationFilter Life Status
FilterTypeFilter Type
OperationalStateOperational State
CurrentFlowCurrent Flow
CurrentModeCurrent Mode
ChangeToModeResponseMode Change Feedback
VacuumOperationalStateVacuum Operational State
RefrigeratorAlarmRefrigerator Alarm
EvseStateCharging Connector State
EvseSupplyStateCharging Station State
ChargingEnabledUntilCharging Enabled Until
MaxChargeCurrentMaximum Current
BatteryCapacityBattery Capacity
MinChargeCurrentMinimum Current
SetTemperatureSet Temperature
SetTemperatureLevelSet Temperature Level
MediaInputPlayback Source
SetBackTemperature Setback
OpenAngleOpening Angle
BSSIDBSSID
CurrentTemperatureCalibrationTemperature Compensation
HeaterCoolerButtonEventHeater/Cooler Button Event
HeaterCoolerPolarityHeater/Cooler Polarity Setting
SelfCheckAlarm Self-Test
FirmwareRevisionFirmware Version
SerialNumberSerial Number
VendorNameVendor Name
VendorIDVendor ID
ProductNameProduct Name
ReachableConnectivity State
HardwareVersionHardware Version
MacMAC Address
DeviceIDDevice ID
EndpointNameDevice or Card Name
OnOffOn/Off State
CurrentLevelCurrent Level
CurrentXX Value
CurrentYY Value
ColorTemperatureColor Temperature
ButtonEventButton Event
CameraActiveStatusCamera Sleep State
CurrentPositionPercentageCurrent Position Percentage
TargetPositionPercentageTarget Position Percentage
IRTypeInfrared Type
IRBrandInfrared Brand
CurrentVoltageVoltage
CurrentPowerPower
CumulativeEnergyConsumptionCumulative Energy Consumption
HeaterCoolerModeHeating/Cooling Mode
HeatingTemperatureHeating Temperature
CoolingTemperatureCooling Temperature
FanModeFan Mode
RockSettingOscillation
CurrentHumidityHumidity
CurrentPlaybackStatePlayback State
PlaybackDurationDuration
SampledPositionPlayback Progress
PlaybackModePlayback Mode
MediaInformationMedia Information
VolumeVolume
MuteMute
LockStateLock State
DoorStateDoor State
IRKeyInfrared Command
BatPercentRemainingBattery Percentage
SweeperStateSweeper State
VOCDensityVOC Concentration
VOCQualityVOC Level
CurrentPressurePressure
PM2.5DensityPM2.5 Concentration
PM2.5LevelPM2.5 Level
PM1.0DensityPM1.0 Concentration
PM10DensityPM10 Concentration
CO2DensityCO2 Concentration
CO2LevelCO2 Level
CurrentIlluminanceIlluminance
ContactSensorStateContact State
SmokeDensitySmoke Concentration
SmokeDetectedSmoke Detection Status
GasDensityGas Concentration
GasDetectedGas Detection Status
SleepStateSleep State
SleepQualitySleep Quality
OnBedIn-Bed State
SleepStageSleep Stage
LeakStateLeak State
OccupancyPresence State
OccupancySensorTypePresence Sensor Type
MotionDetectedMotion Detection
RotationAngleRotation Angle
RotationDirectionRotation Direction
RotationEventRotation Event
CubeEventCube Event
VibrationEventVibration Sensor Event
SmokeDensitydBSmoke Density (dB)
CurrentRRed Value
CurrentGGreen Value
CurrentBBlue Value
SupportedEndpointDynamicDynamic Mode Supported
EndpointArrayDynamicDynamic Endpoint Array
FeedFeed
AttitudeDetectedAttitude Detection
TargetPlaybackStateTarget Playback State
EnableRemoteControlEnable Remote Control
HardwareVersionStringSpecified Endpoint Hardware Version
FirmwareRevisionStringFirmware Version
ProductIDProduct ID
MinPINCodeLengthMinimum PIN Code Length
MinRFIDCodeLengthMinimum RFID Length
OperatingModeOperating Mode
ActuatorEnabledActuator Enabled
ReverseIdentifyReverse Identification
HueHue
SaturationSaturation
MinHeatCoolDeadBandMinimum Heating/Cooling Dead Band
ChannelWireless Channel
ExtendedPANIDNetwork Extended PAN ID
WindowCoveringMotorsBindingWindow Covering Motors Binding
CurrentRotationAngleCurrent Rotation Angle
TargetRotationAngleTarget Rotation Angle
CurrentGarageDoorStateCurrent Garage Door State
TargetGarageDoorStateTarget Garage Door State
HoldRotationAngleHold Rotation Angle
ModeCountMode Count
PlaybackSampledPositionPlayback Sampled Position
SelectedMediaOutputSourceSelected Media Output Source
LockOperationLock Operation
DoorLockAlarmDoor Lock Alarm
LockUserChangeLock User Change
ModelValueModel Value
EndpointCountEndpoint Count
EndpointStructureEndpoint Structure
EndpointDeviceTypesEndpoint Device Types
EndpointDynamicCountEndpoint Dynamic Count
EndpointArrayEndpoint Array
EndpointFunctionsEndpoint Functions
SelectedEndpointDynamicSelected Endpoint Dynamic
PartNumberPart Number
BLVersionBL Version
ManufacturerChipIDManufacturer Chip ID
SupportedMatterRolesSupported Matter Roles
HubConnectionStatusHub Connection Status
DeviceXCodeDevice X Code
MatterSpecificationVersionMatter Specification Version
MCUVersionMCU Version
ConfigurationFlagConfiguration Flag
RadarVersionRadar Version
ConfigurationVersionConfiguration Version
ChipTemperatureChip Temperature
LocationLocation
EndpointTagEndpoint Tag
EndpointApplianceTypeEndpoint Appliance Type
EndpointRoomEndpoint Room
EndpointVisibilityEndpoint Visibility
EndpointIconEndpoint Icon
EndpointStatisticsEndpoint Statistics
EndpointRoomNameEndpoint Room Name
VoiceLanguageVoice Language
EnergySavingEnableEnergy Saving Enable
CurrentSensitivityLevelCurrent Sensitivity Level
TransmissionPowerSettingTransmission Power Setting
HubArkTechEnableHub Ark Tech Enable
BeepEnableBeep Enable
NightLightModeNight Light Mode
OutputInterlockFlagOutput Interlock Flag
ActivityDetectionModeSettingActivity Detection Mode Setting
TimeZoneTime Zone
NumberOfSensitivityLevelIsSupportedNumber Of Sensitivity Level Is Supported
PollingTimePolling Time
InstallationOrientationConfigurationInstallation Orientation Configuration
DetectionModeSettingDetection Mode Setting
LightingModeSettingLighting Mode Setting
ResetModeReset Mode
MagicPairPayloadMagic Pair Payload
SupportedEcosystemSupported Ecosystem
MatterPayloadMatter Payload
HomeKitPayloadHome Kit Payload
BoundEcosystemBound Ecosystem
BatReplacementDescriptionBat Replacement Description
BatChargeStateBat Charge State
BatReplaceabilityBat Replaceability
PowerModePower Mode
WiredPresentWired Present
StateOfLowBatState Of Low Bat
LoadSafetyManagementLoad Safety Management
VoltageSafetyManagementVoltage Safety Management
CurrentSafetyManagementCurrent Safety Management
OverCurrentResponseSettingOver Current Response Setting
TemperatureSafetyManagementTemperature Safety Management
RebootCountReboot Count
RebootReasonReboot Reason
UpTimeUp Time
NetworkInterfacesNetwork Interfaces
AntiDeletionSettingAnti Deletion Setting
AntiDeletionLevelSettingAnti Deletion Level Setting
ActiveHardwareFaultsActive Hardware Faults
DebugInfoDebug Info
FreeMemoryFree Memory
AntiDeletionNotificationAnti Deletion Notification
RoutingAgingCountThresholdRouting Aging Count Threshold
PreOperationModePre Operation Mode
NWKRetransmissionCountNWK Retransmission Count
ZigbeeTotalMessageInOneHourZigbee Total Message In One Hour
ZigbeeCoordMacZigbee Coord Mac
APSRetransmissionCountAPS Retransmission Count
ZigbeeResentMessageInOneHourZigbee Resent Message In One Hour
PANIDPANID
ZigbeeExtendedPANIDZigbee Extended PANID
ZigbeeGeneralDiagnosticsZigbee General Diagnostics
MessageTransmissionFailureCountThresholdMessage Transmission Failure Count Threshold
EnableNWKACKEnable NWKACK
ZigbeeKeySeqNumberZigbee Key Seq Number
LQILink Quality Indicator
ZigbeeFrameCounterZigbee Frame Counter
CCAModeCCA Mode
ZigbeeNextHopMacZigbee Next Hop Mac
EnableAPSACKEnable APSACK
MACRetransmissionCountMAC Retransmission Count
ZigbeeFailedMessageInOneHourZigbee Failed Message In One Hour
ZigbeeNeighborTableInfoZigbee Neighbor Table Info
CurOperationModeCur Operation Mode
ZigbeeAvgSuccessfulResendCountZigbee Avg Successful Resend Count
ZigbeeCoordNetworkKeyZigbee Coord Network Key
LanAccessAddressLan Access Address
RemoteProxyAccessEnableRemote Proxy Access Enable
InternetAccessAddressInternet Access Address
IdentifyTypeIdentify Type
IdentifyTimeIdentify Time
HomeStationCredentialsHome Station Credentials
WiFiChannelWi Fi Channel
ChildDeviceProvisioningStateChild Device Provisioning State
ZigbeeDiagnosticsZigbee Diagnostics
ZigbeeAuthRandcodeZigbee Auth Randcode
ZigbeeAuthRandcodeResponseZigbee Auth Randcode Response
WiFiDiagnosticsWi Fi Diagnostics
MagicPairKeychainMagic Pair Keychain
SupportedNetworkSupported Network
SlaveAddressSlave Address
ThreadDiagnosticsThread Diagnostics
AuthenticationStatusAuthentication Status
WiFiRSSIWi Fi RSSI
CurrentTemperatureCurrent Temperature
PackageRecognitionReportPackage Recognition Report
FaceIDReportFace ID Report
HoldTimeHold Time
ActivityDetectedActivity Detected
PresenceConfigurationPresence Configuration
PresencePresence
HumanRecognitionReportHuman Recognition Report
TripTimeTrip Time
BindingBinding
SupportedBindingDeviceTypesSupported Binding Device Types
SupportedBindingFunctionsSupported Binding Functions
LocalControlDisabledLocal Control Disabled
OutputSwitchingTypeOutput Switching Type
OutputNodeModeOutput Node Mode
StartUpOnOffStart Up On Off
PresetPreset
PresetTypesPreset Types
ActivePresetHandleActive Preset Handle
NumberOfPresetsNumber Of Presets
AntiFreezeTemperatureAnti Freeze Temperature
TiltAngleDeviationTilt Angle Deviation
StationaryStateStationary State
InitialTiltAngleInitial Tilt Angle
EventReportIntervalEvent Report Interval
ObjectOrientationEnableObject Orientation Enable
StationaryTiltAngleStationary Tilt Angle
PeakTiltAnglePeak Tilt Angle
ObjectMotionDetectionEnableObject Motion Detection Enable
ObjectOrientationStateObject Orientation State
CubeWorkModeSettingCube Work Mode Setting
TopFaceTop Face
TopFaceChangedTop Face Changed
HoldRotationIntervalHold Rotation Interval
RotationIntervalRotation Interval
BinaryOutputPVBinary Output Present Value
AnalogInputPVAnalog Input Present Value
LoginStateLogin State
SelectedSourceSelected Source
FlameDetectedFlame Detected
OperationalErrorOperational Error
BridgeDeviceIDBridge Device ID
MultiStateInputPVMulti State Input Present Value
PulseDurationPulse Duration
LoadTypeLoad Type
ThemeIDTheme ID
AllpagesAllpages
MaxPageNumMax Page Num
ScreenWidthScreen Width
DataVersionData Version
ThemeVersionTheme Version
ScreenHeightScreen Height
EnableIndicatorEnable Indicator
HeartRateHeart Rate
MultiStateOutputPVMulti State Output Present Value
WaterFreezeDetectorWaterFreezeDetector
StepValueStep Value
LockOperationErrorLock Operation Error
SupportedRemoteFeaturesSupported Remote Features
NumberOfCredentialsSupportedPerUserNumber Of Credentials Supported Per User
NumberOfTotalUsersSupportedNumber Of Total Users Supported
NumberOfYearDaySchedulesSupportedPerUserNumber Of Year Day Schedules Supported Per User
NumberOfPINUsersSupportedNumber Of PIN Users Supported
RemoteControlWithAuthCodeRemote Control With Auth Code
RemoteUnlockRemote Unlock
NumberOfRFIDUsersSupportedNumber Of RFID Users Supported
NumberOfWeekDaySchedulesSupportedPerUserNumber Of Week Day Schedules Supported Per User
VacuumOperationalErrorVacuum Operational Error
DefaultOpenDurationDefault Open Duration
RemainingDurationRemaining Duration
SamplingIntervalSampling Interval
CameraRTSPURLCamera RTSPURL
P2PCaptureStatusP2 P Capture Status
CameraRTSPEnableCamera RTSP Enable
GestureRecognitionReportGesture Recognition Report
BreathingMonitoringBreathingMonitoring
BreathingRateBreathing Rate
CharStringValuePVChar String Value Present Value
VehicleIDVehicle ID
EvseFaultStateEvse Fault State
BuiltInEffectsBuilt In Effects
MaxUserDefinedEffectsMax User Defined Effects
CurrentEffectIDCurrent Effect ID
EffectInfoEffect Info
MaxEffectNameLengthMax Effect Name Length
UserDefinedEffectsUser Defined Effects
OnTransitionTimeOn Transition Time
OffTransitionTimeOff Transition Time
ColorModeColor Mode
WhitePointXYWhite Point XY
LEDICQuantityLEDIC Quantity
ColorRGBColor RGB
ColorXYColor XY
StartUpXYColorStart Up XY Color
LightingMusicSyncModeLighting Music Sync Mode
StartUpColorTemperatureStart Up Color Temperature
LightingDynamicSceneModeLighting Dynamic Scene Mode
LightingMusicSyncEnableLighting Music Sync Enable
ColorPointRGBXYColor Point RGBXY
LEDICProtocolLEDIC Protocol
LEDTypeLED Type
MotorSpeedPercentageMotor Speed Percentage
WindowCoveringCategoryWindow Covering Category
UnconfiguredTravelControlPermissionUnconfigured Travel Control Permission
LimitPointSettingLimit Point Setting
ObstacleLimitMarkingBlockTimeObstacle Limit Marking Block Time
MotorSpeedSettingMotor Speed Setting
ManualPullStartStopEnabledManual Pull Start Stop Enabled
ObstacleLimitSensitivityObstacle Limit Sensitivity
TravelConfiguredTravel Configured
WindowCoveringTypeWindow Covering Type
ObstacleLimitAutoReboundEnableObstacle Limit Auto Rebound Enable
ManualPullEventManual Pull Event
WindowCoveringOpenOrientationWindow Covering Open Orientation
ManualPullStartEnabledManual Pull Start Enabled
LimitPointCountLimit Point Count
TargetPositionRotationPercentageTargetPositionRotationPercenta
CurrentPositionRotationPercentageCurrentPositionRotationPercent
ManualPullStopEnabledManual Pull Stop Enabled
ObstacleLimitMarkingEnableObstacle Limit Marking Enable
ManualPullAdaptiveSpeedEnabledManual Pull Adaptive Speed Enabled
DurationOccupiedWithinOneWeekDuration Occupied Within One Week
DurationOccupiedWithinOneDayDuration Occupied Within One Day
FireProductIdentificationFire Product Identification
SmokeChamberContaminationSmoke Chamber Contamination
AlarmErrorAlarm Error
SmokeStateSmoke State
AlarmsEnabledAlarms Enabled
ContaminationStateContamination State
EnableHeartbeatIndicatorEnable Heartbeat Indicator
AnalogOutputPVAnalog Output Present Value
PetRecognitionReportPet Recognition Report
AnomalySoundDetectedAnomaly Sound Detected
RingtonePlayVolumeRingtone Play Volume
RingtonePlayIndexRingtone Play Index
RingtonePlayStatusRingtone Play Status
RingtonePlayDurationRingtone Play Duration
BridgedNodeListBridged Node List
SupportedHubCapabilitySupported Hub Capability
MatterBridgeSupportedMatter Bridge Supported
MatterDACStateMatter DAC State
MatterOnboardingPayloadMatter Onboarding Payload
MatterManufacturerListMatter Manufacturer List
MatterBindStateMatter Bind State
MatterPairingStateMatter Pairing State
MatterPairingSwitchMatter Pairing Switch
BinaryInputPVBinary Input Present Value
VehicleDetectedVehicle Detected

SupportedEndpointDynamic

Indicates whether the current Device instance supports dynamic configuration.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

EndpointCount

Indicates the number of Endpoints contained in the current Device.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueint32
Maxint3265279.0
Minint322.0
Stepuint321.0

EndpointStructure

Describes the hierarchy (nesting relationships) of Endpoints in the configuration instance used by the current Device.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueEndpointStructureTraitPresentValueStructure

EndpointDeviceTypes

Describes the Device Type of each Endpoint in all configuration instances of the current Device. Use with EndpointArray or EndpointArrayDynamic.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist

EndpointDynamicCount

Indicates the number of dynamic Endpoint configuration instances supported by the current Device. The default value is 1.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueint32
Maxint3265279.0
Minint320.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present Valuelist

EndpointArray

Describes all possible combinations of Endpoints contained in the current Device. Use with SupportedEndpointDynamic, EndpointDynamicCount, and SelectedEndpointDynamic.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist

EndpointFunctions

This Trait provides access to and reporting for Endpoint function data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist

SelectedEndpointDynamic

Represents the array index in EndpointArray and indicates the currently selected Device Endpoint configuration instance.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueint32
Maxint3265279.0
Minint320.0
Stepuint321.0

ProductName

Specifies a human-readable (displayable) name for the Endpoint model, such as a manufacturer-assigned model name or other identifier.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

PartNumber

This Trait provides access to and reporting for part-number data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

BLVersion

Specifies the Bootloader version. The maximum length is 64 UTF-8 characters.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

ManufacturerChipID

Identifies the manufacturer chip ID.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665535.0
Minuint160.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present ValueHubConnectionStatusEnum80
Supported Valueslist[HubConnectionStatusEnum8]
Default Valueuint80

DeviceXCode

Represents the device type X code of the device.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665535.0
Minuint160.0
Stepuint321.0

MatterSpecificationVersion

This Trait provides access to and reporting for the Matter specification version.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

VendorName

This Trait provides access to and reporting for vendor-name data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

FirmwareRevisionString

This Trait provides access to and reporting for firmware-version data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

DeviceID

Represents the unique identifier of the device.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

VendorID

This Trait provides access to and reporting for vendor-ID data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

MCUVersion

Specifies the MCU version. (Present Value: String(64), default: null.)

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

ProductID

Specifies the manufacturer-assigned numeric ID that uniquely identifies this specific Endpoint product.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665535.0
Minuint160.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present Valueboolean

ModelValue

AIOT model value, for example, lumi.gateway.cn01.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

HardwareVersion

Specifies the version number of the Endpoint hardware. The meaning of its value and the versioning rules are defined by the manufacturer.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

Mac

Specifies the MAC address of the device.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

RadarVersion

Specifies the radar module version. (Present Value: String(64), default: null.)

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

SerialNumber

This Trait provides access to and reporting for serial-number data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present ValueConfigurationVersionTraitPresentValueStructure

Reachable

Indicates whether the device is reachable. 0: Offline; 1: Online.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

FirmwareRevision

Contains the current version number of the software running on this Endpoint.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

ChipTemperature

Indicates the current temperature measured by the device.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat1000.0
Minfloat-50.0
Stepuint320.01
Default Valuefloat0

Location

This Trait provides access to and reporting for region data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665535.0
Minuint160.0
Stepuint321.0

EndpointName

Describes the Endpoint name as a string with a maximum length of 32.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

EndpointApplianceType

Describes the current appliance type, such as Light, Fan, or Air Conditioner. The available type list varies by Device Type.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString
Supported Valueslist[characterString]

EndpointRoom

Describes the ID of the room where the Endpoint is located, as a string with a maximum length of 32 bytes.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

EndpointVisibility

Describes the visibility of all Endpoints contained in the current Device. 0: Invisible; 1: Visible.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

EndpointIcon

Describes the current icon ID. The available icon list varies by Device Type and cannot be customized by manufacturers.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

EndpointStatistics

Describes whether the device can be included in statistics.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

EndpointRoomName

Describes the name of the room where the Endpoint is located, as a string with a maximum length of 128 bytes.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

VoiceLanguage

The language used for voice prompts and voice feedback.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueVoiceLanguageEnum81
Supported Valueslist[VoiceLanguageEnum8]
Default Valueuint81

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

NameTypeDefaultReadableWritableReportable
Present Valueboolean

CurrentSensitivityLevel

Indicates the currently selected general-configuration sensitivity level.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.0

TransmissionPowerSetting

A dedicated Trait for setting the device transmit power.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat10.0
Minfloat-32.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

BeepEnable

Enables or disables audible feedback for device operations.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

NightLightMode

Sets night-light mode. In Auto mode, the device automatically turns the night light on or off based on ambient light.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueNightLightModeEnum8
Supported Valueslist[NightLightModeEnum8]

OutputInterlockFlag

When two attributes have the same value, the states corresponding to those attributes are interlocked.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint80
Maxuint8255.0
Minuint80.0
Stepuint321.0
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present ValueActivityDetectionModeSettingEnum321
Supported Valueslist[ActivityDetectionModeSettingEnum32]
Default Valueuint321

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

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

NumberOfSensitivityLevelIsSupported

This Trait provides access to and reporting for the number of supported sensitivity levels.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.0

PollingTime

Sets the polling interval for communication between the device and the network.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint320
Maxuint32250000.0
Minuint320.0
Stepuint32250.0
Default Valueuint320

InstallationOrientationConfiguration

This Trait provides access to and reporting for installation-orientation configuration data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueInstallationOrientationConfigurationEnum160
Supported Valueslist[InstallationOrientationConfigurationEnum16]
Default Valueuint160

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

NameTypeDefaultReadableWritableReportable
Present ValueDetectionModeSettingEnum160
Supported Valueslist[DetectionModeSettingEnum16]
Default Valueuint160

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

NameTypeDefaultReadableWritableReportable
Present ValueLightingModeSettingEnum80
Supported Valueslist[LightingModeSettingEnum8]
Default Valueuint80

ResetMode

Supports operations including factory reset and network-configuration reset.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueResetModeEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present ValueMagicPairPayloadTraitPresentValueStructure

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

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present ValueMatterPayloadTraitPresentValueStructure

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

NameTypeDefaultReadableWritableReportable
Present ValueHomeKitPayloadTraitPresentValueStructure

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

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.0

CurrentVoltage

Indicates the currently measured supply voltage. Unit: volts (V).

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat500.0
Minfloat0.0
Stepuint320.01

CircuitCurrent

The current flowing through a specific circuit or part of a circuit, typically used to measure current load.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat10000.0
Minfloat0.0
Stepuint320.001
Default Valuefloat0

CumulativeEnergyConsumption

This Trait provides access to and reporting for cumulative energy-consumption data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat1.0E8
Minfloat0.0
Stepuint320.1

CurrentPower

Indicates the current real-time power consumption. Unit: watts (W).

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat5000.0
Minfloat0.0
Stepuint320.1

BatReplacementDescription

This Trait must provide a user-facing battery description.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuestring32
Supported Valueslist[characterString]

BatChargeState

Indicates the battery charging state. 0: Unknown; 1: Charging; 2: Full charge; 3: Not charging; 4: Not chargeable.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueBatChargeStateEnum8
Supported Valueslist[BatChargeStateEnum8]

BatReplaceability

This Trait must indicate whether the battery is replaceable.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueBatReplaceabilityEnum8
Supported Valueslist[BatReplaceabilityEnum8]

PowerMode

Indicates the device power-supply mode. 0: Unknown; 1: Mains power; 2: Battery; 3: DC power.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuePowerModeEnum8
Supported Valueslist[PowerModeEnum8]

BatPercentRemaining

Indicates the percentage of battery capacity remaining.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint320.1
Default Valuefloat50

WiredPresent

Indicates whether wired power (a power adapter) is detected.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

Rechargeable

This Trait must indicate whether the battery is rechargeable.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

StateOfLowBat

Indicates whether the battery is in a low-battery state. 0: Normal; 1: Low battery; 2: Critically low.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueStateOfLowBatEnum8
Supported Valueslist[StateOfLowBatEnum8]

BatReplacementNeeded

This Trait must indicate whether the battery needs to be replaced.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

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

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.0

LoadSafetyManagement

A safety mechanism that monitors electrical or mechanical loads.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueLoadSafetyManagementEnum80
Supported Valueslist[LoadSafetyManagementEnum8]
Default Valueuint80

VoltageSafetyManagement

A safety mechanism that monitors supply voltage and provides protection during overvoltage or undervoltage conditions.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueVoltageSafetyManagementEnum80
Supported Valueslist[VoltageSafetyManagementEnum8]
Default Valueuint80

CurrentSafetyManagement

A safety mechanism that monitors device current and triggers protection during overcurrent conditions.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueCurrentSafetyManagementEnum80
Supported Valueslist[CurrentSafetyManagementEnum8]
Default Valueuint80

OverCurrentResponseSetting

This setting defines the scope of overcurrent protection.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueOverCurrentResponseSettingEnum8
Supported Valueslist[OverCurrentResponseSettingEnum8]

TemperatureSafetyManagement

A safety mechanism that monitors device temperature and triggers protective measures when an overtemperature condition occurs.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueTemperatureSafetyManagementEnum80
Supported Valueslist[TemperatureSafetyManagementEnum8]
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present Valueuint32
Maxuint1665535.0
Minuint160.0
Stepuint321.0

RebootReason

The Present Value indicates the reason for the device's most recent startup.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueRebootReasonEnum8
Supported Valueslist[RebootReasonEnum8]

UpTime

The UpTime trait should indicate, as accurately as possible, the time elapsed in seconds since the node was last restarted.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint320
Maxuint324.2949673E9
Minuint320.0
Stepuint321.0
Default Valueuint320

NetworkInterfaces

This trait describes the network interfaces supported by the device.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist[NetworkInterfacesTraitPresentValueStructure]

AntiDeletionSetting

Used to configure protection against accidental deletion.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueAntiDeletionSettingEnum80
Supported Valueslist[AntiDeletionSettingEnum8]
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present ValueAntiDeletionLevelSettingEnum80
Supported Valueslist[AntiDeletionLevelSettingEnum8]
Default Valueuint80

ActiveHardwareFaults

Hardware faults.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueActiveHardwareFaultsEnum32255
Supported Valueslist[ActiveHardwareFaultsEnum32]
Default Valueuint32255

DebugInfo

Debug information generated while the device is running. The data type is a string with a maximum length of 1024 bytes.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

FreeMemory

Indicates the device's currently available memory, in kilobytes (KB).

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint32
Maxuint324.2949673E9
Minuint320.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present ValueAntiDeletionNotificationEnum8
Supported Valueslist[AntiDeletionNotificationEnum8]

RoutingAgingCountThreshold

Configures the aging-count threshold for device packet routing.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint85
Maxuint820.0
Minuint83.0
Stepuint321.0
Default Valueuint85

PreOperationMode

Indicates the device's previous Zigbee network connection state.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuePreOperationModeEnum8
Supported Valueslist[PreOperationModeEnum8]

NWKRetransmissionCount

Indicates the number of network-layer retransmissions during packet transmission.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint83
Maxuint820.0
Minuint83.0
Stepuint321.0
Default Valueuint83

ZigbeeTotalMessageInOneHour

Indicates the total number of Zigbee messages sent in one hour.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint32
Maxuint324.2949673E9
Minuint320.0
Stepuint321.0

ZigbeeCoordMac

Represents the MAC address of the Zigbee coordinator.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

APSRetransmissionCount

The number of automatic retransmissions attempted by the Zigbee APS layer when a packet acknowledgement is not received.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint83
Maxuint820.0
Minuint83.0
Stepuint321.0
Default Valueuint83

ZigbeeResentMessageInOneHour

Indicates the number of Zigbee messages retransmitted in one hour.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint32
Maxuint324.2949673E9
Minuint320.0
Stepuint321.0

PANID

The Present Value indicates the Zigbee network PAN ID.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665534.0
Minuint160.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

ZigbeeGeneralDiagnostics

A general reporting channel for child-device self-diagnostic information.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

MessageTransmissionFailureCountThreshold

Configures the threshold count for failed device packet transmissions.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint810
Maxuint820.0
Minuint83.0
Stepuint321.0
Default Valueuint810

EnableNWKACK

Toggles the option to enable network-layer acknowledgements during network communication.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

RebootReason

The Present Value indicates the reason for the device's most recent startup.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueRebootReasonEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present Valueuint80
Maxuint8255.0
Minuint80.0
Stepuint321.0
Default Valueuint80

LQI

Indicates the Thread network Link Quality Indicator (LQI), which reflects RF link quality between Thread devices. Range: 0–255.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present Valueuint32
Maxuint324.2949673E9
Minuint320.0
Stepuint321.0

Channel

The Present Value indicates the Zigbee network channel number.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665535.0
Minuint160.0
Stepuint321.0

CCAMode

Indicates the device's CCA state.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueCCAModeEnum8
Supported Valueslist[CCAModeEnum8]

ZigbeeNextHopMac

Defines the Zigbee MAC address of the next-hop device.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

EnableAPSACK

Toggles the option to enable APS acknowledgements during network communication.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

MACRetransmissionCount

Indicates the number of MAC-layer retransmissions during packet transmission.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint83
Maxuint814.0
Minuint83.0
Stepuint321.0
Default Valueuint83

ZigbeeFailedMessageInOneHour

Indicates the number of Zigbee messages that failed to send in one hour.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint32
Maxuint324.2949673E9
Minuint320.0
Stepuint321.0

ZigbeeNeighborTableInfo

Provides network-topology information for Zigbee devices.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

CurOperationMode

Indicates the device's current Zigbee network connection state.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueCurOperationModeEnum8
Supported Valueslist[CurOperationModeEnum8]

ZigbeeAvgSuccessfulResendCount

Indicates the average number of successful Zigbee message retransmissions.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint32
Maxuint324.2949673E9
Minuint320.0
Stepuint321.0

ZigbeeCoordNetworkKey

Represents the network key of the Zigbee coordinator.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

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

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present ValueIdentifyTypeEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat10.0
Minfloat0.0
Stepuint320.1

HomeStationCredentials

Home Station Credentials information.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueHomeStationCredentialsTraitPresentValueStructure

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

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint16165.0
Minuint161.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present ValueChildDeviceProvisioningStateEnum80
Supported Valueslist[ChildDeviceProvisioningStateEnum8]
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present ValueZigbeeDiagnosticsTraitPresentValueStructure

ZigbeeAuthRandcode

A random number issued by the cloud when a Zigbee 3.0 device connects to the cloud for authentication.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

ZigbeeAuthRandcodeResponse

The Confirm result returned when a Zigbee 3.0 device authenticates with the cloud.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present ValueWiFiDiagnosticsTraitPresentValueStructure

MagicPairKeychain

Used for the MagicPair network commissioning keychain.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.0

SlaveAddress

The address assigned to the device as a slave on a bus, used for master-slave communication addressing.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint8255
Maxuint8255.0
Minuint81.0
Stepuint321.0
Default Valueuint8255

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

NameTypeDefaultReadableWritableReportable
Present ValueThreadDiagnosticsTraitPresentValueStructure

AuthenticationStatus

Indicates the device authentication status, including whether authentication has passed and whether the certificate is valid.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueAuthenticationStatusEnum80
Supported Valueslist[AuthenticationStatusEnum8]
Default Valueuint80

WiFiRSSI

A metric of Wi-Fi connection signal strength, measured in dBm, ranging from -100 dBm (very weak) to 0 dBm (strongest).

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueint8
Maxint80.0
Minint8-100.0
Stepuint321.0

CurrentTemperature

Indicates the current temperature.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat26
Maxfloat100.0
Minfloat-50.0
Stepuint320.01
Default Valuefloat26

SetTemperatureLevel

SetTemperatureLevel allows users to adjust the temperature to a preset level. The Supported Values parameter indicates the list of supported levels.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint80
Maxuint8255.0
Minuint80.0
Stepuint321.0
Supported Valueslist[characterString]
Default Valueuint80

SetTemperature

SetTemperature allows users to specify and adjust the target temperature of a device or system.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat20
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat20

PackageRecognitionReport

Automatically reports an event when a package is delivered, removed, or changes state.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuePackageRecognitionReportEnum8
Supported Valueslist[PackageRecognitionReportEnum8]

FaceIDReport

A unique identifier associated with a specific face, used for facial recognition or authentication.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint64
Maxuint641.8446744E19
Minuint640.0
Stepuint321.0

HoldTime

Unoccupied-state determination delay.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint161
Minuint161.0
Default Valueuint161

ActivityDetected

Indicates whether any human activity is detected while a space is occupied.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

PresenceConfiguration

Used to configure occupancy and vacancy software-sensor settings.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuePresenceConfigurationTraitPresentValueStructure

Presence

Presence detects whether a person is in the monitored area.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuePresenceEnum80
Supported Valueslist[PresenceEnum8]
Default Valueuint80

HumanRecognitionReport

Reports whether a human figure is detected in the defined detection area.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueHumanRecognitionReportEnum8
Supported Valueslist[HumanRecognitionReportEnum8]

AirQuality

AirQuality indicates the air-quality level.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueAirQualityEnum80
Supported Valueslist[AirQualityEnum8]
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present ValueVOCQualityEnum8
Supported Valueslist[VOCQualityEnum8]

VOCDensity

This trait is used to access and report VOC concentration data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat1
Maxfloat9999.0
Minfloat1.0
Stepuint321.0
Default Valuefloat1

AttitudeDetected

This trait is used to access and report posture-detection data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueAttitudeDetectedEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat300.0
Minfloat1.0
Stepuint321.0

TargetPositionPercentage

This trait is used to access and report target position percentage data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat50

CurrentPositionPercentage

Indicates the actual position as a percentage from 0% to 100%, with a default step of 1%.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat50

Binding

Binding represents a persistent relationship between an endpoint and one or more other local or remote endpoints.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist[BindingTraitPresentValueStructure]

SupportedBindingDeviceTypes

Indicates the list of device types to which this controller endpoint can bind.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist

SupportedBindingFunctions

Indicates the list of functions to which this controller endpoint can bind and control.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist

Feed

This trait is used to access and report feeding-related data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueFeedEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present Valueboolean

ButtonEvent

This trait is used to access and report button-event data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueButtonEventEnum8
Supported Valueslist[ButtonEventEnum8]

OutputSwitchingType

Defines the type of external switch connected to the device.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueOutputSwitchingTypeEnum8
Supported Valueslist[OutputSwitchingTypeEnum8]

OnOff

Writing turns the camera device on or off. Reading indicates the current power state. Values: false = off, true = on.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

OutputInterlockFlag

When the values of two attributes are the same, the states represented by those attributes are interlocked.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint80
Maxuint8255.0
Minuint80.0
Stepuint321.0
Default Valueuint80

OutputNodeMode

Defines the operating mode of the output node.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueOutputNodeModeEnum32
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present ValueStartUpOnOffEnum8
Supported Valueslist[StartUpOnOffEnum8]

IRKey

This trait is used to access and report infrared-command data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueIRKeyEnum32
Supported Valueslist[IRKeyEnum32]

IRType

Defines the device type of the IR remote control.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueIRTypeEnum8
Supported Valueslist[IRTypeEnum8]

CoolingTemperature

Indicates the cooling temperature.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat26
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat26

CurrentHumidity

This trait is used to access and report humidity data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat50

CurrentTemperature

Indicates the current temperature.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat26
Maxfloat100.0
Minfloat-50.0
Stepuint320.01
Default Valuefloat26

Preset

This trait is used to access and report preset data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist[PresetTraitPresentValueStructure]

SetBack

Indicates the thermostat temperature setback range.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat25.5
Minfloat0.0
Stepuint320.1

PresetTypes

This trait is used to access and report preset-type data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist

HeaterCoolerMode

This trait is used to access and report heating/cooling mode data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueHeaterCoolerModeEnum8
Supported Valueslist[HeaterCoolerModeEnum8]

ActivePresetHandle

This trait is used to access and report active preset handle data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterStringnull
Default ValuecharacterStringnull

HeatingTemperature

Indicates the heating temperature.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat18
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat18

NumberOfPresets

This trait is used to access and report preset-count data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint80
Minuint80.0
Default Valueuint80

HeaterCoolerButtonEvent

An event triggered by button interaction on a thermostat or climate-control device.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueHeaterCoolerButtonEventEnum8
Supported Valueslist[HeaterCoolerButtonEventEnum8]

MinHeatCoolDeadBand

Indicates the minimum difference between heating and cooling temperatures in automatic mode.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat2
Maxfloat2.5
Minfloat0.0
Stepuint320.1
Default Valuefloat2

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

NameTypeDefaultReadableWritableReportable
Present Valuenumber

TemperatureUIDisplayMode

This trait specifies the unit used to display temperature on the thermostat's built-in screen.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueTemperatureUIDisplayModeEnum80
Supported Valueslist[TemperatureUIDisplayModeEnum8]
Default Valueuint80

AntiFreezeTemperature

The anti-freeze protection temperature setting usually specifies the threshold that triggers the anti-freeze mechanism, for example, 5 °C.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat5
Maxfloat15.0
Minfloat5.0
Stepuint320.5
Default Valuefloat5

HeaterCoolerPolarity

Specifies the polarity configuration used to determine whether the system controls cooling or heating.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueHeaterCoolerPolarityEnum82
Supported Valueslist[HeaterCoolerPolarityEnum8]
Default Valueuint82

TiltAngleDeviation

Indicates the actual change (offset) in Tilt angle during the current movement.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat180.0
Minfloat-180.0
Stepuint320.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

NameTypeDefaultReadableWritableReportable
Present ValueStationaryStateEnum81
Supported Valueslist[StationaryStateEnum8]
Default Valueuint81

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat180.0
Minfloat-180.0
Stepuint320.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

NameTypeDefaultReadableWritableReportable
Present Valueuint3260
Maxuint32300.0
Minuint325.0
Stepuint321.0
Default Valueuint3260

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

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

StationaryTiltAngle

Indicates the tilt angle when an object becomes stationary after moving.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat180.0
Minfloat-180.0
Stepuint320.01

PeakTiltAngle

Indicates the maximum tilt angle recorded between wake-up and becoming stationary.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat180.0
Minfloat-180.0
Stepuint320.01

ObjectMotionDetectionEnable

Enables or disables object-motion detection. True indicates enabled (object movement will be detected); False indicates disabled.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

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

NameTypeDefaultReadableWritableReportable
Present ValueObjectOrientationStateEnum8
Supported Valueslist[ObjectOrientationStateEnum8]

VibrationEvent

This trait is used to access and report motion-sensor events.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueVibrationEventEnum8
Supported Valueslist[VibrationEventEnum8]

CubeWorkModeSetting

Enables multiple operating-mode settings for Magic Cube devices to improve the user experience and interaction.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueCubeWorkModeSettingEnum80
Supported Valueslist[CubeWorkModeSettingEnum8]
Default Valueuint80

TopFace

Indicates the face currently pointing upward on the cube controller, used to define the device state.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueTopFaceEnum8
Supported Valueslist[TopFaceEnum8]

CubeEvent

This trait is used to access and report cube-event data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueCubeEventEnum8
Supported Valueslist[CubeEventEnum8]

TopFaceChanged

Indicates that the device's “top face” has changed. Triggered when the user flips the device, such as a cube controller.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueTopFaceChangedEnum8
Supported Valueslist[TopFaceChangedEnum8]

HoldRotationInterval

The duration of a hold-to-rotate event, that is, the rotation interval.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665535.0
Minuint161.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present ValueRotationEventEnum8
Supported Valueslist[RotationEventEnum8]

RotationDirection

Describes the rotation direction. Values: 0 = Clockwise, 1 = Counterclockwise.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueRotationDirectionEnum8
Supported Valueslist[RotationDirectionEnum8]

InvertedRotationAngle

The angle of inverted rotation.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat3600.0
Minfloat-3600.0
Stepuint321.0
Default Valuefloat0

RotationAngle

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat3600.0
Minfloat-3600.0
Stepuint321.0
Default Valuefloat0

RotationInterval

The duration of a rotation event, that is, the rotation interval.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665535.0
Minuint161.0
Stepuint321.0

HoldRotationAngle

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat3600.0
Minfloat-3600.0
Stepuint321.0
Default Valuefloat0

BinaryOutputPV

BinaryOutputPV stores the command or actual on/off state of a binary output.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

AnalogInputPV

AnalogInputPV conveys the real-time value of an analog input channel and its engineering metadata.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat

TargetPlaybackState

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueTargetPlaybackStateEnum8
Supported Valueslist[TargetPlaybackStateEnum8]

MediaInformation

Describes media information, such as the title and artist.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

PlaybackDuration

Indicates the playback duration in ms.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat7200000.0
Minfloat0.0
Stepuint321.0

CurrentPlaybackState

Describes the current playback state.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueCurrentPlaybackStateEnum8
Supported Valueslist[CurrentPlaybackStateEnum8]

PlaybackMode

Describes the current playback mode.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuePlaybackModeEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat7200000.0
Minfloat0.0
Stepuint321.0

LoginState

Describes the login state of the media service.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

PlaybackSampledPosition

Sets and queries the current playback position.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint64
Maxuint644.294967295E9
Minuint640.0
Stepuint321.0

SelectedMediaOutputSource

Describes the selected media output source.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueSelectedMediaOutputSourceEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present ValueSelectedSourceEnum8
Supported Valueslist[SelectedSourceEnum8]

MediaInput

MediaInput provides a list of available input sources and commands for selecting and renaming them.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueenum8

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

NameTypeDefaultReadableWritableReportable
Present ValueFlameDetectedEnum8
Supported Valueslist[FlameDetectedEnum8]

OperationalError

OperationalError indicates that the device or system cannot perform its intended function.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueOperationalErrorEnum160
Supported Valueslist[OperationalErrorEnum16]
Default Valueuint160

OperationalState

OperationalState indicates the current functional or operating state of the device, including whether it is active or idle.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueOperationalStateEnum160
Supported Valueslist[OperationalStateEnum16]
Default Valueuint160

RefrigeratorAlarm

RefrigeratorAlarm indicates the current refrigerator alarm state.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist

CurrentMode

CurrentMode represents the device’s current operating state or setting; values come from a predefined set of options.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueenum80
Default Valueenum80

ChangeToModeResponse

ChangeToModeResponse is a response message or status indicating the result of a request to switch the device to a specific mode.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueChangeToModeResponseEnum160
Supported Valueslist[ChangeToModeResponseEnum16]
Default Valueuint160

BridgeDeviceID

Represents the DeviceID of the Bridge device connected to this bridged node. String(32).

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

MultiStateInputPV

MultiStateInputPV provides the current enumerated state, a human-readable state label, and optional descriptive text.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint32

PulseDuration

Defines the pulse duration for a pulsed load.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665535.0
Minuint160.0
Stepuint321.0

LoadType

Describes the type of load connected to the switch. 0: General, 1: Linkable, 2: Pulsed.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueLoadTypeEnum8
Supported Valueslist[LoadTypeEnum8]

ThemeID

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint161
Minuint161.0
Default Valueuint161

Allpages

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuelist[AllpagesTraitPresentValueStructure]

MaxPageNum

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint161
Default Valueuint161

ScreenWidth

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16240
Default Valueuint16240

DataVersion

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint640
Default Valueuint640

ThemeVersion

Theme version.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint161
Maxuint1699999.0
Minuint161.0
Stepuint321.0
Default Valueuint161

ScreenHeight

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16240
Default Valueuint16240

EnableIndicator

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuetlv

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

NameTypeDefaultReadableWritableReportable
Present ValueStartUpOnOffEnum8
Supported Valueslist[StartUpOnOffEnum8]

Condition

Represents the remaining filter life as a percentage.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat100
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat100

ChangeIndication

ChangeIndication defines the filter-life status.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueChangeIndicationEnum80
Supported Valueslist[ChangeIndicationEnum8]
Default Valueuint80

FilterType

FilterType defines the filter type.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueFilterTypeEnum8
Supported Valueslist[FilterTypeEnum8]

WindSetting

WindSetting defines the airflow type.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueWindSettingEnum80
Supported Valueslist[WindSettingEnum8]
Default Valueuint80

AirflowDirection

AirflowDirection defines the airflow direction.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueAirflowDirectionEnum80
Supported Valueslist[AirflowDirectionEnum8]
Default Valueuint80

FanMode

FanMode defines the fan mode.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueFanModeEnum8
Supported Valueslist[FanModeEnum8]

FanSpeed

FanSpeed represents the fan speed as a percentage.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8100.0
Minuint80.0
Stepuint321.0

RockSetting

Defines the oscillation mode.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueRockSettingEnum80
Supported Valueslist[RockSettingEnum8]
Default Valueuint80

HeartRate

Measures heartbeats per minute in real time.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat300.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

CurrentPressure

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat101
Maxfloat200000.0
Minfloat0.0
Stepuint321.0
Default Valuefloat101

MultiStateOutputPV

MultiStateOutputPV contains the requested or currently active enumerated output state.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint32

ContactSensorState

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

OpenAngle

Door or window opening angle.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat360.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat50

WaterFreezeDetector

Note: WaterFreezeDetector is a Function (water freeze detector) in the specification source, not an independent Trait. This Function contains only the BooleanState Trait.

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat100.0
Minfloat1.0
Stepuint3210.0

Mute

Indicates the speaker mute state.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

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

NameTypeDefaultReadableWritableReportable
Present ValueLockOperationTraitPresentValueStructure

LockOperationError

When a door-lock operation fails for any reason, the lock emits a LockOperationError event.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueLockOperationErrorTraitPresentValueStructure

SupportedRemoteFeatures

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

NumberOfCredentialsSupportedPerUser

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint80
Default Valueuint80

NumberOfTotalUsersSupported

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint160
Default Valueuint160

DoorState

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueDoorStateEnum8
Supported Valueslist[DoorStateEnum8]

NumberOfYearDaySchedulesSupportedPerUser

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint80
Default Valueuint80

LockState

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueLockStateEnum8
Supported Valueslist[LockStateEnum8]

EnableRemoteControl

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

NumberOfPINUsersSupported

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint160
Default Valueuint160

LockUserChange

When a door-lock user, schedule, or credential changes, the lock emits a LockUserChange event.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueLockUserChangeTraitPresentValueStructure

RemoteControlWithAuthCode

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

DoorLockAlarm

The door lock can send several alarms when critical conditions occur.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueDoorLockAlarmTraitPresentValueStructure

RemoteUnlock

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

NumberOfRFIDUsersSupported

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint160
Default Valueuint160

NumberOfWeekDaySchedulesSupportedPerUser

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint80
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present ValueCO2LevelEnum8
Supported Valueslist[CO2LevelEnum8]

CO2Density

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat9999.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

VacuumOperationalError

VacuumOperationalError indicates the specific error type encountered when the device or system cannot perform its intended function.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueVacuumOperationalErrorEnum160
Supported Valueslist[VacuumOperationalErrorEnum16]
Default Valueuint160

VacuumOperationalState

VacuumOperationalState indicates the current operating state or mode of the vacuum device.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueVacuumOperationalStateEnum160
Supported Valueslist[VacuumOperationalStateEnum16]
Default Valueuint160

CurrentValveState

CurrentValveState represents the valve’s current operating state.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueCurrentValveStateEnum8
Supported Valueslist[CurrentValveStateEnum8]

DefaultOpenDuration

DefaultOpenDuration represents the default duration, in seconds, that the valve remains open when the OpenDuration field is not specified.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat1
Maxfloat100000.0
Minfloat1.0
Stepuint321.0
Default Valuefloat1

RemainingDuration

RemainingDuration indicates the time remaining before the valve automatically closes.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat100000.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0
Is NullbooleanFalse

ScreenBrightness

Controls the screen brightness level, with values from 1% to 100%.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat1.0
Stepuint321.0
Default Valuefloat50

SamplingInterval

Defines the data sampling interval.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat5
Maxfloat3600.0
Minfloat0.5
Stepuint320.1
Default Valuefloat5

CurrentIlluminance

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100000.0
Minfloat0.0
Stepuint321.0
Default Valuefloat50

CameraActiveStatus

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

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

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

P2PCaptureStatus

P2P animated snapshot status switch.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

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

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

P2PCaptureEnabled

Indicates whether the camera has P2P (peer-to-peer) snapshot capture enabled.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

CurrentSensitivityLevel

Indicates the currently selected general-configuration sensitivity level.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.0

GasDensity

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

SelfCheck

Enables self-checks to verify that device functions are operating normally.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

Mute

Indicates the speaker mute state.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

GasDetected

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

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

NameTypeDefaultReadableWritableReportable
Present ValueGestureRecognitionReportEnum16
Supported Valueslist[GestureRecognitionReportEnum16]

BreathingMonitoring

Note: BreathingMonitoring is a Function (breathing monitoring) in the specification source, not an independent Trait. This Function contains only the BreathingRate Trait.

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat60.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

CharStringValuePV

Indicates the current value of the CharacterString Value Object.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

SweeperState

This Trait provides access to and reporting for the associated data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueSweeperStateEnum8
Supported Valueslist[SweeperStateEnum8]

EvseSupplyState

EvseSupplyState represents the current power supply state of the electric vehicle supply equipment (EVSE).

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueEvseSupplyStateEnum32
Supported Valueslist[EvseSupplyStateEnum32]

MinChargeCurrent

MinChargeCurrent indicates the minimum current level at which the electric vehicle can charge.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat10000.0
Minfloat0.0
Stepuint320.001
Default Valuefloat0

EvseState

EVSEState represents the current state of the electric vehicle supply equipment (EVSE).

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueEvseStateEnum32
Supported Valueslist[EvseStateEnum32]

ChargingEnabledUntil

ChargingEnabledUntil indicates the time until which charging of the electric vehicle (EV) or device is allowed.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat6
Maxfloat10000.0
Minfloat0.0
Stepuint320.001
Default Valuefloat6
Is NullbooleanFalse

BatteryCapacity

BatteryCapacity is the total electrical energy that a battery can store, typically measured in kilowatt-hours.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat10000.0
Minfloat0.0
Stepuint320.001
Default Valuefloat0

VehicleID

VehicleID is the unique identifier assigned to each electric vehicle (EV).

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuestring32

EvseFaultState

EvseFaultState represents the current fault state of the electric vehicle supply equipment (EVSE).

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueEvseFaultStateEnum32
Supported Valueslist[EvseFaultStateEnum32]

BatPercentRemaining

Indicates the remaining battery percentage.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint320.1
Default Valuefloat50

MaxChargeCurrent

MaxChargeCurrent indicates the maximum current level at which the electric vehicle can charge.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat10000.0
Minfloat0.0
Stepuint320.001
Default Valuefloat0

CurrentFlow

CurrentFlow represents the current flow value in m³/h.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat65535.0
Minfloat0.0
Stepuint320.01
Default Valuefloat0

ExpressedState

ExpressedState defines the alarm state.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueExpressedStateEnum80
Supported Valueslist[ExpressedStateEnum8]
Default Valueuint80

CODetected

Indicates whether a carbon monoxide leak has been detected.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

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

NameTypeDefaultReadableWritableReportable
Present Valuelist[BuiltInEffectsTraitPresentValueStructure]
Is NullbooleanFalse

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

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint832.0
Minuint81.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Is NullbooleanFalse

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

NameTypeDefaultReadableWritableReportable
Present Valuelist[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

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint832.0
Minuint81.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present Valuelist[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

NameTypeDefaultReadableWritableReportable
Present Valueint320
Maxint324.294967295E9
Minint321.0
Stepuint321.0
Default Valueint320

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat1.0
Stepuint321.0
Default Valuefloat50
Maximum Actual Valuefloat
Minimum Actual Valuefloat

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

NameTypeDefaultReadableWritableReportable
Present Valueint320
Maxint324.294967295E9
Minint321.0
Stepuint321.0
Default Valueint320

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

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665279.0
Minuint160.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present ValueColorModeEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present ValueWhitePointXYPresentValueStructure

ColorTemperature

This Trait is used to access and report the color-temperature value.

Implementations commonly convert between Kelvin and mireds: Mired = 1000000 / Kelvin.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint32270
Maxuint32370.0
Minuint32153.0
Stepuint321.0
Default Valueuint32270

LEDICQuantity

Indicates the number of dimming-driver ICs.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665535.0
Minuint160.0
Stepuint321.0

ColorRGB

ColorRGB represents an RGB color value in the RGB color space.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint320
Maxuint321.6777215E7
Minuint320.0
Stepuint321.0
Default Valueuint320

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

NameTypeDefaultReadableWritableReportable
Present Valueuint320
Maxuint324.2949673E9
Minuint320.0
Stepuint321.0
Default Valueuint320

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat360.0
Minfloat0.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present ValueStartUpXYColorTraitPresentValueStructure0
Maxuint324.2949673E9
Minuint320.0
Stepuint321.0
Default ValueStartUpXYColorTraitPresentValueStructure0

LightingMusicSyncMode

Determines how lighting responds to music when enabled, such as with random effects, breathing transitions, flowing rainbows, or water ripples.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueLightingMusicSyncModeEnum80
Supported Valueslist[LightingMusicSyncModeEnum8]
Default Valueuint80

StartUpColorTemperature

Sets the default color temperature applied when the device powers on and the light is on.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint32270
Maxuint32370.0
Minuint32153.0
Stepuint321.0
Default Valueuint32270

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

NameTypeDefaultReadableWritableReportable
Present ValueLightingDynamicSceneModeEnum80
Supported Valueslist[LightingDynamicSceneModeEnum8]
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat50

CurrentG

This Trait is used to access and report green-value data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueint32
Maxint32255.0
Minint320.0
Stepuint321.0

CurrentB

This Trait is used to access and report blue-value data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueint32
Maxint32255.0
Minint320.0
Stepuint321.0

LightingMusicSyncEnable

Synchronizes lighting color and brightness with the rhythm of music for dynamic audiovisual effects.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

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

NameTypeDefaultReadableWritableReportable
Present Valueuint16
Maxuint1665279.0
Minuint160.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present ValueColorPointRGBXYPresentValueStructure

LEDICProtocol

Indicates the LED IC protocol.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueLEDICProtocolEnum8
Supported Valueslist[LEDICProtocolEnum8]

LEDType

Indicates the LED package type.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueLEDTypeEnum8
Supported Valueslist[LEDTypeEnum8]

CurrentR

This Trait is used to access and report red-value data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueint32
Maxint32255.0
Minint320.0
Stepuint321.0

MotorSpeedPercentage

Defines the motor operating-speed percentage, ranging from 1 (lowest speed) to 100 (highest speed).

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat1.0
Stepuint321.0
Default Valuefloat50

WindowCoveringCategory

Reported by curtain-type devices to classify window-covering devices into broad categories.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueWindowCoveringCategoryEnum80
Supported Valueslist[WindowCoveringCategoryEnum8]
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present Valueboolean

UnconfiguredTravelControlPermission

Indicates whether control is allowed when the curtain motor device travel is not configured.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

LimitPointSetting

Used to configure curtain motor limit points, specifically the fully open or fully closed limit position.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueLimitPointSettingEnum8
Supported Valueslist[LimitPointSettingEnum8]

ObstacleLimitMarkingBlockTime

The duration, in seconds, for which the obstacle limit-marking function is disabled.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint8255
Maxuint8255.0
Minuint810.0
Stepuint321.0
Default Valueuint8255

MotorSpeedSetting

Defines the motor operating-speed level, ranging from 1 (lowest speed) to 2 (highest speed).

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueMotorSpeedSettingEnum81
Supported Valueslist[MotorSpeedSettingEnum8]
Default Valueuint81

ManualPullStartStopEnabled

Enables users to manually start or stop curtain/window-covering movement by pulling.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

CurrentRotationAngle

Present Value indicates the current rotation angle of the window-covering device, ranging from -90 to 90 degrees.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat90.0
Minfloat-90.0
Stepuint321.0

ObstacleLimitSensitivity

The sensitivity setting when a curtain motor encounters an obstacle.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueObstacleLimitSensitivityEnum82
Supported Valueslist[ObstacleLimitSensitivityEnum8]
Default Valueuint82

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat300.0
Minfloat1.0
Stepuint321.0

TravelConfigured

Indicates whether the curtain motor travel (movement range) has been configured.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

CurrentPositionPercentage

Identifies the actual position as a percentage from 0% to 100%, with a default step of 1%.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat50

MotorControllability

Indicates whether the motor is currently controllable.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

MotorDirectionReversed

Specifies whether the motor operating direction is reversed, affecting how the window covering opens and closes.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

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

NameTypeDefaultReadableWritableReportable
Present ValueWindowCoveringTypeEnum80
Supported Valueslist[WindowCoveringTypeEnum8]
Default Valueuint80

ObstacleLimitAutoReboundEnable

When enabled, the curtain motor reverses direction upon encountering an obstacle to prevent damage.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

ManualPullEvent

Tracks or emits events triggered by manual pull interactions with a window-covering device.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueManualPullEventEnum32
Supported Valueslist[ManualPullEventEnum32]

TargetPositionPercentage

This Trait is used to access and report target-position percentage data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat50

TargetRotationAngle

Present Value specifies the target rotation angle of the window-covering device, ranging from -90 to 90 degrees.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat90.0
Minfloat-90.0
Stepuint321.0

WindowCoveringOpenOrientation

Identifies the actual window-covering opening direction for automatic control.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueWindowCoveringOpenOrientationEnum8
Supported Valueslist[WindowCoveringOpenOrientationEnum8]

MotorOperationStatus

Indicates the motor's current operating state.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueMotorOperationStatusEnum82
Supported Valueslist[MotorOperationStatusEnum8]
Default Valueuint82

ManualPullStartEnabled

Enables users to manually start curtain/window-covering movement by pulling.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

LimitPointCount

Represents the number of limit points (or travel limits) configured for the curtain-type motor.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint80
Maxuint82.0
Minuint80.0
Stepuint321.0
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

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

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

ManualPullStopEnabled

Enables users to manually stop curtain/window-covering movement by pulling.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

ObstacleLimitMarkingEnable

Enables or disables marking a limit point (open or closed) when the motor encounters an obstacle.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

ManualPullAdaptiveSpeedEnabled

Allows adaptive speed adjustment during manual pulling, providing pull-force-based variable-speed response.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

HoldTime

Unoccupied determination delay.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint161
Minuint161.0
Default Valueuint161

DurationOccupiedWithinOneWeek

Represents the total time, in milliseconds, that an occupancy sensor detects occupancy within a calendar week beginning Monday at 00:00:00.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat6.048E8
Minfloat0.0
Stepuint321.0

Occupancy

This Trait is used to access and report presence-status data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

DurationOccupiedWithinOneDay

Represents the total time, in milliseconds, that an occupancy sensor detects occupancy within one day.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat
Maxfloat8.64E7
Minfloat0.0
Stepuint321.0

OccupancySensorType

Specifies the occupancy-sensor type, such as PIR, ultrasonic, radar, or vision.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueOccupancySensorTypeEnum8
Supported Valueslist[OccupancySensorTypeEnum8]

BooleanState

BooleanState describes how Boolean values are used in the device context, possibly in a smart-home system, to represent status information.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

ExpressedState

ExpressedState defines the state of an alarm device.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueExpressedStateEnum80
Supported Valueslist[ExpressedStateEnum8]
Default Valueuint80

FireProductIdentification

This Trait is used to access and report fire identification-code data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

SmokeDensitydB

This Trait is used to access and report smoke-density dB data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat10.0
Minfloat0.0
Stepuint320.001
Default Valuefloat0

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

NameTypeDefaultReadableWritableReportable
Present ValueSmokeChamberContaminationEnum80
Supported Valueslist[SmokeChamberContaminationEnum8]
Default Valueuint80

AlarmError

This Trait is used to access and report alarm-error data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueAlarmErrorEnum8
Supported Valueslist[AlarmErrorEnum8]

SelfCheck

Facilitates self-checks to verify that device functions operate correctly.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

SmokeState

This Trait is used to access and report smoke-state data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueSmokeStateEnum8
Supported Valueslist[SmokeStateEnum8]

AlarmsEnabled

This Trait is used to access and report alarm-enable data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

ContaminationState

This Trait is used to access and report alarm-device contamination data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

Mute

Indicates the speaker mute state.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

SmokeDensity

This Trait is used to access and report smoke-density data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat5.0
Minfloat0.0
Stepuint320.001
Default Valuefloat0

SmokeDetected

This Trait is used to access and report smoke-detection status data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

EnableHeartbeatIndicator

This Trait is used to access and report heartbeat-indicator control data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean1
Default Valueboolean1

FreshAirMode

This trait defines the fresh-air mode.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueFreshAirModeEnum80
Supported Valueslist[FreshAirModeEnum8]
Default Valueuint80

AnalogOutputPV

AnalogOutputPV carries the commanded or actual value of an analog-output object.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat

MotionDetected

This Trait is used to access and report motion-detection data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueMotionDetectedEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present ValuePetRecognitionReportEnum16
Supported Valueslist[PetRecognitionReportEnum16]

PM1.0Density

This Trait is used to access and report PM1.0-density data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat65535.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

PM2.5Density

This Trait is used to access and report PM2.5-density data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat1000.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

PM2.5Level

This Trait is used to access and report PM2.5-level data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuePM2.5LevelEnum8
Supported Valueslist[PM2.5LevelEnum8]

PM10Density

This Trait is used to access and report PM10-density data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat65535.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

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

NameTypeDefaultReadableWritableReportable
Present ValueAnomalySoundDetectedEnum8
Supported Valueslist[AnomalySoundDetectedEnum8]

RingtonePlayVolume

Indicates the volume level for playing a ringtone or music. The range is 0 (muted) to 100 (maximum volume).

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat50
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat50

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

NameTypeDefaultReadableWritableReportable
Present ValueRingtonePlayIndexEnum32
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present ValueRingtonePlayStatusEnum80
Supported Valueslist[RingtonePlayStatusEnum8]
Default Valueuint80

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

NameTypeDefaultReadableWritableReportable
Present Valueuint320
Maxuint324.294967295E9
Minuint320.0
Stepuint321.0
Default Valueuint320

BridgedNodeList

Represents the list of bridged-node Device IDs added to this Bridge Node. It is an array of strings.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present Valueuint32
Maxuint324.294967295E9
Minuint320.0
Stepuint321.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

NameTypeDefaultReadableWritableReportable
Present Valueboolean

MatterDACState

Indicates the readiness state of the Matter Device Attestation Certificate (DAC). 0: retrieving the DAC; 1: DAC retrieval failed; 2: DAC ready.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueMatterDACStateEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present ValueMatterBindStateEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present ValueMatterPairingStateEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present Valueboolean

TargetGarageDoorState

This Trait is used to access and report target garage-door-state data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueTargetGarageDoorStateEnum8
Supported Valueslist[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

NameTypeDefaultReadableWritableReportable
Present ValueCurrentGarageDoorStateEnum8
Supported Valueslist[CurrentGarageDoorStateEnum8]

SleepQuality

Defines sleep quality, with a range of 0 to 100.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valuefloat0
Maxfloat100.0
Minfloat0.0
Stepuint321.0
Default Valuefloat0

SleepStage

Defines the sleep stage.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueSleepStageEnum8
Supported Valueslist[SleepStageEnum8]

SleepState

This Trait is used to access and report sleep-state data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueSleepStateEnum8
Supported Valueslist[SleepStateEnum8]

OnBed

Defines the in-bed state.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

BinaryInputPV

BinaryInputPV reports the instantaneous logical state of a discrete input and can optionally describe polarity inversion.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean0
Default Valueboolean0

LeakState

This Trait is used to access and report leak-state data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

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

NameTypeDefaultReadableWritableReportable
Present ValueVehicleDetectedEnum8
Supported Valueslist[VehicleDetectedEnum8]

BSSID

BSSID indicates the BSSID of the Wi-Fi network to which the node is currently connected.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValuecharacterString

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

NameTypeDefaultReadableWritableReportable
Present Valueuint320
Maxuint324.294967295E9
Minuint320.0
Stepuint321.0
Default Valueuint320

MinPINCodeLength

This Trait is used to access and report minimum PIN-code-length data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.0

MinRFIDCodeLength

This Trait is used to access and report minimum RFID-code-length data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueuint8
Maxuint8255.0
Minuint80.0
Stepuint321.0

OperatingMode

This Trait is used to access and report operating-mode data.

Parameters

NameTypeDefaultReadableWritableReportable
Present ValueOperatingModeEnum8
Supported Valueslist[OperatingModeEnum8]

ActuatorEnabled

This Trait is used to access and report actuator-enable data.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueboolean

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

NameTypeDefaultReadableWritableReportable
Present Valueuint64
Maxuint641.8446744073709552E19
Minuint640.0
Stepuint321.0

ModeCount

Describes the number of modes supported by the device. Format: int.

Parameters

NameTypeDefaultReadableWritableReportable
Present Valueint32
Maxint324.294967295E9
Minint320.0
Stepuint321.0