Skip to main content

Data Types

This document summarizes custom data types (enumerations, structures, and so on) referenced by Trait and Command parameters.

ActiveHardwareFaultsEnum32

This enumeration defines the valid Present Value values for the ActiveHardwareFaults Trait.

ValueNameDescription
0x00UnspecifiedUnknown fault
0x01RadioRadio fault
0x02SensorSensor fault
0x03ResettableOverTempOver-temperature protection
0x04NonResettableOverTempOver-temperature fault
0x05PowerSourcePower-source fault
0x06VisualDisplayFaultDisplay fault
0x07AudioOutputFaultAudio-output fault
0x08UserInterfaceFaultUser-interface fault
0x09NonVolatileMemoryErrorNon-volatile memory error
0x0ATamperDetectedDevice tampering detected
0xFFNormalNo fault

ActivityDetectionModeSettingEnum32

This enumeration defines the valid Present Value values for the ActivityDetectionModeSetting Trait.

ValueNameDescription
0x01HumanPresenceHuman presence
0x03PersonnelLocationPersonnel location
0x05FallDetectionFall detection
0x08CeilingFallSingleTrackingCeiling-mounted fall detection and single-person location
0x09SleepModeSleep
0x11GestureControlGesture

AddOrUpdateThreadNetwork Command Structure

Parameter structure for the AddOrUpdateThreadNetwork Command.

Member IndexFieldTypeRequiredDescription
0OperationalDatasetoctetStringRequiredOperational Dataset.

AddOrUpdateThreadNetworkResponse Command Structure

Parameter structure for the AddOrUpdateThreadNetworkResponse Command.

Member IndexFieldTypeRequiredDescription
0StatusCodesuint8RequiredStatus Codes.

AddOrUpdateWiFiNetwork Command Structure

Parameter structure for the AddOrUpdateWiFiNetwork Command.

Member IndexFieldTypeRequiredDescription
0SSIDcharacterStringOptionalSSID.
1CredentialscharacterStringOptionalCredentials.
2Encryptionuint8OptionalEncryption.
3CountryDomaincharacterStringOptionalCountry Domain.
4BindkeycharacterStringOptionalBindkey.
5TimeZonecharacterStringOptionalTime Zone.

AddOrUpdateWiFiNetworkResponse Command Structure

Parameter structure for the AddOrUpdateWiFiNetworkResponse Command.

Member IndexFieldTypeRequiredDescription
0StatusCodesuint8RequiredStatus Codes.

AddOrUpdateZigbeeNetwork Command Structure

Parameter structure for the AddOrUpdateZigbeeNetwork Command.

Member IndexFieldTypeRequiredDescription
0Channeluint8RequiredChannel.
1ExtendedPANIDoctetStringRequiredExtended PANID.
2NetworkKeyoctetStringRequiredNetwork Key.
3NetworkNamecharacterStringOptionalNetwork Name.
4PANIDuint16RequiredPANID.

AddOrUpdateZigbeeNetworkResponse Command Structure

Parameter structure for the AddOrUpdateZigbeeNetworkResponse Command.

Member IndexFieldTypeRequiredDescription
0StatusCodesuint8RequiredStatus Codes.

AddressingModeEnum8

This enumeration defines the valid values for the AddressingMode field in NetworkInterfacesTraitPresentValueStructure.

ValueNameDescription
0x00DHCPDHCP.
0x01StaticStatic.
0x02AutoAuto.
0xFFUnspecifiedUnspecified or unknown

AddUserDefinedEffect Command Structure

Parameter structure for the AddUserDefinedEffect Command.

Member IndexFieldTypeRequiredDescription
0EffectNamecharacterStringRequiredEffect Name.
1EffectDatacharacterStringRequiredEffect Data.

AirflowDirectionEnum8

This enumeration defines the valid Present Value values for the AirflowDirection Trait.

ValueNameDescription
0x00ForwardForward
0x01ReverseReverse

AirQualityEnum8

This enumeration defines the valid Present Value values for the AirQuality Trait.

ValueNameDescription
0x00UnknownUnknown
0x01ExcellentExcellent
0x02GoodGood
0x03FairFair
0x04InferiorInferior
0x05PoorPoor

AlarmErrorEnum8

This enumeration defines the valid Present Value values for the AlarmError Trait.

ValueNameDescription
0x00SUCCESSSuccess
0x01FAILUREFailure
0x02NOT_ALLOWEDNot allowed

AllpagesTraitPresentValueStructure

AllpagesWidgetStructure

This structure defines the field layout of items in the Allpages page Widgets list.

Member IndexFieldTypeRequiredDescription
0WidgetIDuint16RequiredWidget ID.
1WidgetPositionWidgetPositionStructureRequiredWidget Position.
2WidgetModeenum8RequiredWidget Mode.
3AssociatedDeviceInfoAssociatedDeviceInfoStructureRequiredAssociated Device Info.

AnomalySoundDetectedEnum8

This enumeration defines the valid Present Value values for the AnomalySoundDetected Trait.

ValueNameDescription
0x01CryDetectedCry Detected.
0x02SnoreDetectedSnore Detected.
0x03LoudSoundDetectedLoud Sound Detected.
0x04BabyCryDetectedBaby Cry Detected.
0x05AlarmSoundDetectedAlarm Sound Detected.
0x06DogBarkDetectedDog Bark Detected.
0x07CoughDetectedCough Detected.

AntiDeletionLevelSettingEnum8

This enumeration defines the valid Present Value values for the AntiDeletionLevelSetting Trait.

ValueNameDescription
0x00EnableResetAndFactoryEnable Reset And Factory.
0x01DisableFactoryOnlyDisable Factory Only.
0x02DisableResetAndFactoryDisable Reset And Factory.

AntiDeletionNotificationEnum8

This enumeration defines the valid Present Value values for the AntiDeletionNotification Trait.

ValueNameDescription
0x01TriggerTrigger.

AntiDeletionSettingEnum8

This enumeration defines the valid Present Value values for the AntiDeletionSetting Trait.

ValueNameDescription
0x00DisableDisabled
0x01EnableEnabled

AssociatedDeviceInfoStructure

This structure defines the layout of the AssociatedDeviceInfo field in Widget.

Member IndexFieldTypeRequiredDescription
0DeviceNamecharacterStringRequiredDevice Name.
1DeviceTypeIDuint16RequiredDevice Type ID.
2DeviceIconcharacterStringRequiredDevice Icon.
3DeviceIDcharacterStringRequiredDevice ID.
4EndPointIDuint16RequiredEnd Point ID.
5ParentIDcharacterStringOptionalParent ID.
6ModelValuecharacterStringOptionalModel Value.

AttitudeDetectedEnum8

This enumeration defines the valid Present Value values for the AttitudeDetected Trait.

ValueNameDescription
0x00NormalNormal
0x01FallDownFall Down.
0x02SuspectedFallSuspected Fall.

AuthenticationStatusEnum8

This enumeration defines the valid Present Value values for the AuthenticationStatus Trait.

ValueNameDescription
0x00NotAuthenticatedNot Authenticated.
0x01CertifiedAndValidCertified And Valid.
0x02NoCertificateNo Certificate.
0x03CertificateInvalidCertificate Invalid.

BatChargeStateEnum8

This enumeration defines the valid Present Value values for the BatChargeState Trait.

ValueNameDescription
0x00UnknownUnknown
0x01TheBatteryIsChargingCharging
0x02TheBatteryIsAtFullChargeFully charged
0x03TheBatteryIsNotChargingNot charging
0x04TheBatteryIsNotChargeableNot chargeable

BatReplaceabilityEnum8

This enumeration defines the valid Present Value values for the BatReplaceability Trait.

ValueNameDescription
0x00UnspecifiedUnspecified
0x01NotReplaceableNot replaceable
0x02UserReplaceableUser-replaceable
0x03FactoryReplaceableFactory-replaceable

BindingTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the Binding Trait.

Member IndexFieldTypeRequiredDescription
0DeviceIDcharacterStringRequiredDevice ID.
1ParentIDcharacterStringOptionalParent ID.
2GroupIDuint32OptionalGroup ID.
3ModelValuecharacterStringOptionalModel Value.
4EndPointIDuint32RequiredEnd Point ID.
5DeviceTypeIDuint32RequiredDevice Type ID.

BuiltInEffectsTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the BuiltInEffects Trait.

Member IndexFieldTypeRequiredDescription
0EffectIDuint8RequiredEffect ID.
1BuiltInEffectLabelIDenum8RequiredBuilt In Effect Label ID.

ButtonEventEnum8

This enumeration defines the valid Present Value values for the ButtonEvent Trait.

ValueNameDescription
0x00SinglePressSingle press
0x01DoublePressDouble press
0x02LongPressLong press
0x03LongPressReleaseLong-press release

CCAModeEnum8

This enumeration defines the valid Present Value values for the CCAMode Trait.

ValueNameDescription
0x00CCA1CCA1.
0x01CCA1CCA1.

ChangeIndicationEnum8

This enumeration defines the valid Present Value values for the ChangeIndication Trait.

ValueNameDescription
0x00OKOK
0x01WarmingWarning
0x02CriticalCritical

ChangeTemperature Command Structure

Parameter structure for the ChangeTemperature Command.

Member IndexFieldTypeRequiredDescription
0SetTemperaturefloatRequiredSet Temperature.

ChangeTemperatureLevel Command Structure

Parameter structure for the ChangeTemperatureLevel Command.

Member IndexFieldTypeRequiredDescription
0SetTemperatureLeveluint8RequiredSet Temperature Level.

ChangeToMode Command Structure

Parameter structure for the ChangeToMode Command.

Member IndexFieldTypeRequiredDescription
0CurrentModeuint16RequiredCurrent Mode.

ChangeToModeResponseEnum16

This enumeration defines the valid Present Value values for the ChangeToModeResponse Trait.

ValueNameDescription
0x00SuccessSuccess
0x01UnsupportedModeUnsupported Mode.
0x02GenericFailureGeneric Failure.
0x03InvalidInModeInvalid In Mode.
0x41StuckStuck.
0x42DustBinMissingDust Bin Missing.
0x43DustBinFullDust Bin Full.
0x44WaterTankEmptyWater Tank Empty.
0x45WaterTankMissingWater Tank Missing.
0x46WaterTankLidOpenWater Tank Lid Open.
0x47MopCleaningPadMissingMop Cleaning Pad Missing.
0x48BatteryLowBattery Low.

ChildDeviceProvisioningStateEnum8

This enumeration defines the valid Present Value values for the ChildDeviceProvisioningState Trait.

ValueNameDescription
0x00NotProvisioningNot Provisioning.
0x01ProvisioningProvisioning.

ClearWeekDaySchedule Command Structure

Parameter structure for the ClearWeekDaySchedule Command.

Member IndexFieldTypeRequiredDescription
0WeekDayIndexuint8RequiredWeek Day Index.
1UserIndexuint16RequiredUser Index.

ClearYearDaySchedule Command Structure

Parameter structure for the ClearYearDaySchedule Command.

Member IndexFieldTypeRequiredDescription
0YearDayIndexuint8RequiredYear Day Index.
1UserIndexuint16RequiredUser Index.

CO2LevelEnum8

This enumeration defines the valid Present Value values for the CO2Level Trait.

ValueNameDescription
0x00ExcellentExcellent
0x01LightPollutionLight Pollution.
0x02HeavyPollutionHeavy Pollution.

ColorModeEnum8

This enumeration defines the valid Present Value values for the ColorMode Trait.

ValueNameDescription
0x00HSVHSV.
0x01XYXY.
0x02ColorTemperatureColor Temperature.

ColorPointRGBXYPresentValueStructure

This structure defines the layout of the Present Value fields for ColorPointRGBXY.

Member IndexFieldTypeRequiredDescription
0ColorPointRXuint16RequiredColor Point RX.
1ColorPointRYuint16RequiredColor Point RY.
2ColorPointGXuint16RequiredColor Point GX.
3ColorPointGYuint16RequiredColor Point GY.
4ColorPointBXuint16RequiredColor Point BX.
5ColorPointBYuint16RequiredColor Point BY.

ConfigStaticIPAddr Command Structure

Parameter structure for the ConfigStaticIPAddr Command.

Member IndexFieldTypeRequiredDescription
0IPAddresscharacterStringOptionalIP Address.
1SubnetMaskcharacterStringOptionalSubnet Mask.
2DefaultGatewaycharacterStringOptionalDefault Gateway.
3PrimaryDNScharacterStringOptionalPrimary DNS.
4SecondaryDNScharacterStringOptionalSecondary DNS.
5InterfaceNamecharacterStringOptionalInterface Name.
6AddressingModeenum8OptionalAddressing Mode.

ConfigurationVersionTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the ConfigurationVersion Trait.

Member IndexFieldTypeRequiredDescription
0ConfigurationVersionuint32RequiredConfiguration Version.
1ThingModelMd5characterStringRequiredThing Model Md5.

ConnectToHomeStation Command Structure

Parameter structure for the ConnectToHomeStation Command.

Member IndexFieldTypeRequiredDescription
0SSIDcharacterStringRequiredSSID.
1CredentialscharacterStringRequiredCredentials.

ConnectToHomeStationResponse Command Structure

Parameter structure for the ConnectToHomeStationResponse Command.

Member IndexFieldTypeRequiredDescription
0ConnectToHomeStationResponseenum8RequiredConnect To Home Station Response.

CubeEventEnum8

This enumeration defines the valid Present Value values for the CubeEvent Trait.

ValueNameDescription
0x00Flip90Flip90.
0x01Flip180Flip180.
0x02PushPush.
0x03TapTwiceTap Twice.
0x04ShakeShake.
0x05SwingSwing.
0x06RotateRotate.
0x07TriggeredAfter1MinuteTriggered After1 Minute.
0x0APickUpHoldPick Up Hold.

CubeWorkModeSettingEnum8

This enumeration defines the valid Present Value values for the CubeWorkModeSetting Trait.

ValueNameDescription
0x00Action ModeAction Mode.
0x01Scene ModeScene Mode.

CurOperationModeEnum8

This enumeration defines the valid Present Value values for the CurOperationMode Trait.

ValueNameDescription
0x00UnjoinedModeUnjoined Mode.
0x01NewlyJoinedModeNewly Joined Mode.
0x02PollingModePolling Mode.
0x03UserModeUser Mode.
0x04DegradedModeDegraded Mode.
0x05RejoinModeRejoin Mode.

CurrentGarageDoorStateEnum8

This enumeration defines the valid Present Value values for the CurrentGarageDoorState Trait.

ValueNameDescription
0x01UnknownUnknown
0x02OpenOpen
0x03ClosedClosed
0x04OpeningOpenFair
0x05ClosingClosedFair
0x06NotFullyOpenNot Fully Open.
0x07NotFullyClosedNot Fully Closed.

CurrentPlaybackStateEnum8

This enumeration defines the valid Present Value values for the CurrentPlaybackState Trait.

ValueNameDescription
0x00PlayingPlaying.
0x01PausedPaused.
0x02StoppedStopped.
0x03BufferingBuffering.
0x04FastForwardingFast Forwarding.
0x05RewindingRewinding.

CurrentSafetyManagementEnum8

This enumeration defines the valid Present Value values for the CurrentSafetyManagement Trait.

ValueNameDescription
0x00CurrentNormalCurrent Normal.
0x01OverCurrentAnomalyOver Current Anomaly.
0x02OverCurrentProtectionOver Current Protection.

CurrentValveStateEnum8

This enumeration defines the valid Present Value values for the CurrentValveState Trait.

ValueNameDescription
0x00ClosedClosed
0x01OpenOpen
0x02TransitioningTransitioning.

DetectionModeSettingEnum16

This enumeration defines the valid Present Value values for the DetectionModeSetting Trait.

ValueNameDescription
0x00UnconfiguredUnconfigured.
0x03DoorWindowStateDoor Window State.
0x05ObjectOrientationObject Orientation.

DoorLockAlarmTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the DoorLockAlarm Trait.

Member IndexFieldTypeRequiredDescription
0AlarmCodeenum8RequiredAlarm Code.

DoorStateEnum8

This enumeration defines the valid Present Value values for the DoorState Trait.

ValueNameDescription
0x00DoorOpenDoor Open.
0x01DoorClosedDoor Closed.
0x02DoorJammedDoor Jammed.
0x03DoorForcedOpenDoor Forced Open.
0x04DoorUnspecifiedErrorDoor Unspecified Error.
0x05DoorAjarDoor Ajar.

EffectInfoTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the EffectInfo Trait.

Member IndexFieldTypeRequiredDescription
0EffectIDuint8RequiredEffect ID.
1EffectDatacharacterStringRequiredEffect Data.
2EffectNamecharacterStringRequiredEffect Name.

EndpointStructureNodeStructure

This structure defines the field layout of nested child nodes in EndpointStructure.

Member IndexFieldTypeRequiredDescription
0EndpointIduint16RequiredEndpoint Id.
1ChildEndpointslist[EndpointStructureNodeStructure]OptionalChild Endpoints.

EndpointStructureTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the EndpointStructure Trait.

Member IndexFieldTypeRequiredDescription
0EndpointIduint16RequiredEndpoint Id.
1ChildEndpointslist[EndpointStructureNodeStructure]OptionalChild Endpoints.

EvseFaultStateEnum32

This enumeration defines the valid Present Value values for the EvseFaultState Trait.

ValueNameDescription
0x00NoErrorNo Error.
0x01MeterFailureMeter Failure.
0x02OverVoltageOver Voltage.
0x03UnderVoltageUnder Voltage.
0x04OverCurrentOver Current.
0x05ContactWetFailureContact Wet Failure.
0x06ContactDryFailureContact Dry Failure.
0x07GroundFaultGround Fault.
0x08PowerLossPower Loss.
0x09PowerQualityPower Quality.
0x0APilotShortCircuitPilot Short Circuit.
0x0BEmergencyStopEmergency Stop.
0x0CEVDisconnectedEV Disconnected.
0x0DWrongPowerSupplyWrong Power Supply.
0x0ELiveNeutralSwapLive Neutral Swap.
0x0FOverTemperatureOver Temperature.
0xFFOtherOther.

EvseStateEnum32

This enumeration defines the valid Present Value values for the EvseState Trait.

ValueNameDescription
0x00NotPluggedInNot Plugged In.
0x01PluggedInNoDemandPlugged In No Demand.
0x02PluggedInDemandPlugged In Demand.
0x03PluggedInChargingPlugged In Charging.
0x04PluggedInDischargingPlugged In Discharging.
0x05SessionEndingSession Ending.
0x06FaultFault.

EvseSupplyStateEnum32

This enumeration defines the valid Present Value values for the EvseSupplyState Trait.

ValueNameDescription
0x00DisabledDisabled
0x01ChargingEnabledCharging Enabled.
0x02DischargingEnabledDischarging Enabled.
0x03DisabledErrorDisabled Error.
0x04DisabledDiagnosticsDisabled Diagnostics.
0x05EnabledChargingandDischargingEnabled Chargingand Discharging.

ExpressedStateEnum8

This enumeration defines the valid Present Value values for the ExpressedState Trait.

ValueNameDescription
0x00NormalNormal
0x01SmokeAlarmSmoke Alarm.
0x02COAlarmCO Alarm.
0x03BatteryAlertBattery Alert.
0x04TestingTesting.
0x05HardwareFaultHardware Fault.
0x06EndOfServiceEnd Of Service.
0x07InterconnectSmokeInterconnect Smoke.
0x08InterconnectCOInterconnect CO.

FanModeEnum8

This enumeration defines the valid Present Value values for the FanMode Trait.

ValueNameDescription
0x00OffClosed
0x01LowSpeedLow Speed.
0x02MediumSpeedMedium Speed.
0x03HighSpeedHigh Speed.
0x04AutoAuto.
0x05SmartSmart.

FeedEnum8

This enumeration defines the valid Present Value values for the Feed Trait.

ValueNameDescription
0x01RemoteFeedingRemote Feeding.

FilterTypeEnum8

This enumeration defines the valid Present Value values for the FilterType Trait.

This section defines the relevant fields and values. |-------|--------------------|----------| | 0x00 | HEPA | HEPA | | 0x01 | Activated Carbon | Activated Carbon. | | 0x02 | Photocatalytic | Photocatalytic. | | 0x03 | UV | UV. |

FlameDetectedEnum8

This enumeration defines the valid Present Value values for the FlameDetected Trait.

ValueNameDescription
0x01FlameDetectedFlame Detected.

FreshAirModeEnum8

This enumeration defines the valid Present Value values for the FreshAirMode Trait.

ValueNameDescription
0x00ManualManual.
0x01AutoAuto.
0x02ExhaustExhaust.
0x03HeatExchangeHeat Exchange.
0x04InternalCirculationInternal Circulation.
0x05ExternalCirculationExternal Circulation.
0x06PowerSavingPower Saving.
0x07StrongStrong.
0x08FreshAirFresh Air.
0x09BypassBypass.

GestureRecognitionReportEnum16

This enumeration defines the valid Present Value values for the GestureRecognitionReport Trait.

ValueNameDescription
0x02TwoTwo.
0x04FourFour.
0x05FiveFive.
0x06EightEight.
0x0AGoodGood.
0x65TwoBothHandsTwo Both Hands.
0x66FourBothHandsFour Both Hands.
0x67FiveBothHandsFive Both Hands.
0x68EightBothHandsEight Both Hands.

GetEffectData Command Structure

Parameter structure for the GetEffectData Command.

Member IndexFieldTypeRequiredDescription
0EffectIDuint8RequiredEffect ID.

GetWeekDaySchedule Command Structure

Parameter structure for the GetWeekDaySchedule Command.

Member IndexFieldTypeRequiredDescription
0WeekDayIndexuint8RequiredWeek Day Index.
1UserIndexuint16RequiredUser Index.

GetYearDaySchedule Command Structure

Parameter structure for the GetYearDaySchedule Command.

Member IndexFieldTypeRequiredDescription
0YearDayIndexuint8RequiredYear Day Index.
1UserIndexuint16RequiredUser Index.

GoToPositionPercentage Command Structure

Parameter structure for the GoToPositionPercentage Command.

Member IndexFieldTypeRequiredDescription
0PositionPercentagefloatRequiredPosition Percentage.
1TransitionTimeuint32OptionalTransition Time.

GoToPositionRotationPercentage Command Structure

Parameter structure for the GoToPositionRotationPercentage Command.

Member IndexFieldTypeRequiredDescription
0RotationPercentagefloatRequiredRotation Percentage.

HeaterCoolerButtonEventEnum8

This enumeration defines the valid Present Value values for the HeaterCoolerButtonEvent Trait.

ValueNameDescription
0x00PowerShortPressPower Short Press.
0x01FanSpeedShortPressFan Speed Short Press.
0x02TempUpShortPressTemp Up Short Press.
0x03TempDownShortPressTemp Down Short Press.
0x04ModeShortPressMode Short Press.
0x10PowerMidPressPower Mid Press.
0x11FanSpeedMidPressFan Speed Mid Press.
0x12TempUpMidPressTemp Up Mid Press.
0x13TempDownMidPressTemp Down Mid Press.
0x14ModeMidPressMode Mid Press.
0x30PowerLongPressPower Long Press.
0x31FanSpeedLongPressFan Speed Long Press.
0x32TempUpLongPressTemp Up Long Press.
0x33TempDownLongPressTemp Down Long Press.
0x34ModeLongPressMode Long Press.

HeaterCoolerModeEnum8

This enumeration defines the valid Present Value values for the HeaterCoolerMode Trait.

ValueNameDescription
0x00CoolCool.
0x01HeatHeat.
0x02AutoAuto.
0x03FanFan.
0x04DryDry.
0x05SleepSleep
0x06FreshAirFresh Air.
0x07FloorHeatFloor Heat.
0x08HeatandFloorHeatHeatand Floor Heat.
0x09FloorHeatandFreshAirFloor Heatand Fresh Air.
0x0AEmergencyHeatEmergency Heat.
0x0BPrecoolingPrecooling.
0x0COffClosed
0x0DManualManual.
0x0EAntiFreezeAnti Freeze.

HeaterCoolerPolarityEnum8

This enumeration defines the valid Present Value values for the HeaterCoolerPolarity Trait.

ValueNameDescription
0x00ForwardForward.
0x01ReverseReverse.
0x02BidirectionalBidirectional.

HomeKitPayloadTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the HomeKitPayload Trait.

Member IndexFieldTypeRequiredDescription
0QRCodecharacterStringRequiredQR Code.
1DigitalPairingCodecharacterStringRequiredDigital Pairing Code.

HomeStationCredentialsTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the HomeStationCredentials Trait.

Member IndexFieldTypeRequiredDescription
0SSIDcharacterStringRequiredSSID.
1CredentialscharacterStringRequiredCredentials.

HubConnectionStatusEnum8

This enumeration defines the valid Present Value values for the HubConnectionStatus Trait.

ValueNameDescription
0x00DisconnectedDisconnected.
0x01ConnectedConnected.

HumanRecognitionReportEnum8

This enumeration defines the valid Present Value values for the HumanRecognitionReport Trait.

ValueNameDescription
0x01HumanDetectedHuman Detected.

Identify Command Structure

Parameter structure for the Identify Command.

Member IndexFieldTypeRequiredDescription
0IdentifyTimefloatRequiredIdentify Time.

IdentifyTypeEnum8

This enumeration defines the valid Present Value values for the IdentifyType Trait.

ValueNameDescription
0x00NoneNone
0x01LightLight
0x02LEDIndicatorLEDIndicator
0x03AudibleBeepAudibleBeep
0x04DisplayDisplay
0x05ActuatorActuator

InstallationOrientationConfigurationEnum16

This enumeration defines the valid Present Value values for the InstallationOrientationConfiguration Trait.

ValueNameDescription
0x00HorizontalHorizontal.
0x01VerticalVertical.

InterfaceTypeEnum8

This enumeration defines the valid values for the Type field in NetworkInterfacesTraitPresentValueStructure.

ValueNameDescription
0x00UnspecifiedUnspecified
0x01WiFiWi Fi.
0x02EthernetEthernet.
0x03CellularCellular.
0x04ThreadThread.

IRKeyEnum32

This enumeration defines the valid Present Value values for the IRKey Trait.

ValueNameDescription
0x00ReservedReserved
0x01PowerPower
0x02ModeMode
0x03Temp+Temp+
0x04Temp-Temp-
0x05WindSpeedWindSpeed
0x25A5P_KEYP_KEY

IRTypeEnum8

This enumeration defines the valid Present Value values for the IRType Trait.

ValueNameDescription
0x00AirConditionerAirConditioner
0x01TVTV
0x02FanFan
0x03TVBoxTVBox
0x04ProjectorProjector
0x05SettopBoxSettopBox
0x06DVDDVD
0x07HeaterHeater
0x08AirPurifierAirPurifier
0x09SpeakerSpeaker
0x0ALightingLighting
0x0BCameraCamera
0x0CCustomizeCustomize

LEDICProtocolEnum8

This enumeration defines the valid Present Value values for the LEDICProtocol Trait.

ValueNameDescription
0x01SIDSID.

LEDTypeEnum8

This enumeration defines the valid Present Value values for the LEDType Trait.

ValueNameDescription
0x01RGBWRGBW

LightingDynamicSceneModeEnum8

This enumeration defines the valid Present Value values for the LightingDynamicSceneMode Trait.

ValueNameDescription
0x00BreathBreath.
0x01ForwardRainbowForward Rainbow.
0x02WaterFlowWater Flow.
0x03FlickerFlicker.
0x04JumpJump.
0x05ReverseRainbowReverse Rainbow.
0x06FloatingFloating.
0x07RunningRunning.

LightingModeSettingEnum8

This enumeration defines the valid Present Value values for the LightingModeSetting Trait.

ValueNameDescription
0x00LevelLevel.
0x01ColorTempColor Temp.
0x02RGBRGB.
This section defines the relevant fields and values.

LightingMusicSyncModeEnum8

This enumeration defines the valid Present Value values for the LightingMusicSyncMode Trait.

ValueNameDescription
0x00RandomRandom.
0x01BreathBreath.
0x02RainbowRainbow.
0x03WaterFlowWater Flow.

LimitPointSettingEnum8

This enumeration defines the valid Present Value values for the LimitPointSetting Trait.

ValueNameDescription
0x00ClearLimitPointsClear Limit Points.
0x01SetOpenLimitSet Open Limit.
0x02SetCloseLimitSet Close Limit.

LoadSafetyManagementEnum8

This enumeration defines the valid Present Value values for the LoadSafetyManagement Trait.

ValueNameDescription
0x00LoadNormalLoad Normal.
0x01OverLoadAnomalyOver Load Anomaly.
0x02OverLoadProtectionOver Load Protection.

LoadTypeEnum8

This enumeration defines the valid Present Value values for the LoadType Trait.

ValueNameDescription
0x00GeneralGeneral
0x01LinkableLinkable
0x02PulsedPulsed

LockDoor Command Structure

Parameter structure for the LockDoor Command.

Member IndexFieldTypeRequiredDescription
0CodecharacterStringOptionalCode.

LockOperationErrorTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the LockOperationError Trait.

Member IndexFieldTypeRequiredDescription
0LockOperationTypeenum8RequiredLock Operation Type.
1OperationSourceenum8RequiredOperation Source.
2OperationErrorenum8RequiredOperation Error.
3UserIndexuint16RequiredUser Index.
4FabricIDuint64RequiredFabric ID.
5SourceNodeuint64RequiredSource Node.
6Credentialslist[Struct]OptionalCredentials.

LockOperationTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the LockOperation Trait.

Member IndexFieldTypeRequiredDescription
0LockOperationTypeenum8RequiredLock Operation Type.
1OperationSourceenum8RequiredOperation Source.
2UserSourceenum8OptionalUser Source.
3UserIduint32OptionalUser Id.
4CredentialIduint32OptionalCredential Id.
5MatterVendorIduint16OptionalMatter Vendor Id.
6LockPositionenum8OptionalLock Position.

LockStateEnum8

This enumeration defines the valid Present Value values for the LockState Trait.

ValueNameDescription
0x00NotFullyLockedNot Fully Locked.
0x01LockedLocked.
0x02UnlockedUnlocked.

LockUserChangeTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the LockUserChange Trait.

Member IndexFieldTypeRequiredDescription
0LockDataTypeenum8RequiredLock Data Type.
1DataOperationTypeenum8RequiredData Operation Type.
2OperationSourceenum8RequiredOperation Source.
3UserIndexuint16RequiredUser Index.
4FabricIDuint64RequiredFabric ID.
5SourceNodeuint64RequiredSource Node.
6DataIndexuint16OptionalData Index.

MagicPairPayloadTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the MagicPairPayload Trait.

Member IndexFieldTypeRequiredDescription
0QRCodecharacterStringRequiredQR Code.
1DigitalPairingCodecharacterStringRequiredDigital Pairing Code.

ManualPullEventEnum32

This enumeration defines the valid Present Value values for the ManualPullEvent Trait.

ValueNameDescription
0x01ManualOpenManual Open.
0x02ManualCloseManual Close.
0x03ManualStopManual Stop.

MatterBindStateEnum8

This enumeration defines the valid Present Value values for the MatterBindState Trait.

ValueNameDescription
0x00UnboundUnbound
0x01BoundBound

MatterDACStateEnum8

This enumeration defines the valid Present Value values for the MatterDACState Trait.

ValueNameDescription
0x00LoadingDACLoadingDAC
0x01FailedDACFailedDAC
0x02ReadyDACReadyDAC

MatterPairingStateEnum8

This enumeration defines the valid Present Value values for the MatterPairingState Trait.

ValueNameDescription
0x00NonMatterPairingStateNon Matter Pairing State.
0x01MatterPairingStateMatter Pairing State.
0x02LimitExceededLimit Exceeded.
0x03InvalidDACInvalid DAC.
0x04UnderPreparationUnder Preparation.

MatterPayloadTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the MatterPayload Trait.

Member IndexFieldTypeRequiredDescription
0QRCodecharacterStringRequiredQR Code.
1DigitalPairingCodecharacterStringRequiredDigital Pairing Code.

MediaPlaybackCommand Command Structure

Parameter structure for the MediaPlaybackCommand Command.

Member IndexFieldTypeRequiredDescription
0MediaTypeenum8RequiredMedia Type.
1CommandcharacterStringOptionalCommand.
2TitlecharacterStringOptionalTitle.

MotionDetectedEnum8

This enumeration defines the valid Present Value values for the MotionDetected Trait.

ValueNameDescription
0x00EnterEnter.
0x01LeftLeft.
0x02LeftInLeft In.
0x03RightOutRight Out.
0x04RightInRight In.
0x05LeftOutLeft Out.
0x06AccessAccess.
0x07AwayAway.

MotorOperationStatusEnum8

This enumeration defines the valid Present Value values for the MotorOperationStatus Trait.

ValueNameDescription
0x00ClosingClosedFair
0x01OpeningOpenFair
0x02StoppedStopped.
0x03ObstacleStopObstacle Stop.
0x04ObstacleLimitAutoReboundObstacle Limit Auto Rebound.

MotorSpeedSettingEnum8

This enumeration defines the valid Present Value values for the MotorSpeedSetting Trait.

ValueNameDescription
0x00LowSpeedLow Speed.
0x01MediumSpeedMedium Speed.
0x02HighSpeedHigh Speed.

MoveToColorTemperature Command Structure

Parameter structure for the MoveToColorTemperature Command.

Member IndexFieldTypeRequiredDescription
0ColorTemperatureuint32RequiredColor Temperature.
1Timeint32OptionalTime.
2ExecuteIfOffbooleanOptionalExecute If Off.

MoveToColorTemperatureBrightness Command Structure

Parameter structure for the MoveToColorTemperatureBrightness Command.

Member IndexFieldTypeRequiredDescription
0ColorTemperatureuint32RequiredColor Temperature.
1LevelfloatRequiredLevel.
2Timeint32OptionalTime.
3ExecuteIfOffbooleanOptionalExecute If Off.

MoveToHueAndSaturation Command Structure

Parameter structure for the MoveToHueAndSaturation Command.

Member IndexFieldTypeRequiredDescription
0HuefloatRequiredHue.
1SaturationfloatRequiredSaturation.
2Timeint32OptionalTime.
3ExecuteIfOffbooleanOptionalExecute If Off.

MoveToHueSaturationBrightness Command Structure

Parameter structure for the MoveToHueSaturationBrightness Command.

Member IndexFieldTypeRequiredDescription
0HuefloatRequiredHue.
1SaturationfloatRequiredSaturation.
2LevelfloatRequiredLevel.
3Timeint32OptionalTime.
4ExecuteIfOffbooleanOptionalExecute If Off.

MoveToXYColor Command Structure

Parameter structure for the MoveToXYColor Command.

Member IndexFieldTypeRequiredDescription
0ColorXuint16RequiredColor X.
1ColorYuint16RequiredColor Y.
2Timeint32OptionalTime.
3ExecuteIfOffbooleanOptionalExecute If Off.

MoveToXYColorBrightness Command Structure

Parameter structure for the MoveToXYColorBrightness Command.

Member IndexFieldTypeRequiredDescription
0ColorXuint16RequiredColor X.
1ColorYuint16RequiredColor Y.
2LevelfloatRequiredLevel.
3Timeint32OptionalTime.
4ExecuteIfOffbooleanOptionalExecute If Off.

NetworkInterfacesTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the NetworkInterfaces Trait.

Member IndexFieldTypeRequiredDescription
0NamecharacterStringOptionalName.
1IsOperationalbooleanRequiredIs Operational.
2OffPremiseServicesReachableIPv4booleanOptionalOff Premise Services Reachable I Pv4.
3OffPremiseServicesReachableIPv6booleanOptionalOff Premise Services Reachable I Pv6.
4HardwareAddresscharacterStringRequiredHardware Address.
5IPv4Addresseslist[characterString]OptionalI Pv4 Addresses.
6IPv6Addresseslist[characterString]OptionalI Pv6 Addresses.
7TypeInterfaceTypeEnum8RequiredType.
8RSSIint8OptionalRSSI.
9AddressingModeAddressingModeEnum8OptionalAddressing Mode.
10SSIDcharacterStringOptionalSSID.
11BSSIDcharacterStringOptionalBSSID.
12RouterMACcharacterStringOptionalRouter MAC.
13Channeluint8OptionalChannel.
14SubnetMaskcharacterStringOptionalSubnet Mask.
15DefaultGatewaycharacterStringOptionalDefault Gateway.
16PrimaryDNScharacterStringOptionalPrimary DNS.
17SecondaryDNScharacterStringOptionalSecondary DNS.

NightLightModeEnum8

This enumeration defines the valid Present Value values for the NightLightMode Trait.

ValueNameDescription
0x00OffOff.
0x01OnOn.
0x02AutoAuto.

ObjectOrientationStateEnum8

This enumeration defines the valid Present Value values for the ObjectOrientationState Trait.

ValueNameDescription
0x01HorizontalUpHorizontal Up.
0x02HorizontalDownHorizontal Down.
0x03VerticalVertical.
0x04TiltedTilted.

ObstacleLimitSensitivityEnum8

This enumeration defines the valid Present Value values for the ObstacleLimitSensitivity Trait.

ValueNameDescription
0x00LowLow.
0x01MediumLowMedium Low.
0x02MediumMedium.
0x03MediumHighMedium High.
0x04HighHigh.

OccupancySensorTypeEnum8

This enumeration defines the valid Present Value values for the OccupancySensorType Trait.

ValueNameDescription
0x00PIRPIR.
0x01UltrasonicUltrasonic.
0x02PIRAndUltrasonicPIR And Ultrasonic.
0x03PhysicalContactPhysical Contact.
0x04RadarRadar.
0x05VisionVision.

OperatingModeEnum8

This enumeration defines the valid Present Value values for the OperatingMode Trait.

ValueNameDescription
0x00NormalNormal
0x01VacationVacation
0x02PrivacyPrivacy
0x03NoRemoteLockUnlockNoRemoteLockUnlock
0x04PassagePassage

OperationalErrorEnum16

This enumeration defines the valid Present Value values for the OperationalError Trait.

ValueNameDescription
0x00NoErrorNo Error.
0x01UnableToStartOrResumeUnable To Start Or Resume.
0x02UnableToCompleteOperationUnable To Complete Operation.
0x03CommandInvalidInStateCommand Invalid In State.

OperationalStateEnum16

This enumeration defines the valid Present Value values for the OperationalState Trait.

ValueNameDescription
0x00StoppedStopped.
0x01RunningRunning.
0x02PausedPaused.
0x03ErrorError.

OutputNodeModeEnum32

This enumeration defines the valid Present Value values for the OutputNodeMode Trait.

ValueNameDescription
0x00WetModeWet Mode.
0x01DryPulseNormallyClosedDry Pulse Normally Closed.
0x02DryPulseNormallyOpenDry Pulse Normally Open.
0x03DryToggleModeDry Toggle Mode.

OutputSwitchingTypeEnum8

This enumeration defines the valid Present Value values for the OutputSwitchingType Trait.

ValueNameDescription
0x01NonResettableSwitchNon Resettable Switch.
0x02MomentaryPushSwitchMomentary Push Switch.
0x03ActiveLowCloseRelayActive Low Close Relay.
0x04InsertCardOnModeInsert Card On Mode.
0x05InsertCardOffModeInsert Card Off Mode.

OverCurrentResponseSettingEnum8

This enumeration defines the valid Present Value values for the OverCurrentResponseSetting Trait.

ValueNameDescription
0x00ShutdownSingleShutdown Single.
0x01ShutdownAllShutdown All.

PackageRecognitionReportEnum8

This enumeration defines the valid Present Value values for the PackageRecognitionReport Trait.

ValueNameDescription
0x01PackageAppearedPackage Appeared.
0x02PackageDisappearedPackage Disappeared.

PanTiltDirectionControl Command Structure

Parameter structure for the PanTiltDirectionControl Command.

Member IndexFieldTypeRequiredDescription
0Directionuint8RequiredDirection.

PetRecognitionReportEnum16

This enumeration defines the valid Present Value values for the PetRecognitionReport Trait.

ValueNameDescription
0x01CatDetectedCat Detected.
0x02DogDetectedDog Detected.
0x03CatOrDogDetectedCat Or Dog Detected.

PlaybackModeEnum8

This enumeration defines the valid Present Value values for the PlaybackMode Trait.

ValueNameDescription
0x00ShuffleShuffle
0x01OrderOrder
0x02SingleCycleSingleCycle
0x03AllCycleAllCycle

PM2.5LevelEnum8

This section defines the relevant fields and values.

ValueNameDescription
0x00UnknownUnknown
0x01ExcellentExcellent
0x02GoodGood.
0x03FairFair.
0x04InferiorInferior
0x05PoorPoor

PowerModeEnum8

This enumeration defines the valid Present Value values for the PowerMode Trait.

ValueNameDescription
0x00UnknownUnknown
0x01MainsMains.
0x02BatteryBattery.
0x03DCSourceDC Source.
0x04ACSourceAC Source.

PreOperationModeEnum8

This enumeration defines the valid Present Value values for the PreOperationMode Trait.

ValueNameDescription
0x00UnjoinedModeUnjoined Mode.
0x01NewlyJoinedModeNewly Joined Mode.
0x02PollingModePolling Mode.
0x03UserModeUser Mode.
0x04DegradedModeDegraded Mode.
0x05RejoinModeRejoin Mode.

PresenceConfigurationTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the PresenceConfiguration Trait.

Member IndexFieldTypeRequiredDescription
0HubListlist[characterString]RequiredHub List.
1EventsStructOptionalEvents.
2StatesStructOptionalStates.
3EntriescharacterStringOptionalEntries.
4Configuint32OptionalConfig.

PresenceEnum8

This enumeration defines the valid Present Value values for the Presence Trait.

ValueNameDescription
0x00UnknownUnknown
0x01NoHumanDetectedNo Human Detected.
0x02HumanDetectedHuman Detected.

PresetTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the Preset Trait.

Member IndexFieldTypeRequiredDescription
0PresetHandlecharacterStringRequiredPreset Handle.
1PresetScenarioenum8RequiredPreset Scenario.
2NamecharacterStringOptionalName.
3CoolingSetpointfloatOptionalCooling Setpoint.
4HeatingSetpointfloatOptionalHeating Setpoint.
5BuiltInbooleanRequiredBuilt In.

PreviewEffect Command Structure

Parameter structure for the PreviewEffect Command.

Member IndexFieldTypeRequiredDescription
0EffectDatacharacterStringRequiredEffect Data.

PreviewTransition Command Structure

Parameter structure for the PreviewTransition Command.

Member IndexFieldTypeRequiredDescription
0OnTransitionTimeuint16RequiredOn Transition Time.
1OffTransitionTimeuint16RequiredOff Transition Time.
2DimmingCurvaturefloatRequiredDimming Curvature.
3InitialBrightnessuint8RequiredInitial Brightness.

Reboot Command Structure

Parameter structure for the Reboot Command.

Member IndexFieldTypeRequiredDescription
0RebootTypeenum8RequiredReboot Type.
1Delayuint32OptionalDelay.

RebootReasonEnum8

This enumeration defines the valid Present Value values for the RebootReason Trait.

ValueNameDescription
0x00UnspecifiedUnknown
0x01PowerOnRebootPower On Reboot.
0x02BrownOutResetBrown Out Reset.
0x03SoftwareWatchdogResetSoftware Watchdog Reset.
0x04HardwareWatchdogResetHardware Watchdog Reset.
0x05SoftwareUpdateCompletedSoftware Update Completed.
0x06SoftwareResetSoftware Reset.

RemoveUserDefinedEffect Command Structure

Parameter structure for the RemoveUserDefinedEffect Command.

Member IndexFieldTypeRequiredDescription
0EffectIDuint8RequiredEffect ID.

ResetModeEnum8

This enumeration defines the valid Present Value values for the ResetMode Trait.

ValueNameDescription
0x01FactoryResetFactory Reset.
0x02NetworkResetNetwork Reset.
0x03ConfigurationsResetConfigurations Reset.
0x04PSWResetPSW Reset.

RingtonePlayIndexEnum32

This enumeration defines the valid Present Value values for the RingtonePlayIndex Trait.

ValueNameDescription
0x00PoliceCar1Police Car1.
0x01PoliceCar2Police Car2.
0x02SafetyAccidentSafety Accident.
0x03MissileCountdownMissile Countdown.
0x04GhostSoundGhost Sound.
0x05SniperRifleSniper Rifle.
0x06IntenseBattleIntense Battle.
0x07AirRaidSirenAir Raid Siren.
0x08DogBarkDog Bark.
0x0ADoorbellDoorbell.
0x0BKnockKnock.
0x0CFunnyFunny.
0x0DAlarmClockAlarm Clock.
0x0EArmingArming.
0x0FDisarmingDisarming.
0x14MiMixMiMix
0x15EnthusiasticEnthusiastic
0x16GuitarClassicGuitarClassic
0x17IceWorldPianoIceWorldPiano
0x18LeisureTimeLeisureTime
0x19ChildhoodChildhood
0x1AMorningStreamIetMorningStreamIet
0x1BMusixBoxMusixBox
0x1COrangeOrange
0x2710DefaultRingtoneDefault Ringtone.

RingtonePlayStatusEnum8

This enumeration defines the valid Present Value values for the RingtonePlayStatus Trait.

ValueNameDescription
0x00StoppedStopped.
0x01PlayingPlaying.

RockSettingEnum8

This enumeration defines the valid Present Value values for the RockSetting Trait.

ValueNameDescription
0x00OffClosed
0x01RockLeftRightRock Left Right.
0x02RockUpDownRock Up Down.
0x03RockRoundRock Round.
0x04SwingSwing.
0x05FixedDirectionFixed Direction.
0x15FixedFixed.

RotationControl Command Structure

Parameter structure for the RotationControl Command.

Member IndexFieldTypeRequiredDescription
0Directionenum8RequiredDirection.

RotationDirectionEnum8

This enumeration defines the valid Present Value values for the RotationDirection Trait.

ValueNameDescription
0x00ClockwiseClockwise
0x01CounterClockwiseCounterClockwise

RotationEventEnum8

This enumeration defines the valid Present Value values for the RotationEvent Trait.

ValueNameDescription
0x00RotateRotate.
0x01HoldToRotateHold To Rotate.
0x02InvertedRotateInverted Rotate.

SelectedMediaOutputSourceEnum8

This enumeration defines the valid Present Value values for the SelectedMediaOutputSource Trait.

ValueNameDescription
0x00InternalInternal.
0x01BluetoothBluetooth.
0x02AuxAux.
0x03SPDIFSPDIF
0x04CoaxialCoaxial.
0x05Audio1Audio1.
0x06Audio2Audio2.
0x07Audio3Audio3.
0x08AV1AV1
0x09AV2AV2
0x0AAV3AV3
0x0BHDMI1HDMI1
0x0CHDMI2HDMI2
0x0DHDMI3HDMI3
0x0EOtherOther.

SelectedSourceEnum8

This enumeration defines the valid Present Value values for the SelectedSource Trait.

ValueNameDescription
0x00InternalInternal
0x01BluetoothBluetooth
0x02ExternalExternal

SelectInput Command Structure

Parameter structure for the SelectInput Command.

Member IndexFieldTypeRequiredDescription
0MediaInputuint8RequiredMedia Input.

SendIRCode Command Structure

Parameter structure for the SendIRCode Command.

Member IndexFieldTypeRequiredDescription
0Modeenum8RequiredMode.
1BrandIduint32RequiredBrand Id.
2RemoteIduint32RequiredRemote Id.
3IRCodecharacterStringOptionalIR Code.
4IRCodeLengthuint16OptionalIR Code Length.
5ACKeycharacterStringOptionalAC Key.
6Frequencyuint32RequiredFrequency.

SetActivePreset Command Structure

Parameter structure for the SetActivePreset Command.

Member IndexFieldTypeRequiredDescription
0PresetHandlecharacterStringRequiredPreset Handle.

SetBrightness Command Structure

Parameter structure for the SetBrightness Command.

Member IndexFieldTypeRequiredDescription
0LevelfloatRequiredLevel.
1Timeint32OptionalTime.
2ExecuteIfOffbooleanOptionalExecute If Off.

SetBrightnessWithOnOff Command Structure

Parameter structure for the SetBrightnessWithOnOff Command.

Member IndexFieldTypeRequiredDescription
0LevelfloatRequiredLevel.
1Timeint32OptionalTime.

SetWeekDaySchedule Command Structure

Parameter structure for the SetWeekDaySchedule Command.

Member IndexFieldTypeRequiredDescription
0WeekDayIndexuint8RequiredWeek Day Index.
1UserIndexuint16RequiredUser Index.
2DaysMaskenum8RequiredDays Mask.
3StartHouruint8RequiredStart Hour.
4StartMinuteuint8RequiredStart Minute.
5EndHouruint8RequiredEnd Hour.
6EndMinuteuint8RequiredEnd Minute.

SetYearDaySchedule Command Structure

Parameter structure for the SetYearDaySchedule Command.

Member IndexFieldTypeRequiredDescription
0YearDayIndexuint8RequiredYear Day Index.
1UserIndexuint16RequiredUser Index.
2LocalStartTimeuint64RequiredLocal Start Time.
3LocalEndTimeuint64RequiredLocal End Time.

SleepStageEnum8

This enumeration defines the valid Present Value values for the SleepStage Trait.

ValueNameDescription
0x00LightSleepLightSleep
0x01DeepSleepDeepSleep
0x02REMREM

SleepStateEnum8

This enumeration defines the valid Present Value values for the SleepState Trait.

ValueNameDescription
0x00UnknownUnknown
0x01AwakeAwake.
0x02SleepSleep.

SmokeChamberContaminationEnum8

This enumeration defines the valid Present Value values for the SmokeChamberContamination Trait.

ValueNameDescription
0x00NormalNormal.
0x01ContaminatedContaminated.

SmokeStateEnum8

This enumeration defines the valid Present Value values for the SmokeState Trait.

ValueNameDescription
0x00NormalNormal
0x01WarningWarning
0x02CriticalCritical.

StartEffect Command Structure

Parameter structure for the StartEffect Command.

Member IndexFieldTypeRequiredDescription
0EffectIDenum8RequiredEffect ID.

StartUpOnOffEnum8

This enumeration defines the valid Present Value values for the StartUpOnOff Trait.

ValueNameDescription
0x00OffOff.
0x01OnOn.
0x02ToggleToggle.
0x03HoldHold.

StartUpXYColorTraitPresentValueStructure

StateOfLowBatEnum8

This enumeration defines the valid Present Value values for the StateOfLowBat Trait.

ValueNameDescription
0x00FalseFalse.
0x01TrueTrue.
0x02CriticalCritical.

StationaryStateEnum8

This enumeration defines the valid Present Value values for the StationaryState Trait.

ValueNameDescription
0x00InMotionIn Motion.
0x01StationaryStationary.

StepBrightness Command Structure

Parameter structure for the StepBrightness Command.

Member IndexFieldTypeRequiredDescription
0SizefloatRequiredSize.
1Timeint32OptionalTime.
2ExecuteIfOffbooleanOptionalExecute If Off.

StepBrightnessWithOnOff Command Structure

Parameter structure for the StepBrightnessWithOnOff Command.

Member IndexFieldTypeRequiredDescription
0SizefloatRequiredSize.
1Timeint32OptionalTime.

StepColorTemperature Command Structure

Parameter structure for the StepColorTemperature Command.

Member IndexFieldTypeRequiredDescription
0Sizeint32RequiredSize.
1Timeint32OptionalTime.
2ExecuteIfOffbooleanOptionalExecute If Off.

StepPosition Command Structure

Parameter structure for the StepPosition Command.

Member IndexFieldTypeRequiredDescription
0SizefloatRequiredSize.
1Timeint32OptionalTime.

SweeperStateEnum8

This enumeration defines the valid Present Value values for the SweeperState Trait.

ValueNameDescription
0x00CleaningCleaning.
0x01PausedPaused.
0x02NotCleaningNot Cleaning.

TargetGarageDoorStateEnum8

This enumeration defines the valid Present Value values for the TargetGarageDoorState Trait.

ValueNameDescription
0x00ClosedClosed
0x01OpenOpen

TargetPlaybackStateEnum8

This enumeration defines the valid Present Value values for the TargetPlaybackState Trait.

ValueNameDescription
0x00PlayPlay.
0x01PausePause.
0x02StopStop.
0x03StartOverStart Over.
0x04FastForwardFast Forward.
0x05RewindRewind.
0x06PreviousPrevious.
0x07NextNext.
0x08PlaySpecificListPlay Specific List.

TemperatureSafetyManagementEnum8

This enumeration defines the valid Present Value values for the TemperatureSafetyManagement Trait.

ValueNameDescription
0x00TempNormalTemp Normal.
0x01OverTempAnomalyOver Temp Anomaly.
0x02OverTempProtectionOver Temp Protection.
0x0BUnderTempAnomalyUnder Temp Anomaly.

TemperatureUIDisplayModeEnum8

This enumeration defines the valid Present Value values for the TemperatureUIDisplayMode Trait.

ValueNameDescription
0x00CelsiusCelsius.
0x01FahrenheitFahrenheit.

ThreadDiagnosticsTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the ThreadDiagnostics Trait.

Member IndexFieldTypeRequiredDescription
0Channeluint8RequiredChannel.
1ExtendedPANIDuint64RequiredExtended PANID.
2NetworkKeyoctetStringRequiredNetwork Key.
3NetworkNamecharacterStringRequiredNetwork Name.
4PANIDuint16RequiredPANID.
5PSKcoctetStringRequiredPS Kc.
6ActiveTimeStampuint64RequiredActive Time Stamp.
7SecurityPolicycharacterStringRequiredSecurity Policy.
8OperationalDatasetoctetStringRequiredOperational Dataset.
9RSSIint8OptionalRSSI.
10LQIuint8OptionalLQI.
11BorderAgentIDoctetStringOptionalBorder Agent ID.
12MeshLocalPrefixcharacterStringOptionalMesh Local Prefix.
13CommissionerCredentialcharacterStringOptionalCommissioner Credential.
14VersioncharacterStringOptionalVersion.
15Roleuint8OptionalRole.

TopFaceChangedEnum8

This enumeration defines the valid Present Value values for the TopFaceChanged Trait.

ValueNameDescription
0x00Face 1 UpFace 1 Up.
0x01Face 2 UpFace 2 Up.
0x02Face 3 UpFace 3 Up.
0x03Face 4 UpFace 4 Up.
0x04Face 5 UpFace 5 Up.
0x05Face 6 UpFace 6 Up.

TopFaceEnum8

This enumeration defines the valid Present Value values for the TopFace Trait.

ValueNameDescription
0x00Face 1 UpFace 1 Up.
0x01Face 2 UpFace 2 Up.
0x02Face 3 UpFace 3 Up.
0x03Face 4 UpFace 4 Up.
0x04Face 5 UpFace 5 Up.
0x05Face 6 UpFace 6 Up.

TriggerWarning Command Structure

Parameter structure for the TriggerWarning Command.

Member IndexFieldTypeRequiredDescription
0Warningenum8RequiredWarning.

TriggerZigbeeNetworkInfoUpload Command Structure

Parameter structure for the TriggerZigbeeNetworkInfoUpload Command.

Member IndexFieldTypeRequiredDescription
0InstallCodecharacterStringRequiredInstall Code.
1MACcharacterStringRequiredMAC.

UnboltDoor Command Structure

Parameter structure for the UnboltDoor Command.

Member IndexFieldTypeRequiredDescription
0CodecharacterStringOptionalCode.

UnlockDoor Command Structure

Parameter structure for the UnlockDoor Command.

Member IndexFieldTypeRequiredDescription
0CodecharacterStringOptionalCode.

UpdateUserDefinedEffect Command Structure

Parameter structure for the UpdateUserDefinedEffect Command.

Member IndexFieldTypeRequiredDescription
0EffectIDuint8RequiredEffect ID.
1EffectDatacharacterStringRequiredEffect Data.

UserDefinedEffectsTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the UserDefinedEffects Trait.

Member IndexFieldTypeRequiredDescription
0EffectIDuint8RequiredEffect ID.
1EffectNamecharacterStringRequiredEffect Name.

VacuumOperationalErrorEnum16

This enumeration defines the valid Present Value values for the VacuumOperationalError Trait.

ValueNameDescription
0x00NoErrorNo Error.
0x01UnableToStartOrResumeUnable To Start Or Resume.
0x02UnableToCompleteOperationUnable To Complete Operation.
0x03CommandInvalidInStateCommand Invalid In State.
0x40FailedToFindChargingDockFailed To Find Charging Dock.
0x41StuckStuck.
0x42DustBinMissingDust Bin Missing.
0x43DustBinFullDust Bin Full.
0x44WaterTankEmptyWater Tank Empty.
0x45WaterTankMissingWater Tank Missing.
0x46WaterTankLidOpenWater Tank Lid Open.
0x47MopCleaningPadMissingMop Cleaning Pad Missing.

VacuumOperationalStateEnum16

This enumeration defines the valid Present Value values for the VacuumOperationalState Trait.

ValueNameDescription
0x00StoppedStopped.
0x01RunningRunning.
0x02PausedPaused.
0x03ErrorError.
0x40SeekingChargerSeeking Charger.
0x41ChargingCharging.
0x42DockedDocked.

VehicleDetectedEnum8

This enumeration defines the valid Present Value values for the VehicleDetected Trait.

ValueNameDescription
0x01VehicleDetectedVehicle Detected.

VibrationEventEnum8

This enumeration defines the valid Present Value values for the VibrationEvent Trait.

ValueNameDescription
0x00ThreeKnocksThree Knocks.
0x01MoveMove.
0x02VibrateVibrate.
0x03TiltTilt.
0x04FreeFallFree Fall.

VOCQualityEnum8

This enumeration defines the valid Present Value values for the VOCQuality Trait.

ValueNameDescription
0x00UnknownUnknown
0x01ExcellentExcellent
0x02GoodGood.
0x03FairFair.
0x04InferiorInferior
0x05PoorPoor

VoiceLanguageEnum8

This enumeration defines the valid Present Value values for the VoiceLanguage Trait.

ValueNameDescription
0x01ChineseChinese.
0x02EnglishEnglish.
0x03CantoneseCantonese.
0x04SpanishSpanish.
0x05RussianRussian.
0x06KoreanKorean.
0x07PortugueseBRPortuguese BR.
0x08GermanGerman.
0x09FrenchFrench.
0x0AItalianItalian.
0x0BJapaneseJapanese.
0x0CPolishPolish.
0x0DCzechCzech.
0x0ESlovakSlovak.
0x0FTurkishTurkish.
0x10HungarianHungarian.
0x11DutchDutch.
0x12GreekGreek.
0x13ArabicArabic.

VoltageSafetyManagementEnum8

This enumeration defines the valid Present Value values for the VoltageSafetyManagement Trait.

ValueNameDescription
0x00VoltageNormalVoltage Normal.
0x01OverVoltageAnomalyOver Voltage Anomaly.
0x02OverVoltageProtectionOver Voltage Protection.
0x03UnderVoltageProtectionUnder Voltage Protection.

WhitePointXYPresentValueStructure

This structure defines the layout of the Present Value fields for WhitePointXY.

Member IndexFieldTypeRequiredDescription
0WhitePointXuint16RequiredWhite Point X.
1WhitePointYuint16RequiredWhite Point Y.

WidgetPositionStructure

This structure defines the layout of the WidgetPosition field in Widget.

Member IndexFieldTypeRequiredDescription
0xuint16RequiredX.
1yuint16RequiredY.
2widthuint16RequiredWidth.
3heightuint16RequiredHeight.

WiFiDiagnosticsTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the WiFiDiagnostics Trait.

Member IndexFieldTypeRequiredDescription
0BSSIDcharacterStringRequiredBSSID.
1Encryptionuint8OptionalEncryption.
2Versionuint8OptionalVersion.
3Channeluint8RequiredChannel.
4RSSIint8RequiredRSSI.
5NetworkNamecharacterStringRequiredNetwork Name.
6IPV4AddresscharacterStringOptionalIPV4 Address.
7IPV6AddresscharacterStringOptionalIPV6 Address.
8SubnetMaskcharacterStringOptionalSubnet Mask.
9GatewaycharacterStringOptionalGateway.
10DNScharacterStringOptionalDNS.
11AlternateDNScharacterStringOptionalAlternate DNS.

WindowCoveringCategoryEnum8

This enumeration defines the valid Present Value values for the WindowCoveringCategory Trait.

ValueNameDescription
0x00RollerShadeRoller Shade.
0x01RollerShade2MotorRoller Shade2 Motor.
0x02RollerShadeExteriorRoller Shade Exterior.
0x03RollerShadeExterior2MotorRoller Shade Exterior2 Motor.
0x04DraperyDrapery.
0x05AwningAwning.
0x06ShutterShutter.
0x07TiltBlindTiltOnlyTilt Blind Tilt Only.
0x08TiltBlindLiftAndTiltTilt Blind Lift And Tilt.
0x09ProjectorScreenProjector Screen.
0xFFUnknownUnknown

WindowCoveringOpenOrientationEnum8

This enumeration defines the valid Present Value values for the WindowCoveringOpenOrientation Trait.

ValueNameDescription
0x00LeftRightLeft Right.
0x01LeftToRightLeft To Right.
0x02RightToLeftRight To Left.
0x03UpUp.
0x04HorizontalHorizontal.
0x05VerticalVertical.

WindowCoveringTypeEnum8

This enumeration defines the valid Present Value values for the WindowCoveringType Trait.

ValueNameDescription
0x00RollerShadeRoller Shade.
0x01VenetianBlindVenetian Blind.
0x02ShangrilaBlindShangrila Blind.
0x03ZebraBlindZebra Blind.
0x04CurtainCurtain.
0x05VerticalVenetianBlindVertical Venetian Blind.
0x1FRomanShadeRoman Shade.
0x20BalloonShadeBalloon Shade.
0x21WovenWoodWoven Wood.
0x22PleatedShadePleated Shade.
0x23CellularShadeCellular Shade.
0x24LayeredShadeLayered Shade.
0x25LayeredShade2DLayered Shade2 D.
0x26SheerShadeSheer Shade.
0x27TiltOnlyInteriorBlindTilt Only Interior Blind.
0x28InteriorBlindInterior Blind.
0x29VerticalBlindStripCurtainVertical Blind Strip Curtain.
0x2AInteriorVenetianBlindInterior Venetian Blind.
0x2BExteriorVenetianBlindExterior Venetian Blind.
0x2CLateralLeftCurtainLateral Left Curtain.
0x2DLateralRightCurtainLateral Right Curtain.
0x2ECentralCurtainCentral Curtain.
0x2FRollerShutterRoller Shutter.
0x30ExteriorVerticalScreenExterior Vertical Screen.
0x31AwningTerracePatioAwning Terrace Patio.
0x32AwningVerticalScreenAwning Vertical Screen.
0x33TiltOnlyPergolaTilt Only Pergola.
0x34SwingingShutterSwinging Shutter.
0x35SlidingShutterSliding Shutter.
0xFFUnknownUnknown

WindSettingEnum8

This enumeration defines the valid Present Value values for the WindSetting Trait.

ValueNameDescription
0x00NormalNormal
0x01SleepSleep
0x02NaturalNatural.

ZigbeeDiagnosticsTraitPresentValueStructure

This structure defines the layout of the Present Value fields for the ZigbeeDiagnostics Trait.

Member IndexFieldTypeRequiredDescription
0Channeluint8RequiredChannel.
1ExtendedPANIDuint64RequiredExtended PANID.
2NetworkKeyoctetStringRequiredNetwork Key.
3NetworkNamecharacterStringRequiredNetwork Name.
4PANIDuint16RequiredPANID.
5RSSIint8OptionalRSSI.
6LQIuint8OptionalLQI.