Application Framework command interface Reference#
This document describes the ZCL command interface used by the Ember Application Framework for filling ZCL command buffers.
Modules#
Global Commands#
Command description for ReadAttributes.
Command description for ReadAttributes.
Command description for ReadAttributesResponse.
Command description for ReadAttributesResponse.
Command description for WriteAttributes.
Command description for WriteAttributes.
Command description for WriteAttributesUndivided.
Command description for WriteAttributesUndivided.
Command description for WriteAttributesResponse.
Command description for WriteAttributesResponse.
Command description for WriteAttributesNoResponse.
Command description for WriteAttributesNoResponse.
Command description for ConfigureReporting.
Command description for ConfigureReporting.
Command description for ConfigureReportingResponse.
Command description for ConfigureReportingResponse.
Command description for ReadReportingConfiguration.
Command description for ReadReportingConfiguration.
Command description for ReadReportingConfigurationResponse.
Command description for ReadReportingConfigurationResponse.
Command description for ReportAttributes.
Command description for ReportAttributes.
Command description for DefaultResponse.
Command description for DefaultResponse.
Command description for DiscoverAttributes.
Command description for DiscoverAttributes.
Command description for DiscoverAttributesResponse.
Command description for DiscoverAttributesResponse.
Command description for ReadAttributesStructured.
Command description for ReadAttributesStructured.
Command description for WriteAttributesStructured.
Command description for WriteAttributesStructured.
Command description for WriteAttributesStructuredResponse.
Command description for WriteAttributesStructuredResponse.
This command may be used to discover all commands processed (received) by this cluster, including optional or manufacturer specific commands.
This command may be used to discover all commands processed (received) by this cluster, including optional or manufacturer specific commands.
The discover commands received response command is sent in response to a discover commands received command, and is used to discover which commands a particular cluster can process.
The discover commands received response command is sent in response to a discover commands received command, and is used to discover which commands a particular cluster can process.
This command may be used to discover all commands which may be generated (sent) by the cluster, including optional or manufacturer specific commands.
This command may be used to discover all commands which may be generated (sent) by the cluster, including optional or manufacturer specific commands.
The discover client commands response command is sent in response to a discover client commands command, and is used to discover which commands a particular cluster supports.
The discover client commands response command is sent in response to a discover client commands command, and is used to discover which commands a particular cluster supports.
This command is similar to the discover attributes command, but also includes a field to indicate whether the attribute is readable, writeable or reportable.
This command is similar to the discover attributes command, but also includes a field to indicate whether the attribute is readable, writeable or reportable.
This command is sent in response to a discover attribute extended command and is used to determine if attributes are readable, writable or reportable.
This command is sent in response to a discover attribute extended command and is used to determine if attributes are readable, writable or reportable.
Basic Commands#
Command that resets all attribute values to factory default.
This command gets locales supported.
The locales supported response command is sent in response to a get locales supported command, and is used to discover which locales the device supports.
Identify Commands#
Command description for Identify.
Command description for IdentifyQuery.
Invoke EZMode on an Identify Server.
Update Commission State on the server device.
Command description for IdentifyQueryResponse.
Command description for TriggerEffect.
Groups Commands#
Command description for AddGroup.
Command description for ViewGroup.
Command description for GetGroupMembership.
Command description for RemoveGroup.
Command description for RemoveAllGroups.
Command description for AddGroupIfIdentifying.
Command description for AddGroupResponse.
Command description for ViewGroupResponse.
Command description for GetGroupMembershipResponse.
Command description for RemoveGroupResponse.
Scenes Commands#
Add a scene to the scene table. Extension field sets are supported, and are inputed as arrays of the form [[cluster ID] [length] [value0...n] ...].
Command description for ViewScene.
Command description for RemoveScene.
Command description for RemoveAllScenes.
Command description for StoreScene.
Command description for RecallScene.
Command description for GetSceneMembership.
Command description for AddSceneResponse.
Command description for ViewSceneResponse.
Command description for RemoveSceneResponse.
Command description for RemoveAllScenesResponse.
Command description for StoreSceneResponse.
Command description for GetSceneMembershipResponse.
Command description for EnhancedAddScene.
Command description for EnhancedViewScene.
Command description for CopyScene.
Command description for EnhancedAddSceneResponse.
Command description for EnhancedViewSceneResponse.
Command description for CopySceneResponse.
On/off Commands#
Command description for Off.
Command description for On.
Command description for Toggle.
Command description for OffWithEffect.
Command description for OnWithRecallGlobalScene.
Command description for OnWithTimedOff.
Client command that turns the device off with a transition given by the transition time in the Ember Sample transition time attribute.
Client command that turns the device on with a transition given by the transition time in the Ember Sample transition time attribute.
Client command that toggles the device with a transition given by the transition time in the Ember Sample transition time attribute.
Client command that turns the device on with a transition given by the transition time in the Ember Sample transition time attribute.
Client command that toggles the device with a transition given by the transition time in the Ember Sample transition time attribute.
Level Control Commands#
Command description for MoveToLevel.
Command description for Move.
Command description for Step.
Command description for Stop.
Command description for MoveToLevelWithOnOff.
Command description for MoveWithOnOff.
Command description for StepWithOnOff.
Command description for StopWithOnOff.
Command description for MoveToClosestFrequency.
Alarms Commands#
Command description for ResetAlarm.
Command description for ResetAllAlarms.
Command description for GetAlarm.
Command description for ResetAlarmLog.
Command description for Alarm.
Command description for GetAlarmResponse.
RSSI Location Commands#
Command description for SetAbsoluteLocation.
Command description for SetDeviceConfiguration.
Command description for GetDeviceConfiguration.
Command description for GetLocationData.
Command description for RssiResponse.
Command description for SendPings.
Command description for AnchorNodeAnnounce.
Command description for DeviceConfigurationResponse.
Command description for LocationDataResponse.
Command description for LocationDataNotification.
Command description for CompactLocationDataNotification.
Command description for RssiPing.
Command description for RssiRequest.
Command description for ReportRssiMeasurements.
Command description for RequestOwnLocation.
Commissioning Commands#
Command description for RestartDevice.
Command description for SaveStartupParameters.
Command description for RestoreStartupParameters.
Command description for ResetStartupParameters.
Command description for RestartDeviceResponse.
Command description for SaveStartupParametersResponse.
Command description for RestoreStartupParametersResponse.
Command description for ResetStartupParametersResponse.
Partition Commands#
The TransferPartitionedFrame command is used to send a partitioned frame to another Partition cluster.
The ReadHandshakeParam command is used in order to read the appropriate set of parameters for each transaction to be performed by the Partition Cluster.
The WriteHandshakeParam command is used during the handshake phase in order to write the appropriate parameters for each transaction to be performed by the Partition Cluster.
MultipleACK command.
The ReadHandshakeParamResponse command is used in order to response to the corresponding ReadHandshakeParam command in order to communicate the appropriate set of parameters configured for each transaction to be performed by the Partition Cluster.
Over the Air Bootloading Commands#
This command is generated when the upgrade server wishes to notify the clients of the available OTA upgrade image. The command can be sent as unicast which provides a way for the server to force the upgrade on the client. The command can also be sent as broadcast or multicast to certain class of clients (for example, the ones that have matching manufacturing and device ids).
This command is generated upon receipt of an Image Notify command to indicate that the client is looking for the next firmware image to upgrade to. The client may also choose to send the command periodically to the server.
This command is generated upon receipt of an QueryNextImageRequest command to response whether the server has a valid OTA upgrade image for the client or not. If the server has the file, information regarding the file and OTA upgrade process will be included in the command.
This command is generated by the client to request blocks of OTA upgrade file data.
This command is generated by the client to request pages of OTA upgrade file data. A page would contain multiple blocks of data.
This command is generated by the server in response to the block or page request command. If the server has the data available, it will reply back with a SUCCESS status. For other error cases, it may reply with status WAIT_FOR_DATA (server does not have the data available yet) or ABORT (invalid requested parameters or other failure cases).
This command is generated by the client to notify the server of the end of the upgrade process. The process may end with success or error status.
This command is generated by the server in response to the upgrade request in order to let the client know when to upgrade to running new firmware image.
This command is generated by the client to request a file that is specific to itself. The intention is to provide a way for the client to request non-OTA upgrade file.
This command is generated upon receipt of an QuerySpecificFileRequest command to response whether the server has a valid file for the client or not. If the server has the file, information regarding the file and OTA process will be included in the command.
Power Profile Commands#
The PowerProfileRequest Command is generated by a device supporting the client side of the Power Profile cluster in order to request the Power Profile of a server device.
The PowerProfileStateRequest Command is generated in order to retrieve the identifiers of current Power Profiles.
The GetPowerProfilePriceResponse command allows a device (client) to communicate the cost associated to the selected Power Profile to another device (server) requesting it.
The GetOverallSchedulePriceResponse command allows a device (client) to communicate the overall cost associated to all Power Profiles scheduled to another device (server) requesting it.
The EnergyPhasesScheduleNotification Command is generated by a device supporting the client side of the Power Profile cluster in order to schedule the start of the selected Power Profile and its phases.
This command is generated by the client side of Power Profile cluster as a reply to the EnergyPhasesScheduleRequest command.
The PowerProfileScheduleConstraintsRequest Command is generated by a device supporting the client side of the Power Profile cluster in order to request the constraints -if set- of Power Profile of a client device, in order to set the proper boundaries for the scheduling when calculating the schedules.
The EnergyPhasesScheduleStateRequest Command is generated by a device supporting the client side of the Power Profile cluster to check the states of the scheduling of a power profile, which is supported in the device implementing the server side of Power Profile cluster.
The Get Power Profile Price Extended Response command allows a device (client) to communicate the cost associated to all Power Profiles scheduled to another device (server) requesting it according to the specific options contained in the Get Power Profile Price Extended Response.
The PowerProfileNotification Command is generated by a device supporting the server side of the Power Profile cluster in order to send the information of the specific parameters (such as Peak power and others) belonging to each phase.
This command is generated by the server side of Power Profile cluster as a reply to the PowerProfileRequest command.
The PowerProfileStateResponse command allows a device (server) to communicate its current Power Profile(s) to another device (client) that previously requested them.
The GetPowerProfilePrice Command is generated by the server (e.g. White goods) in order to retrieve the cost associated to a specific Power profile.
The PowerProfileStateNotification Command is generated by the server (e.g. White goods) in order to update the state of the power profile and the current energy phase.
The GetOverallSchedulePrice Command is generated by the server (e.g. White goods) in order to retrieve the overall cost associated to all the Power Profiles scheduled by the scheduler (the device supporting the Power Profile cluster client side) for the next 24 hours.
The EnergyPhasesScheduleRequest Command is generated by the server (e.g. White goods) in order to retrieve from the scheduler (e.g. Home Gateway) the schedule (if available) associated to the specific Power Profile carried in the payload.
The EnergyPhasesScheduleStateResponse Command is generated by the server (e.g. White goods) in order to reply to a EnergyPhasesScheduleStateRequest command about the scheduling states that are set in the server side.
The EnergyPhasesScheduleStateNotification Command is generated by the server (e.g. White goods) in order to notify (un-solicited command) a client side about the scheduling states that are set in the server side.
The PowerProfileScheduleConstraintsNotification Command is generated by a device supporting the server side of the Power Profile cluster to notify the client side of this cluster about the imposed constraints and let the scheduler (i.e. the entity supporting the Power Profile cluster client side) to set the proper boundaries for the scheduling.
The PowerProfileScheduleConstraintsResponse Command is generated by a device supporting the server side of the Power Profile cluster to reply to a client side of this cluster which sent a PowerProfileScheduleConstraintsRequest.
The Get Power Profile Price Extended command is generated by the server (e.g., White Goods) in order to retrieve the cost associated to a specific Power profile considering specific conditions described in the option field (e.g., a specific time).
Appliance Control Commands#
This basic message is used to remotely control and to program household appliances.
This basic message is used to retrieve Household Appliances status.
This basic message is used to set appliance functions, i.e. information regarding the execution of an appliance cycle. Condition parameters such as start time or finish time information could be provided through this command.
This command shall be used to resume the normal behavior of a household appliance being in pause mode after receiving a Overload Pause command.
This command shall be used to pause the household appliance as a consequence of an imminent overload event.
This basic message is used to send warnings the household appliance as a consequence of a possible overload event, or the notification of the end of the warning state.
This command shall be used to return household appliance status, according to Appliance Status Values and Remote Enable Flags Values.
This command shall be used to return household appliance status, automatically when appliance status changes.
Poll Control Commands#
The Poll Control Cluster server sends out a Check-in command to the devices to which it is paired based on the server's Check-in Interval attribute.
The Check-in Response is sent in response to the receipt of a Check-in command.
The Fast Poll Stop command is used to stop the fast poll mode initiated by the Check-in response.
The Set Long Poll Interval command is used to set the read only Long Poll Interval Attribute.
The Set Short Poll Interval command is used to set the read only Short Poll Interval Attribute.
Green Power Commands#
From GPP to GPS to tunnel GP frame.
From GPP to GPSs in entire network to get pairing indication related to GPD for Proxy Table update.
From GPP to neighbor GPPs to indicate GP Notification sent in unicast mode.
From GPP to GPS to tunnel GPD commissioning data.
To enable commissioning mode of the sink, over the air.
To configure GPD Command Translation Table.
To provide GPD Command Translation Table content.
To configure Sink Table.
To read out selected Sink Table Entries, by index or by GPD ID.
To reply with read-out Proxy Table entries, by index or by GPD ID.
From GPS to GPP to acknowledge GP Notification received in unicast mode.
From GPS to the entire network to (de)register for tunneling service, or for removing GPD from the network.
From GPS to GPPs in the whole network to indicate commissioning mode.
From GPS to selected GPP, to provide data to be transmitted to Rx-capable GPD.
To provide GPD Command Translation Table content.
To selected Proxy Table entries, by index or by GPD ID.
To request selected Proxy Table entries, by index or by GPD ID.
Door Lock Commands#
Locks the door.
Unlocks the door.
Toggles the door lock from its current state to the opposite state locked or unlocked.
Unlock the door with a timeout. When the timeout expires, the door will automatically re-lock.
Retrieve a log record at a specified index.
Set the PIN for a specified user id.
Retrieve PIN information for a user with a specific user ID.
Clear the PIN for a user with a specific user ID.
Clear all PIN codes on the lock for all users.
Set the status value for a specified user ID.
Retrieve the status byte for a specific user.
Set the schedule of days during the week that the associated user based on the user ID will have access to the lock and will be able to operate it.
Retrieve a weekday schedule for doorlock user activation for a specific schedule id and user id.
Clear a weekday schedule for doorlock user activation for a specific schedule id and user id.
Set a door lock user id activation schedule according to a specific absolute local start and end time.
Retrieve a yearday schedule for a specific scheduleId and userId.
Clear a yearday schedule for a specific scheduleId and userId.
Set the holiday schedule for a specific user.
Retrieve a holiday schedule for a specific scheduleId.
Clear a holiday schedule for a specific scheduleId.
Set the type value for a user based on user ID.
Retrieve the type for a specific user based on the user ID.
Set the PIN for a specified user id.
Retrieve RFID ID information for a user with a specific user ID.
Clear the RFID ID for a user with a specific user ID.
Clear all RFID ID codes on the lock for all users.
Set the Disposable Schedule by specifying local start time and local end time for the specific user.
Retrieve the disposable schedule for the specific user.
Clear the Disposable schedule for the specific user.
Clear the Biometric Credential for the specific user.
Clear out all Biometric Credentials on the lock.
Indicates lock success or failure.
Indicates unlock success or failure.
Response provided to the toggle command, indicates whether the toggle was successful or not.
Response provided to unlock with specific timeout. This command indicates whether the unlock command was successful or not.
Returns the specific log record requested.
Indicates whether the setting of the PIN was successful or not.
Returns the PIN requested according to the user ID passed.
Returns success or failure depending on whether the PIN was cleared or not.
Returns success or failure depending on whether the PINs were cleared or not.
Returns success or failure depending on whether the user status was set or not.
Returns the user status.
Returns the status of setting the weekday schedule.
Returns the weekday schedule requested.
Returns the status of clearing the weekday schedule.
Returns success or failure depending on whether the yearday schedule was set or not.
Returns the yearday schedule requested.
Returns success or failure depending on whether the yearday schedule was removed or not.
Returns success or failure depending on whether the holiday schedule was set or not.
Returns the holiday schedule requested.
Returns success or failure depending on whether the holiday schedule was removed or not.
returns success or failure depending on whether the user type was set or not.
Returns the user type for the user ID requested.
Indicates whether the setting of the RFID ID was successful or not.
Returns the RFID ID requested according to the user ID passed.
Returns success or failure depending on whether the RFID ID was cleared or not.
Returns success or failure depending on whether the RFID IDs were cleared or not.
Returns pass/fail of the SetDisposableSchedule command.
Returns the Disposable schedule data for the User ID.
Returns pass/fail of the command.
Returns pass/fail of the command.
Returns pass/fail of the command.
Indicates that an operation event has taken place. Includes the associated event information.
Indicates that a programming event has taken place. Includes the associated programming event information.
Window Covering Commands#
Moves window covering to InstalledOpenLimit - Lift and InstalledOpenLimit - Tilt.
Moves window covering to InstalledClosedLimit - Lift and InstalledCloseLimit - Tilt.
Stop any adjusting of window covering.
Goto lift value specified.
Goto lift percentage specified.
Goto tilt value specified.
Goto tilt percentage specified.
Barrier Control Commands#
Command to instruct a barrier to go to a percent open state.
Command that instructs the barrier to stop moving.
Thermostat Commands#
Command description for SetpointRaiseLower.
Command description for SetWeeklySchedule.
Command description for GetWeeklySchedule.
The Clear Weekly Schedule command is used to clear the weekly schedule.
The Get Relay Status Log command is used to query the thermostat internal relay status log.
The Current Weekly Schedule Command is sent from the server in response to the Get Weekly Schedule Command.
This command is sent from the thermostat cluster server in response to the Get Relay Status Log.
Color Control Commands#
Move to specified hue.
Move hue up or down at specified rate.
Step hue up or down by specified size at specified rate.
Move to specified saturation.
Move saturation up or down at specified rate.
Step saturation up or down by specified size at specified rate.
Move to hue and saturation.
Move to specified color.
Moves the color.
Steps the lighting to a specific color.
Move to a specific color temperature.
Command description for EnhancedMoveToHue.
Command description for EnhancedMoveHue.
Command description for EnhancedStepHue.
Command description for EnhancedMoveToHueAndSaturation.
Command description for ColorLoopSet.
Command description for StopMoveStep.
Command description for MoveColorTemperature.
Command description for StepColorTemperature.
IAS Zone Commands#
Command description for zoneEnrollResponse.
Used to tell the IAS Zone server to commence normal operation mode.
Certain IAS Zone servers may have operational configurations that could be configured OTA or locally on the device. This command enables them to be remotely placed into a test mode so that the user or installer may configure their field of view, sensitivity, and other operational parameters.
Command description for zoneStatusChangeNotification.
Command description for zoneEnrollRequest.
Confirms that the IAS Zone server has commenced normal operation mode.
Confirms that the IAS Zone server has commenced test mode and that the IAS Zone client should treat any Zone Status Change Notification commands received from the sending IAS Zone server as being in response to test events.
IAS ACE Commands#
Command description for Arm.
Command description for Bypass.
Command description for Emergency.
Command description for Fire.
Command description for Panic.
Command description for GetZoneIdMap.
Command description for GetZoneInformation.
Used by the ACE client to request an update to the status of the ACE server.
Used by the ACE client to retrieve the bypassed zones.
Used by the ACE client to request an update to the zone status of the ACE server.
Command description for ArmResponse.
Command description for GetZoneIdMapResponse.
Command description for GetZoneInformationResponse.
This command updates ACE clients in the system of changes to zone status recorded by the ACE server (e.g., IAS CIE device).
This command updates ACE clients in the system of changes to panel status recorded by the ACE server (e.g., IAS CIE device).
Command updates requesting IAS ACE clients in the system of changes to the security panel status recorded by the ACE server.
Sets the list of bypassed zones on the IAS ACE client.
Provides the response of the security panel to the request from the IAS ACE client to bypass zones via a Bypass command.
This command updates requesting IAS ACE clients in the system of changes to the IAS Zone server statuses recorded by the ACE server (e.g., IAS CIE device).
IAS WD Commands#
Command description for StartWarning.
Command description for Squawk.
Generic Tunnel Commands#
This command is generated when an application wishes to find the ZigBee address (node, endpoint) of the Generic Tunnel server cluster with a given ProtocolAddress attribute. The command is typically multicast to a group of inter-communicating Generic Tunnel clusters.
This command is generated upon receipt of a Match Protocol Address command to indicate that the Protocol Address was successfully matched.
This command is typically sent upon startup, and whenever the ProtocolAddress attribute changes. It is typically multicast to a group of inter-communicating Generic Tunnel clusters.
BACnet Protocol Tunnel Commands#
This command is generated when a BACnet network layer wishes to transfer a BACnet NPDU across a ZigBee tunnel to another BACnet network layer.
11073 Protocol Tunnel Commands#
This command is generated when an 11073 network layer wishes to transfer an 11073 APDU across a ZigBee tunnel to another 11073 network layer.
This command is generated when an Health Care client wishes to connect to a Health Care server for the purposes of transmitting 11073 APDUs across the 11073 tunnel.
This command is generated when an Health Care client wishes to disconnect from a Health Care server.
Generated in response to requests related to connection or any event that causes the tunnel to become disconnected.
ISO 7816 Protocol Tunnel Commands#
Command description for TransferApdu.
Command description for TransferApdu.
Command description for InsertSmartCard.
Command description for ExtractSmartCard.
Price Commands#
The PublishPrice command is generated in response to receiving a Get Current Price command, in response to a Get Scheduled Prices command, and when an update to the pricing information is available from the commodity provider, either before or when a TOU price becomes active.
The PublishBlockPeriod command is generated in response to receiving a GetBlockPeriod(s) command or when an update to the block tariff schedule is available from the commodity provider.
The PublishConversionFactor command is sent in response to a GetConversionFactor command or if a new Conversion factor is available.
The PublishCalorificValue command is sent in response to a GetCalorificValue command or if a new calorific value is available.
The PublishTariffInformation command is sent in response to a GetTariffInformation command or if new tariff information is available (including price matrix and block thresholds).
PublishPriceMatrix command is used to publish the Block Price Information Set (up to 15 tiers x 15 blocks) and the Extended Price Information Set (up to 48 tiers). The PublishPriceMatrix command is sent in response to a GetPriceMatrix command.
The PublishBlockThreshold command is sent in response to a GetBlockThreshold command.
The PublishCO2Value command is sent in response to a GetCO2Value command or if a new CO2 conversion factor is available.
The PublishTierLabels command is generated in response to receiving a GetTierLabels command or when there is a tier label change.
The PublishBillingPeriod command is generated in response to receiving a GetBillingPeriod(s) command or when an update to the Billing schedule is available from the commodity Supplier.
The PublishConsolidatedBill command is used to make consolidated billing information of previous billing periods available to other end devices. This command is issued in response to a GetConsolidatedBill command or if new billing information is available.
The PublishCPPEvent command is sent from an ESI to its price clients to notify them of a Critical Peak Pricing event.
The PublishCreditPayment command is used to update the credit payment information is available.
The PublishCurrencyConversion command is sent in response to a GetCurrencyConversion command or when a new currency becomes available.
The CancelTariff command indicates that all data associated with a particular tariff instance should be discarded.
The GetCurrentPrice command initiates a PublishPrice command for the current time.
The GetScheduledPrices command initiates a PublishPrice command for available price events.
The PriceAcknowledgement command described provides the ability to acknowledge a previously sent PublishPrice command.
The GetBlockPeriods command initiates a PublishBlockPeriod command for the currently scheduled block periods.
The GetConversionFactor command initiates a PublishConversionFactor command for the scheduled conversion factor updates.
The GetCalorificValue command initiates a PublishCalorificValue command for the scheduled conversion factor updates.
The GetTariffInformation command initiates a PublishTariffInformation command for the scheduled tariff updates.
The GetPriceMatrix command initiates a PublishPriceMatrix command for the scheduled Price Matrix updates.
The GetBlockThresholds command initiates a PublishBlockThreshold command for the scheduled Block Threshold updates.
The GetCO2Value command initiates a PublishCO2Value command for the scheduled CO2 conversion factor updates.
The GetTierLabels command allows a client to retrieve the tier labels associated with a given tariff; this command initiates a PublishTierLabels command from the server.
The GetBillingPeriod command initiates one or more PublishBillingPeriod commands for the currently scheduled billing periods.
The GetConsolidatedBill command initiates one or more PublishConsolidatedBill commands with the requested billing information.
The CPPEventResponse command is sent from a Client (IHD) to the ESI to notify it of a Critical Peak Pricing event authorization.
The GetCreditPayment command initiates PublishCreditPayment commands for the requested credit payment information.
The GetCurrencyConversionCommand command initiates a PublishCurrencyConversion command for the currency conversion factor updates. A server shall be capable of storing both the old and the new currencies.
The GetTariffCancellation command initiates the return of the last CancelTariff command held on the associated server.
Demand Response and Load Control Commands#
Command description for LoadControlEvent.
Command description for CancelLoadControlEvent.
Command description for CancelAllLoadControlEvents.
Command description for ReportEventStatus.
Command description for GetScheduledEvents.
Simple Metering Commands#
This command is generated when the Client command GetProfile is received.
This command is used to request the ESI to mirror Metering Device data.
This command is used to request the ESI to remove its mirror of Metering Device data.
This command is generated when the client command Request Fast Poll Mode is received.
This command is generated in response to a ScheduleSnapshot command, and is sent to confirm whether the requested snapshot schedule has been set up.
This command is generated in response to a TakeSnapshot command, and is sent to confirm whether the requested snapshot has been accepted and successfully taken.
This command is generated in response to a GetSnapshot command. It is used to return a single snapshot to the client.
This command is used to send the requested sample data to the client. It is generated in response to a GetSampledData command.
ConfigureMirror is sent to the mirror once the mirror has been created. The command deals with the operational configuration of the Mirror.
The ConfigureNotificationScheme is sent to the mirror once the mirror has been created. The command deals with the operational configuration of the Mirror and the device that reports to the mirror. No default schemes are allowed to be overwritten.
The ConfigureNotificationFlags command is used to set the commands relating to the bit value for each NotificationFlags attribute that the scheme is proposing to use.
The GetNotifiedMessage command is used only when a BOMD is being mirrored. This command provides a method for the BOMD to notify the Mirror message queue that it wants to receive commands that the Mirror has queued. The Notification flags set within the command shall inform the mirror of the commands that the BOMD is requesting.
This command is transmitted by a Metering Device in response to a ChangeSupply command.
This command is transmitted by a Metering Device in response to a StartSampling command.
The GetProfile command is generated when a client device wishes to retrieve a list of captured Energy, Gas or water consumption for profiling purposes.
The Request Mirror Response Command allows the ESI to inform a sleepy Metering Device it has the ability to store and mirror its data.
The Mirror Removed Command allows the ESI to inform a sleepy Metering Device mirroring support has been removed or halted.
The Request Fast Poll Mode command is generated when the metering client wishes to receive near real-time updates of InstantaneousDemand.
This command is used to set up a schedule of when the device shall create snapshot data.
This command is used to instruct the cluster server to take a single snapshot.
This command is used to request snapshot data from the cluster server.
The sampling mechanism allows a set of samples of the specified type of data to be taken, commencing at the stipulated start time. This mechanism may run concurrently with the capturing of profile data, and may refer the same parameters, albeit possibly at a different sampling rate.
This command is used to request sampled data from the server. Note that it is the responsibility of the client to ensure that it does not request more samples than can be held in a single command payload.
This command is sent in response to the ReportAttribute command when the MirrorReporting attribute is set.
The ResetLoadLimitCounter command shall cause the LoadLimitCounter attribute to be reset.
This command is sent from the Head-end or ESI to the Metering Device to instruct it to change the status of the valve or load switch, i.e. the supply.
This command is a simplified version of the ChangeSupply command, intended to be sent from an IHD to a meter as the consequence of a user action on the IHD. Its purpose is to provide a local disconnection/reconnection button on the IHD in addition to the one on the meter.
This command is used to specify the required status of the supply following the occurance of certain events on the meter.
This command is used to update the 'Uncontrolled Flow Rate' configuration data used by flow meters.
Messaging Commands#
Command description for DisplayMessage.
The CancelMessage command provides the ability to cancel the sending or acceptance of previously sent messages.
The DisplayProtected Message command is for use with messages that are protected by a password or PIN.
The CancelAllMessages command indicates to a client device that it should cancel all display messages currently held by it.
Command description for GetLastMessage.
The Message Confirmation command provides an indication that a Utility Customer has acknowledged and/or accepted the contents of a previously sent message. Enhanced Message Confirmation commands shall contain an answer of 'NO', 'YES' and/or a message confirmation string.
This command initiates the return of the first (and maybe only) Cancel All Messages command held on the associated server, and which has an implementation time equal to or later than the value indicated in the payload.
Tunneling Commands#
RequestTunnel is the client command used to setup a tunnel association with the server. The request payload specifies the protocol identifier for the requested tunnel, a manufacturer code in case of proprietary protocols and the use of flow control for streaming protocols.
Client command used to close the tunnel with the server. The parameter in the payload specifies the tunnel identifier of the tunnel that has to be closed. The server leaves the tunnel open and the assigned resources allocated until the client sends the CloseTunnel command or the CloseTunnelTimeout fires.
Command that indicates (if received) that the client has sent data to the server. The data itself is contained within the payload.
This command is generated by the receiver of a TransferData command if the tunnel status indicates that something is wrong. There are two three cases in which TransferDataError is sent: (1) The TransferData received contains a TunnelID that does not match to any of the active tunnels of the receiving device. This could happen if a (sleeping) device sends a TransferData command to a tunnel that has been closed by the server after the CloseTunnelTimeout. (2) The TransferData received contains a proper TunnelID of an active tunnel, but the device sending the data does not match to it. (3) The TransferData received contains more data than indicated by the MaximumIncomingTransferSize of the receiving device.
Command sent in response to each TransferData command in case - and only in case - flow control has been requested by the client in the TunnelRequest command and is supported by both tunnel endpoints. The response payload indicates the number of octets that may still be received by the receiver.
The ReadyData command is generated - after a receiver had to stop the dataflow using the AckTransferData(0) command - to indicate that the device is now ready to continue receiving data. The parameter NumberOfOctetsLeft gives a hint on how much space is left for the next data transfer. The ReadyData command is only issued if flow control is enabled.
Get Supported Tunnel Protocols is the client command used to determine the Tunnel protocols supported on another device.
RequestTunnelResponse is sent by the server in response to a RequestTunnel command previously received from the client. The response contains the status of the RequestTunnel command and a tunnel identifier corresponding to the tunnel that has been set-up in the server in case of success.
Command that transfers data from server to the client. The data itself has to be placed within the payload.
This command is generated by the receiver of a TransferData command if the tunnel status indicates that something is wrong. There are two three cases in which TransferDataError is sent: (1) The TransferData received contains a TunnelID that does not match to any of the active tunnels of the receiving device. This could happen if a (sleeping) device sends a TransferData command to a tunnel that has been closed by the server after the CloseTunnelTimeout. (2) The TransferData received contains a proper TunnelID of an active tunnel, but the device sending the data does not match to it. (3) The TransferData received contains more data than indicated by the MaximumIncomingTransferSize of the receiving device.
Command sent in response to each TransferData command in case - and only in case - flow control has been requested by the client in the TunnelRequest command and is supported by both tunnel endpoints. The response payload indicates the number of octets that may still be received by the receiver.
The ReadyData command is generated - after a receiver had to stop the dataflow using the AckTransferData(0) command - to indicate that the device is now ready to continue receiving data. The parameter NumberOfOctetsLeft gives a hint on how much space is left for the next data transfer. The ReadyData command is only issued if flow control is enabled.
Supported Tunnel Protocol Response is sent in response to a Get Supported Tunnel Protocols command previously received. The response contains a list of Tunnel protocols supported by the device; the payload of the response should be capable of holding up to 16 protocols.
TunnelClosureNotification is sent by the server to indicate that a tunnel has been closed due to expiration of a CloseTunnelTimeout.
Prepayment Commands#
This command is sent to the Metering Device to activate the use of any Emergency Credit available on the Metering Device.
The ChangeDebt command is send to the Metering Device to change the fuel or Non fuel debt values.
This command is a method to set up the parameters for the emergency credit.
The ConsumerTopUp command is used by the IPD and the ESI as a method of applying credit top up values to the prepayment meter.
The CreditAdjustment command is sent to update the accounting base for the Prepayment meter.
This command is sent to a Metering Device to instruct it to change its mode of operation. i.e. from Credit to Prepayment.
This command is used to request the cluster server for snapshot data.
This command is sent to the Metering Device to retrieve the log of Top Up codes received by the meter.
This command is sent from client to a Prepayment server to set the warning level for low credit.
This command is used to request the contents of the repayment log.
This command is sent from a client to the Prepayment server to set the maximum credit level allowed in the meter.
This command is sent from a client to the Prepayment server to set the overall debt cap allowed in the meter.
This command is generated in response to a GetPrepaySnapshot command. It is used to return a single snapshot to the client.
This command is send in response to the ChangePaymentMode Command.
This command is send in response to the ConsumerTopUp Command.
This command is used to send the Top Up Code Log entries to the client.
This command is used to send the contents of the Repayment Log.
Energy Management Commands#
This command is reused from the DRLC cluster. This command is generated in response to the Manage Event command.
The Manage Event command allows a remote device (such as an IHD or web portal) to change the behavior of a DRLC cluster client when responding to a DRLC Load Control Event.
Calendar Commands#
The PublishCalendar command is published in response to a GetCalendar command or if new calendar information is available.
The PublishDayProfile command is published in response to a GetDayProfile command.
The PublishWeekProfile command is published in response to a GetWeekProfile command.
The PublishSeasons command is published in response to a GetSeason command.
The PublishSpecialDays command is published in response to a GetSpecialDays command or if a calendar update is available.
The CancelCalendar command indicates that all data associated with a particular calendar instance should be discarded.
This command initiates PublishCalendar command(s) for scheduled Calendar updates.
This command initiates one or more PublishDayProfile commands for the referenced Calendar.
This command initiates one or more PublishWeekProfile commands for the referenced Calendar.
This command initiates one or more PublishSeasons commands for the referenced Calendar.
This command initiates one or more PublishSpecialDays commands for the scheduled Special Day Table updates.
This command initiates the return of the last CancelCalendar command held on the associated server.
Device Management Commands#
This command is used to request the ESI to respond with information regarding any available change of tenancy.
This command is used to request the ESI to respond with information regarding any available change of supplier.
This command is used to request the current password from the server.
This command is used to request the ESI to respond with information regarding any pending change of Site ID.
This command is sent in response to a GetEventConfiguration command.
This command is used to request the ESI to respond with information regarding any pending change of Customer ID Number.
This command is used to change the tenancy of a meter.
This command is used to change the Supplier (energy supplier) that is supplying the meter (s).
This command is used to send the current password to the client.
This command is used to set the siteID.
This command provides a method to set the event configuration attributes, held in a client device.
This command allows the server to request details of event configurations.
This command is used to set the CustomerIDNumber attribute held in the Metering cluster.
Events Commands#
The GetEventLog command allows a client to request events from a server's event logs. One or more PublishEventLog commands are returned on receipt of this command.
The ClearEventLogRequest command requests that an Events server device clear the specified event log(s).
The PublishEvent command is generated upon an event trigger from within the reporting device and, if supported, the associated Event Configuration attribute in the Device Management cluster.
This command is generated on receipt of a GetEventLog command. The command returns the most recent event first and up to the number of events requested.
This command is generated on receipt of a Clear Event Log Request command.
MDU Pairing Commands#
The Pairing Response command provides a device joining a MDU network with a list of the devices that will constitute the 'virtual HAN' for the household in which the joining device is to operate.
The Pairing Request command allows a device joining a MDU network to determine the devices that will constitute the 'virtual HAN' for the household in which it is to operate.
Sub-GHz Commands#
The server sends it to temporarily suspend ZCL messages from clients it identifies as causing too much traffic.
The client sends it to determine the current status of its ZCL communications from the server.
Key Establishment Commands#
Command description for InitiateKeyEstablishmentRequest.
Command description for EphemeralDataRequest.
Command description for ConfirmKeyDataRequest.
Command description for TerminateKeyEstablishment.
Command description for TerminateKeyEstablishment.
Command description for InitiateKeyEstablishmentResponse.
Command description for EphemeralDataResponse.
Command description for ConfirmKeyDataResponse.
Information Commands#
Command description for RequestInformation.
Command description for PushInformationResponse.
Command description for SendPreference.
Command description for RequestPreferenceResponse.
Command description for Update.
Command description for Delete.
Command description for ConfigureNodeDescription.
Command description for ConfigureDeliveryEnable.
Command description for ConfigurePushInformationTimer.
Command description for ConfigureSetRootId.
Command description for RequestInformationResponse.
Command description for PushInformation.
Command description for SendPreferenceResponse.
Command description for ServerRequestPreference.
Command description for RequestPreferenceConfirmation.
Command description for UpdateResponse.
Command description for DeleteResponse.
Data Sharing Commands#
Command description for ReadFileRequest.
Command description for ReadRecordRequest.
Command description for WriteFileResponse.
Command description for WriteFileRequest.
Command description for ModifyFileRequest.
Command description for ModifyRecordRequest.
Command description for FileTransmission.
Command description for RecordTransmission.
Gaming Commands#
Command description for SearchGame.
Command description for JoinGame.
Command description for StartGame.
Command description for PauseGame.
Command description for ResumeGame.
Command description for QuitGame.
Command description for EndGame.
Command description for StartOver.
Command description for ActionControl.
Command description for DownloadGame.
Command description for GameAnnouncement.
Command description for GeneralResponse.
Data Rate Control Commands#
Command description for PathCreation.
Command description for DataRateNotification.
Command description for PathDeletion.
Command description for DataRateControl.
Voice over ZigBee Commands#
Command description for EstablishmentRequest.
Command description for VoiceTransmission.
Command description for VoiceTransmissionCompletion.
Command description for ControlResponse.
Command description for EstablishmentResponse.
Command description for VoiceTransmissionResponse.
Command description for Control.
Chatting Commands#
Command description for JoinChatRequest.
Command description for LeaveChatRequest.
Command description for SearchChatRequest.
Command description for SwitchChairmanResponse.
Command description for StartChatRequest.
Command description for ChatMessage.
Command description for GetNodeInformationRequest.
Command description for StartChatResponse.
Command description for JoinChatResponse.
Command description for UserLeft.
Command description for UserJoined.
Command description for SearchChatResponse.
Command description for SwitchChairmanRequest.
Command description for SwitchChairmanConfirm.
Command description for SwitchChairmanNotification.
Command description for GetNodeInformationResponse.
Payment Commands#
Command description for BuyRequest.
Command description for AcceptPayment.
Command description for PaymentConfirm.
Command description for BuyConfirm.
Command description for ReceiptDelivery.
Command description for TransactionEnd.
Billing Commands#
Command description for Subscribe.
Command description for Unsubscribe.
Command description for StartBillingSession.
Command description for StopBillingSession.
Command description for BillStatusNotification.
Command description for SessionKeepAlive.
Command description for CheckBillStatus.
Command description for SendBillRecord.
Appliance Events and Alert Commands#
This basic message is used to retrieve Household Appliance current alerts.
This message is used to return household appliance current alerts.
This message is used to notify the current modification of warning and/or fault conditions.
This message is used to notify an event occurred during the normal working of the appliance.
Appliance Statistics Commands#
The Appliance Statistics Cluster server occasionally sends out a Log Notification command to the devices to which it needs to log information related to statistics (e.g., home gateways) which implement the client side of Appliance Statistics Cluster.
The Appliance Statistics Cluster server sends out a Log Response command to respond to a Log Request command generated by the client side of the Appliance Statistics cluster.
The Log Queue Response command is generated as a response to a LogQueueRequest command in order to notify the client side of the Appliance statistics cluster about the logs stored in the server side (queue) that can be retrieved by the client side of this cluster through a LogRequest command.
The Appliance Statistics Cluster server sends out a Statistic Available command to notify the client side of the Appliance Statistics cluster that there are statistics that can be retrieved by using the Log Request command.
The Log request command is sent from a device supporting the client side of the Appliance Statistics cluster (e.g., Home Gateway) to retrieve the log from the device supporting the server side (e.g., appliance).
The Log Queue Request command is send from a device supporting the client side of the Appliance Statistics cluster (e.g. Home Gateway) to retrieve the information about the logs inserted in the queue, from the device supporting the server side (e.g. appliance).
Electrical Measurement Commands#
A function which returns the power profiling information requested in the GetProfileInfo command. The power profiling information consists of a list of attributes which are profiled along with the period used to profile them.
A function which returns the electricity measurement profile. The electricity measurement profile includes information regarding the amount of time used to capture data related to the flow of electricity as well as the intervals thes.
A function which retrieves the power profiling information from the electrical measurement server.
A function which retrieves an electricity measurement profile from the electricity measurement server for a specific attribute Id requested.
ZLL Commissioning Commands#
Command description for ScanRequest.
Command description for DeviceInformationRequest.
Command description for IdentifyRequest.
Command description for ResetToFactoryNewRequest.
Command description for NetworkStartRequest.
Command description for NetworkJoinRouterRequest.
Command description for NetworkJoinEndDeviceRequest.
Command description for NetworkUpdateRequest.
Command description for GetGroupIdentifiersRequest.
Command description for GetEndpointListRequest.
Command description for ScanResponse.
Command description for DeviceInformationResponse.
Command description for NetworkStartResponse.
Command description for NetworkJoinRouterResponse.
Command description for NetworkJoinEndDeviceResponse.
Command description for EndpointInformation.
Command description for GetGroupIdentifiersResponse.
Command description for GetEndpointListResponse.
Sample Mfg Specific Cluster Commands#
A sample manufacturer specific command within the sample manufacturer specific cluster.
Sample Mfg Specific Cluster 2 Commands#
A sample manufacturer specific command within the sample manufacturer specific cluster.
Configuration Cluster Commands#
Command to write a token value over the air.
Command to lock the token values.
Command to read a token value.
Command to unlock tokens with a device-specific password (if allowed).
Response to a token value read.
MFGLIB Cluster Commands#
Command to put the device into streaming mode.
Command to put the device into tone mode.
Command to put the device into RX mode.
SL Works With All Hubs Commands#
Enable enforcement of APS-level security for all cluster commands.
Disable enforcement of APS-level security for all cluster commands.
Query status of APS-level security enforcement for a specified cluster.
Trigger device to request a new APS link key from the Trust Center.
Enable WWAH App Event retry algorithm.
Disable WWAH App Event retry algorithm.
Trigger device to request current attribute values from Time Cluster server.
Enable WWAH rejoin algorithm.
Disable WWAH rejoin algorithm.
Set the enrollment method of an IAS Zone server.
Clear the binding table.
Enable device to periodically check connectivity with Zigbee Coordinator.
Disable device from periodically checking connectivity with Zigbee Coordinator.
Set MAC poll failure wait time.
Set pending network update parameters.
Require all unicast commands to have APS ACKs enabled.
Roll back changes made by Require APS ACK on Unicasts.
Query whether unicast commands are required to have APS ACKs enabled.
Query for specified debug report.
Causes device to perform a scan for beacons advertising the device's network.
Disallow OTA downgrade of all device firmware components.
Causes device to ignore MGMT Leave Without Rejoin commands.
Causes device to ignore Touchlink Interpan messages.
Enable WWAH Parent Classification advertisements.
Disable WWAH Parent Classification advertisements.
Process only network key rotation commands sent via unicast and encrypted by Trust Center Link Key.
Enable WWAH Bad Parent Recovery feature.
Disable WWAH Bad Parent Recovery feature.
Enable Configuration Mode.
Disable Configuration Mode.
Use only the Trust Center as cluster server for the set of clusters specified.
Causes device to send an appropriate Trust Center for Cluster Server Query Response command.
Command description for SlAPSLinkKeyAuthorizationQueryResponse.
Command description for SlPoweringOffNotification.
Command description for SlPoweringOnNotification.
Command description for SlShortAddressChange.
Command description for SlAPSAckEnablementQueryResponse.
Command description for SlPowerDescriptorChange.
Command description for SlNewDebugReportNotification.
Command description for SlDebugReportQueryResponse.
Command description for SlTrustCenterForClusterServerQueryResponse.
Command description for SlSurveyBeaconsResponse.
Command description for SlUseTrustCenterForClusterServerResponse.