eCLD_IASACEGetZoneParameter

teZCL_Status eCLD_IASACEGetZoneParameter(
    uint8 u8SourceEndPointId,
    teCLD_IASACE_ZoneParameterID eParameterId,
    uint8 u8ZoneID,
    uint8 *pu8ParameterLength,
    uint8 *pu8ParameterValue);

Description

This function can be used on an IAS ACE cluster server to obtain the value of a Zone parameter. The Zone parameters for a particular Zone ID are held on the server in a tsCLD_IASACE_ZoneParameter structure (see Section 38.7.3) and this function can be used to read the value of one parameter in the structure. Before attempting the read, the function verifies that the specified Zone ID is present in the Zone table and that the specified parameter identifier is valid.

The function expects the read parameter value to be returned as a uint8 array.

Parameters

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

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

  • E_CLD_IASACE_ZONE_PARAMETER_ZONE_CONFIG_FLAG

  • E_CLD_IASACE_ZONE_PARAMETER_ZONE_STATUS_FLAG

  • E_CLD_IASACE_ZONE_PARAMETER_ZONE_STATUS

  • E_CLD_IASACE_ZONE_PARAMETER_AUDIBLE_NOTIFICATION

  • E_CLD_IASACE_ZONE_PARAMETER_ZONE_LABEL

  • E_CLD_IASACE_ZONE_PARAMETER_ARM_DISARM_CODE

• u8ZoneID: Zone ID of zone information to be accessed

• *pu8ParameterLength: Pointer to location to receive the number of uint8 elements in the array containing the parameter value obtained

• *pu8ParameterValue: Pointer to location to receive the first element of the array containing the parameter value obtained

Returns

• E_ZCL_SUCCESS (Zone parameter successfully read)

• E_ZCL_ERR_CLUSTER_NOT_FOUND (cluster instance not found)

• E_ZCL_ERR_PARAMETER_NULL (a specified pointer is NULL)

• E_ZCL_ERR_NO_REPORT_ENTRIES (Zone ID not found in Zone table)

• E_ZCL_ERR_ATTRIBUTE_NOT_FOUND (Zone parameter identifier invalid)

• E_ZCL_ERR_PARAMETER_RANGE (returned array too long to be stored)

Parent topic:Functions