tsCLD_CommissioningCallBackMessage

For a Commissioning event, the eEventType field of the tsZCL_CallBackEvent structure is set to E_ZCL_CBET_CLUSTER_CUSTOM. This event structure also contains an element sClusterCustomMessage, which is itself a structure containing a field pvCustomData. This field is a pointer to the following tsCLD_CommissioningCallBackMessage structure:

typedef struct
{
    uint8                      u8CommandId;
    union
    {
        tsCLD_Commissioning_RestartDevicePayload                    
                              *psRestartDevicePayload;
        tsCLD_Commissioning_ModifyStartupParametersPayload          
                              *psModifyStartupParamsPayload; 
    } uReqMessage;
    union
    {
        tsCLD_Commissioning_ResponsePayload                         
                              *psCommissioningResponsePayload; 
    } uRespMessage;
} tsCLD_CommissioningCallBackMessage;

where:

• u8CommandId indicates the type of Commissioning command that has been received by a cluster server or client (the same enumerations are used for requests on the server and responses on the client), one of:

  • E_CLD_COMMISSIONING_CMD_RESTART_DEVICE

  • E_CLD_COMMISSIONING_CMD_SAVE_STARTUP_PARAMS

  • E_CLD_COMMISSIONING_CMD_RESTORE_STARTUP_PARAMS

  • E_CLD_COMMISSIONING_CMD_RESET_STARTUP_PARAMS

• uReqMessage is a union containing the payload of a request command in the following form:

  • psRestartDevicePayload is a pointer to a structure containing the Restart Device command payload - see Section 43.9.2

  • psModifyStartupParamsPayload is a pointer to a structure containing the (common) payload for the Save Start-up Parameters, Restore Start-up Parameters and Reset Start-up Parameters commands - see Section43.9.3

• uRespMessage is a union containing the payload of a response command in the following form:

  • psCommissioningResponsePayload is a pointer to a structure containing the (common) payload for the Save Start-up Parameters, Restore Start-up Parameters and Reset Start-up Parameters responses - see Section 43.9.4

For further information on Commissioning cluster events, refer to Section 43.6.

Parent topic:Structures