Zone Parameters

The following structure is used to store the ‘zone parameters’ on the IAS ACE cluster server.

typedef struct
{
    zbmap8                        u8ZoneConfigFlag;
    zbmap8                        u8ZoneStatusFlag;
    zbmap16                       eZoneStatus;
    zenum8                        eAudibleNotification;
    tsZCL_CharacterString         sZoneLabel;
    uint8                                   
          au8ZoneLabel[CLD_IASACE_MAX_LENGTH_ZONE_LABEL];
    tsZCL_CharacterString         sArmDisarmCode;
    uint8                                   
          au8ArmDisarmCode[CLD_IASACE_MAX_LENGTH_ARM_DISARM_CODE];
}tsCLD_IASACE_ZoneParameter;

where:

  • u8ZoneConfigFlag is is a bitmap used to configure the temporal role of a zone (as Day, Night or Day/Night) and whether the zone is allowed to be bypassed. Macros are provided as follows:

Bit

Macro

0

CLD_IASACE_ZONE_CONFIG_FLAG_BYPASS *

1

CLD_IASACE_ZONE_CONFIG_FLAG_DAY_HOME

2

CLD_IASACE_ZONE_CONFIG_FLAG_NIGHT_SLEEP

3

CLD_IASACE_ZONE_CONFIG_FLAG_NOT_BYPASSED **

4-7

Reserved

  • * Determines whether the zone is allowed to be bypassed: 1 - allowed, 0 - not allowed

  • ** Used to configure a status of ZONE_NOT_BYPASSED in responses to Bypass commands

  • u8ZoneStatusFlag is a bitmap used to indicate the current status of a zone as armed or bypassed. Macros are provided as follows:

Bit

Macro

0

CLD_IASACE_ZONE_STATUS_FLAG_BYPASS

1

CLD_IASACE_ZONE_STATUS_FLAG_ARM

2-7

Reserved

  • e``ZoneStatus is the zone status as the value of the b16ZoneStatus attribute of the IAS Zone cluster (see Section 37.2)

  • eAudibleNotification is a value specifying whether an audible notification (e.g. a chime) is required to signal a zone status change (enumerations are available in teCLD_IASACE_AudibleNotification - see Section 38.8.4):

Value

Status

0x00

Audible notification muted

0x01

Audible notification sounded

0x02 - 0xFF

Reserved

  • sZoneLabel is the name/label for the zone represented as a character string

  • au8ZoneLabel[] is the name/label for the zone represented as an array of ASCII values

  • sArmDisarmCode is the arm/disarm code for the zone represented as a character string

  • au8ArmDisarmCode[] is the arm/disarm code for the zone represented as an array of ASCII values

Parent topic:Structures