MCUXpresso SDK Documentation

Version: 25.12.00 25.12.00-pvw2 25.12.00-pvw1 25.09.00 25.09.00-pvw2 latest

Open on Repo Open an Issue

Source (.md/.rst) Page PDF (.pdf)

JNUG3132

Table of Contents

• Preface
  • Introduction
  • Prerequisites
  • Chip Compatibility
  • Organization
  • Conventions
  • Acronyms
  • Related Documents
  • Support Resources
• Part I: Fundamentals
• ZigBee Cluster Library (ZCL)
  • ZCL Member Clusters
    • General
    • Measurement and Sensing
    • Lighting
    • Heating, Ventilation, and Air-Conditioning (HVAC)
    • Closures
    • Security and Safety
    • Smart Energy
    • Commissioning
    • Appliances
    • Over-The-Air (OTA) Upgrade
  • General ZCL Resources
  • ZCL Compile-time Options
    • Enabled Clusters
    • Support for Attribute Read/Write
    • Optional Attributes
    • Number of Endpoints
    • Default Responses
    • APS Acknowledgements
    • Cooperative Tasks
    • Parameter Checking
    • ‘Wild Card’ Profile
• ZCL Fundamentals and Features
  • Initializing the ZCL
  • Shared Device Structures
  • Accessing Attributes
    • Attribute Access Permissions
    • Reading Attributes
      • Reading a set of attributes of a remote cluster
      • Reading an Attribute of a Local Cluster
    • Writing Attributes
      • Writing to Attributes of a Remote Cluster
      • Writing an Attribute Value to a Local Cluster
    • Attribute Discovery
      • Compile-time Options
      • Application Coding
    • Attribute Reporting
  • Global Attributes
    • ClusterRevision
    • AttributeReportingStatus
  • Default Responses
  • Handling Commands for Unsupported Clusters
  • Handling Commands from Other Manufacturers
  • Bound Transmission Management
    • Compile-time Options
  • Command Discovery
    • Discovering Command Sets
      • Discovering commands that can be received
      • Discovering commands that can be generated
    • Compile-time Options
• Event Handling
  • Event Structure
  • Processing Events
  • Events
    • Input Events
    • Read Events
    • Write Events
    • General Events
• Error Handling
  • Last Stack Error
  • Error/Command Status on Receiving Command
• Part II: Common Resources
• ZCL Functions
  • General Functions
    • eZCL_Initialise
      • Description
      • Parameters
      • Returns
    • eZCL_Register
      • Description
      • Parameters
      • Returns
    • vZCL_EventHandler
      • Description
      • Parameters
      • Returns
    • eZCL_Update100mS
      • Description
      • Parameters
      • Returns
    • vZCL_DisableAPSACK
      • Description
      • Parameters
      • Returns
    • eZCL_GetLastZpsError
      • Description
      • Parameters
      • Returns
    • vZCL_RegisterHandleGeneralCmdCallBack
      • Description
      • Parameters
      • Returns
    • vZCL_RegisterCheckForManufCodeCallBack
      • Description
      • Parameters
      • Returns
  • Attribute Access Functions
    • eZCL_SendReadAttributesRequest
      • Description
      • Parameters
      • Returns
    • eZCL_SendWriteAttributesRequest
      • Description
      • Parameters
      • Returns
    • eZCL_SendWriteAttributesNoResponseRequest
      • Description
      • Parameters
      • Returns
    • eZCL_SendWriteAttributesUndividedRequest
      • Description
      • Parameters
      • Returns
    • eZCL_SendDiscoverAttributesRequest
      • Description
      • Parameters
      • Returns
    • eZCL_SendDiscoverAttributesExtendedRequest
      • Description
      • Parameters
      • Returns
    • eZCL_SendConfigureReportingCommand
      • Description
      • Parameters
      • Returns
    • eZCL_SendReadReportingConfigurationCommand
      • Description
      • Parameters
      • Returns
    • eZCL_ReportAllAttributes
      • Description
      • Parameters
      • Returns
    • eZCL_ReportAttribute
      • Description
      • Parameters
      • Returns
    • eZCL_CreateLocalReport
      • Description
      • Parameters
      • Returns
    • eZCL_SetReportableFlag
      • Description
      • Parameters
      • Returns
    • vZCL_SetDefaultReporting
      • Description
      • Parameters
      • Returns
    • eZCL_HandleReadAttributesResponse
      • Description
      • Parameters
      • Returns
    • • Description
      • Parameters
      • Returns
    • eZCL_WriteLocalAttributeValue
      • Description
      • Parameters
      • Returns
    • eZCL_OverrideClusterControlFlags
      • Description
      • Parameters
      • Returns
    • eZCL_SetSupportedSecurity
      • Description
      • Parameters
      • Returns
  • Command Discovery Functions
    • eZCL_SendDiscoverCommandReceivedRequest
      • Description
      • Parameters
      • Returns
    • eZCL_SendDiscoverCommandGeneratedRequest
      • Description
      • Parameters
      • Returns
• ZCL Structures
  • General Structures
    • tsZCL_EndPointDefinition
    • tsZCL_ClusterDefinition
    • tsZCL_AttributeDefinition
    • tsZCL_Address
    • tsZCL_AttributeReportingConfigurationRecord
    • tsZCL_AttributeReportingConfigurationResponse
    • tsZCL_AttributeReadReportingConfigurationRecord
    • tsZCL_IndividualAttributesResponse
    • tsZCL_DefaultResponse
    • tsZCL_AttributeDiscoveryResponse
    • tsZCL_AttributeDiscoveryExtendedResponse
    • tsZCL_ReportAttributeMirror
    • tsZCL_OctetString
    • tsZCL_CharacterString
    • tsZCL_ClusterCustomMessage
    • tsZCL_ClusterInstance
    • tsZCL_CommandDiscoveryIndividualResponse
    • tsZCL_CommandDiscoveryResponse
    • tsZCL_CommandDefinition
    • tsZCL_SceneExtensionTable
    • tsZCL_WriteAttributeRecord
  • Event Structure (tsZCL_CallBackEvent)
• Enumerations and Status Codes
  • General Enumerations
    • Addressing Modes (teZCL_AddressMode)
    • Broadcast Modes (ZPS_teAplAfBroadcastMode)
    • Attribute Types (teZCL_ZCLAttributeType)
    • Command Status (teZCL_CommandStatus)
    • Report Attribute Status (teZCL_ReportAttributeStatus)
    • Security Level (teZCL_ZCLSendSecurity)
  • General Return codes (ZCL Status)
  • ZCL Event Enumerations
• Part III: General Clusters
• Basic Cluster
  • Overview
  • Basic Cluster structure and attributes
  • Mandatory Attribute Settings
  • Functions
    • eCLD_BasicCreateBasic
      • Description
      • Parameters
      • Returns
    • eCLD_BasicCommandResetToFactoryDefaultsSend
      • Description
      • Parameters
      • Returns
  • Enumerations
    • teCLD_BAS_ClusterID
    • teCLD_BAS_PowerSource
    • teCLD_BAS_GenericDeviceClass
    • eCLD_BAS_GenericDeviceType
    • teCLD_BAS_PhysicalEnvironment
  • Compile-time options
    • Optional Attributes
    • Global Attributes
    • Optional Commands
    • Product Code Length
    • Product URL Length
• Power Configuration Cluster
  • Overview
  • Power Configuration Cluster structure and attributes
    • Mains Information Attribute Set
    • Mains Settings Attribute Set
    • Battery Information Attribute Set (Battery 1)
    • Battery Settings Attribute Set (Battery 1)
    • Global Attribute Set
  • Attributes for Default Reporting
  • Functions
    • eCLD_PowerConfigurationCreatePowerConfiguration
      • Description
      • Parameters
      • Returns
  • Enumerations and Defines
    • teCLD_PWRCFG_AttributeId
    • teCLD_PWRCFG_BatterySize
    • Defines for Voltage Alarms
      • Mains Alarm Mask
      • Battery Alarm Mask
  • Compile-time options
    • Optional Attributes
    • Global Attributes
• Device Temperature Configuration Cluster
• Identify Cluster
  • Overview
  • Identify Cluster Structure and Attribute
  • Initialization
  • Sending Commands
    • Starting and Stopping Identification Mode
    • Requesting Identification Effects
    • Inquiring about Identification Mode
    • Using EZ-mode Commissioning Features
      • ‘EZ-mode Invoke’ Command
      • ‘Commissioning State’ Attribute
  • Sleeping Devices in Identification Mode
  • Functions
    • eCLD_IdentifyCreateIdentify
      • Description
      • Parameters
      • Returns
    • eCLD_IdentifyCommandIdentifyRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_IdentifyCommandTriggerEffectSend
      • Description
      • Parameters
      • Returns
    • eCLD_IdentifyCommandIdentifyQueryRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_IdentifyEZModeInvokeCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_IdentifyUpdateCommissionStateCommandSend
      • Description
      • Parameters
      • Returns
  • Structures
    • Custom Data Structure
    • Custom Command Payloads
    • Custom Command Responses
    • EZ-mode Commissioning Command Payloads
      • ‘EZ-Mode Invoke’ Command Payload
      • ‘Update Commission State’ Command Payload
  • Enumerations
    • teCLD_Identify_ClusterID
  • Compile-time options
    • Cluster Revision
    • Trigger Effect
    • Enhanced Functionality for EZ-mode Commissioning
• Groups Cluster
  • Overview
  • Groups Cluster structure and attributes
  • Initialization
  • Sending Commands
    • Adding Endpoints to Groups
    • Removing Endpoints from Groups
    • Obtaining Information about Groups
  • Functions
    • eCLD_GroupsCreateGroups
      • Description
      • Parameters
      • Returns
    • eCLD_GroupsAdd
      • Description
      • Parameters
      • Returns
    • eCLD_GroupsCommandAddGroupRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_GroupsCommandViewGroupRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_GroupsCommandGetGroupMembershipRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_GroupsCommandRemoveGroupRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_GroupsCommandRemoveAllGroupsRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_GroupsCommandAddGroupIfIdentifyingRequestSend
      • Description
      • Parameters
      • Returns
  • Structures
    • Custom Data Structure
    • Group Table Entry
    • Custom Command Payloads
      • Add Group Request Payload
      • View Group Request Payload
      • Get Group Membership Request Payload
      • Remove Group Request Payload
    • Custom Command Responses
      • Add Group Response Payload
      • View Group Response Payload
      • Get Group Membership Response Payload
      • Remove Group Response Payload
  • Enumerations
    • teCLD_Groups_ClusterID
  • Compile-time Options
• Scenes Cluster
  • Overview
  • Scenes Cluster structure and attributes
  • Initialization
  • Sending Remote Commands
    • Creating a Scene
    • Copying a Scene
    • Applying a Scene
    • Deleting a Scene
    • Obtaining Information about Scenes
  • Issuing Local Commands
    • Creating a Scene
    • Applying a Scene
  • Functions
    • eCLD_ScenesCreateScenes
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesAdd
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesStore
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesRecall
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandAddSceneRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandViewSceneRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandRemoveSceneRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandRemoveAllScenesRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandStoreSceneRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandRecallSceneRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandGetSceneMembershipRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandEnhancedAddSceneRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandEnhancedViewSceneRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ScenesCommandCopySceneSceneRequestSend
      • Description
      • Parameters
      • Returns
  • Structures
    • Custom Data Structure
    • Custom Command Payloads
      • Add Scene Request Payload
      • View Scene Request Payload
      • Remove Scene Request Payload
      • Remove All Scenes Request Payload
      • Store Scene Request Payload
      • Recall Scene Request Payload
      • Get Scene Membership Request Payload
      • Enhanced Add Scene Request Payload
      • View Scene Request Payload
      • Copy Scene Request Payload
    • Custom Command Responses
      • Add Scene Response Payload
      • View Scene Response Payload
      • Remove Scene Response Payload
      • Remove All Scenes Response Payload
      • Store Scene Response Payload
      • Get Scene Membership Response Payload
      • Enhanced Add Scene Response Payload
      • Enhanced View Scene Response Payload
      • Copy Scene Response Payload
    • Scenes Table Entry
  • Enumerations
    • teCLD_Scenes_ClusterID
  • Compile-time options
• On/Off Cluster
  • Overview
  • On/Off Cluster Structure and Attribute
  • Attributes for Default Reporting
  • Initialization
  • Sending Commands
    • Switching On and Off
      • Timeout on the ‘On’ Command
      • On/Off with Transition Effect
    • Switching Off Lights with Effect
    • Switching On Timed Lights
  • Saving Light Settings
  • Functions
    • eCLD_OnOffCreateOnOff
      • Description
      • Parameters
      • Returns
    • eCLD_OnOffCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_OnOffCommandOffWithEffectSend
      • Description
      • Parameters
      • Returns
    • eCLD_OnOffCommandOnWithTimedOffSend
      • Description
      • Parameters
      • Returns
  • Structures
    • Custom Data Structure
    • Custom Command Payloads
      • Off With Effect Request Payload
      • On With Timed Off Request Payload
  • Enumerations
    • teCLD_OnOff_ClusterID
    • teCLD_OOSC_SwitchType (On/Off Switch Types)
    • teCLD_OOSC_SwitchAction (On/Off Switch Actions)
  • Compile-time options
    • Optional Attributes
    • Optional Commands
    • Cluster Revision
• On/Off Switch Configuration Cluster
  • Overview
  • On/Off Switch Config Cluster Structure and Attribute
  • Initialisation
  • Functions
    • eCLD_OOSCCreateOnOffSwitchConfig
      • Description
      • Parameters
      • Returns
  • Enumerations
    • teCLD_OOSC_ClusterID
    • teCLD_OOSC_SwitchType
    • teCLD_OOSC_SwitchAction
  • Compile-time options
• Level Control Cluster
  • Overview
  • Level Control Cluster structure and attributes
  • Attributes for Default Reporting
  • Initialization
  • Sending Remote Commands
    • Changing Level
      • Move to Level Command
      • Move Command
      • Step Command
    • Stopping a Level Change
  • Issuing Local Commands
    • Setting Level
    • Obtaining Level
  • Functions
    • eCLD_LevelControlCreateLevelControl
      • Description
      • Parameters
      • Returns
    • eCLD_LevelControlSetLevel
      • Description
      • Parameters
      • Returns
    • eCLD_LevelControlGetLevel
      • Description
      • Parameters
      • Returns
    • eCLD_LevelControlCommandMoveToLevelCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_LevelControlCommandMoveCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_LevelControlCommandStepCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_LevelControlCommandStopCommandSend
      • Description
      • Parameters
      • Returns
  • Structures
    • Level Control Transition Structure
    • Custom Data Structure
    • Custom Command Payloads
      • Move To Level Command Payload
      • Move Command Payload
      • Step Command Payload
      • Stop Command Payload
  • Enumerations
    • teCLD_LevelControl_ClusterID
    • teCLD_LevelControl_Transition
    • teCLD_LevelControl_MoveMode
  • Compile-time options
    • Optional Attributes
    • Global Attributes
• Alarms Cluster
  • Overview
  • Alarms Cluster structure and attributes
  • Initialization
  • Alarm Operations
    • Raising an Alarm
    • Resetting Alarms (from Client)
  • Alarms Events
  • Functions
    • eCLD_AlarmsCreateAlarms
      • Description
      • Parameters
      • Returns
    • eCLD_AlarmsCommandResetAlarmCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_AlarmsCommandResetAllAlarmsCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_AlarmsCommandGetAlarmCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_AlarmsCommandResetAlarmLogCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_AlarmsResetAlarmLog
      • Description
      • Parameters
      • Returns
    • eCLD_AlarmsAddAlarmToLog
      • Description
      • Parameters
      • Returns
    • eCLD_AlarmsGetAlarmFromLog
      • Description
      • Parameters
      • Returns
    • eCLD_AlarmsSignalAlarm
      • Description
      • Parameters
      • Returns
  • Structures
    • Event Callback Message Structure
    • Custom Data Structure
    • Custom Command Payloads
      • Reset Alarm Command Payload
      • Alarm Notification Payload
    • Custom Response Payloads
      • Get Alarm Response Payload
    • Alarms Table Entry
  • Enumerations
    • teCLD_Alarms_AttributeID
• Time Cluster and ZCL Time
  • Overview
    • Time Attribute
    • ZCL Time
  • Time Cluster structure and attributes
  • Attribute Settings
    • Mandatory Attributes
      • utctTime
      • u8TimeStatus
    • Optional Attributes
      • i32TimeZone
      • u32DstStart
      • u32DstEnd
      • i32DstShift
      • u32StandardTime
      • u32LocalTime
      • u32LastSetTime
      • u32ValidUntilTime
  • Maintaining ZCL Time
    • Updating ZCL Time Following Sleep
    • ZCL Time Synchronization
  • Time-Synchronization of Devices
    • Initialising and Maintaining Master Time
    • Initial Synchronisation of Devices
    • Re-synchronisation of Devices
  • Time Event
  • Functions
    • eCLD_TimeCreateTime
      • Description
      • Parameters
      • Returns
    • vZCL_SetUTCTime
      • Description
      • Parameters
      • Returns
    • u32ZCL_GetUTCTime
      • Description
      • Parameters
      • Returns
    • bZCL_GetTimeHasBeenSynchronised
      • Description
      • Parameters
      • Returns
    • vZCL_ClearTimeHasBeenSynchronised
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • teCLD_TM_AttributeID
  • Compile-time Options
• Input and Output Clusters
  • Analogue Input (Basic)
    • Overview
    • Analogue Input (Basic) Structure and Attributes
    • Attributes for Default Reporting
    • Functions
    • eCLD_AnalogInputBasicCreateAnalogInputBasic
      • Description
      • Parameters
      • Returns
    • Enumerations
    • teCLD_AnalogInputBasicCluster_AttrID
    • teCLD_AnalogInputBasic_Reliability
    • Compile-time Options
      • Optional Attributes
      • Global Attributes
  • Analogue Output (Basic)
    • Overview
    • Analogue Output (Basic) Structure and Attributes
    • Attributes for Default Reporting
    • Functions
      • eCLD_AnalogOutputBasicCreateAnalogOutputBasic
    • Enumerations
      • teCLD_AnalogOutputBasicCluster_AttrID
      • teCLD_AnalogOutputBasic_Reliability
    • Compile-time options
      • Optional Attributes
      • Global Attributes
  • Binary Input (Basic) Cluster
    • Overview
    • Binary Input (Basic) Structure and Attributes
    • Attributes for Default Reporting
    • Functions
      • eCLD_BinaryInputBasicCreateBinaryInputBasic
    • Enumerations
      • teCLD_BinaryInputBasicCluster_AttrID
      • teCLD_BinaryInputBasic_Polarity
      • teCLD_BinaryInputBasic_Reliability
    • Compile-time options
      • Optional Attributes
      • Global Attributes
  • Binary Output (Basic)
    • Overview
    • Binary Output (Basic) Structure and Attributes
    • Attributes for Default Reporting
    • Functions
      • eCLD_BinaryOutputBasicCreateBinaryOutputBasic
    • Enumerations
      • teCLD_BinaryOutputBasicCluster_AttrID
      • teCLD_BinaryOutputBasic_Polarity
      • teCLD_BinaryOutputBasic_Reliability
    • Compile-time options
      • Optional Attributes
  • Multistate Input (Basic)
    • Overview
    • Multistate Input (Basic) Structure and Attributes
    • Attributes for Default Reporting
    • Functions
      • eCLD_MultistateInputBasicCreateMultistateInputBasic
    • Enumerations
      • teCLD_MultistateInputBasicCluster_AttrID
      • teCLD_MultistateInputBasic_Reliability
    • Compile-time options
      • Optional Attributes
      • Global Attributes
  • Multistate Output (Basic)
    • Overview
    • Multistate Output (Basic) Structure and Attributes
    • Attributes for Default Reporting
    • Functions
      • eCLD_MultistateOutputBasicCreateMultistateOutputBasic
    • Enumerations
      • teCLD_MultistateOutputBasicCluster_AttrID
      • teCLD_MultistateOutputBasic_Reliability
    • Compile-time options
      • Optional attributes
      • Global attributes
• Poll Control Cluster
  • Overview
  • Cluster structure and attributes
  • Attribute Settings
  • Poll Control Operations
    • Initialization
    • Configuration
    • Operation
      • Fast Poll Mode Timeout
      • Invalid Check-in Responses
  • Poll Control Events
  • Functions
    • Server/Client Function
      • eCLD_PollControlCreatePollControl
    • Server Functions
      • eCLD_PollControlUpdate
      • eCLD_PollControlSetAttribute
      • eCLD_PollControlUpdateSleepInterval
    • Client Functions
      • eCLD_PollControlSetLongPollIntervalSend
      • eCLD_PollControlSetShortPollIntervalSend
      • eCLD_PollControlFastPollStopSend
  • Return codes
  • Enumerations
    • ‘Attribute ID’ enumerations
    • ‘Command’ Enumerations
  • Structures
    • tsCLD_PPCallBackMessage
    • tsCLD_PollControl_CheckinResponsePayload
    • tsCLD_PollControl_SetLongPollIntervalPayload
    • tsCLD_PollControl_SetShortPollIntervalPayload
    • tsCLD_PollControlCustomDataStructure
  • Compile-time Options
    • Optional Server Attributes
    • Global Attributes
    • Set Valid Range for ‘Check-in Interval’
    • Set Valid Range for ‘Fast Poll Timeout’
    • Set Valid Range for ‘Long Poll Interval’
    • Set Valid Range for ‘Short Poll Interval’
    • Optional Commands
    • Maximum Number of Clients
    • Disable APS Acknowledgments for Bound Transmissions
• Power Profile Cluster
  • Overview
  • Cluster structure and attributes
  • Attributes for default reporting
  • Power profiles
  • Power profile operations
    • Initialization
    • Adding and removing a power profile (server only)
      • Adding a power profile entry
      • Removing a power profile entry
      • Obtaining a Power Profile Entry
    • Communicating power profiles
      • Requesting a power profile (by client)
      • Notification of a power profile (by server)
    • Communicating schedule information
      • Requesting a schedule (by server)
      • Notification of a Schedule (by Client)
      • Notification of Energy Phases in Power Profile Schedule (by Server)
      • Requesting the Scheduled Energy Phases (by Client)
    • Executing a Power Profile Schedule
    • Communicating Price Information
      • Requesting Cost of a Power Profile Schedule (by Server)
      • Requesting Cost of Power Profile Schedules Over a Day (by Server)
  • Power Profile Events
  • Functions
    • Server/Client Function
      • eCLD_PPCreatePowerProfile
    • Server Functions
      • eCLD_PPSchedule
      • eCLD_PPSetPowerProfileState
      • eCLD_PPAddPowerProfileEntry
      • eCLD_PPRemovePowerProfileEntry
      • eCLD_PPGetPowerProfileEntry
      • eCLD_PPPowerProfileNotificationSend
      • eCLD_PPEnergyPhaseScheduleStateNotificationSend
      • eCLD_PPPowerProfileScheduleConstraintsNotificationSend
      • eCLD_PPEnergyPhasesScheduleReqSend
      • eCLD_PPPowerProfileStateNotificationSend
      • eCLD_PPGetPowerProfilePriceSend
      • eCLD_PPGetPowerProfilePriceExtendedSend
      • eCLD_PPGetOverallSchedulePriceSend
    • Client Functions
      • eCLD_PPPowerProfileRequestSend
      • eCLD_PPEnergyPhasesScheduleNotificationSend
      • eCLD_PPPowerProfileStateReqSend
      • eCLD_PPEnergyPhasesScheduleStateReqSend
      • eCLD_PPPowerProfileScheduleConstraintsReqSend
  • Return codes
  • Enumerations
    • ‘Attribute ID’ Enumerations
    • ‘Power Profile State’ Enumerations
    • ‘Server-Generated Command’ Enumerations
    • ‘Server-Received Command’ Enumerations
  • Structures
    • tsCLD_PPCallBackMessage
    • tsCLD_PPEntry
    • tsCLD_PP_PowerProfileReqPayload
    • tsCLD_PP_PowerProfilePayload
    • tsCLD_PP_PowerProfileStatePayload
    • tsCLD_PP_EnergyPhasesSchedulePayload
    • tsCLD_PP_PowerProfileScheduleConstraintsPayload
    • tsCLD_PP_GetPowerProfilePriceExtendedPayload
    • tsCLD_PP_GetPowerProfilePriceRspPayload
    • tsCLD_PP_GetOverallSchedulePriceRspPayload
    • tsCLD_PP_EnergyPhaseInfo
    • tsCLD_PP_EnergyPhaseDelay
    • tsCLD_PP_PowerProfiIeRecord
    • tsCLD_PPCustomDataStructure
  • Compile-time Options
    • Global Attributes
    • Enabling ‘Get Power Profile Price’ Command
    • Enabling ‘Get Power Profile Price Extended’ Command
    • Enable ‘Get Overall Schedule Price’ Command
    • Number of Power Profiles
    • Maximum Number of Energy Phases
    • Disabling APS Acknowledgments for Bound Transmissions
• Diagnostics Cluster
  • Overview
  • Diagnostics Structure and Attributes
    • ‘Hardware Information’ Attribute Set
    • ‘Stack/Network Information’ Attribute Set
    • Global Attributes
  • Functions
    • eCLD_DiagnosticsCreateDiagnostics
      • Description
      • Parameters
      • Returns
    • eCLD_DiagnosticsUpdate
      • Description
      • Parameters
      • Returns
  • Enumerations
    • teCLD_Diagnostics_AttributeId
  • Compile-time Options
    • Optional Attributes
    • Global Attributes
• Part IV: Measurement and Sensing Clusters
• Illuminance Measurement Cluster
  • Overview
  • Illuminance Measurement Structure and Attributes
  • Attributes for Default Reporting
  • Functions
    • eCLD_IlluminanceMeasurementCreateIlluminanceMeasurement
      • Description
      • Parameters
      • Returns
  • Enumerations
    • teCLD_IM_ClusterID
  • Compile-time options
    • Optional Attributes
    • Global Attributes
• Illuminance Level Sensing Cluster
• Temperature Measurement Cluster
  • Overview
  • Temperature Measurement Structure and Attributes
  • Attributes for Default Reporting
  • Functions
    • eCLD_TemperatureMeasurementCreateTemperatureMeasurement
      • Description
      • Parameters
      • Returns
  • Enumerations
    • teCLD_TemperatureMeasurement_AttributeID
  • Compile-time Options
    • Optional Attribute
    • Global Attributes
• Pressure Measurement Cluster
  • Overview
  • Cluster structure and attributes
    • ‘Pressure Measurement Information’ Attribute Set
    • Global Attributes
  • Initialization and Operation
  • Pressure Measurement Events
  • Functions
    • eCLD_PressureMeasurementCreatePressureMeasurement
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Attribute ID’ Enumerations
  • Structures
  • Compile-time Options
    • Optional Attributes
    • Global Attributes
• Flow Measurement Cluster
  • Overview
  • Cluster structure and attributes
    • ‘Flow Measurement Information’ Attribute Set
    • Global Attributes
  • Initialization and Operation
  • Flow Measurement Events
  • Functions
    • eCLD_FlowMeasurementCreateFlowMeasurement
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Attribute ID’ Enumerations
  • Structures
  • Compile-time Options
    • Optional Attributes
    • Global Attributes
• Relative Humidity Measurement Cluster
  • Overview
  • RH Measurement Structure and Attributes
  • Attributes for Default Reporting
  • Functions
    • eCLD_RelativeHumidityMeasurementCreateRelativeHumidityMeasurement
      • Description
      • Parameters
      • Returns
  • Enumerations
    • teCLD_RHM_ClusterID
  • Compile-time Options
    • Optional Attribute
    • Global Attributes
• Occupancy Sensing Cluster
  • Overview
  • Occupancy Sensing Structure and Attributes
    • ‘Occupancy Sensor Information’ Attribute Set
    • ‘PIR Configuration’ Attribute Set
    • ‘Ultrasonic Configuration’ Attribute Set
    • Global Attributes
  • Attributes for Default Reporting
  • Functions
    • eCLD_OccupancySensingCreateOccupancySensing
      • Description
      • Parameters
      • Returns
  • Enumerations
    • teCLD_OS_ClusterID
  • Compile-time options
    • Optional Attributes
    • Global Attributes
• Electrical Measurement Cluster
  • Overview
  • Cluster structure and attributes
    • ‘Basic Information’ Attribute Set
    • ‘AC (Non-phase Specific) Measurements’ Attribute Set
    • ‘AC (Single Phase or Phase A) Measurements’ Attribute Set
    • ‘AC Formatting’ Attribute Set
    • Manufacturer-specific Attributes
    • Global Attributes
  • Initialisation and Operation
  • Electrical Measurement Events
  • Functions
    • eCLD_ElectricalMeasurementCreateElectricalMeasurement
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Attribute ID’ Enumerations
  • Structures
  • Compile-time options
    • Optional Attributes
    • Global Attributes
• Part V: Lighting Clusters
• Colour Control Cluster
  • Overview
  • Colour Control Cluster structure and attributes
    • ‘Colour Information’ Attribute Set
    • ‘Defined Primaries Information’
    • ‘Additional Defined Primaries Information’ Attribute Set
    • ‘Defined Colour Points Settings’
    • Enhanced Colour Mode Attributes
  • Attributes for Default Reporting
  • Initialization
  • Sending Commands
    • Controlling Hue
      • ‘Move to Hue’ Command
      • ‘Move Hue’ Command
      • ‘Step Hue’ Command
    • Controlling Saturation
      • ‘Move to Saturation’ Command
      • ‘Move Saturation’ Command
      • ‘Step Saturation’ Command
    • Controlling Colour (CIE x and y Chromaticities)
      • ‘Move to Colour’ Command
      • ‘Move Colour’ Command
      • ‘Step Colour’ Command
    • Controlling Colour Temperature
      • ‘Move to Colour Temperature’ Command
      • ‘Move Colour Temperature’ Command
      • ‘Step Colour Temperature’ Command
    • Controlling ‘Enhanced’ Hue
      • ‘Enhanced Move to Hue’ Command
      • ‘Enhanced Move Hue’ Command
      • ‘Enhanced Step Hue’ Command
    • Controlling a Colour Loop
      • ‘Colour Loop Set’ Command
    • Controlling Hue and Saturation
      • ‘Move to Hue and Saturation’ Command
      • ‘Enhanced Move to Hue and Saturation’ Command
  • Functions
    • eCLD_ColourControlCreateColourControl
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandMoveToHueCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandMoveHueCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandStepHueCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandMoveToSaturationCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandMoveSaturationCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandStepSaturationCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandMoveToHueAndSaturationCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandMoveToColourCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandMoveColourCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandStepColourCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandEnhancedMoveToHueCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandEnhancedMoveHueCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandEnhancedStepHueCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandEnhancedMoveToHueAndSaturationCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandColourLoopSetCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandStopMoveStepCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandMoveToColourTemperatureCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandMoveColourTemperatureCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControlCommandStepColourTemperatureCommandSend
      • Description
      • Parameters
      • Returns
    • eCLD_ColourControl_GetRGB
      • Description
      • Parameters
      • Returns
  • Structures
    • Custom Data Structure
    • Custom Command Payloads
      • Move to Hue Command Payload
      • Move Hue Command Payload
      • Step Hue Command Payload
      • Move To Saturation Command Payload
      • Move Saturation Command Payload
      • Step Saturation Command Payload
      • Move To Hue And Saturation Command Payload
      • Move To Colour Command Payload
      • Move Colour Command Payload
      • Step Colour Command Payload
      • Move To Colour Temperature Command Payload
      • Move Colour Temperature Command Payload
      • Step Colour Temperature Command Payload
      • Enhanced Move To Hue Command Payload
      • Enhanced Move Hue Command Payload
      • Enhanced Step Hue Command Payload
      • Enhanced Move To Hue And Saturation Command Payload
      • Colour Loop Set Command Payload
      • Stop Move Step Command Payload
  • Enumerations
    • teCLD_ColourControl_ClusterID
  • Compile-time Options
    • Optional Attributes
    • Global Attributes
    • ‘Colour Capabilities’ Definition
• Ballast Configuration Cluster
• Part VI: HVAC Clusters
• Thermostat Cluster
  • Overview
  • Thermostat Cluster structure and attributes
    • ‘Thermostat Information’ Attribute Set
    • ‘Thermostat Settings’ Attribute Set
    • Global Attributes
  • Attributes for Default Reporting
  • Thermostat Operations
    • Initialisation
    • Recording and Reporting the Local Temperature
    • Configuring Heating and Cooling Setpoints
  • Thermostat Events
    • E_CLD_THERMOSTAT_CMD_SETPOINT_RAISE_LOWER
  • Functions
    • eCLD_ThermostatCreateThermostat
      • Description
      • Parameters
      • Returns
    • eCLD_ThermostatSetAttribute
      • Description
      • Parameters
      • Returns
    • eCLD_ThermostatStartReportingLocalTemperature
      • Description
      • Parameters
      • Returns
    • eCLD_ThermostatCommandSetpointRaiseOrLowerSend
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Attribute ID’ Enumerations
    • ‘Operating Capabilities’ Enumerations
    • ‘Command ID’ Enumerations
    • ‘Setpoint Raise Or Lower’ Enumerations
  • Structures
    • Custom Data Structure
    • tsCLD_ThermostatCallBackMessage
    • tsCLD_Thermostat_SetpointRaiseOrLowerPayload
  • Compile-time options
    • Optional Attributes
    • Global Attributes
    • Minimum Cooling Setpoint
    • Maximum Cooling Setpoint
    • Minimum Heating Setpoint
    • Maximum Heating Setpoint
• Fan Control Cluster
  • Overview
  • Fan Control Structure and Attributes
  • Initialisation
  • Functions
    • eCLD_CreateFanControl
      • Description
      • Parameters
      • Returns
  • Enumerations
    • teCLD_FanControl_AttributeID
    • teCLD_FC_FanMode
    • teCLD_FC_FanModeSequence
  • Compile-time options
• Thermostat UI Configuration Cluster
  • Overview
  • Cluster structure and attributes
  • Initialization
  • Functions
    • eCLD_ThermostatUIConfigCreateThermostatUIConfig
      • Description
      • Parameters
      • Returns
    • eCLD_ThermostatUIConfigConvertTemp
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Attribute ID’ Enumerations
    • ‘Temperature Display Mode’ Enumerations
    • ‘Keypad Functionality’ Enumerations
  • Compile-time Options
• Part VII: Closure Clusters
• Door Lock Cluster
  • Overview
  • Door Lock Cluster structure and attributes
  • Attributes for Default Reporting
  • Door Lock Events
  • Functions
    • eCLD_DoorLockCreateDoorLock
      • Description
      • Parameters
      • Returns
    • eCLD_DoorLockSetLockState
      • Description
      • Parameters
      • Returns
    • eCLD_DoorLockGetLockState
      • Description
      • Parameters
      • Returns
    • eCLD_DoorLockCommandLockUnlockRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_DoorLockSetSecurityLevel
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Attribute ID’ Enumerations
    • ‘Lock State’ Enumerations
    • ‘Lock Type’ Enumerations
    • ‘Door State’ Enumerations
    • ‘Command ID’ Enumerations
  • Structures
    • tsCLD_DoorLockCallBackMessage
    • tsCLD_DoorLock_LockUnlockResponsePayload
  • Compile-time options
    • Optional Attributes
    • Global Attributes
• Part VIII: Security and Safety Clusters
• IAS Zone Cluster
  • Overview
  • IAS Zone Structure and Attributes
    • ‘Zone Information’ Attribute Set
    • ‘Zone Settings’ Attribute Set
  • Enrollment
    • Trip-to-Pair
    • Auto-Enroll-Response
    • Auto-Enroll-Request
  • IAS Zone Events
  • Functions
    • eCLD_IASZoneCreateIASZone
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneUpdateZoneStatus
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneUpdateZoneState
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneUpdateZoneType
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneUpdateZoneID
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneUpdateCIEAddress
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneEnrollReqSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneEnrollRespSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneStatusChangeNotificationSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneNormalOperationModeReqSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASZoneTestModeReqSend
      • Description
      • Parameters
      • Returns
  • Structures
    • Custom Data Structure
    • Custom Command Payloads
      • ‘Enroll Request’ Payload
      • ‘Enroll Response’ Payload
      • ‘Zone Status Change Notification’ Payload
      • ‘Initiate Test Mode Request’ Payload
  • Compile-time options
    • Optional Attributes
    • Global Attributes
    • Optional Commands
    • Disable APS Acknowledgements for Bound Transmissions
• IAS Ancillary Control Equipment Cluster
  • Overview
  • IAS ACE Structure and Attributes
  • Table and Parameters
  • Command Summary
  • IAS ACE Events
  • Functions
    • eCLD_IASACECreateIASACE
      • Description
      • Parameters
      • Returns
    • eCLD_IASACEAddZoneEntry
      • Description
      • Parameters
      • Returns
    • eCLD_IASACERemoveZoneEntry
      • Description
      • Parameters
      • Returns
    • eCLD_IASACEGetZoneTableEntry
      • Description
      • Parameters
      • Returns
    • eCLD_IASACEGetEnrolledZones
      • Description
      • Parameters
      • Returns
    • eCLD_IASACESetPanelParameter
      • Description
      • Parameters
      • Returns
    • eCLD_IASACEGetPanelParameter
      • Description
      • Parameters
      • Returns
    • eCLD_IASACESetZoneParameter
      • Description
      • Parameters
      • Returns
    • eCLD_IASACESetZoneParameterValue
      • Description
      • Parameters
      • Returns
    • eCLD_IASACEGetZoneParameter
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_ArmSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_BypassSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_EmergencySend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_FireSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_PanicSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_GetZoneIDMapSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_GetZoneInfoSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_GetPanelStatusSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_SetBypassedZoneListSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_GetBypassedZoneListSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_GetZoneStatusSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_ZoneStatusChangedSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASACE_PanelStatusChanged
      • Description
      • Parameters
      • Returns
  • Structures
    • Custom Data Structure
    • Zone Table Entry
    • Zone Parameters
    • Panel Parameters
    • Custom Command Payloads
      • ‘Arm’ Command Payload
      • ‘Bypass’ Command Payload
      • ‘Get Zone Information’ Command Payload
      • ‘Set Bypassed Zone List’ Command Payload
      • ‘Get Zone Status’ Command Payload
      • ‘Panel Status Changed or Get Panel Status Response’
    • Event Data Structures
      • E_CLD_IASACE_CMD_ARM_RESP Data
      • E_CLD_IASACE_CMD_GET_ZONE_ID_MAP_RESP Data
      • E_CLD_IASACE_CMD_GET_ZONE_INFO_RESP Data
      • E_CLD_IASACE_CMD_ZONE_STATUS_CHANGED Data
      • E_CLD_IASACE_CMD_PANEL_STATUS_CHANGED Data
      • E_CLD_IASACE_CMD_GET_PANEL_STATUS_RESP Data
      • E_CLD_IASACE_CMD_BYPASS_RESP Data
      • E_CLD_IASACE_CMD_GET_ZONE_STATUS_RESP Data
  • Enumerations
    • teCLD_IASACE_ArmMode
    • teCLD_IASACE_PanelStatus
    • teCLD_IASACE_AlarmStatus
    • teCLD_IASACE_AudibleNotification
  • Compile-time options
    • Maximum Size of Zone Table
    • Maximum Length of Arm/Disarm Code
    • Maximum Length of Zone Label
    • Disable APS Acknowledgements for Bound Transmissions
    • Cluster Revision
• IAS Warning Device Cluster
  • Overview
  • IAS WD Structure and Attribute
  • Issuing Warnings
  • IAS WD Events
  • Functions
    • eCLD_IASWDCreateIASWD
      • Description
      • Parameters
      • Returns
    • eCLD_IASWDUpdate
      • Description
      • Parameters
      • Returns
    • eCLD_IASWDUpdateMaxDuration
      • Description
      • Parameters
      • Returns
    • eCLD_IASWDStartWarningReqSend
      • Description
      • Parameters
      • Returns
    • eCLD_IASWDSquawkReqSend
      • Description
      • Parameters
      • Returns
  • Structures
    • Custom Data Structure
    • Custom Command Payloads
      • ‘Start Warning’ Payload
      • ‘Squawk’ Payload
    • Event Data Structures
      • E_CLD_IASWD_CLUSTER_UPDATE_STROBE Data
      • E_CLD_IASWD_CLUSTER_UPDATE_WARNING Data
  • Compile-time Options
• Part IX: Smart Energy Clusters
• Price Cluster
  • Overview
  • Price cluster structure and attributes
    • ‘Tier Label’ Attribute Set
    • ‘Block Threshold’ Attribute Set
    • ‘Block Period’ Attribute Set
    • ‘Commodity’ Attribute Set
    • ‘Block Price Information’ Attribute Set
    • ‘Billing Period Information’ Attribute Set
    • Client Attribute Set
  • Attribute settings
  • Initializing and maintaining price lists
  • Publishing price information
    • Unsolicited Price Updates
    • Get Current Price
    • Get Scheduled Prices
  • Time-synchronization via Publish Price commands
  • Conversion factor and calorific value (gas only)
    • Initializing Conversion Factors and Calorific Values at Network Startup
  • Price events
    • E_SE_PRICE_TABLE_ADD
    • E_SE_PRICE_TABLE_ACTIVE
    • E_SE_PRICE_GET_CURRENT_PRICE_RECEIVED
    • E_SE_PRICE_TIME_UPDATE
    • E_SE_PRICE_ACK_RECEIVED
    • E_SE_PRICE_NO_PRICE_TABLES
    • E_SE_PRICE_CONVERSION_FACTOR_TABLE_ACTIVE
    • E_SE_PRICE_CONVERSION_FACTOR_ADD
    • E_SE_PRICE_CALORIFIC_VALUE_TABLE_ACTIVE
    • E_SE_PRICE_CALORIFIC_VALUE_ADD
  • Functions
    • eSE_PriceCreate
      • Description
      • Parameters
      • Returns
    • eSE_PriceGetCurrentPriceSend
      • Description
      • Parameters
      • Returns
    • eSE_PriceGetScheduledPricesSend
      • Description
      • Parameters
      • Returns
    • eSE_PriceAddPriceEntry
      • Description
      • Parameters
      • Returns
    • eSE_PriceAddPriceEntryToClient
      • Description
      • Parameters
      • Returns
    • eSE_PriceGetPriceEntry
      • Description
      • Parameters
      • Returns
    • eSE_PriceDoesPriceEntryExist
      • Description
      • Parameters
      • Returns
    • eSE_PriceRemovePriceEntry
      • Description
      • Parameters
      • Returns
    • eSE_PriceClearAllPriceEntries
      • Description
      • Parameters
      • Returns
    • eSE_PriceAddConversionFactorEntry
      • Description
      • Parameters
      • Returns
    • eSE_PriceGetConversionFactorSend
      • Description
      • Parameters
      • Returns
    • eSE_PriceGetConversionFactorEntry
      • Description
      • Parameters
      • Returns
    • eSE_PriceDoesConversionFactorEntryExist
      • Description
      • Parameters
      • Returns
    • eSE_PriceRemoveConversionFactorEntry
      • Description
      • Parameters
      • Returns
    • eSE_PriceClearAllConversionFactorEntries
      • Description
      • Parameters
      • Returns
    • eSE_PriceAddCalorificValueEntry
      • Description
      • Parameters
      • Returns
    • eSE_PriceGetCalorificValueSend
      • Description
      • Parameters
      • Returns
    • eSE_PriceGetCalorificValueEntry
      • Description
      • Parameters
      • Returns
    • eSE_PriceDoesCalorificValueEntryExist
      • Description
      • Parameters
      • Returns
    • eSE_PriceRemoveCalorificValueEntry
      • Description
      • Parameters
      • Returns
    • eSE_PriceClearAllCalorificValueEntries
      • Description
      • Parameters
      • Returns
  • Return codes
  • Structures
    • tsSE_PricePublishPriceCmdPayload
    • tsSE_PricePublishConversionCmdPayload
    • tsSE_PricePublishCalorificValueCmdPayload
  • Enumerations
    • ‘Attribute ID’ Enumerations
    • ‘Price Event’ Enumerations
    • ‘Calorific Value Unit’ Enumerations
  • Compile-time options
    • Price List Size
    • Price Tier Label Attribute Set
    • Block Threshold Attribute Set
    • Block Price Information Attribute Set
    • Conversion Factor (Gas Only)
    • Calorific Value (Gas Only)
• Demand-Response and Load Control Cluster
  • Overview
  • DRLC Cluster structure and attributes
  • Initialization
  • Load Control Events (LCEs)
    • LCE Contents
    • LCE Lists
  • LCE Handling
    • LCE Handling on Server
    • LCE Handling on Clients
      • LCE Activation and De-activation
      • Getting Scheduled Events
      • Reporting LCE Actions to Server
      • Over-riding LCE Settings
    • Canceling LCEs
  • Message Signing (Security)
  • DRLC Events
    • Event and Command Types
      • E_SE_DRLC_EVENT_API
      • E_SE_DRLC_EVENT_COMMAND
      • E_SE_DRLC_EVENT_ACTIVE
      • E_SE_DRLC_EVENT_EXPIRED
      • E_SE_DRLC_EVENT_CANCELLED
    • Other Elements of tsSE_DRLCCallBackMessage
      • eDRLCStatus
      • u32CurrentTime
      • uMessage
  • Functions
    • eSE_DRLCCreate
      • Description
      • Parameters
      • Returns
    • eSE_DRLCAddLoadControlEvent
      • Description
      • Parameters
      • Returns
    • eSE_DRLCGetScheduledEventsSend
      • Description
      • Parameters
      • Returns
    • eSE_DRLCCancelLoadControlEvent
      • Description
      • Parameters
      • Returns
    • eSE_DRLCCancelAllLoadControlEvents
      • Description
      • Parameters
      • Returns
    • eSE_DRLCSetEventUserOption
      • Description
      • Parameters
      • Returns
    • eSE_DRLCSetEventUserData
      • Description
      • Parameters
      • Returns
    • eSE_DRLCGetLoadControlEvent
      • Description
      • Parameters
      • Returns
    • eSE_DRLCFindLoadControlEvent
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Device Class’ Enumerations
    • ‘DRLC Event’ Enumerations
    • ‘Criticality Level’ Enumerations
    • ‘LCE Cancellation’ Enumerations
    • ‘LCE Participation’ Enumerations
    • ‘LCE Data Modification’ Enumerations
    • ‘LCE List’ Enumerations
    • ‘LCE Status’ Enumerations
  • Structures
    • tsSE_DRLCLoadControlEvent
    • tsSE_DRLCGetScheduledEvents
    • tsSE_DRLCCancelLoadControlEvent
    • tsSE_DRLCReportEvent
    • tsSE_DRLCCallBackMessage
  • Compile-time options
    • Length of LCE Lists
    • LCE Re-sends
    • Message Signing (Security)
• Simple Metering Cluster
  • Overview
  • Simple Metering Cluster structure and attributes
    • ‘Reading Information’ Attribute Set
    • ‘Time-Of-Use (TOU) Information’ Attribute Set
    • ‘Meter Status’ Attribute Set
    • ‘Formatting’ Attribute Set
    • ‘Historical Consumption’ Attribute Set
    • ‘Load Profile Configuration’ Attribute Set
    • ‘Supply Limit’ Attribute Set
    • ‘Block Information’ Attribute Set
  • Attribute Settings
    • eMeteringDeviceType
    • u8MeterStatus
    • eUnitOfMeasure
    • u8SummationFormatting
    • u48CurrentSummationDelivered
  • Remotely Reading Simple Metering Attributes
  • Mirroring Metering Data
    • Configuring Mirroring on ESP
      • Writing and Preserving Array of IEEE Addresses
      • Recreating Mirrors Following an ESP Reset
    • Configuring Mirroring on Metering Devices
    • Mirroring Data
      • Maintaining the Mirrored eMeteringDeviceType Attribute
    • Reading Mirrored Data
    • Removing a Mirror
  • Consumption Data Archive (‘Get Profile’)
    • Updating Consumption Data on Server
    • Sending and Handling a ‘Get Profile’ Request
  • Simple Metering Events
    • Event Types
    • Command Types
      • E_CLD_SM_CLIENT_RECEIVED_COMMAND
      • E_CLD_SM_SERVER_RECEIVED_COMMAND
      • E_CLD_SM_FAST_POLLING_TIMER_EXPIRED
  • Functions
    • eSE_SMCreate
      • Description
      • Parameters
      • Returns
    • eSE_ReadMeterAttributes
      • Description
      • Parameters
      • Returns
    • eSE_HandleReadMeterAttributesResponse
      • Description
      • Parameters
      • Returns
    • eSM_ServerRequestMirrorCommand
      • Description
      • Parameters
      • Returns
    • eSM_ServerRemoveMirrorCommand
      • Description
      • Parameters
      • Returns
    • eSM_CreateMirror
      • Description
      • Parameters
      • Returns
    • eSM_RemoveMirror
      • Description
      • Parameters
      • Returns
    • eSM_GetFreeMirrorEndPoint
      • Description
      • Parameters
      • Returns
    • eSM_IsMirrorSourceAddressValid
      • Description
      • Parameters
      • Returns
    • eSM_ServerUpdateConsumption
      • Description
      • Parameters
      • Returns
    • eSM_ClientGetProfileCommand
      • Description
      • Parameters
      • Returns
    • u32SM_GetReceivedProfileData
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Attribute ID’ Enumerations
    • ‘Meter Status’ Enumerations
    • ‘Unit of Measure’ Enumerations
    • ‘Summation Formatting’ Enumerations
      • Extracting the number of digits to the right of the decimal point:
      • Extracting the number of digits to the left of the decimal point:
      • Determining whether leading zeros will be suppressed:
    • ‘Supply Direction’ Enumerations
    • ‘Metering Device Type’ Enumerations
    • ‘Simple Metering Event’ Enumerations
    • ‘Server Command’ Enumerations
    • ‘Client Command’ Enumerations
    • ‘Consumption Interval’ Enumerations
    • ‘Simple Metering Status’ Enumerations
  • Structures
    • tsSM_CallBackMessage
    • tsSE_Mirror
    • tsSE_MirrorClusterInstances
    • tsSM_CustomStruct
    • tsSEGetProfile
    • tsSM_RequestMirrorResponseCommand
    • tsSM_MirrorRemovedResponseCommand
    • tsSM_GetProfileRequestCommand
    • tsSM_GetProfileResponseCommand
    • tsSM_Error
  • Compile-time options
    • Optional Attributes
    • Mirroring
    • Get Profile
• Part X: Commissioning Clusters
• Commissioning Cluster
  • Overview
  • Commissioning Cluster structure and attributes
    • Start-up Parameters (tsCLD_StartupParameters)
    • Join Parameters (tsCLD_JoinParameters)
    • End Device Parameters (tsCLD_EndDeviceParameters)
    • Concentrator Parameters (tsCLD_ConcentratorParameters)
  • Attribute Settings
  • Initialisation
  • Commissioning Commands
    • Device Start-up
    • Stored Start-up Parameters
      • Saving Start-up Parameters
      • Retrieving Stored Start-up Parameters
    • Reset Start-up Parameters to Default Values
  • Commissioning Events
  • Functions
    • eCLD_CommissioningClusterCreateCommissioning
      • Description
      • Parameters
      • Returns
    • eCLD_CommissioningCommandRestartDeviceSend
      • Description
      • Parameters
      • Returns
    • eCLD_CommissioningCommandSaveStartupParamsSend
      • Description
      • Parameters
      • Returns
    • eCLD_CommissioningCommandRestoreStartupParamsSend
      • Description
      • Parameters
      • Returns
    • eCLD_CommissioningCommandResetStartupParamsSend
      • Description
      • Parameters
      • Returns
    • eCLD_CommissioningCommandModifyStartupParamsSend
      • Description
      • Parameters
      • Returns
    • eCLD_CommissioningSetAttribute
      • Description {
      • Parameters
      • Returns
  • Enumerations
    • teCLD_Commissioning_AttributeID
    • teCLD_Commissioning_AttributeSet
    • teCLD_Commissioning_Command
  • Structures
    • Attribute Set Structures
    • tsCLD_Commissioning_RestartDevicePayload
    • tsCLD_Commissioning_ModifyStartupParametersPayload
    • tsCLD_Commissioning_ResponsePayload
    • tsCLD_CommissioningCustomDataStructure
    • tsCLD_CommissioningCallBackMessage
  • Compile-time options
    • Optional Attributes
    • Optional Commands
• Touchlink Commissioning Cluster
  • Overview
  • Cluster structure and attributes
  • Commissioning operations
  • Using Touchlink
    • Creating a network
    • Adding to an existing network
    • Updating network settings
    • Stealing a node
  • Using the Commissioning Utility
  • Touchlink Commissioning events
    • Touchlink command events
    • Commissioning Utility Command Events
  • Functions
    • Touchlink functions
      • eZLL_RegisterCommissionEndPoint
      • eCLD_ZllCommissionCreateCommission
      • eCLD_ZllCommissionCommandScanReqCommandSend
      • eCLD_ZllCommissionCommandScanRspCommandSend
      • eCLD_ZllCommissionCommandDeviceInfoReqCommandSend
      • eCLD_ZllCommissionCommandDeviceInfoRspCommandSend
      • eCLD_ZllCommission​​​CommandDeviceIdentify​ReqCommandSend
      • eCLD_ZllCommissionCommandFactoryResetReqCommandSend
      • eCLD_ZllCommissionCommandNetworkStartReqCommandSend
      • eCLD_ZllCommissionCommandNetworkStartRspCommandSend
      • eCLD_ZllCommissionCommandNetworkJoinRouterReqCommandSend
      • eCLD_ZllCommissionCommandNetworkJoinRouterRspCommandSend
      • eCLD_ZllCommissionCommandNetworkJoinEndDeviceReqCommandSend
      • eCLD_ZllCommissionCommandNetworkJoinEndDeviceRspCommandSend
      • eCLD_ZllCommissionCommandNetworkUpdateReqCommandSend
    • Commissioning Utility functions
      • eCLD_ZllUtilityCreateUtility
      • eCLD_ZllUtilityCommandEndpointInformationCommandSend
      • eCLD_ZllUtilityCommandGetGroupIdReqCommandSend
      • eCLD_ZllUtilityCommandGetGroupIdRspCommandSend
      • eCLD_ZllUtilityCommandGetEndpointListReqCommandSend
      • eCLD_ZllUtilityCommandGetEndpointListRspCommandSend
      • eCLD_ZllUtilityCommandHandler
  • Structures
    • tsZLL_CommissionEndpoint
    • tsZLL_CommissionEndpointClusterInstances
    • tsCLD_ZllCommissionCustomDataStructure
    • tsCLD_ZllCommissionCallBackMessage
    • tsCLD_ZllCommission_ScanReqCommandPayload
    • tsCLD_ZllCommission_ScanRspCommandPayload
    • tsCLD_ZllCommission_DeviceInfoReqCommandPayload
    • tsCLD_ZllCommission_DeviceInfoRspCommandPayload
    • tsCLD_ZllCommission_IdentifyReqCommandPayload
    • tsCLD_ZllCommission_FactoryResetReqCommandPayload
    • tsCLD_ZllCommission_NetworkStartReqCommandPayload
    • tsCLD_ZllCommission_NetworkStartRspCommandPayload
    • tsCLD_ZllCommission_NetworkJoinRouterReqCommandPayload
    • tsCLD_ZllCommission_NetworkJoinRouterRspCommandPayload
    • tsCLD_ZllCommission_NetworkJoinEndDeviceReqCommandPayload
    • tsCLD_ZllCommission_NetworkJoinEndDeviceRspCommandPayload
    • tsCLD_ZllCommission_NetworkUpdateReqCommandPayload
    • tsCLD_ZllUtilityCustomDataStructure
    • tsCLD_ZllUtilityCallBackMessage
    • tsCLD_ZllUtility_EndpointInformationCommandPayload
  • Enumerations
    • Touchlink event enumerations
    • Commissioning utility event enumerations
  • Compile-time options
• Part XI: Appliances Clusters
• Appliance Control Cluster
  • Overview
  • Cluster structure and attributes
  • Attributes for default reporting
  • Sending commands
    • Execution Commands from Client to Server
    • Status Commands from Client to Server
    • Status Notifications from Server to Client
  • Appliance control events
  • Functions
    • eCLD_ApplianceControlCreateApplianceControl
      • Description
      • Parameters
      • Returns
    • eCLD_ACExecutionOfCommandSend
      • Description
      • Parameter
      • Returns
    • eCLD_ACSignalStateSend
      • Description
      • Parameters
      • Returns
    • eCLD_ACSignalStateResponseORSignalStateNotificationSend
      • Description
      • Parameters
      • Returns
    • eCLD_ACSignalStateNotificationSend
      • Description
      • Parameters
      • Returns
    • eCLD_ACChangeAttributeTime
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Attribute ID’ Enumerations
    • ‘Client Command ID’ Enumerations
    • ‘Server command ID’ enumerations
  • Structures
    • tsCLD_ApplianceControlCallBackMessage
    • tsCLD_AC_ExecutionOfCommandPayload
    • tsCLD_AC_SignalStateResponseORSignalStateNotificationPayload
    • tsCLD_ApplianceControlCustomDataStructure
  • Compile-time options
    • Optional attributes
    • Global Attributes
• Appliance Identification Cluster
• Appliance Events and Alerts Cluster
  • Overview
  • Cluster structure and attribute
  • Sending Messages
    • ‘Get Alerts’ Messages from Client to Server
    • ‘Alerts Notification’ Messages from Server to Client
    • ‘Event Notification’ Messages from Server to Client
  • Appliance Events and Alerts Events
  • Functions
    • eCLD_ApplianceEventsAndAlertsCreateApplianceEventsAndAlerts
      • Description
      • Parameters
      • Returns
    • eCLD_AEAAGetAlertsSend
      • Description
      • Parameter
      • Returns
    • eCLD_AEAAGetAlertsResponseORAlertsNotificationSend
      • Description
      • Parameters
      • Returns
    • eCLD_AEAAAlertsNotificationSend
      • Description
      • Parameters
      • Returns
    • eCLD_AEAAEventNotificationSend
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Command ID’ Enumerations
  • Structures
    • tsCLD_ApplianceEventsAndAlertsCallBackMessage
    • tsCLD_AEAA_GetAlertsResponseORAlertsNotificationPayload
    • tsCLD_AEAA_EventNotificationPayload
    • tsCLD_ApplianceEventsAndAlertsCustomDataStructure
  • Compile-time options
    • Maximum Number of Alerts Reported
    • Global Attributes
• Appliance Statistics Cluster
  • Overview
  • Cluster structure and attributes
  • Sending messages
    • ‘Log Queue Request’ messages from client to server
    • ‘Statistics Available’ messages from server to client
    • ‘Log Request’ messages from client to server
    • ‘Log Notification’ messages from server to client
  • Log Operations on Server
    • Adding and Removing Logs
    • Obtaining Logs
  • Appliance statistics events
  • Functions
    • eCLD_ApplianceStatisticsCreateApplianceStatistics
      • Description
      • Parameters
      • Returns
    • eCLD_ASCAddLog
      • Description
      • Parameter
      • Returns
    • eCLD_ASCRemoveLog
      • Description
      • Parameter
      • Returns
    • eCLD_ASCGetLogsAvailable
      • Description
      • Parameter
      • Returns
    • eCLD_ASCGetLogEntry
      • Description
      • Parameter
      • Returns
    • eCLD_ASCLogQueueRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ASCLogRequestSend
      • Description
      • Parameters
      • Returns
    • eCLD_ASCLogQueueResponseORStatisticsAvailableSend
      • Description
      • Parameters
      • Returns
    • eCLD_ASCStatisticsAvailableSend
      • Description
      • Parameters
      • Returns
    • eCLD_ASCLogNotificationORLogResponseSend
      • Description
      • Parameters
      • Returns
    • eCLD_ASCLogNotificationSend
      • Description
      • Parameters
      • Returns
  • Return codes
  • Enumerations
    • ‘Attribute ID’ enumerations
    • ‘Client Command ID’ enumerations
    • ‘Server Command ID’ enumerations
  • Structures
    • tsCLD_ApplianceStatisticsCallBackMessage
    • tsCLD_ASC_LogRequestPayload
    • tsCLD_ASC_LogNotificationORLogResponsePayload
    • tsCLD_ASC_LogQueueResponseORStatisticsAvailablePayload
    • tsCLD_LogTable
    • tsCLD_ApplianceStatisticsCustomDataStructure
  • Compile-time options
    • Global Attributes
    • Maximum Log Size
    • Maximum Log Queue Length
    • Enable Insertion of UTC Time
    • Disable APS Acknowledgements for Bound Transmissions
• Part XII: Over-The-Air Upgrade
• OTA Upgrade cluster
  • Overview
  • OTA Upgrade Images in Internal Flash Memory
  • OTA Upgrade Cluster structure and attributes
  • Basic Principles
    • OTA Upgrade Cluster Server
    • OTA Upgrade Cluster Client
  • Application Requirements
  • Initialization
  • Implementing OTA Upgrade Mechanism
    • Query Jitter
  • Ancillary Features and Resources for OTA Upgrade
    • Rate Limiting
      • ‘Block Request Delay’ Attribute
      • Enabling the Rate Limiting Feature
      • Implementation in the Server Application
      • Implementation in the Client Application
    • Device-Specific File Downloads
    • Image Block Size and Fragmentation
    • Page Requests
      • Enabling the Page Requests Feature
      • Implementation in the Server Application
      • Implementation in the Client Application
    • Persistent Data Management
    • Flash Memory Organization
      • Application Images
      • Persistent Data
    • Low-Voltage Flag
  • OTA Upgrade events
    • Server-side Events
    • Client-side Events
    • Server-side and Client-side Events
  • Functions
    • General Functions
      • eOTA_Create
      • vOTA_FlashInit
      • eOTA_AllocateEndpointOTASpace
      • vOTA_GenerateHash
      • eOTA_GetCurrentOtaHeader
    • Server Functions
      • eOTA_SetServerAuthorisation
      • eOTA_SetServerParams
      • eOTA_GetServerData
      • eOTA_EraseFlashSectorsForNewImage
      • eOTA_FlashWriteNewImageBlock
      • eOTA_NewImageLoaded
      • eOTA_ServerImageNotify
      • eOTA_ServerQueryNextImageResponse
      • eOTA_ServerImageBlockResponse
      • eOTA_SetWaitForDataParams
      • eOTA_ServerUpgradeEndResponse
      • eOTA_ServerSwitchToNewImage
      • eOTA_InvalidateStoredImage
      • eOTA_ServerQuerySpecificFileResponse
    • Client Functions
      • eOTA_SetServerAddress
      • eOTA_ClientQueryNextImageRequest
      • eOTA_ClientImageBlockRequest
      • eOTA_ClientImagePageRequest
      • eOTA_ClientUpgradeEndRequest
      • eOTA_HandleImageVerification
      • eOTA_UpdateClientAttributes
      • eOTA_RestoreClientData
      • vOTA_SetImageValidityFlag
      • eOTA_ClientQuerySpecificFileRequest
      • eOTA_SpecificFileUpgradeEndRequest
      • vOTA_SetLowVoltageFlag
  • Structures
    • tsOTA_ImageHeader
    • tsOTA_Common
    • tsOTA_HwFncTable
    • tsNvmDefs
    • tsOTA_ImageNotifyCommand
    • tsOTA_QueryImageRequest
    • tsOTA_QueryImageResponse
    • tsOTA_BlockRequest
    • tsOTA_ImagePageRequest
    • tsOTA_ImageBlockResponsePayload
    • tsOTA_UpgradeEndRequestPayload
    • tsOTA_UpgradeEndResponsePayload
    • tsOTA_SuccessBlockResponsePayload
    • tsOTA_BlockResponseEvent
    • tsOTA_WaitForData
    • tsOTA_WaitForDataParams
    • tsOTA_PageReqServerParams
    • tsOTA_PersistedData
    • tsOTA_QuerySpecificFileRequestPayload
    • tsOTA_QuerySpecificFileResponsePayload
    • tsOTA_CallBackMessage
    • tsCLD_PR_Ota
    • tsCLD_AS_Ota
    • tsOTA_ImageVersionVerify
    • tsOTA_UpgradeDowngradeVerify
  • Enumerations
    • teOTA_Cluster
    • teOTA_UpgradeClusterEvents
    • eOTA_AuthorisationState
    • teOTA_ImageNotifyPayloadType
  • Compile-time options
    • Optional Attributes (Client only)
    • Global Attributes
    • Number of Images
    • OTA Block Size
    • Page Requests
    • Hardware Versions in OTA Header
    • Custom Serialization Data
    • OTA Command Acks
    • Frequency of Requests (Client only)
    • Upper Limit on Minimum Block Request Delay
    • Device Address Copying
    • No Security Certificate
    • Internal Storage of OTA Upgrade Image on Client
  • Build Process
    • Modifying Makefiles
    • Building Applications
    • Preparing and Downloading Initial Client Image
    • Preparing and Downloading Server Image
  • OTA Configuration for Internal Flash
    • Switching to a new image
• Part XIII: Appendices
• Appendix A: Mutex callbacks
• Appendix B: Attribute reporting
  • Appendix B.1: Automatic attribute reporting
  • Appendix B.2: Default reporting
  • Appendix B.3: Configuring attribute reporting
    • B.3.1: Compile-time Options
    • B.3.2: Server Options
      • Generate Attribute Reports
      • Handle ‘Configure Reporting’ Commands
      • Handle ‘Read Reporting Configuration’ Commands
      • Number of Attribute Reports
      • Number of String Attribute Reports
      • Maximum Size of Reportable String Attribute
      • Minimum Attribute Reporting Interval
      • Maximum Attribute Reporting Interval
    • B.3.3: Client Options
      • Receive Attribute Reports
      • Send ‘Configure Reporting’ Commands
      • Send ‘Read Reporting Configuration’ Commands
    • B.3.4: General (Server and Client) Options
    • B.3.5: Configuring Automatic Attribute Reports (from Client)
      • 1. Sending a ‘Configure Reporting’ Command (from Client)
      • 2. Receiving a ‘Configure Reporting’ Command (on Server)
      • 3. Receiving a ‘Configure Reporting’ Response (on Client)
    • B.3.6: Configuring Default Reporting (on Server)
    • B.3.7: ZCL Configuration for Attribute Reporting
    • B.3.8: Speeding Up Automatic Attribute Reports
  • Appendix B.4: Sending attribute reports
  • Appendix B.5: Receiving attribute reports
  • Appendix B.6: Querying attribute reporting configuration
    • Sending a ‘Read Reporting Configuration’ Command (from Client)
    • Receiving a ‘Read Reporting Configuration’ Command (on Server)
    • Receiving a ‘Read Reporting Configuration’ Response (on Client)
  • Appendix B.7: Storing an attribute reporting configuration
    • Persisting an attribute reporting configuration
    • Formatting an attribute reporting configuration record
      • Reduced Data Storage
      • Minimized Data Storage
• Appendix C: Extended attribute discovery
  • Appendix C.1: Compile-time options
  • Appendix C.2: Application coding
• Appendix D: Custom endpoints
  • Appendix D.1: Devices and Endpoints
  • Appendix D.2: Cluster Creation Functions
  • Appendix D.3: Custom Endpoint Set-up
    • Custom Endpoint Structure
• Appendix E: Manufacturer-specific attributes and commands
  • Appendix E.1: Adding Manufacturer-specific Attributes
  • Appendix E.2: Adding Manufacturer-specific Commands
• Appendix F: OTA extension for dual-processor nodes
  • Appendix F.1: Application Upgrades for Different Target Processors
  • Appendix F.2: Storing Upgrade Images in Co-processor Storage on Server
  • Appendix F.3: Use of Image Indices
• Appendix G: Glossary
• Revision history