(0x11) General Cluster Frames
- Luke Tutty (Unlicensed)
- Tracy W (Deactivated)
- Doug Alguire (Deactivated)
The General Clusters command set encompasses the following mandatory ZCL clusters in the general domain:
- Basic
- Identify
- Time
The mandatory commands associated with a given General Cluster are made available only if that cluster is first appended to the application endpoint configuration. For example, the Identify Start and Identify Stop commands will become available to the Host only after it configures an application endpoint with the Identify server cluster.
( PH:0x011, SH:0x00 ) - Received Reset to Factory Default Command
Overview
The Received Reset to Factory Default command is sent by the Module to the Host on reception of a Basic cluster Reset to Factory Default command from the network.
Please note: RapidConnect does not currently support this command. If the Host sends a Reset to Factory Default command, the Module will respond with UNSUPPORTED_CLUSTER_COMMAND (0x81) and will not trigger the Received Reset to Factory Default command.
Payload
The command has no payload.
Effect on Receipt
The Host is expected to reset the values of all supported attributes to their factory defaults. If the Host possesses these values, it should apply the Attribute Write command to re-write them.
Allowed Contexts
All Contexts
Sent By Host/Module
Module.
( PH:0x011, SH:0x10 ) - Identify Start Command
Overview
The Identify Start command is sent by the Module to the Host on reception of an Identify cluster Identify command from the network. Specifically, the command conveys the ID of the endpoint on which the Identify action should occur and will only be passed to the Host at its required time of execution.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint ID | ID of the endpoint on which the Identify action should start. |
Effect on Receipt
The Host shall initiate its Identify action (e.g., blinking LED, etc.) on the specified endpoint.
Allowed Contexts
All Contexts
Sent By Host/Module
Module.
( PH:0x011, SH:0x11 ) - Identify Stop Command
Overview
The Identify Stop command is sent by the Module to the Host on expiration of a preceding Identify Start command (i.e., when the Identify Time duration of that command has been expended) or on reception of an explicit command from the network prompting the application to stop identifying on the given endpoint.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0 | Endpoint | ID of the endpoint on which the Identify action should stop. |
Effect on Receipt
The Host shall stop its Identify action on the specified endpoint.
Allowed Contexts
All Contexts
Sent By Host/Module
Module.
( PH:0x011, SH:0x40 ) - Time Client Get Time Command
Overview
The Time Client Get Time command is sent by the Host to the Module to query the UTC and Local Time attributes of the application. Appending the Time cluster to the application endpoint configuration enables the application Time client, which automatically synchronizes its time with the network Time server.
Payload
The command has no payload.
Effect on Receipt
The Module will respond with the Time Client Get Time Response command.
Allowed Contexts
All Contexts
Sent By Host/Module
Host.
( PH:0x011, SH:0x41 ) - Time Client Get Time Response Command
Overview
The Time Client Get Time Response command is sent by the Module to the Host in response to a Time Client Get Time request. The command conveys both the current UTC and Local Time, as maintained by the application in synchronization with the network Time Server.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0..3 | Current UTC Time | The Current UTC Time. |
4..7 | Current Local Time | The Current Local Time. |
Effect on Receipt
None.
Allowed Contexts
All Contexts
Sent By Host/Module
Module.
( PH:0x011, SH:0x42 ) - Time Client Time Changed Command
Overview
The Time Client Time Changed command is sent by the Module to the Host to inform the Host of a change to the Current UTC Time and/or Current Local Time, as retrieved from the network Time Server. The command is also generated when the application first synchronizes its time with the Time Server.
Payload
The command has no payload.
Effect on Receipt
The Host should update its time by performing a Time Client Get Time query.
Allowed Contexts
All Contexts
Sent By Host/Module
Module.
( PH:0x011, SH:0x43 ) - Network Time Sync Period Write Command
Overview
The Network Time Sync Period Write command is sent from the Host to the Module to modify how often the Time Server will be polled by the device. The command conveys the time sync period in minutes.
By default the Time Server is polled every five minutes. This applies to all device types, including sleepy devices. Since such devices are battery-powered, it is good practice to minimize network communication when possible. Polling the Time Server every five minutes is considered excessive for a sleepy device.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Sync Period | The time period, in minutes, for the Time client to sync with the Time server 0x0001-0xFFFF: Valid range for time period |
Effect on Receipt
None
Allowed Contexts
All Contexts
Sent By Host/Module
Host.
( PH:0x011, SH:0x44 ) - Network Time Sync Period Request Command
Overview
The Network Time Sync Period Request command is sent from the Host to the Module to read the current value for the time sync period.
Payload
The command has no payload.
Effect on Receipt
The Module will respond with the Network Time Sync Period Response command, which conveys the current value of the time sync period.
Allowed Contexts
All Contexts
Sent By Host/Module
Host.
( PH:0x011, SH:0x45 ) - Network Time Sync Period Response Command
Overview
The Network Time Sync Period Response command is sent from the Module to the Host in response to a Network Time Sync Period Request command. The command conveys the time sync period currently set on the module.
Payload
Byte Index | Field Name | Notes |
|---|---|---|
0,1 | Sync Period | The time period, in minutes, for the Time client to sync with the Time server 0x0001-0xFFFF: Valid range for time period |
Effect on Receipt
None.
Allowed Contexts
All Contexts
Sent By Host/Module
Module.
Legal Notices
Copyright © 2020 MMB Networks, Inc. All rights reserved.
Confidential materials prepared and delivered by MMB Networks for receipt and review only by any partner subject to a valid and enforceable MMB Networks confidentiality agreement. Any receipt, review, or misuse of any of the content exchanged hereunder by any party not a party to this confidential exchange shall be subject to any and all rights available under the law. All rights, title and interest to the materials shall remain with MMB Networks.
Any suggestions provided to MMB Networks with respect to MMB Networks' products or services shall be collectively deemed “Feedback.” You, on behalf of yourself, or if you are providing Feedback on behalf of your employer or another entity, represent and warrant that you have full legal authority to bind such entity to these terms, agree to grant and hereby grant to MMB Networks a nonexclusive, perpetual, irrevocable, royalty free, worldwide license to use and otherwise exploit such Feedback within any MMB Networks products and services.