eCLD_IASACEGetPanelParameter

teZCL_Status eCLD_IASACEGetPanelParameter(
    uint8 u8SourceEndPointId,
    teCLD_IASACE_PanelParameterID eParameterId,
    uint8 *pu8ParameterValue);

Description

This function can be used on an IAS ACE cluster server to obtain the value of a Panel parameter. The Panel parameters are held on the server in a tsCLD_IASACE_PanelParameter structure (see Section 38.7.4) and this function can be used to read the value of one parameter in the structure. The function verifies that the specified parameter identifier is valid before attempting the read.

Parameters

  • u8SourceEndPointId: Number of the endpoint on which the IAS ACE cluster resides

  • eParameterId : Enumeration identifying the Panel parameter to be read, one of:

  • E_CLD_IASACE_PANEL_PARAMETER_PANEL_STATUS

  • E_CLD_IASACE_PANEL_PARAMETER_SECONDS_REMAINING

  • E_CLD_IASACE_PANEL_PARAMETER_AUDIBLE_NOTIFICATION

  • E_CLD_IASACE_PANEL_PARAMETER_ALARM_STATUS

  • pu8ParameterValue: Pointer to location to receive read parameter value

Returns

  • E_ZCL_SUCCESS (Panel parameter successfully read)

  • E_ZCL_ERR_CLUSTER_NOT_FOUND (cluster instance not found)

  • E_ZCL_ERR_PARAMETER_NULL (specfied pointer is NULL)

  • E_ZCL_ERR_ATTRIBUTE_NOT_FOUND (Panel parameter identifier invalid)

Parent topic:Functions