5.2.6.3.1. ZCL General Clusters

This section provides the general clusters implementations in ZCL of ESP Zigbee Core.

5.2.6.3.1.1. Basic

5.2.6.3.1.1.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/basic_desc.h

5.2.6.3.1.1.2. Functions

ezb_err_t ezb_zcl_basic_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an basic cluster descriptor.

Parameters:

• cluster_desc -- [in] The basic cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_basic_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an basic cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the basic cluster configuration structure. Use ezb_zcl_basic_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_basic_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_basic_cluster_client_init(uint8_t ep_id)

Initialize the Basic cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_basic_cluster_server_init(uint8_t ep_id)

Initialize the Basic cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.1.3. Structures

struct ezb_zcl_basic_cluster_server_config_s

Configuration mandatory attributes for the Basic server cluster.

Public Members

uint8_t zcl_version

Configurable mandatory ZCLVersion attribute

uint8_t power_source

Configurable mandatory PowerSource attribute

5.2.6.3.1.1.4. Macros

EZB_ZCL_BASIC_CLUSTER_REVISION

Cluster Revision of the basic cluster implementation.

EZB_ZCL_BASIC_ZCL_VERSION_DEFAULT_VALUE

Default value of ZCLVersion in Basic cluster.

EZB_ZCL_BASIC_ZCL_VERSION_MIN_VALUE

Minimum value of ZCLVersion in Basic cluster.

EZB_ZCL_BASIC_ZCL_VERSION_MAX_VALUE

Maximum value of ZCLVersion in Basic cluster.

EZB_ZCL_BASIC_APPLICATION_VERSION_DEFAULT_VALUE

Default value of ApplicationVersion in Basic cluster.

EZB_ZCL_BASIC_APPLICATION_VERSION_MIN_VALUE

Minimum value of ApplicationVersion in Basic cluster.

EZB_ZCL_BASIC_APPLICATION_VERSION_MAX_VALUE

Maximum value of ApplicationVersion in Basic cluster.

EZB_ZCL_BASIC_STACK_VERSION_DEFAULT_VALUE

Default value of StackVersion in Basic cluster.

EZB_ZCL_BASIC_STACK_VERSION_MIN_VALUE

Minimum value of StackVersion in Basic cluster.

EZB_ZCL_BASIC_STACK_VERSION_MAX_VALUE

Maximum value of StackVersion in Basic cluster.

EZB_ZCL_BASIC_HW_VERSION_DEFAULT_VALUE

Default value of HWVersion in Basic cluster.

EZB_ZCL_BASIC_HW_VERSION_MIN_VALUE

Minimum value of HWVersion in Basic cluster.

EZB_ZCL_BASIC_HW_VERSION_MAX_VALUE

Maximum value of HWVersion in Basic cluster.

EZB_ZCL_BASIC_POWER_SOURCE_DEFAULT_VALUE

Default value of PowerSource in Basic cluster.

EZB_ZCL_BASIC_GENERIC_DEVICE_CLASS_DEFAULT_VALUE

Default value of GenericDevice-Class in Basic cluster.

EZB_ZCL_BASIC_GENERIC_DEVICE_CLASS_MIN_VALUE

Minimum value of GenericDevice-Class in Basic cluster.

EZB_ZCL_BASIC_GENERIC_DEVICE_CLASS_MAX_VALUE

Maximum value of GenericDevice-Class in Basic cluster.

EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_DEFAULT_VALUE

Default value of GenericDevice-Type in Basic cluster.

EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_MIN_VALUE

Minimum value of GenericDevice-Type in Basic cluster.

EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_MAX_VALUE

Maximum value of GenericDevice-Type in Basic cluster.

EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DEFAULT_VALUE

Default value of PhysicalEnvironment in Basic cluster.

EZB_ZCL_BASIC_DEVICE_ENABLED_DEFAULT_VALUE

Default value of DeviceEnabled in Basic cluster.

EZB_ZCL_BASIC_ALARM_MASK_DEFAULT_VALUE

Default value of AlarmMask in Basic cluster.

EZB_ZCL_BASIC_DISABLE_LOCAL_CONFIG_DEFAULT_VALUE

Default value of DisableLocalConfig in Basic cluster.

EZB_ZCL_CLUSTER_ID_BASIC_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_BASIC_SERVER_ROLE_INIT

5.2.6.3.1.1.5. Type Definitions

typedef struct ezb_zcl_basic_cluster_server_config_s ezb_zcl_basic_cluster_server_config_t

Configuration mandatory attributes for the Basic server cluster.

typedef ezb_zcl_basic_cluster_server_config_t ezb_zcl_basic_cluster_config_t

5.2.6.3.1.1.6. Enumerations

enum ezb_zcl_basic_server_attr_t

Attribute identifiers for the basic server cluster.

Values:

enumerator EZB_ZCL_ATTR_BASIC_ZCL_VERSION_ID

ZCLVersion attribute.

enumerator EZB_ZCL_ATTR_BASIC_APPLICATION_VERSION_ID

ApplicationVersion attribute.

enumerator EZB_ZCL_ATTR_BASIC_STACK_VERSION_ID

StackVersion attribute.

enumerator EZB_ZCL_ATTR_BASIC_HW_VERSION_ID

HWVersion attribute.

enumerator EZB_ZCL_ATTR_BASIC_MANUFACTURER_NAME_ID

ManufacturerName attribute.

enumerator EZB_ZCL_ATTR_BASIC_MODEL_IDENTIFIER_ID

ModelIdentifier attribute.

enumerator EZB_ZCL_ATTR_BASIC_DATE_CODE_ID

DateCode attribute.

enumerator EZB_ZCL_ATTR_BASIC_POWER_SOURCE_ID

PowerSource attribute.

enumerator EZB_ZCL_ATTR_BASIC_GENERIC_DEVICE_CLASS_ID

GenericDevice-Class attribute.

enumerator EZB_ZCL_ATTR_BASIC_GENERIC_DEVICE_TYPE_ID

GenericDevice-Type attribute.

enumerator EZB_ZCL_ATTR_BASIC_PRODUCT_CODE_ID

ProductCode attribute.

enumerator EZB_ZCL_ATTR_BASIC_PRODUCT_URL_ID

ProductURL attribute.

enumerator EZB_ZCL_ATTR_BASIC_MANUFACTURER_VERSION_DETAILS_ID

ManufacturerVersionDetails attribute.

enumerator EZB_ZCL_ATTR_BASIC_SERIAL_NUMBER_ID

SerialNumber attribute.

enumerator EZB_ZCL_ATTR_BASIC_PRODUCT_LABEL_ID

ProductLabel attribute.

enumerator EZB_ZCL_ATTR_BASIC_LOCATION_DESCRIPTION_ID

LocationDescription attribute.

enumerator EZB_ZCL_ATTR_BASIC_PHYSICAL_ENVIRONMENT_ID

PhysicalEnvironment attribute.

enumerator EZB_ZCL_ATTR_BASIC_DEVICE_ENABLED_ID

DeviceEnabled attribute.

enumerator EZB_ZCL_ATTR_BASIC_ALARM_MASK_ID

AlarmMask attribute.

enumerator EZB_ZCL_ATTR_BASIC_DISABLE_LOCAL_CONFIG_ID

DisableLocalConfig attribute.

enumerator EZB_ZCL_ATTR_BASIC_SW_BUILD_ID_ID

SWBuildID attribute.

enum ezb_zcl_basic_server_power_source_t

Enumeration for ZCL PowerSource attribute of Basic.

Values:

enumerator EZB_ZCL_BASIC_POWER_SOURCE_UNKNOWN

Unknown

enumerator EZB_ZCL_BASIC_POWER_SOURCE_SINGLE_PHASE_MAINS

SinglePhaseMains

enumerator EZB_ZCL_BASIC_POWER_SOURCE_THREE_PHASE_MAINS

ThreePhaseMains

enumerator EZB_ZCL_BASIC_POWER_SOURCE_BATTERY

Battery

enumerator EZB_ZCL_BASIC_POWER_SOURCE_DC_SOURCE

DCSource

enumerator EZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_CONSTANTLY_POWERED

EmergencyMainsConstantlyPowered

enumerator EZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_AND_TRANSFER_SWITCH

EmergencyMainsAndTransferSwitch

enumerator EZB_ZCL_BASIC_POWER_SOURCE_UNKNOWN_WITH_BATTERY_BACKUP

UnknownWithBatteryBackup

enumerator EZB_ZCL_BASIC_POWER_SOURCE_SINGLE_PHASE_MAINS_WITH_BATTERY_BACKUP

SinglePhaseMainsWithBatteryBackup

enumerator EZB_ZCL_BASIC_POWER_SOURCE_THREE_PHASE_MAINS_WITH_BATTERY_BACKUP

ThreePhaseMainsWithBatteryBackup

enumerator EZB_ZCL_BASIC_POWER_SOURCE_BATTERY_WITH_BATTERY_BACKUP

BatteryWithBatteryBackup

enumerator EZB_ZCL_BASIC_POWER_SOURCE_DC_SOURCE_WITH_BATTERY_BACKUP

DCSourceWithBatteryBackup

enumerator EZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_CONSTANTLY_POWERED_WITH_BATTERY_BACKUP

EmergencyMainsConstantlyPoweredWithBatteryBackup

enumerator EZB_ZCL_BASIC_POWER_SOURCE_EMERGENCY_MAINS_AND_TRANSFER_SWITCH_WITH_BATTERY_BACKUP

EmergencyMainsAndTransferSwitchWithBatteryBackup

enum ezb_zcl_basic_server_generic_device_class_t

Enumeration for ZCL GenericDevice-Class attribute of Basic.

Values:

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_CLASS_LIGHTING

Lighting

enum ezb_zcl_basic_server_generic_device_type_t

Enumeration for ZCL GenericDevice-Type attribute of Basic.

Values:

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_INCANDESCENT

Incandescent

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_SPOTLIGHT_HALOGEN

SpotlightHalogen

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_HALOGEN_BULB

HalogenBulb

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_CFL

CFL

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_LINEAR_FLUORESCENT

LinearFluorescent

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_LED_BULB

LEDBulb

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_SPOTLIGHT_LED

SpotlightLED

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_LED_STRIP

LEDStrip

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_LED_TUBE

LEDTube

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_GENERIC_INDOOR_LUMINAIRE_OR_LIGHT_FIXTURE

GenericIndoorLuminaireOrLightFixture

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_GENERIC_OUTDOOR_LUMINAIRE_OR_LIGHT_FIXTURE

GenericOutdoorLuminaireOrLightFixture

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_PENDANT_LUMINAIRE_OR_LIGHT_FIXTURE

PendantLuminaireOrLightFixture

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_FLOOR_STANDING_LUMINAIRE_OR_LIGHT_FIXTURE

FloorStandingLuminaireOrLightFixture

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_GENERIC_CONTROLLER

GenericController

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_WALL_SWITCH

WallSwitch

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_PORTABLE_REMOTE_CONTROLLER

PortableRemoteController

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_MOTION_SENSOR_OR_LIGHT_SENSOR

MotionSensorOrLightSensor

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_GENERIC_ACTUATOR

GenericActuator

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_WALL_SOCKET

WallSocket

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_GATEWAY_OR_BRIDGE

GatewayOrBridge

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_PLUG_IN_UNIT

PlugInUnit

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_RETROFIT_ACTUATOR

RetrofitActuator

enumerator EZB_ZCL_BASIC_GENERIC_DEVICE_TYPE_UNSPECIFIED

Unspecified

enum ezb_zcl_basic_server_physical_environment_t

Enumeration for ZCL PhysicalEnvironment attribute of Basic.

Values:

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_UNSPECIFIED_ENVIRONMENT

UnspecifiedEnvironment

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DEPRECATED

Deprecated

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BAR

Bar

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_COURTYARD

Courtyard

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BATHROOM

Bathroom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BEDROOM

Bedroom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BILLIARD_ROOM

BilliardRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_UTILITY_ROOM

UtilityRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_CELLAR

Cellar

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_STORAGE_CLOSET

StorageCloset

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_THEATER

Theater

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_OFFICE1

Office1

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DECK

Deck

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DEN

Den

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DINING_ROOM

DiningRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_ELECTRICAL_ROOM

ElectricalRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_ELEVATOR

Elevator

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_ENTRY

Entry

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_FAMILY_ROOM

FamilyRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_MAIN_FLOOR

MainFloor

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_UPSTAIRS

Upstairs

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DOWNSTAIRS

Downstairs

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BASEMENT_LOWER_LEVEL

Basement/LowerLevel

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_GALLERY

Gallery

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_GAME_ROOM

GameRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_GARAGE

Garage

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_GYM

Gym

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_HALLWAY

Hallway

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_HOUSE

House

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_KITCHEN

Kitchen

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_LAUNDRY_ROOM

LaundryRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_LIBRARY

Library

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_MASTER_BEDROOM

MasterBedroom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_MUD_ROOM

MudRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_NURSERY

Nursery

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_PANTRY

Pantry

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_OFFICE0

Office0

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_OUTSIDE

Outside

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_POOL

Pool

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_PORCH

Porch

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_SEWING_ROOM

SewingRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_SITTING_ROOM

SittingRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_STAIRWAY

Stairway

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_YARD

Yard

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_ATTIC

Attic

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_HOT_TUB

HotTub

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_LIVING_ROOM1

LivingRoom1

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_SAUNA

Sauna

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_SHOP_OR_WORKSHOP

ShopOrWorkshop

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_GUEST_BEDROOM

GuestBedroom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_GUEST_BATH

GuestBath

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_POWDER_ROOM

PowderRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BACK_YARD

BackYard

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_FRONT_YARD

FrontYard

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_PATIO

Patio

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DRIVEWAY

Driveway

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_SUN_ROOM

SunRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_LIVING_ROOM0

LivingRoom0

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_SPA

Spa

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_WHIRLPOOL

Whirlpool

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_SHED

Shed

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_EQUIPMENT_STORAGE

EquipmentStorage

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_HOBBY_OR_CRAFT_ROOM

HobbyOrCraftRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_FOUNTAIN

Fountain

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_POND

Pond

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_RECEPTION_ROOM

ReceptionRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BREAKFAST_ROOM

BreakfastRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_NOOK

Nook

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_GARDEN

Garden

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BALCONY

Balcony

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_PANIC_ROOM

PanicRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_TERRACE

Terrace

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_ROOF

Roof

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_TOILET

Toilet

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_TOILET_MAIN

ToiletMain

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_OUTSIDE_TOILET

OutsideToilet

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_SHOWER_ROOM

ShowerRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_STUDY

Study

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_FRONT_GARDEN

FrontGarden

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BACK_GARDEN

BackGarden

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_KETTLE

Kettle

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_TELEVISION

Television

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_STOVE

Stove

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_MICROWAVE

Microwave

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_TOASTER

Toaster

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_VACUUM

Vacuum

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_APPLIANCE

Appliance

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_FRONT_DOOR

FrontDoor

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_BACK_DOOR

BackDoor

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_FRIDGE_DOOR

FridgeDoor

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_MEDICATION_CABINET_DOOR

MedicationCabinetDoor

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_WARDROBE_DOOR

WardrobeDoor

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_FRONT_CUPBOARD_DOOR

FrontCupboardDoor

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_OTHER_DOOR

OtherDoor

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_WAITING_ROOM

WaitingRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_TRIAGE_ROOM

TriageRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DOCTORS_OFFICE

DoctorsOffice

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_PATIENTS_PRIVATE_ROOM

PatientsPrivateRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_CONSULTATION_ROOM

ConsultationRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_NURSE_STATION

NurseStation

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_WARD

Ward

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_CORRIDOR

Corridor

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_OPERATING_THEATRE

OperatingTheatre

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DENTAL_SURGERY_ROOM

DentalSurgeryRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_MEDICAL_IMAGING_ROOM

MedicalImagingRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_DECONTAMINATION_ROOM

DecontaminationRoom

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_ATRIUM

Atrium

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_MIRROR

Mirror

enumerator EZB_ZCL_BASIC_PHYSICAL_ENVIRONMENT_UNKNOWN_ENVIRONMENT

UnknownEnvironment

enum ezb_zcl_basic_server_alarm_mask_t

Bitmap for ZCL AlarmMask attribute of Basic.

Values:

enumerator EZB_ZCL_BASIC_ALARM_MASK_GENERAL_HARDWARE_FAULT

GeneralHardwareFault

enumerator EZB_ZCL_BASIC_ALARM_MASK_GENERAL_SOFTWARE_FAULT

GeneralSoftwareFault

enum ezb_zcl_basic_server_disable_local_config_t

Bitmap for ZCL DisableLocalConfig attribute of Basic.

Values:

enumerator EZB_ZCL_BASIC_DISABLE_LOCAL_CONFIG_DISABLE_RESET_TO_FACTORY_DEFAULTS

DisableResetToFactoryDefaults

enumerator EZB_ZCL_BASIC_DISABLE_LOCAL_CONFIG_DISABLE_DEVICE_CONFIGURATION

DisableDeviceConfiguration

enum ezb_zcl_basic_server_cmd_id_t

Received Command identifiers for the Basic cluster.

Values:

enumerator EZB_ZCL_CMD_BASIC_RESET_TO_FACTORY_DEFAULTS_ID

ResetToFactoryDefaults command.

5.2.6.3.1.1.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/basic.h

5.2.6.3.1.1.8. Functions

ezb_err_t ezb_zcl_basic_factory_reset_cmd_req(const ezb_zcl_basic_factory_reset_cmd_t *cmd_req)

Send ZCL Basic FactoryReset command request.

Parameters:

cmd_req -- Pointer to the FactoryReset command structure, ezb_zcl_basic_factory_reset_cmd_s.

Returns:

Error code.

5.2.6.3.1.1.9. Structures

struct ezb_zcl_basic_factory_reset_cmd_s

Structure for the ZCL Basic FactoryReset command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_basic_reset_factory_default_message_s

Message for the ZCL Basic ResetToFactoryDefaults message.

Public Members

ezb_zcl_message_info_t info

Basic information about ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

struct ezb_zcl_basic_reset_factory_default_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of the reset to factory default operation.

struct ezb_zcl_basic_reset_factory_default_message_s out

Output: result to send back.

5.2.6.3.1.1.10. Type Definitions

typedef struct ezb_zcl_basic_factory_reset_cmd_s ezb_zcl_basic_factory_reset_cmd_t

Structure for the ZCL Basic FactoryReset command request.

typedef struct ezb_zcl_basic_reset_factory_default_message_s ezb_zcl_basic_reset_factory_default_message_t

Message for the ZCL Basic ResetToFactoryDefaults message.

5.2.6.3.1.2. Power Configuration

5.2.6.3.1.2.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/power_config_desc.h

5.2.6.3.1.2.2. Functions

ezb_err_t ezb_zcl_power_config_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an power_config cluster descriptor.

Parameters:

• cluster_desc -- [in] The power_config cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_power_config_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an power_config cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the power_config cluster configuration structure. Use ezb_zcl_power_config_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_power_config_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_power_config_cluster_client_init(uint8_t ep_id)

Initialize the PowerConfig cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_power_config_cluster_server_init(uint8_t ep_id)

Initialize the PowerConfig cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.2.3. Structures

struct ezb_zcl_power_config_cluster_server_config_s

Configuration mandatory attributes for the PowerConfig server cluster.

Public Members

uint16_t mains_voltage

Configurable mandatory MainsVoltage attribute

uint16_t mains_voltage_min_threshold

Configurable mandatory MainsVoltageMinThreshold attribute

uint16_t mains_voltage_max_threshold

Configurable mandatory MainsVoltageMaxThreshold attribute

5.2.6.3.1.2.4. Macros

EZB_ZCL_POWER_CONFIG_CLUSTER_REVISION

Cluster Revision of the power_config cluster implementation.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_DEFAULT_VALUE

Default value of MainsVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_MIN_VALUE

Minimum value of MainsVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_MAX_VALUE

Maximum value of MainsVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_FREQUENCY_MIN_VALUE

Minimum value of MainsFrequency in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_FREQUENCY_MAX_VALUE

Maximum value of MainsFrequency in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_ALARM_MASK_DEFAULT_VALUE

Default value of MainsAlarmMask in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_MIN_THRESHOLD_DEFAULT_VALUE

Default value of MainsVoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_MIN_THRESHOLD_MIN_VALUE

Minimum value of MainsVoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_MIN_THRESHOLD_MAX_VALUE

Maximum value of MainsVoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_MAX_THRESHOLD_DEFAULT_VALUE

Default value of MainsVoltageMaxThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_MAX_THRESHOLD_MIN_VALUE

Minimum value of MainsVoltageMaxThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_MAX_THRESHOLD_MAX_VALUE

Maximum value of MainsVoltageMaxThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_DWELL_TRIP_POINT_DEFAULT_VALUE

Default value of MainsVoltageDwellTripPoint in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_DWELL_TRIP_POINT_MIN_VALUE

Minimum value of MainsVoltageDwellTripPoint in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_MAINS_VOLTAGE_DWELL_TRIP_POINT_MAX_VALUE

Maximum value of MainsVoltageDwellTripPoint in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_MIN_VALUE

Minimum value of BatteryVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_MAX_VALUE

Maximum value of BatteryVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_REMAINING_DEFAULT_VALUE

Default value of BatteryPercentageRemaining in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_REMAINING_MIN_VALUE

Minimum value of BatteryPercentageRemaining in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_REMAINING_MAX_VALUE

Maximum value of BatteryPercentageRemaining in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_DEFAULT_VALUE

Default value of BatterySize in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_A_HR_RATING_MIN_VALUE

Minimum value of BatteryAHrRating in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_A_HR_RATING_MAX_VALUE

Maximum value of BatteryAHrRating in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_QUANTITY_MIN_VALUE

Minimum value of BatteryQuantity in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_QUANTITY_MAX_VALUE

Maximum value of BatteryQuantity in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_RATED_VOLTAGE_MIN_VALUE

Minimum value of BatteryRatedVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_RATED_VOLTAGE_MAX_VALUE

Maximum value of BatteryRatedVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_DEFAULT_VALUE

Default value of BatteryAlarmMask in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_MIN_THRESHOLD_DEFAULT_VALUE

Default value of BatteryVoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_MIN_THRESHOLD_MIN_VALUE

Minimum value of BatteryVoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_MIN_THRESHOLD_MAX_VALUE

Maximum value of BatteryVoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD1_DEFAULT_VALUE

Default value of BatteryVoltageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD1_MIN_VALUE

Minimum value of BatteryVoltageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD1_MAX_VALUE

Maximum value of BatteryVoltageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD2_DEFAULT_VALUE

Default value of BatteryVoltageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD2_MIN_VALUE

Minimum value of BatteryVoltageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD2_MAX_VALUE

Maximum value of BatteryVoltageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD3_DEFAULT_VALUE

Default value of BatteryVoltageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD3_MIN_VALUE

Minimum value of BatteryVoltageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD3_MAX_VALUE

Maximum value of BatteryVoltageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_MIN_THRESHOLD_DEFAULT_VALUE

Default value of BatteryPercentageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_MIN_THRESHOLD_MIN_VALUE

Minimum value of BatteryPercentageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_MIN_THRESHOLD_MAX_VALUE

Maximum value of BatteryPercentageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD1_DEFAULT_VALUE

Default value of BatteryPercentageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD1_MIN_VALUE

Minimum value of BatteryPercentageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD1_MAX_VALUE

Maximum value of BatteryPercentageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD2_DEFAULT_VALUE

Default value of BatteryPercentageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD2_MIN_VALUE

Minimum value of BatteryPercentageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD2_MAX_VALUE

Maximum value of BatteryPercentageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD3_DEFAULT_VALUE

Default value of BatteryPercentageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD3_MIN_VALUE

Minimum value of BatteryPercentageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD3_MAX_VALUE

Maximum value of BatteryPercentageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_STATE_DEFAULT_VALUE

Default value of BatteryAlarmState in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_MIN_VALUE

Minimum value of Battery2Voltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_MAX_VALUE

Maximum value of Battery2Voltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_REMAINING_DEFAULT_VALUE

Default value of Battery2PercentageRemaining in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_REMAINING_MIN_VALUE

Minimum value of Battery2PercentageRemaining in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_REMAINING_MAX_VALUE

Maximum value of Battery2PercentageRemaining in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_SIZE_DEFAULT_VALUE

Default value of Battery2Size in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_SIZE_MIN_VALUE

Minimum value of Battery2Size in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_SIZE_MAX_VALUE

Maximum value of Battery2Size in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_A_HR_RATING_MIN_VALUE

Minimum value of Battery2AHrRating in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_A_HR_RATING_MAX_VALUE

Maximum value of Battery2AHrRating in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_QUANTITY_MIN_VALUE

Minimum value of Battery2Quantity in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_QUANTITY_MAX_VALUE

Maximum value of Battery2Quantity in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_RATED_VOLTAGE_MIN_VALUE

Minimum value of Battery2RatedVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_RATED_VOLTAGE_MAX_VALUE

Maximum value of Battery2RatedVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_ALARM_MASK_DEFAULT_VALUE

Default value of Battery2AlarmMask in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_MIN_THRESHOLD_DEFAULT_VALUE

Default value of Battery2VoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_MIN_THRESHOLD_MIN_VALUE

Minimum value of Battery2VoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_MIN_THRESHOLD_MAX_VALUE

Maximum value of Battery2VoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD1_DEFAULT_VALUE

Default value of Battery2VoltageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD1_MIN_VALUE

Minimum value of Battery2VoltageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD1_MAX_VALUE

Maximum value of Battery2VoltageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD2_DEFAULT_VALUE

Default value of Battery2VoltageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD2_MIN_VALUE

Minimum value of Battery2VoltageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD2_MAX_VALUE

Maximum value of Battery2VoltageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD3_DEFAULT_VALUE

Default value of Battery2VoltageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD3_MIN_VALUE

Minimum value of Battery2VoltageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD3_MAX_VALUE

Maximum value of Battery2VoltageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_MIN_THRESHOLD_DEFAULT_VALUE

Default value of Battery2PercentageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_MIN_THRESHOLD_MIN_VALUE

Minimum value of Battery2PercentageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_MIN_THRESHOLD_MAX_VALUE

Maximum value of Battery2PercentageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD1_DEFAULT_VALUE

Default value of Battery2PercentageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD1_MIN_VALUE

Minimum value of Battery2PercentageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD1_MAX_VALUE

Maximum value of Battery2PercentageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD2_DEFAULT_VALUE

Default value of Battery2PercentageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD2_MIN_VALUE

Minimum value of Battery2PercentageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD2_MAX_VALUE

Maximum value of Battery2PercentageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD3_DEFAULT_VALUE

Default value of Battery2PercentageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD3_MIN_VALUE

Minimum value of Battery2PercentageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD3_MAX_VALUE

Maximum value of Battery2PercentageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY2_ALARM_STATE_DEFAULT_VALUE

Default value of Battery2AlarmState in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_MIN_VALUE

Minimum value of Battery3Voltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_MAX_VALUE

Maximum value of Battery3Voltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_REMAINING_DEFAULT_VALUE

Default value of Battery3PercentageRemaining in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_REMAINING_MIN_VALUE

Minimum value of Battery3PercentageRemaining in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_REMAINING_MAX_VALUE

Maximum value of Battery3PercentageRemaining in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_SIZE_DEFAULT_VALUE

Default value of Battery3Size in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_A_HR_RATING_MIN_VALUE

Minimum value of Battery3AHrRating in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_A_HR_RATING_MAX_VALUE

Maximum value of Battery3AHrRating in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_QUANTITY_MIN_VALUE

Minimum value of Battery3Quantity in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_QUANTITY_MAX_VALUE

Maximum value of Battery3Quantity in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_RATED_VOLTAGE_MIN_VALUE

Minimum value of Battery3RatedVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_RATED_VOLTAGE_MAX_VALUE

Maximum value of Battery3RatedVoltage in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_ALARM_MASK_DEFAULT_VALUE

Default value of Battery3AlarmMask in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_MIN_THRESHOLD_DEFAULT_VALUE

Default value of Battery3VoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_MIN_THRESHOLD_MIN_VALUE

Minimum value of Battery3VoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_MIN_THRESHOLD_MAX_VALUE

Maximum value of Battery3VoltageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD1_DEFAULT_VALUE

Default value of Battery3VoltageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD1_MIN_VALUE

Minimum value of Battery3VoltageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD1_MAX_VALUE

Maximum value of Battery3VoltageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD2_DEFAULT_VALUE

Default value of Battery3VoltageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD2_MIN_VALUE

Minimum value of Battery3VoltageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD2_MAX_VALUE

Maximum value of Battery3VoltageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD3_DEFAULT_VALUE

Default value of Battery3VoltageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD3_MIN_VALUE

Minimum value of Battery3VoltageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD3_MAX_VALUE

Maximum value of Battery3VoltageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_MIN_THRESHOLD_DEFAULT_VALUE

Default value of Battery3PercentageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_MIN_THRESHOLD_MIN_VALUE

Minimum value of Battery3PercentageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_MIN_THRESHOLD_MAX_VALUE

Maximum value of Battery3PercentageMinThreshold in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD1_DEFAULT_VALUE

Default value of Battery3PercentageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD1_MIN_VALUE

Minimum value of Battery3PercentageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD1_MAX_VALUE

Maximum value of Battery3PercentageThreshold1 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD2_DEFAULT_VALUE

Default value of Battery3PercentageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD2_MIN_VALUE

Minimum value of Battery3PercentageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD2_MAX_VALUE

Maximum value of Battery3PercentageThreshold2 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD3_DEFAULT_VALUE

Default value of Battery3PercentageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD3_MIN_VALUE

Minimum value of Battery3PercentageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD3_MAX_VALUE

Maximum value of Battery3PercentageThreshold3 in PowerConfig cluster.

EZB_ZCL_POWER_CONFIG_BATTERY3_ALARM_STATE_DEFAULT_VALUE

Default value of Battery3AlarmState in PowerConfig cluster.

EZB_ZCL_CLUSTER_ID_POWER_CONFIG_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_POWER_CONFIG_SERVER_ROLE_INIT

5.2.6.3.1.2.5. Type Definitions

typedef struct ezb_zcl_power_config_cluster_server_config_s ezb_zcl_power_config_cluster_server_config_t

Configuration mandatory attributes for the PowerConfig server cluster.

typedef ezb_zcl_power_config_cluster_server_config_t ezb_zcl_power_config_cluster_config_t

5.2.6.3.1.2.6. Enumerations

enum ezb_zcl_power_config_server_attr_t

Attribute identifiers for the power_config server cluster.

Values:

enumerator EZB_ZCL_ATTR_POWER_CONFIG_MAINS_VOLTAGE_ID

MainsVoltage attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_MAINS_FREQUENCY_ID

MainsFrequency attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_MAINS_ALARM_MASK_ID

MainsAlarmMask attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_MAINS_VOLTAGE_MIN_THRESHOLD_ID

MainsVoltageMinThreshold attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_MAINS_VOLTAGE_MAX_THRESHOLD_ID

MainsVoltageMaxThreshold attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_MAINS_VOLTAGE_DWELL_TRIP_POINT_ID

MainsVoltageDwellTripPoint attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_ID

BatteryVoltage attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_REMAINING_ID

BatteryPercentageRemaining attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_MANUFACTURER_ID

BatteryManufacturer attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_SIZE_ID

BatterySize attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_A_HR_RATING_ID

BatteryAHrRating attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_QUANTITY_ID

BatteryQuantity attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_RATED_VOLTAGE_ID

BatteryRatedVoltage attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_ALARM_MASK_ID

BatteryAlarmMask attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_MIN_THRESHOLD_ID

BatteryVoltageMinThreshold attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD1_ID

BatteryVoltageThreshold1 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD2_ID

BatteryVoltageThreshold2 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_VOLTAGE_THRESHOLD3_ID

BatteryVoltageThreshold3 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_MIN_THRESHOLD_ID

BatteryPercentageMinThreshold attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD1_ID

BatteryPercentageThreshold1 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD2_ID

BatteryPercentageThreshold2 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_PERCENTAGE_THRESHOLD3_ID

BatteryPercentageThreshold3 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY_ALARM_STATE_ID

BatteryAlarmState attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_VOLTAGE_ID

Battery2Voltage attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_PERCENTAGE_REMAINING_ID

Battery2PercentageRemaining attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_MANUFACTURER_ID

Battery2Manufacturer attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_SIZE_ID

Battery2Size attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_A_HR_RATING_ID

Battery2AHrRating attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_QUANTITY_ID

Battery2Quantity attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_RATED_VOLTAGE_ID

Battery2RatedVoltage attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_ALARM_MASK_ID

Battery2AlarmMask attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_VOLTAGE_MIN_THRESHOLD_ID

Battery2VoltageMinThreshold attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD1_ID

Battery2VoltageThreshold1 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD2_ID

Battery2VoltageThreshold2 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_VOLTAGE_THRESHOLD3_ID

Battery2VoltageThreshold3 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_PERCENTAGE_MIN_THRESHOLD_ID

Battery2PercentageMinThreshold attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD1_ID

Battery2PercentageThreshold1 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD2_ID

Battery2PercentageThreshold2 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_PERCENTAGE_THRESHOLD3_ID

Battery2PercentageThreshold3 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY2_ALARM_STATE_ID

Battery2AlarmState attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_VOLTAGE_ID

Battery3Voltage attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_PERCENTAGE_REMAINING_ID

Battery3PercentageRemaining attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_MANUFACTURER_ID

Battery3Manufacturer attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_SIZE_ID

Battery3Size attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_A_HR_RATING_ID

Battery3AHrRating attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_QUANTITY_ID

Battery3Quantity attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_RATED_VOLTAGE_ID

Battery3RatedVoltage attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_ALARM_MASK_ID

Battery3AlarmMask attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_VOLTAGE_MIN_THRESHOLD_ID

Battery3VoltageMinThreshold attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD1_ID

Battery3VoltageThreshold1 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD2_ID

Battery3VoltageThreshold2 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_VOLTAGE_THRESHOLD3_ID

Battery3VoltageThreshold3 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_PERCENTAGE_MIN_THRESHOLD_ID

Battery3PercentageMinThreshold attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD1_ID

Battery3PercentageThreshold1 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD2_ID

Battery3PercentageThreshold2 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_PERCENTAGE_THRESHOLD3_ID

Battery3PercentageThreshold3 attribute.

enumerator EZB_ZCL_ATTR_POWER_CONFIG_BATTERY3_ALARM_STATE_ID

Battery3AlarmState attribute.

enum ezb_zcl_power_config_server_battery_size_t

Enumeration for ZCL BatterySize attribute of PowerConfig.

Values:

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_NO_BATTERY

NoBattery

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_BUILD_IN

BuildIn

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_OTHER

Other

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_AA

AA

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_AAA

AAA

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_C

C

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_D

D

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_CR2

CR2

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_CR123_A

CR123A

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SIZE_UNKNOWN

Unknown

enum ezb_zcl_power_config_server_mains_alarm_mask_t

Bitmap for ZCL MainsAlarmMask attribute of PowerConfig.

Values:

enumerator EZB_ZCL_POWER_CONFIG_MAINS_ALARM_MASK_MAINS_VOLTAGE_TOO_LOW

MainsVoltageTooLow

enumerator EZB_ZCL_POWER_CONFIG_MAINS_ALARM_MASK_MAINS_VOLTAGE_TOO_HIGH

MainsVoltageTooHigh

enumerator EZB_ZCL_POWER_CONFIG_MAINS_ALARM_MASK_MAINS_POWER_SUPPLY_LOST

MainsPowerSupplyLost

5.2.6.3.1.2.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/power_config.h

5.2.6.3.1.2.8. Macros

EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_CODE(source, threshold)

Calculate the alarm code for ZCL PowerConfig Battery.

Parameters:

• source -- The source, ezb_zcl_power_config_battery_source_t.

• threshold -- The threshold, ezb_zcl_power_config_battery_alarm_threshold_t.

Returns:

The alarm code.

EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_SOURCE_SHIFT(source)

Calculate the source shift for the battery alarm.

Parameters:

• source -- The source, ezb_zcl_power_config_battery_source_t.

Returns:

The source shift.

EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_STATE(source, threshold)

Calculate the alarm state for ZCL PowerConfig Battery Alarm.

Parameters:

• source -- The source, ezb_zcl_power_config_battery_source_t.

• threshold -- The threshold, ezb_zcl_power_config_battery_alarm_threshold_t.

Returns:

The alarm state.

5.2.6.3.1.2.9. Enumerations

enum ezb_zcl_power_config_mains_alarm_code_t

Enumeration alarm codes for ZCL PowerConfig Mains. .

Values:

enumerator EZB_ZCL_POWER_CONFIG_MAINS_ALARM_CODE_MAINS_VOLTAGE_TOO_LOW

MainsVoltageTooLow

enumerator EZB_ZCL_POWER_CONFIG_MAINS_ALARM_CODE_MAINS_VOLTAGE_TOO_HIGH

MainsVoltageTooHigh

enum ezb_zcl_power_config_battery_source_t

Enumeration value for ZCL PowerConfig Battery Source. .

Values:

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SOURCE1

Battery source1

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SOURCE2

Battery source2

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_SOURCE3

Battery source3

enum ezb_zcl_power_config_battery_alarm_mask_t

Enumeration alarm mask for ZCL PowerConfig Battery. .

Values:

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_TOO_LOW

Battery too low

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_ALARM1

Battery alarm1

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_ALARM2

Battery alarm2

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_MASK_ALARM3

Battery alarm3

enum ezb_zcl_power_config_battery_alarm_threshold_t

Enumeration threshold for ZCL PowerConfig Battery Alarm. .

Values:

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_THRESHOLD_MIN

Battery alarm min threshold

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_THRESHOLD_T1

Battery alarm t1 threshold

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_THRESHOLD_T2

Battery alarm t2 threshold

enumerator EZB_ZCL_POWER_CONFIG_BATTERY_ALARM_THRESHOLD_T3

Battery alarm t3 threshold

5.2.6.3.1.3. Device Temperature Configuration

5.2.6.3.1.3.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/device_temp_config_desc.h

5.2.6.3.1.3.2. Functions

ezb_err_t ezb_zcl_device_temp_config_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an device_temp_config cluster descriptor.

Parameters:

• cluster_desc -- [in] The device_temp_config cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_device_temp_config_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an device_temp_config cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the device_temp_config cluster configuration structure. Use ezb_zcl_device_temp_config_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_device_temp_config_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_device_temp_config_cluster_client_init(uint8_t ep_id)

Initialize the DeviceTempConfig cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_device_temp_config_cluster_server_init(uint8_t ep_id)

Initialize the DeviceTempConfig cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.3.3. Structures

struct ezb_zcl_device_temp_config_cluster_server_config_s

Configuration mandatory attributes for the DeviceTempConfig server cluster.

Public Members

int16_t current_temperature

Configurable mandatory CurrentTemperature attribute

5.2.6.3.1.3.4. Macros

EZB_ZCL_DEVICE_TEMP_CONFIG_CLUSTER_REVISION

Cluster Revision of the device_temp_config cluster implementation.

EZB_ZCL_DEVICE_TEMP_CONFIG_CURRENT_TEMPERATURE_MIN_VALUE

Minimum value of CurrentTemperature in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_CURRENT_TEMPERATURE_MAX_VALUE

Maximum value of CurrentTemperature in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_MIN_TEMP_EXPERIENCED_MIN_VALUE

Minimum value of MinTempExperienced in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_MIN_TEMP_EXPERIENCED_MAX_VALUE

Maximum value of MinTempExperienced in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_MAX_TEMP_EXPERIENCED_MIN_VALUE

Minimum value of MaxTempExperienced in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_MAX_TEMP_EXPERIENCED_MAX_VALUE

Maximum value of MaxTempExperienced in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_OVER_TEMP_TOTAL_DWELL_DEFAULT_VALUE

Default value of OverTempTotalDwell in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_OVER_TEMP_TOTAL_DWELL_MIN_VALUE

Minimum value of OverTempTotalDwell in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_OVER_TEMP_TOTAL_DWELL_MAX_VALUE

Maximum value of OverTempTotalDwell in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_DEVICE_TEMP_ALARM_MASK_DEFAULT_VALUE

Default value of DeviceTempAlarmMask in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_LOW_TEMP_THRESHOLD_MIN_VALUE

Minimum value of LowTempThreshold in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_LOW_TEMP_THRESHOLD_MAX_VALUE

Maximum value of LowTempThreshold in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_HIGH_TEMP_THRESHOLD_MIN_VALUE

Minimum value of HighTempThreshold in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_HIGH_TEMP_THRESHOLD_MAX_VALUE

Maximum value of HighTempThreshold in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_LOW_TEMP_DWELL_TRIP_POINT_MIN_VALUE

Minimum value of LowTempDwellTripPoint in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_LOW_TEMP_DWELL_TRIP_POINT_MAX_VALUE

Maximum value of LowTempDwellTripPoint in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_HIGH_TEMP_DWELL_TRIP_POINT_MIN_VALUE

Minimum value of HighTempDwellTripPoint in DeviceTempConfig cluster.

EZB_ZCL_DEVICE_TEMP_CONFIG_HIGH_TEMP_DWELL_TRIP_POINT_MAX_VALUE

Maximum value of HighTempDwellTripPoint in DeviceTempConfig cluster.

EZB_ZCL_CLUSTER_ID_DEVICE_TEMP_CONFIG_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_DEVICE_TEMP_CONFIG_SERVER_ROLE_INIT

5.2.6.3.1.3.5. Type Definitions

typedef struct ezb_zcl_device_temp_config_cluster_server_config_s ezb_zcl_device_temp_config_cluster_server_config_t

Configuration mandatory attributes for the DeviceTempConfig server cluster.

typedef ezb_zcl_device_temp_config_cluster_server_config_t ezb_zcl_device_temp_config_cluster_config_t

5.2.6.3.1.3.6. Enumerations

enum ezb_zcl_device_temp_config_server_attr_t

Attribute identifiers for the device_temp_config server cluster.

Values:

enumerator EZB_ZCL_ATTR_DEVICE_TEMP_CONFIG_CURRENT_TEMPERATURE_ID

CurrentTemperature attribute.

enumerator EZB_ZCL_ATTR_DEVICE_TEMP_CONFIG_MIN_TEMP_EXPERIENCED_ID

MinTempExperienced attribute.

enumerator EZB_ZCL_ATTR_DEVICE_TEMP_CONFIG_MAX_TEMP_EXPERIENCED_ID

MaxTempExperienced attribute.

enumerator EZB_ZCL_ATTR_DEVICE_TEMP_CONFIG_OVER_TEMP_TOTAL_DWELL_ID

OverTempTotalDwell attribute.

enumerator EZB_ZCL_ATTR_DEVICE_TEMP_CONFIG_DEVICE_TEMP_ALARM_MASK_ID

DeviceTempAlarmMask attribute.

enumerator EZB_ZCL_ATTR_DEVICE_TEMP_CONFIG_LOW_TEMP_THRESHOLD_ID

LowTempThreshold attribute.

enumerator EZB_ZCL_ATTR_DEVICE_TEMP_CONFIG_HIGH_TEMP_THRESHOLD_ID

HighTempThreshold attribute.

enumerator EZB_ZCL_ATTR_DEVICE_TEMP_CONFIG_LOW_TEMP_DWELL_TRIP_POINT_ID

LowTempDwellTripPoint attribute.

enumerator EZB_ZCL_ATTR_DEVICE_TEMP_CONFIG_HIGH_TEMP_DWELL_TRIP_POINT_ID

HighTempDwellTripPoint attribute.

enum ezb_zcl_device_temp_config_server_device_temp_alarm_mask_t

Bitmap for ZCL DeviceTempAlarmMask attribute of DeviceTempConfig.

Values:

enumerator EZB_ZCL_DEVICE_TEMP_CONFIG_DEVICE_TEMP_ALARM_MASK_DEVICE_TEMPERATURE_TOO_LOW

DeviceTemperatureTooLow

enumerator EZB_ZCL_DEVICE_TEMP_CONFIG_DEVICE_TEMP_ALARM_MASK_DEVICE_TEMPERATURE_TOO_HIGH

DeviceTemperatureTooHigh

5.2.6.3.1.3.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/device_temp_config.h

5.2.6.3.1.4. Identify

5.2.6.3.1.4.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/identify_desc.h

5.2.6.3.1.4.2. Functions

ezb_err_t ezb_zcl_identify_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an identify cluster descriptor.

Parameters:

• cluster_desc -- [in] The identify cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_identify_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an identify cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the identify cluster configuration structure. Use ezb_zcl_identify_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_identify_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_identify_cluster_client_init(uint8_t ep_id)

Initialize the Identify cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_identify_cluster_server_init(uint8_t ep_id)

Initialize the Identify cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.4.3. Structures

struct ezb_zcl_identify_cluster_server_config_s

Configuration mandatory attributes for the Identify server cluster.

Public Members

uint16_t identify_time

Configurable mandatory IdentifyTime attribute

5.2.6.3.1.4.4. Macros

EZB_ZCL_IDENTIFY_CLUSTER_REVISION

Cluster Revision of the identify cluster implementation.

EZB_ZCL_IDENTIFY_IDENTIFY_TIME_DEFAULT_VALUE

Default value of IdentifyTime in Identify cluster.

EZB_ZCL_IDENTIFY_IDENTIFY_TIME_MIN_VALUE

Minimum value of IdentifyTime in Identify cluster.

EZB_ZCL_IDENTIFY_IDENTIFY_TIME_MAX_VALUE

Maximum value of IdentifyTime in Identify cluster.

EZB_ZCL_CLUSTER_ID_IDENTIFY_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_IDENTIFY_SERVER_ROLE_INIT

5.2.6.3.1.4.5. Type Definitions

typedef struct ezb_zcl_identify_cluster_server_config_s ezb_zcl_identify_cluster_server_config_t

Configuration mandatory attributes for the Identify server cluster.

typedef ezb_zcl_identify_cluster_server_config_t ezb_zcl_identify_cluster_config_t

5.2.6.3.1.4.6. Enumerations

enum ezb_zcl_identify_server_attr_t

Attribute identifiers for the identify server cluster.

Values:

enumerator EZB_ZCL_ATTR_IDENTIFY_IDENTIFY_TIME_ID

IdentifyTime attribute.

enumerator EZB_ZCL_ATTR_IDENTIFY_IDENTIFY_TIMER_CONTEXT_ID

IdentifyTimerContext attribute.

enum ezb_zcl_identify_server_cmd_id_t

Received Command identifiers for the Identify cluster.

Values:

enumerator EZB_ZCL_CMD_IDENTIFY_IDENTIFY_ID

Identify command.

enumerator EZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_ID

IdentifyQuery command.

enumerator EZB_ZCL_CMD_IDENTIFY_TRIGGER_EFFECT_ID

TriggerEffect command.

enum ezb_zcl_identify_client_cmd_id_t

Received Command identifiers for the Identify cluster.

Values:

enumerator EZB_ZCL_CMD_IDENTIFY_IDENTIFY_QUERY_RESPONSE_ID

IdentifyQueryResponse command.

5.2.6.3.1.4.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/identify.h

5.2.6.3.1.4.8. Functions

ezb_err_t ezb_zcl_identify_identify_cmd_req(const ezb_zcl_identify_cmd_t *cmd_req)

Send ZCL Identify Identify command request.

Parameters:

cmd_req -- Pointer to the Identify command request structure, ezb_zcl_identify_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_identify_identify_query_cmd_req(const ezb_zcl_identify_query_cmd_t *cmd_req)

Send ZCL Identify IdentifyQuery command request.

Parameters:

cmd_req -- Pointer to the Identify Query command request structure, ezb_zcl_identify_query_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_identify_trigger_effect_cmd_req(const ezb_zcl_identify_trigger_effect_cmd_t *cmd_req)

Send ZCL Identify TriggerEffect command request.

Parameters:

cmd_req -- Pointer to the TriggerEffect command request structure, ezb_zcl_identify_trigger_effect_cmd_s.

Returns:

Error code.

bool ezb_zcl_is_identifying(uint8_t ep_id)

Check if the device is in identifying state.

Parameters:

ep_id -- Endpoint ID of the device.

Returns:

true if the device is in identifying state, false otherwise.

5.2.6.3.1.4.9. Structures

struct ezb_zcl_identify_cmd_s

Structure for the ZCL Identify Identify command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t identify_time

Identify time in seconds.

struct ezb_zcl_identify_cmd_s payload

Payload of the command.

struct ezb_zcl_identify_query_cmd_s

Structure for the ZCL Identify IdentifyQuery command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_identify_trigger_effect_cmd_s

Structure for the ZCL Identify TriggerEffect command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint8_t effect_id

Effect identifier to use.

uint8_t effect_variant

Variant of the effect to trigger.

struct ezb_zcl_identify_trigger_effect_cmd_s payload

Payload of the command.

struct ezb_zcl_identify_query_rsp_message_s

Message for the ZCL Identify Query response.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint16_t timeout

Identify time in seconds.

struct ezb_zcl_identify_query_rsp_message_s in

Input: parsed fields from the response.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_identify_query_rsp_message_s out

Output: result to send back.

struct ezb_zcl_identify_effect_message_s

Message for the ZCL Identify TriggerEffect request.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint8_t effect_id

Effect identifier to use.

uint8_t effect_variant

Variant of the effect to trigger.

struct ezb_zcl_identify_effect_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_identify_effect_message_s out

Output: result to send back.

5.2.6.3.1.4.10. Type Definitions

typedef struct ezb_zcl_identify_cmd_s ezb_zcl_identify_cmd_t

Structure for the ZCL Identify Identify command request.

typedef struct ezb_zcl_identify_query_cmd_s ezb_zcl_identify_query_cmd_t

Structure for the ZCL Identify IdentifyQuery command request.

typedef struct ezb_zcl_identify_trigger_effect_cmd_s ezb_zcl_identify_trigger_effect_cmd_t

Structure for the ZCL Identify TriggerEffect command request.

typedef struct ezb_zcl_identify_query_rsp_message_s ezb_zcl_identify_query_rsp_message_t

Message for the ZCL Identify Query response.

typedef struct ezb_zcl_identify_effect_message_s ezb_zcl_identify_effect_message_t

Message for the ZCL Identify TriggerEffect request.

5.2.6.3.1.5. Groups

5.2.6.3.1.5.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/groups_desc.h

5.2.6.3.1.5.2. Functions

ezb_err_t ezb_zcl_groups_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an groups cluster descriptor.

Parameters:

• cluster_desc -- [in] The groups cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_groups_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an groups cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the groups cluster configuration structure. Use ezb_zcl_groups_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_groups_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_groups_cluster_client_init(uint8_t ep_id)

Initialize the Groups cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_groups_cluster_server_init(uint8_t ep_id)

Initialize the Groups cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.5.3. Structures

struct ezb_zcl_groups_cluster_server_config_s

Configuration mandatory attributes for the Groups server cluster.

Public Members

uint8_t name_support

Configurable mandatory NameSupport attribute

5.2.6.3.1.5.4. Macros

EZB_ZCL_GROUPS_CLUSTER_REVISION

Cluster Revision of the groups cluster implementation.

EZB_ZCL_GROUPS_NAME_SUPPORT_DEFAULT_VALUE

Default value of NameSupport in Groups cluster.

EZB_ZCL_CLUSTER_ID_GROUPS_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_GROUPS_SERVER_ROLE_INIT

5.2.6.3.1.5.5. Type Definitions

typedef struct ezb_zcl_groups_cluster_server_config_s ezb_zcl_groups_cluster_server_config_t

Configuration mandatory attributes for the Groups server cluster.

typedef ezb_zcl_groups_cluster_server_config_t ezb_zcl_groups_cluster_config_t

5.2.6.3.1.5.6. Enumerations

enum ezb_zcl_groups_server_attr_t

Attribute identifiers for the groups server cluster.

Values:

enumerator EZB_ZCL_ATTR_GROUPS_NAME_SUPPORT_ID

NameSupport attribute.

enum ezb_zcl_groups_server_name_support_t

Bitmap for ZCL NameSupport attribute of Groups.

Values:

enumerator EZB_ZCL_GROUPS_NAME_SUPPORT_SUPPORTED

Supported

enum ezb_zcl_groups_server_cmd_id_t

Received Command identifiers for the Groups cluster.

Values:

enumerator EZB_ZCL_CMD_GROUPS_ADD_GROUP_ID

AddGroup command.

enumerator EZB_ZCL_CMD_GROUPS_VIEW_GROUP_ID

ViewGroup command.

enumerator EZB_ZCL_CMD_GROUPS_GET_GROUP_MEMBERSHIP_ID

GetGroupMembership command.

enumerator EZB_ZCL_CMD_GROUPS_REMOVE_GROUP_ID

RemoveGroup command.

enumerator EZB_ZCL_CMD_GROUPS_REMOVE_ALL_GROUPS_ID

RemoveAllGroups command.

enumerator EZB_ZCL_CMD_GROUPS_ADD_GROUP_IF_IDENTIFYING_ID

AddGroupIfIdentifying command.

enum ezb_zcl_groups_client_cmd_id_t

Received Command identifiers for the Groups cluster.

Values:

enumerator EZB_ZCL_CMD_GROUPS_ADD_GROUP_RESPONSE_ID

AddGroupResponse command.

enumerator EZB_ZCL_CMD_GROUPS_VIEW_GROUP_RESPONSE_ID

ViewGroupResponse command.

enumerator EZB_ZCL_CMD_GROUPS_GET_GROUP_MEMBERSHIP_RESPONSE_ID

GetGroupMembershipResponse command.

enumerator EZB_ZCL_CMD_GROUPS_REMOVE_GROUP_RESPONSE_ID

RemoveGroupResponse command.

5.2.6.3.1.5.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/groups.h

5.2.6.3.1.5.8. Functions

ezb_err_t ezb_zcl_groups_add_group_cmd_req(const ezb_zcl_groups_add_group_cmd_t *cmd_req)

Send ZCL Groups AddGroup command request.

The AddGroup command allows the sending device to add group membership in a particular group for one or more endpoints on the receiving device.

Parameters:

cmd_req -- A pointer to the AddGroup command request structure, ezb_zcl_groups_add_group_cmd_s.

Returns:

Error code

ezb_err_t ezb_zcl_groups_view_group_cmd_req(const ezb_zcl_groups_view_group_cmd_t *cmd_req)

Send ZCL Groups ViewGroup command request.

The ViewGroup command allows the sending device to request that the receiving entity or entities respond with a view group response command containing the application name string for a particular group.

Parameters:

cmd_req -- A pointer to the ViewGroup command request structure, ezb_zcl_groups_view_group_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_groups_get_group_membership_cmd_req(const ezb_zcl_groups_get_group_membership_cmd_t *cmd_req)

Send ZCL Groups GetGroupMembership command request.

Inquires about the group membership of the receiving device/endpoint; response includes capacity and list of group IDs.

Parameters:

cmd_req -- A pointer to the GetGroupMembership command request structure, ezb_zcl_groups_view_group_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_groups_remove_cmd_req(const ezb_zcl_groups_remove_group_cmd_t *cmd_req)

Send ZCL Groups RemoveGroup command request.

The remove group command allows the sender to request that the receiving entity or entities remove their membership, if any, in a particular group.

Parameters:

cmd_req -- A pointer to the RemoveGroup command request structure, ezb_zcl_groups_remove_group_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_groups_remove_all_groups_cmd_req(const ezb_zcl_groups_remove_all_groups_cmd_t *cmd_req)

Send ZCL Groups RemoveAllGroups command request.

The remove all groups command allows the sending device to direct the receiving entity or entities to remove all group associations.

Parameters:

cmd_req -- A pointer to the RemoveAllGroups command request structure, ezb_zcl_groups_remove_all_groups_cmd_s.

Returns:

Error code.

5.2.6.3.1.5.9. Structures

struct ezb_zcl_groups_add_group_cmd_s

Structure for the ZCL Groups AddGroup command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group identifier to which the destination endpoint will be added.

char *group_name

Optional group name.

struct ezb_zcl_groups_add_group_cmd_s payload

Command payload.

struct ezb_zcl_groups_view_group_cmd_s

Structure for the ZCL Groups ViewGroup command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group identifier to query.

struct ezb_zcl_groups_view_group_cmd_s payload

Command payload.

struct ezb_zcl_groups_get_group_membership_cmd_s

Structure for the ZCL Groups GetGroupMembership command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint8_t group_count

Number of group IDs in group_list (0 = return all groups).

uint16_t *group_list

List of group IDs to check for membership.

struct ezb_zcl_groups_get_group_membership_cmd_s payload

Command payload.

struct ezb_zcl_groups_remove_group_cmd_s

Structure for the ZCL Groups RemoveGroup command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group identifier from which the destination endpoint will be removed.

struct ezb_zcl_groups_remove_group_cmd_s payload

Command payload.

struct ezb_zcl_groups_remove_all_groups_cmd_s

Structure for the ZCL Groups RemoveAllGroups command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_groups_add_group_rsp_message_s

Message for the ZCL Groups AddGroupResponse.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

Header of the received ZCL command.

uint8_t status

Status of the AddGroup command (e.g. success, duplicate).

uint16_t group_id

Group ID from the AddGroup command.

struct ezb_zcl_groups_add_group_rsp_message_s in

Input: parsed fields from the response.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_groups_add_group_rsp_message_s out

Output: result to send back.

struct ezb_zcl_groups_view_group_rsp_message_s

Message for the ZCL Groups ViewGroupResponse.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

Header of the received ZCL command.

uint8_t status

Status of the ViewGroup command.

uint16_t group_id

Group ID from the ViewGroup command.

char *group_name

Group name (optional; not supported by the stack).

struct ezb_zcl_groups_view_group_rsp_message_s in

Input: parsed fields from the response.

ezb_zcl_status_t result

Application processing result to return to the stack.

struct ezb_zcl_groups_view_group_rsp_message_s out

Output: result to send back.

struct ezb_zcl_groups_get_group_membership_rsp_message_s

Message for the ZCL Groups GetGroupMemberShipResponse.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

Header of the received ZCL command.

uint8_t capacity

Remaining capacity of the device group table.

uint8_t group_count

Number of groups in group_list.

uint16_t *group_list

Identifiers of all groups in the group table (or the requested subset).

struct ezb_zcl_groups_get_group_membership_rsp_message_s in

Input: parsed fields from the response.

ezb_zcl_status_t result

Application processing result to return to the stack.

struct ezb_zcl_groups_get_group_membership_rsp_message_s out

Output: result to send back.

struct ezb_zcl_groups_remove_group_rsp_message_s

Message for the ZCL Groups RemoveGroupResponse.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

Header of the received ZCL command.

uint8_t status

Status of the RemoveGroup command.

uint16_t group_id

Group ID from the RemoveGroup command.

struct ezb_zcl_groups_remove_group_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Application processing result to return to the stack.

struct ezb_zcl_groups_remove_group_rsp_message_s out

Output: result to send back.

5.2.6.3.1.5.10. Type Definitions

typedef struct ezb_zcl_groups_add_group_cmd_s ezb_zcl_groups_add_group_cmd_t

Structure for the ZCL Groups AddGroup command request.

typedef struct ezb_zcl_groups_view_group_cmd_s ezb_zcl_groups_view_group_cmd_t

Structure for the ZCL Groups ViewGroup command request.

typedef struct ezb_zcl_groups_get_group_membership_cmd_s ezb_zcl_groups_get_group_membership_cmd_t

Structure for the ZCL Groups GetGroupMembership command request.

typedef struct ezb_zcl_groups_remove_group_cmd_s ezb_zcl_groups_remove_group_cmd_t

Structure for the ZCL Groups RemoveGroup command request.

typedef struct ezb_zcl_groups_remove_all_groups_cmd_s ezb_zcl_groups_remove_all_groups_cmd_t

Structure for the ZCL Groups RemoveAllGroups command request.

typedef ezb_zcl_groups_add_group_cmd_t ezb_zcl_groups_add_group_if_identifying_cmd_t

Structure for the ZCL Groups AddGroupIfIdentifying command request.

typedef struct ezb_zcl_groups_add_group_rsp_message_s ezb_zcl_groups_add_group_rsp_message_t

Message for the ZCL Groups AddGroupResponse.

typedef struct ezb_zcl_groups_view_group_rsp_message_s ezb_zcl_groups_view_group_rsp_message_t

Message for the ZCL Groups ViewGroupResponse.

typedef struct ezb_zcl_groups_get_group_membership_rsp_message_s ezb_zcl_groups_get_group_membership_rsp_message_t

Message for the ZCL Groups GetGroupMemberShipResponse.

typedef struct ezb_zcl_groups_remove_group_rsp_message_s ezb_zcl_groups_remove_group_rsp_message_t

Message for the ZCL Groups RemoveGroupResponse.

5.2.6.3.1.6. Scenes

5.2.6.3.1.6.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/scenes_desc.h

5.2.6.3.1.6.2. Functions

ezb_err_t ezb_zcl_scenes_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an scenes cluster descriptor.

Parameters:

• cluster_desc -- [in] The scenes cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_scenes_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an scenes cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the scenes cluster configuration structure. Use ezb_zcl_scenes_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_scenes_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_scenes_cluster_client_init(uint8_t ep_id)

Initialize the Scenes cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_scenes_cluster_server_init(uint8_t ep_id)

Initialize the Scenes cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.6.3. Structures

struct ezb_zcl_scenes_cluster_server_config_s

Configuration mandatory attributes for the Scenes server cluster.

Public Members

uint8_t scene_count

Configurable mandatory SceneCount attribute

uint8_t current_scene

Configurable mandatory CurrentScene attribute

uint16_t current_group

Configurable mandatory CurrentGroup attribute

bool scene_valid

Configurable mandatory SceneValid attribute

uint8_t name_support

Configurable mandatory NameSupport attribute

uint8_t scene_table_size

Configurable mandatory SceneTableSize attribute

5.2.6.3.1.6.4. Macros

EZB_ZCL_SCENES_CLUSTER_REVISION

Cluster Revision of the scenes cluster implementation.

EZB_ZCL_SCENES_SCENE_COUNT_DEFAULT_VALUE

Default value of SceneCount in Scenes cluster.

EZB_ZCL_SCENES_CURRENT_SCENE_DEFAULT_VALUE

Default value of CurrentScene in Scenes cluster.

EZB_ZCL_SCENES_CURRENT_GROUP_DEFAULT_VALUE

Default value of CurrentGroup in Scenes cluster.

EZB_ZCL_SCENES_SCENE_VALID_DEFAULT_VALUE

Default value of SceneValid in Scenes cluster.

EZB_ZCL_SCENES_NAME_SUPPORT_DEFAULT_VALUE

Default value of NameSupport in Scenes cluster.

EZB_ZCL_SCENES_SCENE_TABLE_SIZE_DEFAULT_VALUE

Default value of SceneTableSize in Scenes cluster.

EZB_ZCL_SCENES_SCENE_TABLE_SIZE_MIN_VALUE

Minimum value of SceneTableSize in Scenes cluster.

EZB_ZCL_SCENES_SCENE_TABLE_SIZE_MAX_VALUE

Maximum value of SceneTableSize in Scenes cluster.

EZB_ZCL_CLUSTER_ID_SCENES_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_SCENES_SERVER_ROLE_INIT

5.2.6.3.1.6.5. Type Definitions

typedef struct ezb_zcl_scenes_cluster_server_config_s ezb_zcl_scenes_cluster_server_config_t

Configuration mandatory attributes for the Scenes server cluster.

typedef ezb_zcl_scenes_cluster_server_config_t ezb_zcl_scenes_cluster_config_t

5.2.6.3.1.6.6. Enumerations

enum ezb_zcl_scenes_server_attr_t

Attribute identifiers for the scenes server cluster.

Values:

enumerator EZB_ZCL_ATTR_SCENES_SCENE_COUNT_ID

SceneCount attribute.

enumerator EZB_ZCL_ATTR_SCENES_CURRENT_SCENE_ID

CurrentScene attribute.

enumerator EZB_ZCL_ATTR_SCENES_CURRENT_GROUP_ID

CurrentGroup attribute.

enumerator EZB_ZCL_ATTR_SCENES_SCENE_VALID_ID

SceneValid attribute.

enumerator EZB_ZCL_ATTR_SCENES_NAME_SUPPORT_ID

NameSupport attribute.

enumerator EZB_ZCL_ATTR_SCENES_LAST_CONFIGURED_BY_ID

LastConfiguredBy attribute.

enumerator EZB_ZCL_ATTR_SCENES_SCENE_TABLE_SIZE_ID

SceneTableSize attribute.

enumerator EZB_ZCL_ATTR_SCENES_SCENE_TABLE_ID

SceneTable attribute.

enum ezb_zcl_scenes_server_name_support_t

Bitmap for ZCL NameSupport attribute of Scenes.

Values:

enumerator EZB_ZCL_SCENES_NAME_SUPPORT_SCENE_NAMES_SUPPORTED

SceneNamesSupported

enum ezb_zcl_scenes_server_cmd_id_t

Received Command identifiers for the Scenes cluster.

Values:

enumerator EZB_ZCL_CMD_SCENES_ADD_SCENE_ID

AddScene command.

enumerator EZB_ZCL_CMD_SCENES_VIEW_SCENE_ID

ViewScene command.

enumerator EZB_ZCL_CMD_SCENES_REMOVE_SCENE_ID

RemoveScene command.

enumerator EZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES_ID

RemoveAllScenes command.

enumerator EZB_ZCL_CMD_SCENES_STORE_SCENE_ID

StoreScene command.

enumerator EZB_ZCL_CMD_SCENES_RECALL_SCENE_ID

RecallScene command.

enumerator EZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP_ID

GetSceneMembership command.

enumerator EZB_ZCL_CMD_SCENES_ENHANCED_ADD_SCENE_ID

EnhancedAddScene command.

enumerator EZB_ZCL_CMD_SCENES_ENHANCED_VIEW_SCENE_ID

EnhancedViewScene command.

enumerator EZB_ZCL_CMD_SCENES_COPY_SCENE_ID

CopyScene command.

enum ezb_zcl_scenes_client_cmd_id_t

Received Command identifiers for the Scenes cluster.

Values:

enumerator EZB_ZCL_CMD_SCENES_ADD_SCENE_RESPONSE_ID

AddSceneResponse command.

enumerator EZB_ZCL_CMD_SCENES_VIEW_SCENE_RESPONSE_ID

ViewSceneResponse command.

enumerator EZB_ZCL_CMD_SCENES_REMOVE_SCENE_RESPONSE_ID

RemoveSceneResponse command.

enumerator EZB_ZCL_CMD_SCENES_REMOVE_ALL_SCENES_RESPONSE_ID

RemoveAllScenesResponse command.

enumerator EZB_ZCL_CMD_SCENES_STORE_SCENE_RESPONSE_ID

StoreSceneResponse command.

enumerator EZB_ZCL_CMD_SCENES_GET_SCENE_MEMBERSHIP_RESPONSE_ID

GetSceneMembershipResponse command.

enumerator EZB_ZCL_CMD_SCENES_ENHANCED_ADD_SCENE_RESPONSE_ID

EnhancedAddSceneResponse command.

enumerator EZB_ZCL_CMD_SCENES_ENHANCED_VIEW_SCENE_RESPONSE_ID

EnhancedViewSceneResponse command.

enumerator EZB_ZCL_CMD_SCENES_COPY_SCENE_RESPONSE_ID

CopySceneResponse command.

5.2.6.3.1.6.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/scenes.h

5.2.6.3.1.6.8. Functions

ezb_err_t ezb_zcl_scenes_add_scene_cmd_req(const ezb_zcl_scenes_add_scene_cmd_t *cmd_req)

Send ZCL Scenes AddScene command request.

Parameters:

cmd_req -- Pointer to the AddScene command request structure, ezb_zcl_scenes_add_scene_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_scenes_view_scene_cmd_req(const ezb_zcl_scenes_view_scene_cmd_t *cmd_req)

Send ZCL Scenes ViewScene command request.

Parameters:

cmd_req -- Pointer to the ViewScene command request structure, ezb_zcl_scenes_view_scene_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_scenes_remove_scene_cmd_req(const ezb_zcl_scenes_remove_scene_cmd_t *cmd_req)

Send ZCL Scenes RemoveScene command request.

Parameters:

cmd_req -- Pointer to the RemoveScene command request structure, ezb_zcl_scenes_remove_scene_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_scenes_remove_all_scenes_cmd_req(const ezb_zcl_scenes_remove_all_scenes_cmd_t *cmd_req)

Send ZCL Scenes RemoveAllScenes command request.

Parameters:

cmd_req -- Pointer to the RemoveAllScenes command request structure, ezb_zcl_scenes_remove_all_scenes_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_scenes_store_scene_cmd_req(const ezb_zcl_scenes_store_scene_cmd_t *cmd_req)

Send ZCL Scenes StoreScene command request.

Parameters:

cmd_req -- Pointer to the StoreScene command request structure, ezb_zcl_scenes_store_scene_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_scenes_recall_scene_cmd_req(const ezb_zcl_scenes_recall_scene_cmd_t *cmd_req)

Send ZCL Scenes RecallScene command request.

Parameters:

cmd_req -- Pointer to the RecallScene command request structure, ezb_zcl_scenes_recall_scene_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_scenes_get_scene_membership_cmd_req(const ezb_zcl_scenes_get_scene_membership_cmd_t *cmd_req)

Send ZCL Scenes GetSceneMembership command request.

Parameters:

cmd_req -- Pointer to the GetSceneMembership command request structure, ezb_zcl_scenes_get_scene_membership_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_scenes_copy_scene_cmd_req(const ezb_zcl_scenes_copy_scene_cmd_t *cmd_req)

Send ZCL Scenes CopyScene command request.

Parameters:

cmd_req -- Pointer to the CopyScene command request structure, ezb_zcl_scenes_copy_scene_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_scenes_table_store(uint8_t ep_id, uint16_t group_id, uint8_t scene_id, uint16_t transition_time, ezb_zcl_scenes_extension_field_t *field)

Store the scene to Scenes Table.

The Scenes Table is persistent storage of the scenes.

Parameters:

• ep_id -- Endpoint ID that the Scene Table is located.

• group_id -- Group ID of the scene.

• scene_id -- Scene ID of the scene.

• transition_time -- Transition time of the scene.

• field -- Extension field of the scene to be stored.

Returns:

Error code.

5.2.6.3.1.6.9. Structures

struct ezb_zcl_scenes_extension_field_s

Structure for the ZCL Scenes extension field set format.

Public Members

struct ezb_zcl_scenes_extension_field_s *next

Pointer to next scenes extension field.

uint16_t cluster_id

Cluster ID.

uint8_t length

Length of scenes extension field.

uint8_t *value

Extension field attribute value list.

struct ezb_zcl_scenes_add_scene_cmd_s

Structure for the ZCL Scenes AddScene command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group ID of the scene.

uint8_t scene_id

Scene ID.

uint16_t transition_time

Transition time in 1/10s.

char scene_name[EZB_ZCL_SCENE_NAME_MAX_LENGTH + 1]

Name of the scene.

ezb_zcl_scenes_extension_field_t *extension_field

Scene extension fields.

struct ezb_zcl_scenes_add_scene_cmd_s payload

Payload of the command.

struct ezb_zcl_scenes_view_scene_cmd_s

Structure for the ZCL Scenes ViewScene command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group ID of the scene.

uint8_t scene_id

Scene ID.

struct ezb_zcl_scenes_view_scene_cmd_s payload

Payload of the command.

struct ezb_zcl_scenes_remove_scene_cmd_s

Structure for the ZCL Scenes RemoveScene command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group ID of the scene.

uint8_t scene_id

Scene ID.

struct ezb_zcl_scenes_remove_scene_cmd_s payload

Payload of the command.

struct ezb_zcl_scenes_remove_all_scenes_cmd_s

Structure for the ZCL Scenes RemoveAllScenes command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group ID of the scene.

struct ezb_zcl_scenes_remove_all_scenes_cmd_s payload

Payload of the command.

struct ezb_zcl_scenes_store_scene_cmd_s

Structure for the ZCL Scenes StoreScene command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group ID of the scene.

uint8_t scene_id

Scene ID.

struct ezb_zcl_scenes_store_scene_cmd_s payload

Payload of the command.

struct ezb_zcl_scenes_recall_scene_cmd_s

Structure for the ZCL Scenes RecallScene command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group ID of the scene.

uint8_t scene_id

Scene ID.

uint16_t transition_time

Transition time in 1/10s.

struct ezb_zcl_scenes_recall_scene_cmd_s payload

Payload of the command.

struct ezb_zcl_scenes_get_scene_membership_cmd_s

Structure for the ZCL Scenes GetSceneMembership command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t group_id

Group ID of the scene.

struct ezb_zcl_scenes_get_scene_membership_cmd_s payload

Payload of the command.

struct ezb_zcl_scenes_copy_scene_cmd_s

Structure for the ZCL Scenes CopyScene command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint8_t mode

Copy mode.

uint16_t group_id_from

Group ID of the source scene.

uint8_t scene_id_from

Scene ID of the source scene.

uint16_t group_id_to

Group ID of the destination scene.

uint8_t scene_id_to

Scene ID of the destination scene.

struct ezb_zcl_scenes_copy_scene_cmd_s payload

Payload of the command.

struct ezb_zcl_scenes_store_scene_message_s

Message for the ZCL Scenes StoreScene request.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint16_t group_id

Group ID of the stored scene.

uint8_t scene_id

Scene ID of the stored scene.

struct ezb_zcl_scenes_store_scene_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_scenes_store_scene_message_s out

Output: result to send back.

struct ezb_zcl_scenes_recall_scene_message_s

Message for the ZCL Scenes RecallScene request.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint16_t group_id

Group ID of the recalled scene.

uint8_t scene_id

ID of the recalled scene.

uint16_t transition_time

Transition time for the scene recall.

ezb_zcl_scenes_extension_field_t *field_set

Extension fields associated with the scene.

struct ezb_zcl_scenes_recall_scene_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_scenes_recall_scene_message_s out

Output: result to send back.

struct ezb_zcl_scenes_operate_scene_rsp_message_s

Message for the ZCL Scenes OperateScene response.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint8_t status

Status of response.

uint16_t group_id

Group ID from the response.

uint8_t scene_id

Scene ID from the response.

struct ezb_zcl_scenes_operate_scene_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_scenes_operate_scene_rsp_message_s out

Output: result to send back.

struct ezb_zcl_scenes_view_scene_rsp_message_s

Message for the ZCL Scenes ViewScene response.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint8_t status

Status of response.

uint16_t group_id

Group ID from the response.

uint8_t scene_id

Scene ID from the response.

uint16_t transition_time

Transition time from the response.

ezb_zcl_scenes_extension_field_t *field_set

Extension fields from the response.

struct ezb_zcl_scenes_view_scene_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_scenes_view_scene_rsp_message_s out

Output: result to send back.

struct ezb_zcl_scenes_get_scene_membership_rsp_message_s

Message for the ZCL Scenes GetSceneMembership response.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint8_t status

Status of response.

uint8_t capacity

Capacity of the scene table.

uint16_t group_id

Group ID from the response.

uint8_t scene_count

Number of scenes in the group.

uint8_t *scene_list

List of scene IDs in the group.

struct ezb_zcl_scenes_get_scene_membership_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_scenes_get_scene_membership_rsp_message_s out

Output: result to send back.

5.2.6.3.1.6.10. Macros

EZB_ZCL_SCENE_GLOBAL_SCENE_GROUP_ID

Global scene group ID.

EZB_ZCL_SCENE_GLOBAL_SCENE_ID

Global scene ID.

EZB_ZCL_SCENE_NAME_MAX_LENGTH

The maximum length of the scene name.

Note

The Scene name is 0 to 16 characters

5.2.6.3.1.6.11. Type Definitions

typedef struct ezb_zcl_scenes_extension_field_s ezb_zcl_scenes_extension_field_t

Structure for the ZCL Scenes extension field set format.

typedef struct ezb_zcl_scenes_add_scene_cmd_s ezb_zcl_scenes_add_scene_cmd_t

Structure for the ZCL Scenes AddScene command request.

typedef struct ezb_zcl_scenes_view_scene_cmd_s ezb_zcl_scenes_view_scene_cmd_t

Structure for the ZCL Scenes ViewScene command request.

typedef struct ezb_zcl_scenes_remove_scene_cmd_s ezb_zcl_scenes_remove_scene_cmd_t

Structure for the ZCL Scenes RemoveScene command request.

typedef struct ezb_zcl_scenes_remove_all_scenes_cmd_s ezb_zcl_scenes_remove_all_scenes_cmd_t

Structure for the ZCL Scenes RemoveAllScenes command request.

typedef struct ezb_zcl_scenes_store_scene_cmd_s ezb_zcl_scenes_store_scene_cmd_t

Structure for the ZCL Scenes StoreScene command request.

typedef struct ezb_zcl_scenes_recall_scene_cmd_s ezb_zcl_scenes_recall_scene_cmd_t

Structure for the ZCL Scenes RecallScene command request.

typedef struct ezb_zcl_scenes_get_scene_membership_cmd_s ezb_zcl_scenes_get_scene_membership_cmd_t

Structure for the ZCL Scenes GetSceneMembership command request.

typedef struct ezb_zcl_scenes_copy_scene_cmd_s ezb_zcl_scenes_copy_scene_cmd_t

Structure for the ZCL Scenes CopyScene command request.

typedef struct ezb_zcl_scenes_store_scene_message_s ezb_zcl_scenes_store_scene_message_t

Message for the ZCL Scenes StoreScene request.

typedef struct ezb_zcl_scenes_recall_scene_message_s ezb_zcl_scenes_recall_scene_message_t

Message for the ZCL Scenes RecallScene request.

typedef struct ezb_zcl_scenes_operate_scene_rsp_message_s ezb_zcl_scenes_operate_scene_rsp_message_t

Message for the ZCL Scenes OperateScene response.

typedef struct ezb_zcl_scenes_view_scene_rsp_message_s ezb_zcl_scenes_view_scene_rsp_message_t

Message for the ZCL Scenes ViewScene response.

typedef struct ezb_zcl_scenes_get_scene_membership_rsp_message_s ezb_zcl_scenes_get_scene_membership_rsp_message_t

Message for the ZCL Scenes GetSceneMembership response.

5.2.6.3.1.7. On/Off

5.2.6.3.1.7.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/on_off_desc.h

5.2.6.3.1.7.2. Functions

ezb_err_t ezb_zcl_on_off_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an on_off cluster descriptor.

Parameters:

• cluster_desc -- [in] The on_off cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_on_off_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an on_off cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the on_off cluster configuration structure. Use ezb_zcl_on_off_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_on_off_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_on_off_cluster_client_init(uint8_t ep_id)

Initialize the OnOff cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_on_off_cluster_server_init(uint8_t ep_id)

Initialize the OnOff cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.7.3. Structures

struct ezb_zcl_on_off_cluster_server_config_s

Configuration mandatory attributes for the OnOff server cluster.

Public Members

bool on_off

Configurable mandatory OnOff attribute

5.2.6.3.1.7.4. Macros

EZB_ZCL_ON_OFF_CLUSTER_REVISION

Cluster Revision of the on_off cluster implementation.

EZB_ZCL_ON_OFF_ON_OFF_DEFAULT_VALUE

Default value of OnOff in OnOff cluster.

EZB_ZCL_ON_OFF_ON_OFF_MIN_VALUE

Minimum value of OnOff in OnOff cluster.

EZB_ZCL_ON_OFF_ON_OFF_MAX_VALUE

Maximum value of OnOff in OnOff cluster.

EZB_ZCL_ON_OFF_GLOBAL_SCENE_CONTROL_DEFAULT_VALUE

Default value of GlobalSceneControl in OnOff cluster.

EZB_ZCL_ON_OFF_GLOBAL_SCENE_CONTROL_MIN_VALUE

Minimum value of GlobalSceneControl in OnOff cluster.

EZB_ZCL_ON_OFF_GLOBAL_SCENE_CONTROL_MAX_VALUE

Maximum value of GlobalSceneControl in OnOff cluster.

EZB_ZCL_ON_OFF_ON_TIME_DEFAULT_VALUE

Default value of OnTime in OnOff cluster.

EZB_ZCL_ON_OFF_ON_TIME_MIN_VALUE

Minimum value of OnTime in OnOff cluster.

EZB_ZCL_ON_OFF_ON_TIME_MAX_VALUE

Maximum value of OnTime in OnOff cluster.

EZB_ZCL_ON_OFF_OFF_WAIT_TIME_DEFAULT_VALUE

Default value of OffWaitTime in OnOff cluster.

EZB_ZCL_ON_OFF_OFF_WAIT_TIME_MIN_VALUE

Minimum value of OffWaitTime in OnOff cluster.

EZB_ZCL_ON_OFF_OFF_WAIT_TIME_MAX_VALUE

Maximum value of OffWaitTime in OnOff cluster.

EZB_ZCL_ON_OFF_START_UP_ON_OFF_DEFAULT_VALUE

Default value of StartUpOnOff in OnOff cluster.

EZB_ZCL_CLUSTER_ID_ON_OFF_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_ON_OFF_SERVER_ROLE_INIT

5.2.6.3.1.7.5. Type Definitions

typedef struct ezb_zcl_on_off_cluster_server_config_s ezb_zcl_on_off_cluster_server_config_t

Configuration mandatory attributes for the OnOff server cluster.

typedef ezb_zcl_on_off_cluster_server_config_t ezb_zcl_on_off_cluster_config_t

5.2.6.3.1.7.6. Enumerations

enum ezb_zcl_on_off_server_attr_t

Attribute identifiers for the on_off server cluster.

Values:

enumerator EZB_ZCL_ATTR_ON_OFF_ON_OFF_ID

OnOff attribute.

enumerator EZB_ZCL_ATTR_ON_OFF_GLOBAL_SCENE_CONTROL_ID

GlobalSceneControl attribute.

enumerator EZB_ZCL_ATTR_ON_OFF_ON_TIME_ID

OnTime attribute.

enumerator EZB_ZCL_ATTR_ON_OFF_OFF_WAIT_TIME_ID

OffWaitTime attribute.

enumerator EZB_ZCL_ATTR_ON_OFF_START_UP_ON_OFF_ID

StartUpOnOff attribute.

enumerator EZB_ZCL_ATTR_ON_OFF_ON_OFF_TIMER_CONTEXT_ID

OnOffTimerContext attribute.

enum ezb_zcl_on_off_server_start_up_on_off_t

Enumeration for ZCL StartUpOnOff attribute of OnOff.

Values:

enumerator EZB_ZCL_ON_OFF_START_UP_ON_OFF_SET_ON_OFF_TO_OFF

SetOnOffToOff

enumerator EZB_ZCL_ON_OFF_START_UP_ON_OFF_SET_ON_OFF_TO_ON

SetOnOffToOn

enumerator EZB_ZCL_ON_OFF_START_UP_ON_OFF_TOGGLE_PREVIOUS_ON_OFF

TogglePreviousOnOff

enumerator EZB_ZCL_ON_OFF_START_UP_ON_OFF_SET_PREVIOUS_ON_OFF

SetPreviousOnOff

enum ezb_zcl_on_off_server_cmd_id_t

Received Command identifiers for the OnOff cluster.

Values:

enumerator EZB_ZCL_CMD_ON_OFF_OFF_ID

Off command.

enumerator EZB_ZCL_CMD_ON_OFF_ON_ID

On command.

enumerator EZB_ZCL_CMD_ON_OFF_TOGGLE_ID

Toggle command.

enumerator EZB_ZCL_CMD_ON_OFF_OFF_WITH_EFFECT_ID

OffWithEffect command.

enumerator EZB_ZCL_CMD_ON_OFF_ON_WITH_RECALL_GLOBAL_SCENE_ID

OnWithRecallGlobalScene command.

enumerator EZB_ZCL_CMD_ON_OFF_ON_WITH_TIMED_OFF_ID

OnWithTimedOff command.

5.2.6.3.1.7.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/on_off.h

5.2.6.3.1.7.8. Functions

ezb_err_t ezb_zcl_on_off_off_cmd_req(const ezb_zcl_on_off_cmd_t *cmd_req)

Send ZCL OnOff Off command request.

Break Change: separate on/off command

Parameters:

cmd_req -- Pointer to the Off command request structure, ezb_zcl_on_off_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_on_off_on_cmd_req(const ezb_zcl_on_off_cmd_t *cmd_req)

Send ZCL OnOff On command request.

Parameters:

cmd_req -- Pointer to the On command request structure, ezb_zcl_on_off_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_on_off_toggle_cmd_req(const ezb_zcl_on_off_cmd_t *cmd_req)

Send ZCL OnOff Toggle command request.

Parameters:

cmd_req -- Pointer to the Toggle command request structure, ezb_zcl_on_off_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_on_off_off_with_effect_cmd_req(const ezb_zcl_on_off_off_with_effect_cmd_t *cmd_req)

Send ZCL OnOff OffWithEffect command request.

Parameters:

cmd_req -- Pointer to the OffWithEffect command request structure, ezb_zcl_on_off_off_with_effect_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_on_off_on_with_recall_global_scene_cmd_req(const ezb_zcl_on_off_cmd_t *cmd_req)

Send ZCL OnOff OnWithRecallGlobalScene command request.

Parameters:

cmd_req -- Pointer to the On command request structure, ezb_zcl_on_off_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_on_off_on_with_timed_off_cmd_req(const ezb_zcl_on_off_on_with_timed_off_cmd_t *cmd_req)

Send ZCL OnOff OnWithTimedOff command request.

Parameters:

cmd_req -- Pointer to the OnWithTimedOff command request structure, ezb_zcl_on_off_on_with_timed_off_cmd_s.

Returns:

Error code.

5.2.6.3.1.7.9. Structures

struct ezb_zcl_on_off_cmd_s

Structure for the ZCL OnOff command request (On, Off, or Toggle).

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_on_off_off_with_effect_cmd_s

Structure for the ZCL OnOff OffWithEffect command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint8_t effect_id

Effect identifier to use.

uint8_t effect_variant

Variant of the effect to trigger.

struct ezb_zcl_on_off_off_with_effect_cmd_s payload

Payload of the command.

struct ezb_zcl_on_off_on_with_timed_off_cmd_s

Structure for the ZCL OnOff OnWithTimedOff command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint8_t on_off_control

On/Off control.

uint16_t on_time

On time in 1/10th seconds.

uint16_t off_wait_time

Off wait time in 1/10th seconds.

struct ezb_zcl_on_off_on_with_timed_off_cmd_s payload

Payload of the command.

struct ezb_zcl_on_off_off_with_effect_message_s

Message for the ZCL OnOff OffWithEffect message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

uint8_t effect_id

Effect identifier to use.

uint8_t effect_variant

Variant of the effect to trigger.

struct ezb_zcl_on_off_off_with_effect_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_on_off_off_with_effect_message_s out

Output: result to send back.

5.2.6.3.1.7.10. Type Definitions

typedef struct ezb_zcl_on_off_cmd_s ezb_zcl_on_off_cmd_t

Structure for the ZCL OnOff command request (On, Off, or Toggle).

typedef struct ezb_zcl_on_off_off_with_effect_cmd_s ezb_zcl_on_off_off_with_effect_cmd_t

Structure for the ZCL OnOff OffWithEffect command request.

typedef struct ezb_zcl_on_off_on_with_timed_off_cmd_s ezb_zcl_on_off_on_with_timed_off_cmd_t

Structure for the ZCL OnOff OnWithTimedOff command request.

typedef struct ezb_zcl_on_off_off_with_effect_message_s ezb_zcl_on_off_off_with_effect_message_t

Message for the ZCL OnOff OffWithEffect message.

5.2.6.3.1.8. On/Off Switch Config

5.2.6.3.1.8.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/on_off_switch_config_desc.h

5.2.6.3.1.8.2. Functions

ezb_err_t ezb_zcl_on_off_switch_config_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an on_off_switch_config cluster descriptor.

Parameters:

• cluster_desc -- [in] The on_off_switch_config cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_on_off_switch_config_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an on_off_switch_config cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the on_off_switch_config cluster configuration structure. Use ezb_zcl_on_off_switch_config_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_on_off_switch_config_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_on_off_switch_config_cluster_client_init(uint8_t ep_id)

Initialize the OnOffSwitchConfig cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_on_off_switch_config_cluster_server_init(uint8_t ep_id)

Initialize the OnOffSwitchConfig cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.8.3. Structures

struct ezb_zcl_on_off_switch_config_cluster_server_config_s

Configuration mandatory attributes for the OnOffSwitchConfig server cluster.

Public Members

uint8_t switch_type

Configurable mandatory SwitchType attribute

uint8_t switch_actions

Configurable mandatory SwitchActions attribute

5.2.6.3.1.8.4. Macros

EZB_ZCL_ON_OFF_SWITCH_CONFIG_CLUSTER_REVISION

Cluster Revision of the on_off_switch_config cluster implementation.

EZB_ZCL_ON_OFF_SWITCH_CONFIG_SWITCH_ACTIONS_DEFAULT_VALUE

Default value of SwitchActions in OnOffSwitchConfig cluster.

EZB_ZCL_CLUSTER_ID_ON_OFF_SWITCH_CONFIG_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_ON_OFF_SWITCH_CONFIG_SERVER_ROLE_INIT

5.2.6.3.1.8.5. Type Definitions

typedef struct ezb_zcl_on_off_switch_config_cluster_server_config_s ezb_zcl_on_off_switch_config_cluster_server_config_t

Configuration mandatory attributes for the OnOffSwitchConfig server cluster.

typedef ezb_zcl_on_off_switch_config_cluster_server_config_t ezb_zcl_on_off_switch_config_cluster_config_t

5.2.6.3.1.8.6. Enumerations

enum ezb_zcl_on_off_switch_config_server_attr_t

Attribute identifiers for the on_off_switch_config server cluster.

Values:

enumerator EZB_ZCL_ATTR_ON_OFF_SWITCH_CONFIG_SWITCH_TYPE_ID

SwitchType attribute.

enumerator EZB_ZCL_ATTR_ON_OFF_SWITCH_CONFIG_SWITCH_ACTIONS_ID

SwitchActions attribute.

enum ezb_zcl_on_off_switch_config_server_switch_type_t

Enumeration for ZCL SwitchType attribute of OnOffSwitchConfig.

Values:

enumerator EZB_ZCL_ON_OFF_SWITCH_CONFIG_SWITCH_TYPE_TOGGLE

Toggle

enumerator EZB_ZCL_ON_OFF_SWITCH_CONFIG_SWITCH_TYPE_MOMENTARY

Momentary

enumerator EZB_ZCL_ON_OFF_SWITCH_CONFIG_SWITCH_TYPE_MULTIFUNCTION

Multifunction

enum ezb_zcl_on_off_switch_config_server_switch_actions_t

Enumeration for ZCL SwitchActions attribute of OnOffSwitchConfig.

Values:

enumerator EZB_ZCL_ON_OFF_SWITCH_CONFIG_SWITCH_ACTIONS_ON

On

enumerator EZB_ZCL_ON_OFF_SWITCH_CONFIG_SWITCH_ACTIONS_OFF

Off

enumerator EZB_ZCL_ON_OFF_SWITCH_CONFIG_SWITCH_ACTIONS_TOGGLE

Toggle

5.2.6.3.1.8.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/on_off_switch_config.h

5.2.6.3.1.9. Level Control

5.2.6.3.1.9.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/level_desc.h

5.2.6.3.1.9.2. Functions

ezb_err_t ezb_zcl_level_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an level cluster descriptor.

Parameters:

• cluster_desc -- [in] The level cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_level_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an level cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the level cluster configuration structure. Use ezb_zcl_level_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_level_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_level_cluster_client_init(uint8_t ep_id)

Initialize the Level cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_level_cluster_server_init(uint8_t ep_id)

Initialize the Level cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.9.3. Structures

struct ezb_zcl_level_cluster_server_config_s

Configuration mandatory attributes for the Level server cluster.

Public Members

uint8_t current_level

Configurable mandatory CurrentLevel attribute

5.2.6.3.1.9.4. Macros

EZB_ZCL_LEVEL_CLUSTER_REVISION

Cluster Revision of the level cluster implementation.

EZB_ZCL_LEVEL_CURRENT_LEVEL_DEFAULT_VALUE

Default value of CurrentLevel in Level cluster.

EZB_ZCL_LEVEL_REMAINING_TIME_DEFAULT_VALUE

Default value of RemainingTime in Level cluster.

EZB_ZCL_LEVEL_REMAINING_TIME_MIN_VALUE

Minimum value of RemainingTime in Level cluster.

EZB_ZCL_LEVEL_REMAINING_TIME_MAX_VALUE

Maximum value of RemainingTime in Level cluster.

EZB_ZCL_LEVEL_MIN_LEVEL_DEFAULT_VALUE

Default value of MinLevel in Level cluster.

EZB_ZCL_LEVEL_MAX_LEVEL_DEFAULT_VALUE

Default value of MaxLevel in Level cluster.

EZB_ZCL_LEVEL_MAX_LEVEL_MIN_VALUE

Minimum value of MaxLevel in Level cluster.

EZB_ZCL_LEVEL_MAX_LEVEL_MAX_VALUE

Maximum value of MaxLevel in Level cluster.

EZB_ZCL_LEVEL_CURRENT_FREQUENCY_DEFAULT_VALUE

Default value of CurrentFrequency in Level cluster.

EZB_ZCL_LEVEL_CURRENT_FREQUENCY_MIN_VALUE

Minimum value of CurrentFrequency in Level cluster.

EZB_ZCL_LEVEL_CURRENT_FREQUENCY_MAX_VALUE

Maximum value of CurrentFrequency in Level cluster.

EZB_ZCL_LEVEL_MIN_FREQUENCY_DEFAULT_VALUE

Default value of MinFrequency in Level cluster.

EZB_ZCL_LEVEL_MIN_FREQUENCY_MIN_VALUE

Minimum value of MinFrequency in Level cluster.

EZB_ZCL_LEVEL_MIN_FREQUENCY_MAX_VALUE

Maximum value of MinFrequency in Level cluster.

EZB_ZCL_LEVEL_MAX_FREQUENCY_DEFAULT_VALUE

Default value of MaxFrequency in Level cluster.

EZB_ZCL_LEVEL_MAX_FREQUENCY_MIN_VALUE

Minimum value of MaxFrequency in Level cluster.

EZB_ZCL_LEVEL_MAX_FREQUENCY_MAX_VALUE

Maximum value of MaxFrequency in Level cluster.

EZB_ZCL_LEVEL_ON_OFF_TRANSITION_TIME_DEFAULT_VALUE

Default value of OnOffTransitionTime in Level cluster.

EZB_ZCL_LEVEL_ON_OFF_TRANSITION_TIME_MIN_VALUE

Minimum value of OnOffTransitionTime in Level cluster.

EZB_ZCL_LEVEL_ON_OFF_TRANSITION_TIME_MAX_VALUE

Maximum value of OnOffTransitionTime in Level cluster.

EZB_ZCL_LEVEL_ON_LEVEL_DEFAULT_VALUE

Default value of OnLevel in Level cluster.

EZB_ZCL_LEVEL_ON_LEVEL_MIN_VALUE

Minimum value of OnLevel in Level cluster.

EZB_ZCL_LEVEL_ON_LEVEL_MAX_VALUE

Maximum value of OnLevel in Level cluster.

EZB_ZCL_LEVEL_ON_TRANSITION_TIME_DEFAULT_VALUE

Default value of OnTransitionTime in Level cluster.

EZB_ZCL_LEVEL_ON_TRANSITION_TIME_MIN_VALUE

Minimum value of OnTransitionTime in Level cluster.

EZB_ZCL_LEVEL_ON_TRANSITION_TIME_MAX_VALUE

Maximum value of OnTransitionTime in Level cluster.

EZB_ZCL_LEVEL_OFF_TRANSITION_TIME_DEFAULT_VALUE

Default value of OffTransitionTime in Level cluster.

EZB_ZCL_LEVEL_OFF_TRANSITION_TIME_MIN_VALUE

Minimum value of OffTransitionTime in Level cluster.

EZB_ZCL_LEVEL_OFF_TRANSITION_TIME_MAX_VALUE

Maximum value of OffTransitionTime in Level cluster.

EZB_ZCL_LEVEL_DEFAULT_MOVE_RATE_MIN_VALUE

Minimum value of DefaultMoveRate in Level cluster.

EZB_ZCL_LEVEL_DEFAULT_MOVE_RATE_MAX_VALUE

Maximum value of DefaultMoveRate in Level cluster.

EZB_ZCL_LEVEL_OPTIONS_DEFAULT_VALUE

Default value of Options in Level cluster.

EZB_ZCL_LEVEL_START_UP_CURRENT_LEVEL_MIN_VALUE

Minimum value of StartUpCurrentLevel in Level cluster.

EZB_ZCL_LEVEL_START_UP_CURRENT_LEVEL_MAX_VALUE

Maximum value of StartUpCurrentLevel in Level cluster.

EZB_ZCL_CLUSTER_ID_LEVEL_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_LEVEL_SERVER_ROLE_INIT

5.2.6.3.1.9.5. Type Definitions

typedef struct ezb_zcl_level_cluster_server_config_s ezb_zcl_level_cluster_server_config_t

Configuration mandatory attributes for the Level server cluster.

typedef ezb_zcl_level_cluster_server_config_t ezb_zcl_level_cluster_config_t

5.2.6.3.1.9.6. Enumerations

enum ezb_zcl_level_server_attr_t

Attribute identifiers for the level server cluster.

Values:

enumerator EZB_ZCL_ATTR_LEVEL_CURRENT_LEVEL_ID

CurrentLevel attribute.

enumerator EZB_ZCL_ATTR_LEVEL_REMAINING_TIME_ID

RemainingTime attribute.

enumerator EZB_ZCL_ATTR_LEVEL_MIN_LEVEL_ID

MinLevel attribute.

enumerator EZB_ZCL_ATTR_LEVEL_MAX_LEVEL_ID

MaxLevel attribute.

enumerator EZB_ZCL_ATTR_LEVEL_CURRENT_FREQUENCY_ID

CurrentFrequency attribute.

enumerator EZB_ZCL_ATTR_LEVEL_MIN_FREQUENCY_ID

MinFrequency attribute.

enumerator EZB_ZCL_ATTR_LEVEL_MAX_FREQUENCY_ID

MaxFrequency attribute.

enumerator EZB_ZCL_ATTR_LEVEL_ON_OFF_TRANSITION_TIME_ID

OnOffTransitionTime attribute.

enumerator EZB_ZCL_ATTR_LEVEL_ON_LEVEL_ID

OnLevel attribute.

enumerator EZB_ZCL_ATTR_LEVEL_ON_TRANSITION_TIME_ID

OnTransitionTime attribute.

enumerator EZB_ZCL_ATTR_LEVEL_OFF_TRANSITION_TIME_ID

OffTransitionTime attribute.

enumerator EZB_ZCL_ATTR_LEVEL_DEFAULT_MOVE_RATE_ID

DefaultMoveRate attribute.

enumerator EZB_ZCL_ATTR_LEVEL_OPTIONS_ID

Options attribute.

enumerator EZB_ZCL_ATTR_LEVEL_START_UP_CURRENT_LEVEL_ID

StartUpCurrentLevel attribute.

enumerator EZB_ZCL_ATTR_LEVEL_CVC_CONTEXT_ID

CVCContext attribute.

enum ezb_zcl_level_server_cmd_id_t

Received Command identifiers for the Level cluster.

Values:

enumerator EZB_ZCL_CMD_LEVEL_MOVE_TO_LEVEL_ID

MoveToLevel command.

enumerator EZB_ZCL_CMD_LEVEL_MOVE_ID

Move command.

enumerator EZB_ZCL_CMD_LEVEL_STEP_ID

Step command.

enumerator EZB_ZCL_CMD_LEVEL_STOP_ID

Stop command.

enumerator EZB_ZCL_CMD_LEVEL_MOVE_TO_LEVEL_WITH_ON_OFF_ID

MoveToLevelWithOnOff command.

enumerator EZB_ZCL_CMD_LEVEL_MOVE_WITH_ON_OFF_ID

MoveWithOnOff command.

enumerator EZB_ZCL_CMD_LEVEL_STEP_WITH_ON_OFF_ID

StepWithOnOff command.

enumerator EZB_ZCL_CMD_LEVEL_STOP_WITH_ON_OFF_ID

StopWithOnOff command.

enumerator EZB_ZCL_CMD_LEVEL_MOVE_TO_CLOSEST_FREQUENCY_ID

MoveToClosestFrequency command.

5.2.6.3.1.9.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/level.h

5.2.6.3.1.9.8. Functions

ezb_err_t ezb_zcl_level_move_to_level_cmd_req(const ezb_zcl_level_move_to_level_cmd_t *cmd_req)

Send ZCL Level MoveToLevel command request.

Parameters:

cmd_req -- Pointer to the MoveToLevel command request structure, ezb_zcl_level_move_to_level_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_level_move_to_level_with_on_off_cmd_req(const ezb_zcl_level_move_to_level_cmd_t *cmd_req)

Send ZCL Level MoveToLevelWithOnOff command request.

Parameters:

cmd_req -- Pointer to the MoveToLevelWithOnOff command request structure, ezb_zcl_level_move_to_level_with_on_off_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_level_move_cmd_req(const ezb_zcl_level_move_cmd_t *cmd_req)

Send ZCL Level Move command request.

Parameters:

cmd_req -- Pointer to the Move command request structure, ezb_zcl_level_move_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_level_move_with_on_off_cmd_req(const ezb_zcl_level_move_cmd_t *cmd_req)

Send ZCL Level MoveWithOnOff command request.

Parameters:

cmd_req -- Pointer to the MoveWithOnOff command request structure, ezb_zcl_level_move_with_on_off_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_level_step_cmd_req(const ezb_zcl_level_step_cmd_t *cmd_req)

Send ZCL Level Step command request.

Parameters:

cmd_req -- Pointer to the Step command request structure, ezb_zcl_level_step_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_level_step_with_on_off_cmd_req(const ezb_zcl_level_step_cmd_t *cmd_req)

Send ZCL Level StepWithOnOff command request.

Parameters:

cmd_req -- Pointer to the StepWithOnOff command request structure, ezb_zcl_level_step_with_on_off_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_level_stop_cmd_req(const ezb_zcl_level_stop_cmd_t *cmd_req)

Send ZCL Level Stop command request.

Parameters:

cmd_req -- Pointer to the Stop command request structure, ezb_zcl_level_stop_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_level_stop_with_on_off_cmd_req(const ezb_zcl_level_stop_cmd_t *cmd_req)

Send ZCL Level StopWithOnOff command request.

Parameters:

cmd_req -- Pointer to the StopWithOnOff command request structure, ezb_zcl_level_stop_with_on_off_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_level_move_to_closest_frequency_cmd_req(const ezb_zcl_level_move_to_closest_frequency_cmd_t *cmd_req)

Send ZCL Level MoveToClosestFrequency command request.

Parameters:

cmd_req -- Pointer to the MoveToClosestFrequency command request structure, ezb_zcl_level_move_to_closest_frequency_cmd_s.

Returns:

Error code.

5.2.6.3.1.9.9. Structures

struct ezb_zcl_level_move_to_level_cmd_payload_s

Payload for the ZCL Level MoveToLevel command.

Public Members

uint8_t level

Target level (0-254).

uint16_t transition_time

Time to reach level, in 1/10 s. 0xFFFF = use OnOff transition time.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_level_move_to_level_cmd_s

Structure for the ZCL Level MoveToLevel command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_level_move_to_level_cmd_payload_t payload

Payload of the command.

struct ezb_zcl_level_move_cmd_payload_s

Payload for the ZCL Level Move command.

Public Members

uint8_t move_mode

Up (0) or down (1). ezb_zcl_level_move_mode_t

uint8_t rate

Rate of change in units per second; 0xFF = use default.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_level_move_cmd_s

Structure for the ZCL Level Move command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_level_move_cmd_payload_t payload

Payload of the command.

struct ezb_zcl_level_step_cmd_payload_s

Payload for the ZCL Level Step command.

Public Members

uint8_t step_mode

Up (0) or down (1).

uint8_t step_size

Change in level (1-254).

uint16_t transition_time

Time for the step, in 1/10 s.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_level_step_cmd_s

Structure for the ZCL Level Step command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_level_step_cmd_payload_t payload

Payload of the command.

struct ezb_zcl_level_stop_cmd_payload_s

Payload for the ZCL Level Stop command.

Public Members

uint8_t move_mode

Up (0) or down (1).

uint8_t rate

Rate of change in units per second.

uint8_t options_mask

Bits of Options attribute to check.

uint8_t options_override

Values to override for those bits.

struct ezb_zcl_level_stop_cmd_s

Structure for the ZCL Level Stop command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_level_stop_cmd_payload_t payload

Payload of the command.

struct ezb_zcl_level_move_to_closest_frequency_cmd_payload_s

Payload for the ZCL Level MoveToClosestFrequency command.

Public Members

uint16_t frequency

Target frequency in Hz.

struct ezb_zcl_level_move_to_closest_frequency_cmd_s

Structure for the ZCL Level MoveToClosestFrequency command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_level_move_to_closest_frequency_cmd_payload_t payload

Payload of the command.

5.2.6.3.1.9.10. Type Definitions

typedef struct ezb_zcl_level_move_to_level_cmd_payload_s ezb_zcl_level_move_to_level_cmd_payload_t

Payload for the ZCL Level MoveToLevel command.

typedef struct ezb_zcl_level_move_to_level_cmd_s ezb_zcl_level_move_to_level_cmd_t

Structure for the ZCL Level MoveToLevel command request.

typedef ezb_zcl_level_move_to_level_cmd_t ezb_zcl_level_move_to_level_with_on_off_cmd_t

Structure for the ZCL Level MoveToLevelWithOnOff command request. .

typedef struct ezb_zcl_level_move_cmd_payload_s ezb_zcl_level_move_cmd_payload_t

Payload for the ZCL Level Move command.

typedef struct ezb_zcl_level_move_cmd_s ezb_zcl_level_move_cmd_t

Structure for the ZCL Level Move command request.

typedef ezb_zcl_level_move_cmd_t ezb_zcl_level_move_with_on_off_cmd_t

Structure for the ZCL Level MoveWithOnOff command request. .

typedef struct ezb_zcl_level_step_cmd_payload_s ezb_zcl_level_step_cmd_payload_t

Payload for the ZCL Level Step command.

typedef struct ezb_zcl_level_step_cmd_s ezb_zcl_level_step_cmd_t

Structure for the ZCL Level Step command request.

typedef ezb_zcl_level_step_cmd_t ezb_zcl_level_step_with_on_off_cmd_t

Structure for the ZCL Level StepWithOnOff command request. .

typedef struct ezb_zcl_level_stop_cmd_payload_s ezb_zcl_level_stop_cmd_payload_t

Payload for the ZCL Level Stop command.

typedef struct ezb_zcl_level_stop_cmd_s ezb_zcl_level_stop_cmd_t

Structure for the ZCL Level Stop command request.

typedef ezb_zcl_level_stop_cmd_t ezb_zcl_level_stop_with_on_off_cmd_t

Structure for the ZCL Level StopWithOnOff command request. .

typedef struct ezb_zcl_level_move_to_closest_frequency_cmd_payload_s ezb_zcl_level_move_to_closest_frequency_cmd_payload_t

Payload for the ZCL Level MoveToClosestFrequency command.

typedef struct ezb_zcl_level_move_to_closest_frequency_cmd_s ezb_zcl_level_move_to_closest_frequency_cmd_t

Structure for the ZCL Level MoveToClosestFrequency command request.

5.2.6.3.1.9.11. Enumerations

enum ezb_zcl_level_options_t

Bitmap for the Level cluster Options attribute.

When ExecuteIfOff is set, level commands may run even if the OnOff cluster is off.

Values:

enumerator EZB_ZCL_LEVEL_OPTIONS_EXECUTE_IF_OFF

ExecuteIfOff bit

enumerator EZB_ZCL_LEVEL_OPTIONS_RESERVED

Reserved bit

enum ezb_zcl_level_move_mode_t

Direction for Move commands (continuous level change). .

Values:

enumerator EZB_ZCL_LEVEL_FADE_MODE_UP

Up mode

enumerator EZB_ZCL_LEVEL_FADE_MODE_DOWN

Down mode

5.2.6.3.1.10. Alarms

5.2.6.3.1.10.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/alarms_desc.h

5.2.6.3.1.10.2. Functions

ezb_err_t ezb_zcl_alarms_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an alarms cluster descriptor.

Parameters:

• cluster_desc -- [in] The alarms cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_alarms_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an alarms cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the alarms cluster configuration structure. Use ezb_zcl_alarms_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_alarms_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_alarms_cluster_client_init(uint8_t ep_id)

Initialize the Alarms cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_alarms_cluster_server_init(uint8_t ep_id)

Initialize the Alarms cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.10.3. Structures

struct ezb_zcl_alarms_cluster_server_config_s

Configuration mandatory attributes for the Alarms server cluster.

Public Members

uint16_t alarm_table_size

Configurable mandatory AlarmTableSize attribute

5.2.6.3.1.10.4. Macros

EZB_ZCL_ALARMS_CLUSTER_REVISION

Cluster Revision of the alarms cluster implementation.

EZB_ZCL_ALARMS_ALARM_COUNT_DEFAULT_VALUE

Default value of AlarmCount in Alarms cluster.

EZB_ZCL_ALARMS_ALARM_COUNT_MIN_VALUE

Minimum value of AlarmCount in Alarms cluster.

EZB_ZCL_ALARMS_ALARM_COUNT_MAX_VALUE

Maximum value of AlarmCount in Alarms cluster.

EZB_ZCL_ALARMS_ALARM_TABLE_SIZE_DEFAULT_VALUE

Default value of AlarmTableSize in Alarms cluster.

EZB_ZCL_CLUSTER_ID_ALARMS_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_ALARMS_SERVER_ROLE_INIT

5.2.6.3.1.10.5. Type Definitions

typedef struct ezb_zcl_alarms_cluster_server_config_s ezb_zcl_alarms_cluster_server_config_t

Configuration mandatory attributes for the Alarms server cluster.

typedef ezb_zcl_alarms_cluster_server_config_t ezb_zcl_alarms_cluster_config_t

5.2.6.3.1.10.6. Enumerations

enum ezb_zcl_alarms_server_attr_t

Attribute identifiers for the alarms server cluster.

Values:

enumerator EZB_ZCL_ATTR_ALARMS_ALARM_COUNT_ID

AlarmCount attribute.

enumerator EZB_ZCL_ATTR_ALARMS_ALARM_TABLE_SIZE_ID

AlarmTableSize attribute.

enumerator EZB_ZCL_ATTR_ALARMS_ALARM_TABLE_HANDLE_ID

AlarmTableHandle attribute.

enum ezb_zcl_alarms_server_cmd_id_t

Received Command identifiers for the Alarms cluster.

Values:

enumerator EZB_ZCL_CMD_ALARMS_RESET_ALARM_ID

ResetAlarm command.

enumerator EZB_ZCL_CMD_ALARMS_RESET_ALL_ALARMS_ID

ResetAllAlarms command.

enumerator EZB_ZCL_CMD_ALARMS_GET_ALARM_ID

GetAlarm command.

enumerator EZB_ZCL_CMD_ALARMS_RESET_ALARM_LOG_ID

ResetAlarmLog command.

enum ezb_zcl_alarms_client_cmd_id_t

Received Command identifiers for the Alarms cluster.

Values:

enumerator EZB_ZCL_CMD_ALARMS_ALARM_ID

Alarm command.

enumerator EZB_ZCL_CMD_ALARMS_GET_ALARM_RESPONSE_ID

GetAlarmResponse command.

5.2.6.3.1.10.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/alarms.h

5.2.6.3.1.10.8. Functions

ezb_err_t ezb_zcl_alarms_reset_alarm_cmd_req(const ezb_zcl_alarms_reset_alarm_cmd_t *cmd_req)

Send ZCL Alarms ResetAlarm command request.

Parameters:

cmd_req -- Pointer to the ResetAlarm command request structure, ezb_zcl_alarms_reset_alarm_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_alarms_reset_all_alarms_cmd_req(const ezb_zcl_alarms_reset_all_alarms_cmd_t *cmd_req)

Send ZCL Alarms ResetAllAlarms command request.

Parameters:

cmd_req -- Pointer to the ResetAllAlarms command request structure, ezb_zcl_alarms_reset_all_alarms_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_alarms_get_alarm_cmd_req(const ezb_zcl_alarms_get_alarm_cmd_t *cmd_req)

Send ZCL Alarms GetAlarm command request.

Parameters:

cmd_req -- Pointer to the GetAlarm command request structure, ezb_zcl_alarms_get_alarm_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_alarms_reset_alarm_log_cmd_req(const ezb_zcl_alarms_reset_alarm_log_cmd_t *cmd_req)

Send ZCL Alarms ResetAlarmLog command request.

Parameters:

cmd_req -- Pointer to the ResetAlarmLog command request structure, ezb_zcl_alarms_reset_alarm_log_cmd_t.

Returns:

Error code.

ezb_err_t ezb_zcl_alarms_alarm_cmd_req(const ezb_zcl_alarms_alarm_cmd_t *cmd_req)

Send ZCL Alarms Alarm command request.

Parameters:

cmd_req -- Pointer to the Alarm command request structure, ezb_zcl_alarms_alarm_cmd_s.

Returns:

Error code.

5.2.6.3.1.10.9. Structures

struct ezb_zcl_alarms_cmd_with_no_payload_s

Structure for the ZCL Alarms command request with no payload.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_alarms_reset_alarm_payload_s

Payload for the ZCL Alarms ResetAlarm command.

Public Members

uint8_t alarm_code

Alarm code.

uint16_t cluster_id

Cluster ID.

struct ezb_zcl_alarms_get_alarm_rsp_payload_s

Payload for the ZCL Alarms GetAlarm response.

Public Members

uint8_t status

Status.

uint8_t alarm_code

Alarm code.

uint16_t cluster_id

Cluster ID.

uint32_t timestamp

Timestamp.

struct ezb_zcl_alarms_reset_alarm_cmd_s

Structure for the ZCL Alarms ResetAlarm command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_alarms_reset_alarm_payload_t payload

Payload of the command.

struct ezb_zcl_alarms_alarm_cmd_s

Structure for the ZCL Alarms Alarm command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

ezb_zcl_alarms_alarm_payload_t payload

Payload of the command.

struct ezb_zcl_alarms_reset_alarm_message_s

Message for the ZCL Alarms ResetAlarm message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_alarms_reset_alarm_payload_t payload

Payload from the ResetAlarm command.

struct ezb_zcl_alarms_reset_alarm_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_alarms_reset_alarm_message_s out

Output: result to send back.

struct ezb_zcl_alarms_reset_all_alarms_message_s

Message for the ZCL Alarms ResetAllAlarms message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

struct ezb_zcl_alarms_reset_all_alarms_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_alarms_reset_all_alarms_message_s out

Output: result to send back.

struct ezb_zcl_alarms_alarm_cmd_message_s

Message for the ZCL Alarms Alarm command message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_alarms_alarm_payload_t payload

Payload from the Alarm command.

struct ezb_zcl_alarms_alarm_cmd_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_alarms_alarm_cmd_message_s out

Output: result to send back.

struct ezb_zcl_alarms_get_alarm_rsp_message_s

Message for the ZCL Alarms GetAlarm response message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

ezb_zcl_alarms_get_alarm_rsp_payload_t payload

Payload from the GetAlarm response.

struct ezb_zcl_alarms_get_alarm_rsp_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

struct ezb_zcl_alarms_get_alarm_rsp_message_s out

Output: result to send back.

5.2.6.3.1.10.10. Type Definitions

typedef struct ezb_zcl_alarms_cmd_with_no_payload_s ezb_zcl_alarms_cmd_with_no_payload_t

Structure for the ZCL Alarms command request with no payload.

typedef struct ezb_zcl_alarms_reset_alarm_payload_s ezb_zcl_alarms_reset_alarm_payload_t

Payload for the ZCL Alarms ResetAlarm command.

typedef ezb_zcl_alarms_reset_alarm_payload_t ezb_zcl_alarms_alarm_payload_t

typedef struct ezb_zcl_alarms_get_alarm_rsp_payload_s ezb_zcl_alarms_get_alarm_rsp_payload_t

Payload for the ZCL Alarms GetAlarm response.

typedef struct ezb_zcl_alarms_reset_alarm_cmd_s ezb_zcl_alarms_reset_alarm_cmd_t

Structure for the ZCL Alarms ResetAlarm command request.

typedef ezb_zcl_alarms_cmd_with_no_payload_t ezb_zcl_alarms_reset_all_alarms_cmd_t

Structure for the ZCL Alarms ResetAllAlarms command request. .

typedef ezb_zcl_alarms_cmd_with_no_payload_t ezb_zcl_alarms_get_alarm_cmd_t

Structure for the ZCL Alarms GetAlarm command request. .

typedef ezb_zcl_alarms_cmd_with_no_payload_t ezb_zcl_alarms_reset_alarm_log_cmd_t

Structure for the ZCL Alarms ResetAlarmLog command request. .

typedef struct ezb_zcl_alarms_alarm_cmd_s ezb_zcl_alarms_alarm_cmd_t

Structure for the ZCL Alarms Alarm command request.

typedef struct ezb_zcl_alarms_reset_alarm_message_s ezb_zcl_alarms_reset_alarm_message_t

Message for the ZCL Alarms ResetAlarm message.

typedef struct ezb_zcl_alarms_reset_all_alarms_message_s ezb_zcl_alarms_reset_all_alarms_message_t

Message for the ZCL Alarms ResetAllAlarms message.

typedef struct ezb_zcl_alarms_alarm_cmd_message_s ezb_zcl_alarms_alarm_cmd_message_t

Message for the ZCL Alarms Alarm command message.

typedef struct ezb_zcl_alarms_get_alarm_rsp_message_s ezb_zcl_alarms_get_alarm_rsp_message_t

Message for the ZCL Alarms GetAlarm response message.

5.2.6.3.1.11. Time

5.2.6.3.1.11.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/time_desc.h

5.2.6.3.1.11.2. Functions

ezb_err_t ezb_zcl_time_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an time cluster descriptor.

Parameters:

• cluster_desc -- [in] The time cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_time_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an time cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the time cluster configuration structure. Use ezb_zcl_time_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_time_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_time_cluster_client_init(uint8_t ep_id)

Initialize the Time cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_time_cluster_server_init(uint8_t ep_id)

Initialize the Time cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.11.3. Structures

struct ezb_zcl_time_cluster_server_config_s

Configuration mandatory attributes for the Time server cluster.

Public Members

uint32_t time

Configurable mandatory Time attribute

uint8_t time_status

Configurable mandatory TimeStatus attribute

5.2.6.3.1.11.4. Macros

EZB_ZCL_TIME_CLUSTER_REVISION

Cluster Revision of the time cluster implementation.

EZB_ZCL_TIME_TIME_DEFAULT_VALUE

Default value of Time in Time cluster.

EZB_ZCL_TIME_TIME_MIN_VALUE

Minimum value of Time in Time cluster.

EZB_ZCL_TIME_TIME_MAX_VALUE

Maximum value of Time in Time cluster.

EZB_ZCL_TIME_TIME_STATUS_DEFAULT_VALUE

Default value of TimeStatus in Time cluster.

EZB_ZCL_TIME_TIME_ZONE_DEFAULT_VALUE

Default value of TimeZone in Time cluster.

EZB_ZCL_TIME_TIME_ZONE_MIN_VALUE

Minimum value of TimeZone in Time cluster.

EZB_ZCL_TIME_TIME_ZONE_MAX_VALUE

Maximum value of TimeZone in Time cluster.

EZB_ZCL_TIME_DST_START_DEFAULT_VALUE

Default value of DstStart in Time cluster.

EZB_ZCL_TIME_DST_START_MIN_VALUE

Minimum value of DstStart in Time cluster.

EZB_ZCL_TIME_DST_START_MAX_VALUE

Maximum value of DstStart in Time cluster.

EZB_ZCL_TIME_DST_END_DEFAULT_VALUE

Default value of DstEnd in Time cluster.

EZB_ZCL_TIME_DST_END_MIN_VALUE

Minimum value of DstEnd in Time cluster.

EZB_ZCL_TIME_DST_END_MAX_VALUE

Maximum value of DstEnd in Time cluster.

EZB_ZCL_TIME_DST_SHIFT_DEFAULT_VALUE

Default value of DstShift in Time cluster.

EZB_ZCL_TIME_DST_SHIFT_MIN_VALUE

Minimum value of DstShift in Time cluster.

EZB_ZCL_TIME_DST_SHIFT_MAX_VALUE

Maximum value of DstShift in Time cluster.

EZB_ZCL_TIME_STANDARD_TIME_DEFAULT_VALUE

Default value of StandardTime in Time cluster.

EZB_ZCL_TIME_STANDARD_TIME_MIN_VALUE

Minimum value of StandardTime in Time cluster.

EZB_ZCL_TIME_STANDARD_TIME_MAX_VALUE

Maximum value of StandardTime in Time cluster.

EZB_ZCL_TIME_LOCAL_TIME_DEFAULT_VALUE

Default value of LocalTime in Time cluster.

EZB_ZCL_TIME_LOCAL_TIME_MIN_VALUE

Minimum value of LocalTime in Time cluster.

EZB_ZCL_TIME_LOCAL_TIME_MAX_VALUE

Maximum value of LocalTime in Time cluster.

EZB_ZCL_TIME_LAST_SET_TIME_DEFAULT_VALUE

Default value of LastSetTime in Time cluster.

EZB_ZCL_TIME_LAST_SET_TIME_MIN_VALUE

Minimum value of LastSetTime in Time cluster.

EZB_ZCL_TIME_LAST_SET_TIME_MAX_VALUE

Maximum value of LastSetTime in Time cluster.

EZB_ZCL_TIME_VALID_UNTIL_TIME_DEFAULT_VALUE

Default value of ValidUntilTime in Time cluster.

EZB_ZCL_TIME_VALID_UNTIL_TIME_MIN_VALUE

Minimum value of ValidUntilTime in Time cluster.

EZB_ZCL_TIME_VALID_UNTIL_TIME_MAX_VALUE

Maximum value of ValidUntilTime in Time cluster.

EZB_ZCL_CLUSTER_ID_TIME_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_TIME_SERVER_ROLE_INIT

5.2.6.3.1.11.5. Type Definitions

typedef struct ezb_zcl_time_cluster_server_config_s ezb_zcl_time_cluster_server_config_t

Configuration mandatory attributes for the Time server cluster.

typedef ezb_zcl_time_cluster_server_config_t ezb_zcl_time_cluster_config_t

5.2.6.3.1.11.6. Enumerations

enum ezb_zcl_time_server_attr_t

Attribute identifiers for the time server cluster.

Values:

enumerator EZB_ZCL_ATTR_TIME_TIME_ID

Time attribute.

enumerator EZB_ZCL_ATTR_TIME_TIME_STATUS_ID

TimeStatus attribute.

enumerator EZB_ZCL_ATTR_TIME_TIME_ZONE_ID

TimeZone attribute.

enumerator EZB_ZCL_ATTR_TIME_DST_START_ID

DstStart attribute.

enumerator EZB_ZCL_ATTR_TIME_DST_END_ID

DstEnd attribute.

enumerator EZB_ZCL_ATTR_TIME_DST_SHIFT_ID

DstShift attribute.

enumerator EZB_ZCL_ATTR_TIME_STANDARD_TIME_ID

StandardTime attribute.

enumerator EZB_ZCL_ATTR_TIME_LOCAL_TIME_ID

LocalTime attribute.

enumerator EZB_ZCL_ATTR_TIME_LAST_SET_TIME_ID

LastSetTime attribute.

enumerator EZB_ZCL_ATTR_TIME_VALID_UNTIL_TIME_ID

ValidUntilTime attribute.

enumerator EZB_ZCL_ATTR_TIME_TIME_CTX_ID

TimeCtx attribute.

enum ezb_zcl_time_server_time_status_t

Bitmap for ZCL TimeStatus attribute of Time.

Values:

enumerator EZB_ZCL_TIME_TIME_STATUS_MASTER

Master

enumerator EZB_ZCL_TIME_TIME_STATUS_SYNCHRONIZED

Synchronized

enumerator EZB_ZCL_TIME_TIME_STATUS_MASTER_ZONE_DST

MasterZoneDst

enumerator EZB_ZCL_TIME_TIME_STATUS_SUPERSEDING

Superseding

5.2.6.3.1.11.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/time.h

5.2.6.3.1.11.8. Functions

ezb_err_t ezb_zcl_time_server_interface_register(uint8_t ep_id, ezb_zcl_time_interface_t interface)

Register the time interface for ZCL Time server.

Parameters:

• ep_id -- The endpoint ID.

• interface -- The time interface.

Returns:

Error code.

ezb_err_t ezb_zcl_time_server_synchronize_time(uint8_t ep_id, uint8_t timeout_seconds, ezb_zcl_time_server_sync_callback_t callback, ezb_zcl_time_server_rank_t expected_rank)

Synchronize time from other time servers.

Parameters:

• ep_id -- The endpoint ID of the time cluster.

• timeout_seconds -- The timeout in seconds.

• callback -- Callback to be called when time server selection completes.

• expected_rank -- The expected rank of the time server to synchronize to.

Returns:

Error code.

5.2.6.3.1.11.9. Structures

struct ezb_zcl_time_interface_s

Structure for the Time interface.

Note

The time interface is used to get and set the current UTC time on the device.

Public Members

uint32_t (*get_utc_time)(void)

Get the current UTC time from the device.

Return:

The current UTC time in seconds since the epoch.

void (*set_utc_time)(uint32_t utc_time)

Set the current UTC time on the device.

Param utc_time:

The UTC time in seconds since the epoch.

5.2.6.3.1.11.10. Type Definitions

typedef struct ezb_zcl_time_interface_s ezb_zcl_time_interface_t

Structure for the Time interface.

Note

The time interface is used to get and set the current UTC time on the device.

typedef void (*ezb_zcl_time_server_sync_callback_t)(ezb_err_t status)

Callback function for time server selection during synchronization.

Param status:

The synchronization status/error code (e.g. EZB_ERR_NONE on success, EZB_ERR_TIMEOUT on timeout).

5.2.6.3.1.11.11. Enumerations

enum ezb_zcl_time_server_rank_t

Time server rank for synchronization priority.

Devices SHALL synchronize to a Time server with the highest rank according to the following rules:

1. A server with the Superseding bit set SHALL be chosen over a server without the bit set.

2. A server with the Master bit SHALL be chosen over a server without the bit set.

3. A coordinator with the Superseding and Master bits set SHALL be chosen over a server without the bits set.

4. The server with the lower short address SHALL be chosen.

Higher enum values indicate higher priority.

Values:

enumerator EZB_ZCL_TIME_SERVER_RANK_UNSYNCHRONIZED

Not synchronized.

enumerator EZB_ZCL_TIME_SERVER_RANK_SYNCHRONIZED

Synchronized.

enumerator EZB_ZCL_TIME_SERVER_RANK_MASTER

Master.

enumerator EZB_ZCL_TIME_SERVER_RANK_SUPERSEDING

Superseding.

enumerator EZB_ZCL_TIME_SERVER_RANK_SUPERSEDING_MASTER

Superseding and Master.

enumerator EZB_ZCL_TIME_SERVER_RANK_COORDINATOR_SUPERSEDING_MASTER

Coordinator with Superseding and Master.

5.2.6.3.1.12. Analog Input

5.2.6.3.1.12.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/analog_input_desc.h

5.2.6.3.1.12.2. Functions

ezb_err_t ezb_zcl_analog_input_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an analog_input cluster descriptor.

Parameters:

• cluster_desc -- [in] The analog_input cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_analog_input_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an analog_input cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the analog_input cluster configuration structure. Use ezb_zcl_analog_input_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_analog_input_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_analog_input_cluster_client_init(uint8_t ep_id)

Initialize the AnalogInput cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_analog_input_cluster_server_init(uint8_t ep_id)

Initialize the AnalogInput cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.12.3. Structures

struct ezb_zcl_analog_input_cluster_server_config_s

Configuration mandatory attributes for the AnalogInput server cluster.

Public Members

bool out_of_service

Configurable mandatory OutOfService attribute

float present_value

Configurable mandatory PresentValue attribute

uint8_t status_flags

Configurable mandatory StatusFlags attribute

5.2.6.3.1.12.4. Macros

EZB_ZCL_ANALOG_INPUT_CLUSTER_REVISION

Cluster Revision of the analog_input cluster implementation.

EZB_ZCL_ANALOG_INPUT_OUT_OF_SERVICE_DEFAULT_VALUE

Default value of OutOfService in AnalogInput cluster.

EZB_ZCL_ANALOG_INPUT_RELIABILITY_DEFAULT_VALUE

Default value of Reliability in AnalogInput cluster.

EZB_ZCL_ANALOG_INPUT_STATUS_FLAGS_DEFAULT_VALUE

Default value of StatusFlags in AnalogInput cluster.

EZB_ZCL_ANALOG_INPUT_STATUS_FLAGS_MIN_VALUE

Minimum value of StatusFlags in AnalogInput cluster.

EZB_ZCL_ANALOG_INPUT_STATUS_FLAGS_MAX_VALUE

Maximum value of StatusFlags in AnalogInput cluster.

EZB_ZCL_ANALOG_INPUT_ENGINEERING_UNITS_MIN_VALUE

Minimum value of EngineeringUnits in AnalogInput cluster.

EZB_ZCL_ANALOG_INPUT_ENGINEERING_UNITS_MAX_VALUE

Maximum value of EngineeringUnits in AnalogInput cluster.

EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_MIN_VALUE

Minimum value of ApplicationType in AnalogInput cluster.

EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_MAX_VALUE

Maximum value of ApplicationType in AnalogInput cluster.

EZB_ZCL_CLUSTER_ID_ANALOG_INPUT_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_ANALOG_INPUT_SERVER_ROLE_INIT

5.2.6.3.1.12.5. Type Definitions

typedef struct ezb_zcl_analog_input_cluster_server_config_s ezb_zcl_analog_input_cluster_server_config_t

Configuration mandatory attributes for the AnalogInput server cluster.

typedef ezb_zcl_analog_input_cluster_server_config_t ezb_zcl_analog_input_cluster_config_t

5.2.6.3.1.12.6. Enumerations

enum ezb_zcl_analog_input_server_attr_t

Attribute identifiers for the analog_input server cluster.

Values:

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_DESCRIPTION_ID

Description attribute.

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_MAX_PRESENT_VALUE_ID

MaxPresentValue attribute.

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_MIN_PRESENT_VALUE_ID

MinPresentValue attribute.

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_OUT_OF_SERVICE_ID

OutOfService attribute.

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_PRESENT_VALUE_ID

PresentValue attribute.

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_RELIABILITY_ID

Reliability attribute.

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_RESOLUTION_ID

Resolution attribute.

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_STATUS_FLAGS_ID

StatusFlags attribute.

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_ENGINEERING_UNITS_ID

EngineeringUnits attribute.

enumerator EZB_ZCL_ATTR_ANALOG_INPUT_APPLICATION_TYPE_ID

ApplicationType attribute.

enum ezb_zcl_analog_input_server_reliability_t

Enumeration for ZCL Reliability attribute of AnalogInput.

Values:

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_NO_FAULT_DETECTED

NoFaultDetected

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_NO_SENSOR

NoSensor

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_OVER_RANGE

OverRange

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_UNDER_RANGE

UnderRange

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_OPEN_LOOP

OpenLoop

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_SHORTED_LOOP

ShortedLoop

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_NO_OUTPUT

NoOutput

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_UNRELIABLE_OTHER

UnreliableOther

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_PROCESS_ERROR

ProcessError

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_MULTI_STATE_FAULT

MultiStateFault

enumerator EZB_ZCL_ANALOG_INPUT_RELIABILITY_CONFIGURATION_ERROR

ConfigurationError

enum ezb_zcl_analog_input_server_application_type_t

Enumeration for ZCL ApplicationType attribute of AnalogInput.

Values:

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_TEMPERATURE

Temperature

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_HUMIDITY

Humidity

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_PRESSURE

Pressure

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_FLOW

Flow

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_PERCENTAGE

Percentage

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_PPM

PPM

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_RPM

RPM

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_CURRENT_IN_AMPS

CurrentInAmps

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_FREQUENCY_IN_HZ

FrequencyInHz

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_POWER_IN_WATTS

PowerInWatts

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_POWER_IN_KW

PowerInKw

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_ENERGY_IN_KWH

EnergyInKwh

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_COUNT_UNITLESS

CountUnitless

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_ENTHALPY_IN_KJOULES_PER_KG

EnthalpyInKjoulesPerKg

enumerator EZB_ZCL_ANALOG_INPUT_APPLICATION_TYPE_TIME_IN_SECONDS

TimeInSeconds

enum ezb_zcl_analog_input_server_status_flags_t

Bitmap for ZCL StatusFlags attribute of AnalogInput.

Values:

enumerator EZB_ZCL_ANALOG_INPUT_STATUS_FLAGS_IN_ALARM

InAlarm

enumerator EZB_ZCL_ANALOG_INPUT_STATUS_FLAGS_FAULT

Fault

enumerator EZB_ZCL_ANALOG_INPUT_STATUS_FLAGS_OVERRIDDEN

Overridden

enumerator EZB_ZCL_ANALOG_INPUT_STATUS_FLAGS_OUT_OF_SERVICE

OutOfService

5.2.6.3.1.12.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/analog_input.h

5.2.6.3.1.12.8. Macros

EZB_ZCL_AI_GROUP_ID

Macros for Group ID of ZCL Analog Input.

Analog Input cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Analog Input clusters have Group = 0x01.

Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.

Index = Bits 0 to 15 The specific application usage of the cluster.

EZB_ZCL_AI_SET_APP_TYPE_WITH_ID(_type, _id)

Macros for ApplicationType attribute of ZCL Analog Input.

5.2.6.3.1.12.9. Enumerations

enum ezb_zcl_ai_temperature_in_degrees_celsius_t

Values for 'Temperature in degrees Celsius' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_TEMPERATURE_2_PIPE_ENTERING

2 Pipe Entering

enumerator EZB_ZCL_AI_TEMPERATURE_2_PIPE_LEAVING

2 Pipe Leaving

enumerator EZB_ZCL_AI_TEMPERATURE_BOILER_ENTERING

Boiler Entering

enumerator EZB_ZCL_AI_TEMPERATURE_BOILER_LEAVING

Boiler Leaving

enumerator EZB_ZCL_AI_TEMPERATURE_CHILLER_CHILLED_WATER_ENTERING

Chiller Chilled Water Entering

enumerator EZB_ZCL_AI_TEMPERATURE_CHILLER_CHILLED_WATER_LEAVING

Chiller Chilled Water Leaving

enumerator EZB_ZCL_AI_TEMPERATURE_CHILLER_CONDENSER_WATER_ENTERING

Chiller Condenser Water Entering

enumerator EZB_ZCL_AI_TEMPERATURE_CHILLER_CONDENSER_WATER_LEAVING

Chiller Condenser Water Leaving

enumerator EZB_ZCL_AI_TEMPERATURE_COLD_DECK

Cold Deck

enumerator EZB_ZCL_AI_TEMPERATURE_COOLING_COIL_DISCHARGE

Cooling Coil Discharge

enumerator EZB_ZCL_AI_TEMPERATURE_COOLING_ENTERING_WATER

Cooling entering water

enumerator EZB_ZCL_AI_TEMPERATURE_COOLING_LEAVING_WATER

Cooling leaving Water

enumerator EZB_ZCL_AI_TEMPERATURE_CONDENSER_WATER_RETURN

Condenser water return

enumerator EZB_ZCL_AI_TEMPERATURE_CONDENSER_WATER_SUPPLY

Condenser water supply

enumerator EZB_ZCL_AI_TEMPERATURE_DECOUPLE_LOOP_0

Decouple loop 0. Note: Decouple loop is duplicated in spec

enumerator EZB_ZCL_AI_TEMPERATURE_BUILDING_LOAD

Building load

enumerator EZB_ZCL_AI_TEMPERATURE_DECOUPLE_LOOP_1

Decouple loop 1

enumerator EZB_ZCL_AI_TEMPERATURE_DEW_POINT

Dew point

enumerator EZB_ZCL_AI_TEMPERATURE_DISCHARGE_AIR

Discharge air

enumerator EZB_ZCL_AI_TEMPERATURE_DISCHARGE

Discharge

enumerator EZB_ZCL_AI_TEMPERATURE_EXHAUST_AIR_AFTER_HEAT_RECOVERY

Exhaust air after heat recovery

enumerator EZB_ZCL_AI_TEMPERATURE_EXHAUST_AIR

Exhaust air

enumerator EZB_ZCL_AI_TEMPERATURE_GLYCOL

Glycol

enumerator EZB_ZCL_AI_TEMPERATURE_HEAT_RECOVERY_AIR

Heat recovery air

enumerator EZB_ZCL_AI_TEMPERATURE_HOT_DECK

Hot deck

enumerator EZB_ZCL_AI_TEMPERATURE_HEAT_EXCHANGER_BYPASS

Heat exchanger bypass

enumerator EZB_ZCL_AI_TEMPERATURE_HEAT_EXCHANGER_ENTERING

Heat exchanger entering

enumerator EZB_ZCL_AI_TEMPERATURE_HEAT_EXCHANGER_LEAVING

Heat eXchanger leaving

enumerator EZB_ZCL_AI_TEMPERATURE_MECHANICAL_ROOM

Mechanical room

enumerator EZB_ZCL_AI_TEMPERATURE_MIXED_AIR_0

Mixed air 0. Mixed air is duplicated in spec

enumerator EZB_ZCL_AI_TEMPERATURE_MIXED_AIR_1

Mixed air 1

enumerator EZB_ZCL_AI_TEMPERATURE_OUTDOOR_AIR_DEWPOINT

Outdoor air dewpoint

enumerator EZB_ZCL_AI_TEMPERATURE_OUTDOOR_AIR

Outdoor air

enumerator EZB_ZCL_AI_TEMPERATURE_PREHEAT_AIR

Preheat air

enumerator EZB_ZCL_AI_TEMPERATURE_PREHEAT_ENTERING_WATER

Preheat entering water

enumerator EZB_ZCL_AI_TEMPERATURE_PREHEAT_LEAVING_WATER

Preheat leaving water

enumerator EZB_ZCL_AI_TEMPERATURE_PRIMARY_CHILLED_WATER_RETURN

Primary chilled water return

enumerator EZB_ZCL_AI_TEMPERATURE_PRIMARY_CHILLED_WATER_SUPPLY

Primary chilled water supply

enumerator EZB_ZCL_AI_TEMPERATURE_PRIMARY_HOT_WATER_RETURN

Primary hot watter return

enumerator EZB_ZCL_AI_TEMPERATURE_PRIMARY_HOT_WATER_SUPPLY

Primary hot watter supply

enumerator EZB_ZCL_AI_TEMPERATURE_REHEAT_COIL_DISCHARGE

Reheat coil discharge

enumerator EZB_ZCL_AI_TEMPERATURE_REHEAT_ENTERING_WATER

Reheat entering water

enumerator EZB_ZCL_AI_TEMPERATURE_REHEAT_LEAVING_WATER

Reheat leaving water

enumerator EZB_ZCL_AI_TEMPERATURE_RETURN_AIR

Return air

enumerator EZB_ZCL_AI_TEMPERATURE_SECONDARY_CHILLED_WATER_RETURN

Secondary chilled water return

enumerator EZB_ZCL_AI_TEMPERATURE_SECONDARY_CHILLED_WATER_SUPPLY

Secondary chilled water supply

enumerator EZB_ZCL_AI_TEMPERATURE_SECONDARY_HW_RETURN

Secondary hw return

enumerator EZB_ZCL_AI_TEMPERATURE_SECONDARY_HW_SUPPLY

Secondary hw supply

enumerator EZB_ZCL_AI_TEMPERATURE_SIDELOOP_RESET

Sideloop reset

enumerator EZB_ZCL_AI_TEMPERATURE_SIDELOOP_SETPOINT

Sideloop setpoint

enumerator EZB_ZCL_AI_TEMPERATURE_SIDELOOP

Sideloop

enumerator EZB_ZCL_AI_TEMPERATURE_SOURCE

Source

enumerator EZB_ZCL_AI_TEMPERATURE_SUPPLY_AIR

Supply air

enumerator EZB_ZCL_AI_TEMPERATURE_SUPPLY_LOW_LIMIT

Supply low limit

enumerator EZB_ZCL_AI_TEMPERATURE_TOWER_BASIN

Tower basin

enumerator EZB_ZCL_AI_TEMPERATURE_TWO_PIPE_LEAVING_WATER

Two pipe leaving water

enumerator EZB_ZCL_AI_TEMPERATURE_RESERVED

Reserved

enumerator EZB_ZCL_AI_TEMPERATURE_ZONE_DEWPOINT

Zone dewpoint

enumerator EZB_ZCL_AI_TEMPERATURE_ZONE_SENSOR_SETPOINT

Zone sensor setpoint

enumerator EZB_ZCL_AI_TEMPERATURE_ZONE_SENSOR_SETPOINT_OFFSET

Zone sensor setpoint offset

enumerator EZB_ZCL_AI_TEMPERATURE_ZONE

Zone

enumerator EZB_ZCL_AI_TEMPERATURE_OTHER

Other

enum ezb_zcl_ai_relative_humidity_in_percent_t

Values for 'Relative Humidity in ' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_HUMIDITY_DISCHARGE

Discharge

enumerator EZB_ZCL_AI_HUMIDITY_EXHAUST

Exhaust

enumerator EZB_ZCL_AI_HUMIDITY_HOT_DECK

Hot deck

enumerator EZB_ZCL_AI_HUMIDITY_MIXED_AIR

Mixed air

enumerator EZB_ZCL_AI_HUMIDITY_OUTDOOR_AIR

Outdoor air

enumerator EZB_ZCL_AI_HUMIDITY_RETURN

Return

enumerator EZB_ZCL_AI_HUMIDITY_SIDELOOP

Sideloop

enumerator EZB_ZCL_AI_HUMIDITY_SPACE

Space

enumerator EZB_ZCL_AI_HUMIDITY_ZONE

Zone

enumerator EZB_ZCL_AI_HUMIDITY_OTHER

Other

enum ezb_zcl_ai_pressure_in_pascal_t

Values for 'Pressure in Pascal' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_PRESSURE_BOILER_PUMP_DIFFERENTIAL

Boiler pump differential

enumerator EZB_ZCL_AI_PRESSURE_BUILDING_STATIC

Building static

enumerator EZB_ZCL_AI_PRESSURE_COLD_DECK_DIFFERENTIAL_SENSOR

Cold deck differential sensor

enumerator EZB_ZCL_AI_PRESSURE_CHILLED_WATER_BUILDING_DIFFERENTIAL

Chilled water building differential

enumerator EZB_ZCL_AI_PRESSURE_COLD_DECK_DIFFERENTIAL

Cold deck differential

enumerator EZB_ZCL_AI_PRESSURE_COLD_DECK_STATIC

Cold deck static

enumerator EZB_ZCL_AI_PRESSURE_CONDENSER_WATER_PUMP_DIFFERENTIAL

Condenser water pump differential

enumerator EZB_ZCL_AI_PRESSURE_DISCHARGE_DIFFERENTIAL

Discharge differential

enumerator EZB_ZCL_AI_PRESSURE_DISCHARGE_STATIC_1

Discharge static 1

enumerator EZB_ZCL_AI_PRESSURE_DISCHARGE_STATIC_2

Discharge static 2

enumerator EZB_ZCL_AI_PRESSURE_EXHAUST_AIR_DIFFERENTIAL

Exhaust air differential

enumerator EZB_ZCL_AI_PRESSURE_EXHAUST_AIR_STATIC

Exhaust air static

enumerator EZB_ZCL_AI_PRESSURE_EXHAUST_DIFFERENTIAL_0

Exhaust differential 0. Note: Exhaust differential is duplicated in spec

enumerator EZB_ZCL_AI_PRESSURE_EXHAUST_DIFFERENTIAL_1

Exhaust differential 1

enumerator EZB_ZCL_AI_PRESSURE_HOT_DECK_DIFFERENTIAL_0

Hot deck differential 0. Note: Hot Deck differential is duplicated in spec

enumerator EZB_ZCL_AI_PRESSURE_HOT_DECK_DIFFERENTIAL_1

Hot deck differential 1

enumerator EZB_ZCL_AI_PRESSURE_HOT_DECK_STATIC

Hot deck static

enumerator EZB_ZCL_AI_PRESSURE_HOT_WATER_BLDG_DIFF

Hot water bldg Diff

enumerator EZB_ZCL_AI_PRESSURE_HEAT_EXCHANGER_STEAM

Heat exchanger steam

enumerator EZB_ZCL_AI_PRESSURE_MIN_OUTDOOR_AIR_DIFFERENTIAL

Min outdoor air differential

enumerator EZB_ZCL_AI_PRESSURE_OUTDOOR_AIR_DIFFERENTIAL

Outdoor air differential

enumerator EZB_ZCL_AI_PRESSURE_PRIMARY_CHILLED_WATER_PUMP_DIFFERENTIAL

Primary chilled water pump differential

enumerator EZB_ZCL_AI_PRESSURE_PRIMATY_HOT_WATER_PUMP_DIFFERENTIAL

Primary hot water pump differential

enumerator EZB_ZCL_AI_PRESSURE_RELIEF_DIFFERENTIAL

Relief differential

enumerator EZB_ZCL_AI_PRESSURE_RETURN_AIR_STATIC

Return air Static

enumerator EZB_ZCL_AI_PRESSURE_RETURN_DIFFERENTIAL

Return differential

enumerator EZB_ZCL_AI_PRESSURE_SECONDARY_CHILLED_WATER_PUMP_DIFFERENTIAL

Secondary chilled water pump differential

enumerator EZB_ZCL_AI_PRESSURE_SECONDARY_HOT_WATER_PUMP_DIFFERENTIAL

Secondary hot water pump differential

enumerator EZB_ZCL_AI_PRESSURE_SIDELOOP

Sideloop

enumerator EZB_ZCL_AI_PRESSURE_STEAM

Steam

enumerator EZB_ZCL_AI_PRESSURE_SUPPLY_DIFFERENTIAL_SENSOR

Supply differential sensor

enumerator EZB_ZCL_AI_PRESSURE_OTHER

Other

enum ezb_zcl_ai_flow_in_liters_per_second_t

Values for 'Flow in Liters per Second' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_FLOW_CHILLED_WATER

Chilled water

enumerator EZB_ZCL_AI_FLOW_CHILLER_CHILLED_WATER

Chiller chilled water

enumerator EZB_ZCL_AI_FLOW_CHILLER_CONDENSER_WATER

Chiller condenser water

enumerator EZB_ZCL_AI_FLOW_COLD_DECK

Cold deck

enumerator EZB_ZCL_AI_FLOW_DECOUPLE_LOOP

Decouple loop

enumerator EZB_ZCL_AI_FLOW_DISCHARGE

Discharge

enumerator EZB_ZCL_AI_FLOW_EXHAUST_FAN

Exhaust fan

enumerator EZB_ZCL_AI_FLOW_EXHAUST

Exhaust

enumerator EZB_ZCL_AI_FLOW_FAN

Fan

enumerator EZB_ZCL_AI_FLOW_HOT_DECK

Flow hot deck

enumerator EZB_ZCL_AI_FLOW_HOT_WATER

Hot water

enumerator EZB_ZCL_AI_FLOW_MIN_OUTDOOR_AIR_FAN

Min outdoor air fan

enumerator EZB_ZCL_AI_FLOW_MIN_OUTDOOR_AIR

Min outdoor Air

enumerator EZB_ZCL_AI_FLOW_OUTDOOR_AIR

Outdoor air

enumerator EZB_ZCL_AI_FLOW_PRIMARY_CHILLED_WATER

Primary chilled water

enumerator EZB_ZCL_AI_FLOW_RELIEF_FAN

Relief fan

enumerator EZB_ZCL_AI_FLOW_RELIEF

Relief

enumerator EZB_ZCL_AI_FLOW_RETURN_FAN

Return fan

enumerator EZB_ZCL_AI_FLOW_RETURN

Return

enumerator EZB_ZCL_AI_FLOW_SECONDARY_CHILLED_WATER_FLOW

Secondary chilled water flow

enumerator EZB_ZCL_AI_FLOW_SUPPLY_FAN

Supply fan

enumerator EZB_ZCL_AI_FLOW_TOWER_FAN

Tower fan

enumerator EZB_ZCL_AI_FLOW_OTHER

Other

enum ezb_zcl_ai_percentage_t

Values for 'Percentage ' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_PERCENTAGE_CHILLER_FULL_LOAD_AMPERAGE

Chiller full load amperage

enumerator EZB_ZCL_AI_PERCENTAGE_OTHER

Other

enum ezb_zcl_ai_ppm_t

Values for 'Parts per Million PPM' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_PPM_RETURN_CARBON_DIOXIDE

Return carbon dioxide

enumerator EZB_ZCL_AI_PPM_ZONE_CARBON_DIOXIDE

Zone carbon dioxide

enumerator EZB_ZCL_AI_PPM_OTHER

Other

enum ezb_zcl_ai_rpm_t

Values for 'Rotational Speed in RPM' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_RPM_EXHAUS_FAN_REMOTE

Exhaust fan remote

enumerator EZB_ZCL_AI_RPM_HEAT_RECOVERY_WHEEL_REMOTE

Heat recovery wheel remote

enumerator EZB_ZCL_AI_RPM_MIN_OUTDOOR_AIR_FAN_REMOTE

Min outdoor air fan remote

enumerator EZB_ZCL_AI_RPM_RELIEF_FAN_REMOTE

Relief fan remote

enumerator EZB_ZCL_AI_RPM_RETURN_FAN_REMOTE

Return fan remote

enumerator EZB_ZCL_AI_RPM_SUPPLY_FAN_REMOTE

Supply fan remote

enumerator EZB_ZCL_AI_RPM_VARIABLE_SPEED_DRIVE_MOTOR

Variable speed drive motor

enumerator EZB_ZCL_AI_RPM_VARIABLE_SPEED_DRIVE_SETPOINT

Variable speed drive setpoint

enumerator EZB_ZCL_AI_RPM_OTHER

Other

enum ezb_zcl_ai_current_t

Values for 'Current in Amps' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_CURRENT_CHILLER_AMPS

Chiller amps

enumerator EZB_ZCL_AI_CURRENT_OTHER

Other

enum ezb_zcl_ai_frequency_t

Values for 'Frequency in Hz' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_FREQUENCY_VARIABLE_SPEED_DRIVE_OUTPUT

Variable speed drive output

enumerator EZB_ZCL_AI_FREQUENCY_OTHER

Other

enum ezb_zcl_ai_power_in_watts_t

Values for 'Power in Watts' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_POWER_IN_WATTS_CONSUMPTION

Consumption

enumerator EZB_ZCL_AI_POWER_IN_WATTS_OTHER

Other

enum ezb_zcl_ai_power_in_kilowatts_t

Values for 'Power in kW' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_POWER_IN_KILOWATTS_ABSOLUTE

Absolute

enumerator EZB_ZCL_AI_POWER_IN_KILOWATTS_CONSUMPTION

Consumption

enumerator EZB_ZCL_AI_POWER_IN_KILOWATTS_OTHER

Other

enum ezb_zcl_ai_energy_kwh_t

Values for 'Energy in kWH' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_ENERGY_KWH_VARIABLE_SPEED_DRIVE

Variable speed drive

enumerator EZB_ZCL_AI_ENERGY_KWH_OTHER

Other

enum ezb_zcl_ai_count_unitless_t

Values for 'Count - Unitless' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_COUNT_UNITLESS_COUNT

Count

enumerator EZB_ZCL_AI_COUNT_UNITLESS_OTHER

Other

enum ezb_zcl_ai_enthalpy_t

Values for 'Enthalpy in KJoules per Kg' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_ENTHALPY_OUTDOOR_AIR

Out door air

enumerator EZB_ZCL_AI_ENTHALPY_RETURN_AIR

Return air

enumerator EZB_ZCL_AI_ENTHALPY_SPACE

Space

enumerator EZB_ZCL_AI_ENTHALPY_OTHER

Other

enum ezb_zcl_ai_time_t

Values for 'Time in Seconds' type of Analog Input cluster.

Values:

enumerator EZB_ZCL_AI_TIME_RELATIVE

Relative

enumerator EZB_ZCL_AI_TIME_OTHER

Other

5.2.6.3.1.13. Analog Output

5.2.6.3.1.13.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/analog_output_desc.h

5.2.6.3.1.13.2. Functions

ezb_err_t ezb_zcl_analog_output_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an analog_output cluster descriptor.

Parameters:

• cluster_desc -- [in] The analog_output cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_analog_output_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an analog_output cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the analog_output cluster configuration structure. Use ezb_zcl_analog_output_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_analog_output_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_analog_output_cluster_client_init(uint8_t ep_id)

Initialize the AnalogOutput cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_analog_output_cluster_server_init(uint8_t ep_id)

Initialize the AnalogOutput cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.13.3. Structures

struct ezb_zcl_analog_output_cluster_server_config_s

Configuration mandatory attributes for the AnalogOutput server cluster.

Public Members

bool out_of_service

Configurable mandatory OutOfService attribute

float present_value

Configurable mandatory PresentValue attribute

uint8_t status_flags

Configurable mandatory StatusFlags attribute

5.2.6.3.1.13.4. Macros

EZB_ZCL_ANALOG_OUTPUT_CLUSTER_REVISION

Cluster Revision of the analog_output cluster implementation.

EZB_ZCL_ANALOG_OUTPUT_OUT_OF_SERVICE_DEFAULT_VALUE

Default value of OutOfService in AnalogOutput cluster.

EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_DEFAULT_VALUE

Default value of Reliability in AnalogOutput cluster.

EZB_ZCL_ANALOG_OUTPUT_STATUS_FLAGS_DEFAULT_VALUE

Default value of StatusFlags in AnalogOutput cluster.

EZB_ZCL_ANALOG_OUTPUT_STATUS_FLAGS_MIN_VALUE

Minimum value of StatusFlags in AnalogOutput cluster.

EZB_ZCL_ANALOG_OUTPUT_STATUS_FLAGS_MAX_VALUE

Maximum value of StatusFlags in AnalogOutput cluster.

EZB_ZCL_ANALOG_OUTPUT_ENGINEERING_UNITS_MIN_VALUE

Minimum value of EngineeringUnits in AnalogOutput cluster.

EZB_ZCL_ANALOG_OUTPUT_ENGINEERING_UNITS_MAX_VALUE

Maximum value of EngineeringUnits in AnalogOutput cluster.

EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_MIN_VALUE

Minimum value of ApplicationType in AnalogOutput cluster.

EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_MAX_VALUE

Maximum value of ApplicationType in AnalogOutput cluster.

EZB_ZCL_CLUSTER_ID_ANALOG_OUTPUT_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_ANALOG_OUTPUT_SERVER_ROLE_INIT

5.2.6.3.1.13.5. Type Definitions

typedef struct ezb_zcl_analog_output_cluster_server_config_s ezb_zcl_analog_output_cluster_server_config_t

Configuration mandatory attributes for the AnalogOutput server cluster.

typedef ezb_zcl_analog_output_cluster_server_config_t ezb_zcl_analog_output_cluster_config_t

5.2.6.3.1.13.6. Enumerations

enum ezb_zcl_analog_output_server_attr_t

Attribute identifiers for the analog_output server cluster.

Values:

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_DESCRIPTION_ID

Description attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_MAX_PRESENT_VALUE_ID

MaxPresentValue attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_MIN_PRESENT_VALUE_ID

MinPresentValue attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_OUT_OF_SERVICE_ID

OutOfService attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_PRESENT_VALUE_ID

PresentValue attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_PRIORITY_ARRAY_ID

PriorityArray attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_RELIABILITY_ID

Reliability attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_RELINQUISH_DEFAULT_ID

RelinquishDefault attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_RESOLUTION_ID

Resolution attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_STATUS_FLAGS_ID

StatusFlags attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_ENGINEERING_UNITS_ID

EngineeringUnits attribute.

enumerator EZB_ZCL_ATTR_ANALOG_OUTPUT_APPLICATION_TYPE_ID

ApplicationType attribute.

enum ezb_zcl_analog_output_server_reliability_t

Enumeration for ZCL Reliability attribute of AnalogOutput.

Values:

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_NO_FAULT_DETECTED

NoFaultDetected

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_NO_SENSOR

NoSensor

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_OVER_RANGE

OverRange

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_UNDER_RANGE

UnderRange

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_OPEN_LOOP

OpenLoop

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_SHORTED_LOOP

ShortedLoop

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_NO_OUTPUT

NoOutput

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_UNRELIABLE_OTHER

UnreliableOther

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_PROCESS_ERROR

ProcessError

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_MULTI_STATE_FAULT

MultiStateFault

enumerator EZB_ZCL_ANALOG_OUTPUT_RELIABILITY_CONFIGURATION_ERROR

ConfigurationError

enum ezb_zcl_analog_output_server_application_type_t

Enumeration for ZCL ApplicationType attribute of AnalogOutput.

Values:

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_TEMPERATURE

Temperature

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_HUMIDITY

Humidity

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_PRESSURE

Pressure

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_FLOW

Flow

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_PERCENTAGE

Percentage

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_PPM

PPM

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_RPM

RPM

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_CURRENT_IN_AMPS

CurrentInAmps

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_FREQUENCY_IN_HZ

FrequencyInHz

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_POWER_IN_WATTS

PowerInWatts

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_POWER_IN_KW

PowerInKw

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_ENERGY_IN_KWH

EnergyInKwh

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_COUNT_UNITLESS

CountUnitless

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_ENTHALPY_IN_K_JOULES_PER_KG

EnthalpyInKJoulesPerKg

enumerator EZB_ZCL_ANALOG_OUTPUT_APPLICATION_TYPE_TIME_IN_SECONDS

TimeInSeconds

enum ezb_zcl_analog_output_server_status_flags_t

Bitmap for ZCL StatusFlags attribute of AnalogOutput.

Values:

enumerator EZB_ZCL_ANALOG_OUTPUT_STATUS_FLAGS_IN_ALARM

InAlarm

enumerator EZB_ZCL_ANALOG_OUTPUT_STATUS_FLAGS_FAULT

Fault

enumerator EZB_ZCL_ANALOG_OUTPUT_STATUS_FLAGS_OVERRIDDEN

Overridden

enumerator EZB_ZCL_ANALOG_OUTPUT_STATUS_FLAGS_OUT_OF_SERVICE

OutOfService

5.2.6.3.1.13.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/analog_output.h

5.2.6.3.1.13.8. Macros

EZB_ZCL_AO_GROUP_ID

Macros for Group ID of ZCL Analog Output.

Analog Output cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Analog Output clusters have Group = 0x01.

Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.

Index = Bits 0 to 15 The specific application usage of the cluster.

EZB_ZCL_AO_SET_APP_TYPE_WITH_ID(_type, _id)

Macros for ApplicationType attribute of ZCL Analog Output.

5.2.6.3.1.13.9. Enumerations

enum ezb_zcl_ao_temperature_in_degrees_celsius_t

Values for 'Temperature in degrees Celsius' type of Analog Output cluster.

Values:

enumerator EZB_ZCL_AO_TEMPERATURE_BOILER

Boiler

enumerator EZB_ZCL_AO_TEMPERATURE_BOILER_SETPOINT

Boiler setpoint

enumerator EZB_ZCL_AO_TEMPERATURE_COLD_DECK

Cold deck

enumerator EZB_ZCL_AO_TEMPERATURE_CHILLER_SETPOINT_0

Chiller setpoint 0. Note: Chiller Setpoint is duplicated in spec

enumerator EZB_ZCL_AO_TEMPERATURE_CHILLER_SETPOINT_1

Chiller setpoint 1

enumerator EZB_ZCL_AO_TEMPERATURE_HOT_DECK

Hot deck

enumerator EZB_ZCL_AO_TEMPERATURE_COOLING_VALVE

Cooling valve

enumerator EZB_ZCL_AO_TEMPERATURE_ZONE_TEMPERATURE_SETPOINT

Zone temperature setpoint

enumerator EZB_ZCL_AO_TEMPERATURE_SETPOINT_OFFSET

Setpoint offset

enumerator EZB_ZCL_AO_TEMPERATURE_SETPOINT_SHIFT

Setpoint shift

enumerator EZB_ZCL_AO_TEMPERATURE_OTHER

Other

enum ezb_zcl_ao_relative_humidity_in_percent_t

Values for 'Relative Humidity in ' type of Analog Output cluster.

Values:

enumerator EZB_ZCL_AO_HUMIDITY_HUMIDIFICATION

Humidification

enumerator EZB_ZCL_AO_HUMIDITY_ZONE_RELATIVE_HUMIDITY

Zone relative humidity

enumerator EZB_ZCL_AO_HUMIDITY_OTHER

Other

enum ezb_zcl_ao_percentage_t

Values for 'Percentage ' type of Analog Output cluster.

Values:

enumerator EZB_ZCL_AO_PERCENTAGE_FACE_BYPASS_DAMPER

Face bypass damper

enumerator EZB_ZCL_AO_PERCENTAGE_HEAT_RECOVERY_VALVE

Heat recovery valve

enumerator EZB_ZCL_AO_PERCENTAGE_HEAT_RECOVERY_WHEEL

Heat recovery wheel

enumerator EZB_ZCL_AO_PERCENTAGE_HEATING_VALVE

Heating valve

enumerator EZB_ZCL_AO_PERCENTAGE_HOT_DECK_DAMPER

Hot deck damper

enumerator EZB_ZCL_AO_PERCENTAGE_2_PIPE_DAMPER

2 pipe damper

enumerator EZB_ZCL_AO_PERCENTAGE_2_PIPE_VALVE

2 pipe valve

enumerator EZB_ZCL_AO_PERCENTAGE_BOILER_MIXING_VALVE

Boiler mixing valve

enumerator EZB_ZCL_AO_PERCENTAGE_BOX_COOLING_VALVE

Box cooling valve

enumerator EZB_ZCL_AO_PERCENTAGE_BOX_HEATING_VALVE

Box heating valve

enumerator EZB_ZCL_AO_PERCENTAGE_CHILLED_WATER_BYPASS_VALVE

Chilled water bypass valve

enumerator EZB_ZCL_AO_PERCENTAGE_COLD_DECK_DAMPER

Cold deck damper

enumerator EZB_ZCL_AO_PERCENTAGE_COOLING_DAMPER

Cooling damper

enumerator EZB_ZCL_AO_PERCENTAGE_COOLING_VALVE

Cooling valve

enumerator EZB_ZCL_AO_PERCENTAGE_DAMPER

Damper

enumerator EZB_ZCL_AO_PERCENTAGE_EXHAUST_AIR_DAMPER

Exhaust air damper

enumerator EZB_ZCL_AO_PERCENTAGE_EXHAUST_DAMPER

Exhaust damper

enumerator EZB_ZCL_AO_PERCENTAGE_HOT_WATER_BYPASS_VALVE

Hot water bypass valve

enumerator EZB_ZCL_AO_PERCENTAGE_HOT_WATER_MIXING_VALVE

Hot water mixing valve

enumerator EZB_ZCL_AO_PERCENTAGE_MINIMUM_OUTSIDE_AIR_DAMPER

Minimum outside air damper

enumerator EZB_ZCL_AO_PERCENTAGE_MINIMUM_OUTSIDE_AIR_FAN

Minimum outside air fan

enumerator EZB_ZCL_AO_PERCENTAGE_MIXED_AIR_DAMPER

Mixed air damper

enumerator EZB_ZCL_AO_PERCENTAGE_MIXING_VALVE

Mixing valve

enumerator EZB_ZCL_AO_PERCENTAGE_OUTSIDE_AIR_DAMPER

Ourside air damper

enumerator EZB_ZCL_AO_PERCENTAGE_PRIMARY_CHILLED_WATER_PUMP

Primary chilled water pump

enumerator EZB_ZCL_AO_PERCENTAGE_PRIMARY_HOT_WATER_PUMP

Primary hot water pump

enumerator EZB_ZCL_AO_PERCENTAGE_PRIMARY_HEAT_EXCHANGE_PUMP

Primary heat exchange pump

enumerator EZB_ZCL_AO_PERCENTAGE_PREHEAT_DAMPER

Preheat damper

enumerator EZB_ZCL_AO_PERCENTAGE_PREHEAT_VALVE

Preheat valve

enumerator EZB_ZCL_AO_PERCENTAGE_REHEAT_VALVE_0

Reheat valve 0. Note: Reheat valve is duplicated in spec

enumerator EZB_ZCL_AO_PERCENTAGE_REHEAT_VALVE_1

Reheat valve 1

enumerator EZB_ZCL_AO_PERCENTAGE_RETURN_AIR_DAMPER

Return air damper

enumerator EZB_ZCL_AO_PERCENTAGE_SECONDARY_CHILLED_WATER_PUMP

Secondary chilled water pump

enumerator EZB_ZCL_AO_PERCENTAGE_SEQUENCED_VALVE

Sequenced valve

enumerator EZB_ZCL_AO_PERCENTAGE_SECONDARY_HOT_WATER_PUMP

Secondary hot water pump

enumerator EZB_ZCL_AO_PERCENTAGE_SECONDARY_HEAT_EXCHANGE_PUMP

Secondary heat exchange pump

enumerator EZB_ZCL_AO_PERCENTAGE_SIDELOOP

Sideloop

enumerator EZB_ZCL_AO_PERCENTAGE_SUPPLY_HEATING_VALVE

Supply heating valve

enumerator EZB_ZCL_AO_PERCENTAGE_SUPPLY_DAMPER

Supply damper

enumerator EZB_ZCL_AO_PERCENTAGE_TOWER_BYPASS_VALVE

Tower bypass valve

enumerator EZB_ZCL_AO_PERCENTAGE_TOWER_FAN

Tower fan

enumerator EZB_ZCL_AO_PERCENTAGE_VALVE

Value

enumerator EZB_ZCL_AO_PERCENTAGE_ZONE_1_DAMPER

Zone 1 damper

enumerator EZB_ZCL_AO_PERCENTAGE_ZONE_1_HEATING_VALVE

Zone 1 heating valve

enumerator EZB_ZCL_AO_PERCENTAGE_HEAT_RECOVERY_EXHAUST_BYPASS_DAMPER

Heat recovery exhaust bypass damper

enumerator EZB_ZCL_AO_PERCENTAGE_HEAT_RECOVERY_OUTSIDE_AIR_BYPASS_DAMPER

Heat recovery outside air bypass damper

enumerator EZB_ZCL_AO_PERCENTAGE_OTHER

Other

enum ezb_zcl_ao_ppm_t

Values for 'Parts per Million PPM' type of Analog Output cluster.

Values:

enumerator EZB_ZCL_AO_PPM_SPACE_CARBON_DIOXIDE_LIMIT

Space carbon dioxide limit

enumerator EZB_ZCL_AO_PPM_OTHER

Other

enum ezb_zcl_ao_rpm_t

Values for 'Rotational Speed in RPM' type of Analog Output cluster.

Values:

enumerator EZB_ZCL_AO_RPM_EXHAUST_FAN_SPEED

Exhaust fan speed

enumerator EZB_ZCL_AO_RPM_FAN_SPEED

Fan speed

enumerator EZB_ZCL_AO_RPM_RELIEF_FAN_SPEED

Relief fan speed

enumerator EZB_ZCL_AO_RPM_RETURN_FAN_SPEED

Return fan speed

enumerator EZB_ZCL_AO_RPM_SUPPLY_FAN_SPEED

Supply fan speed

enumerator EZB_ZCL_AO_RPM_OTHER

Other

enum ezb_zcl_ao_time_t

Values for 'Time in Seconds' type of Analog Output cluster.

Values:

enumerator EZB_ZCL_AO_TIME_RELATIVE

Relative

enumerator EZB_ZCL_AO_TIME_OTHER

Other

5.2.6.3.1.14. Analog Value

5.2.6.3.1.14.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/analog_value_desc.h

5.2.6.3.1.14.2. Functions

ezb_err_t ezb_zcl_analog_value_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an analog_value cluster descriptor.

Parameters:

• cluster_desc -- [in] The analog_value cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_analog_value_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an analog_value cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the analog_value cluster configuration structure. Use ezb_zcl_analog_value_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_analog_value_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_analog_value_cluster_client_init(uint8_t ep_id)

Initialize the AnalogValue cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_analog_value_cluster_server_init(uint8_t ep_id)

Initialize the AnalogValue cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.14.3. Structures

struct ezb_zcl_analog_value_cluster_server_config_s

Configuration mandatory attributes for the AnalogValue server cluster.

Public Members

bool out_of_service

Configurable mandatory OutOfService attribute

float present_value

Configurable mandatory PresentValue attribute

uint8_t status_flags

Configurable mandatory StatusFlags attribute

5.2.6.3.1.14.4. Macros

EZB_ZCL_ANALOG_VALUE_CLUSTER_REVISION

Cluster Revision of the analog_value cluster implementation.

EZB_ZCL_ANALOG_VALUE_OUT_OF_SERVICE_DEFAULT_VALUE

Default value of OutOfService in AnalogValue cluster.

EZB_ZCL_ANALOG_VALUE_RELIABILITY_DEFAULT_VALUE

Default value of Reliability in AnalogValue cluster.

EZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_DEFAULT_VALUE

Default value of StatusFlags in AnalogValue cluster.

EZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_MIN_VALUE

Minimum value of StatusFlags in AnalogValue cluster.

EZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_MAX_VALUE

Maximum value of StatusFlags in AnalogValue cluster.

EZB_ZCL_ANALOG_VALUE_APPLICATION_TYPE_MIN_VALUE

Minimum value of ApplicationType in AnalogValue cluster.

EZB_ZCL_ANALOG_VALUE_APPLICATION_TYPE_MAX_VALUE

Maximum value of ApplicationType in AnalogValue cluster.

EZB_ZCL_CLUSTER_ID_ANALOG_VALUE_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_ANALOG_VALUE_SERVER_ROLE_INIT

5.2.6.3.1.14.5. Type Definitions

typedef struct ezb_zcl_analog_value_cluster_server_config_s ezb_zcl_analog_value_cluster_server_config_t

Configuration mandatory attributes for the AnalogValue server cluster.

typedef ezb_zcl_analog_value_cluster_server_config_t ezb_zcl_analog_value_cluster_config_t

5.2.6.3.1.14.6. Enumerations

enum ezb_zcl_analog_value_server_attr_t

Attribute identifiers for the analog_value server cluster.

Values:

enumerator EZB_ZCL_ATTR_ANALOG_VALUE_DESCRIPTION_ID

Description attribute.

enumerator EZB_ZCL_ATTR_ANALOG_VALUE_OUT_OF_SERVICE_ID

OutOfService attribute.

enumerator EZB_ZCL_ATTR_ANALOG_VALUE_PRESENT_VALUE_ID

PresentValue attribute.

enumerator EZB_ZCL_ATTR_ANALOG_VALUE_PRIORITY_ARRAY_ID

PriorityArray attribute.

enumerator EZB_ZCL_ATTR_ANALOG_VALUE_RELIABILITY_ID

Reliability attribute.

enumerator EZB_ZCL_ATTR_ANALOG_VALUE_RELINQUISH_DEFAULT_ID

RelinquishDefault attribute.

enumerator EZB_ZCL_ATTR_ANALOG_VALUE_STATUS_FLAGS_ID

StatusFlags attribute.

enumerator EZB_ZCL_ATTR_ANALOG_VALUE_ENGINEERING_UNITS_ID

EngineeringUnits attribute.

enumerator EZB_ZCL_ATTR_ANALOG_VALUE_APPLICATION_TYPE_ID

ApplicationType attribute.

enum ezb_zcl_analog_value_server_reliability_t

Enumeration for ZCL Reliability attribute of AnalogValue.

Values:

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_FAULT_DETECTED

NoFaultDetected

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_SENSOR

NoSensor

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_OVER_RANGE

OverRange

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_UNDER_RANGE

UnderRange

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_OPEN_LOOP

OpenLoop

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_SHORTED_LOOP

ShortedLoop

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_NO_OUTPUT

NoOutput

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_UNRELIABLE_OTHER

UnreliableOther

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_PROCESS_ERROR

ProcessError

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_MULTI_STATE_FAULT

MultiStateFault

enumerator EZB_ZCL_ANALOG_VALUE_RELIABILITY_CONFIGURATION_ERROR

ConfigurationError

enum ezb_zcl_analog_value_server_application_type_t

Enumeration for ZCL ApplicationType attribute of AnalogValue.

Values:

enumerator EZB_ZCL_ANALOG_VALUE_APPLICATION_TYPE_TEMPERATURE

Temperature

enumerator EZB_ZCL_ANALOG_VALUE_APPLICATION_TYPE_AREA_IN_SQUARE_METERS

AreaInSquareMeters

enumerator EZB_ZCL_ANALOG_VALUE_APPLICATION_TYPE_MULTIPLIER_NUMBER

MultiplierNumber

enumerator EZB_ZCL_ANALOG_VALUE_APPLICATION_TYPE_FLOW

Flow

enum ezb_zcl_analog_value_server_status_flags_t

Bitmap for ZCL StatusFlags attribute of AnalogValue.

Values:

enumerator EZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_IN_ALARM

InAlarm

enumerator EZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_FAULT

Fault

enumerator EZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_OVERRIDDEN

Overridden

enumerator EZB_ZCL_ANALOG_VALUE_STATUS_FLAGS_OUT_OF_SERVICE

OutOfService

5.2.6.3.1.14.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/analog_value.h

5.2.6.3.1.14.8. Macros

EZB_ZCL_AV_GROUP_ID

Macros for Group ID of ZCL Analog Value.

Analog Value cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Analog Value clusters have Group = 0x01.

Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.

Index = Bits 0 to 15 The specific application usage of the cluster.

EZB_ZCL_AV_SET_APP_TYPE_WITH_ID(_type, _id)

Macros for ApplicationType attribute of ZCL Analog Value.

5.2.6.3.1.14.9. Enumerations

enum ezb_zcl_av_temperature_in_degrees_celsius_t

Values for 'Temperature in degrees Celsius' type of Analog Value cluster.

Values:

enumerator EZB_ZCL_AV_TEMPERATURE_SETPOINT_OFFSET_0

Setpoint Offset

enumerator EZB_ZCL_AV_TEMPERATURE_TEMP_DEADBAND

Temp deadband

enumerator EZB_ZCL_AV_TEMPERATURE_OCCUPIED_HEATING_SETPOINT

Occupied heating setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_UNOCCUPIED_HEATING_SETPOINT

Unoccupied heating setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_OCCUPIED_COOLING_SETPOINT

Occupied cooling setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_UNOCCUPIED_COOLING_SETPOINT

Unoccupied cooling setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_STANDBY_HEAT_SETPOINT

Standby heat setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_STANDBY_COOLING_SETPOINT

Standby cooling setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_EFFECTIVE_OCCUPIED_HEATING_SETPOINT

Effective occupied heating setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_EFFECTIVE_UNOCCUPIED_HEATING_SETPOINT

Effective unoccupied heating setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_EFFECTIVE_OCCUPIED_COOLING_SETPOINT

Effective occupied cooling setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_EFFECTIVE_UNOCCUPIED_COOLING_SETPOINT

Effective unoccupied cooling setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_EFFECTIVE_STANDBY_HEAT_SETPOINT

Effective standby heat setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_EFFECTIVE_STANDBY_COOLING_SETPOINT

Effective standby cooling setpoint

enumerator EZB_ZCL_AV_TEMPERATURE_SETPOINT_OFFSET_2

Setpoint offset 2

enumerator EZB_ZCL_AV_TEMPERATURE_SETPOINT_SHIFT

Setpoint shift

enumerator EZB_ZCL_AV_TEMPERATURE_OTHER

Other

enum ezb_zcl_av_area_in_squares_meters_t

Values for 'Area in Square Metres' type of Analog Value cluster.

Values:

enumerator EZB_ZCL_AV_AREA_DUCT_AREA

Duct Area

enumerator EZB_ZCL_AV_AREA_OTHER

Other

enum ezb_zcl_av_multiplier_number_t

Values for 'Multiplier - Number' type of Analog Value cluster.

Values:

enumerator EZB_ZCL_AV_MULTIPLIER_DUCT_MULTIPLIER

Duct Area

enumerator EZB_ZCL_AV_MULTIPLIER_OTHER

Other

enum ezb_zcl_av_flow_in_liters_per_second_t

Values for 'Flow in Litres per Second' type of Analog Value cluster.

Values:

enumerator EZB_ZCL_AV_FLOW_MINIMUM_AIR_FLOW

Minimum Air Flow

enumerator EZB_ZCL_AV_FLOW_MAXIMUM_AIR_FLOW

Maximum Air Flow

enumerator EZB_ZCL_AV_FLOW_HEATING_MINIMUM_AIR_FLOW

Heating Minimum Air Flow

enumerator EZB_ZCL_AV_FLOW_HEATING_MAXIMUM_AIR_FLOW

Heating Maximum Air Flow

enumerator EZB_ZCL_AV_FLOW_STANDBY_MINIMUM_AIR_FLOW

Standby Minimum Air Flow

enumerator EZB_ZCL_AV_FLOW_STANDBY_MAXIMUM_AIR_FLOW

Standby Maximum Air Flow

enumerator EZB_ZCL_AV_FLOW_OTHER

Other

5.2.6.3.1.15. Binary Input

5.2.6.3.1.15.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/binary_input_desc.h

5.2.6.3.1.15.2. Functions

ezb_err_t ezb_zcl_binary_input_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an binary_input cluster descriptor.

Parameters:

• cluster_desc -- [in] The binary_input cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_binary_input_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an binary_input cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the binary_input cluster configuration structure. Use ezb_zcl_binary_input_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_binary_input_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_binary_input_cluster_client_init(uint8_t ep_id)

Initialize the BinaryInput cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_binary_input_cluster_server_init(uint8_t ep_id)

Initialize the BinaryInput cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.15.3. Structures

struct ezb_zcl_binary_input_cluster_server_config_s

Configuration mandatory attributes for the BinaryInput server cluster.

Public Members

bool out_of_service

Configurable mandatory OutOfService attribute

bool present_value

Configurable mandatory PresentValue attribute

uint8_t status_flags

Configurable mandatory StatusFlags attribute

5.2.6.3.1.15.4. Macros

EZB_ZCL_BINARY_INPUT_CLUSTER_REVISION

Cluster Revision of the binary_input cluster implementation.

EZB_ZCL_BINARY_INPUT_OUT_OF_SERVICE_DEFAULT_VALUE

Default value of OutOfService in BinaryInput cluster.

EZB_ZCL_BINARY_INPUT_POLARITY_DEFAULT_VALUE

Default value of Polarity in BinaryInput cluster.

EZB_ZCL_BINARY_INPUT_RELIABILITY_DEFAULT_VALUE

Default value of Reliability in BinaryInput cluster.

EZB_ZCL_BINARY_INPUT_STATUS_FLAGS_DEFAULT_VALUE

Default value of StatusFlags in BinaryInput cluster.

EZB_ZCL_BINARY_INPUT_STATUS_FLAGS_MIN_VALUE

Minimum value of StatusFlags in BinaryInput cluster.

EZB_ZCL_BINARY_INPUT_STATUS_FLAGS_MAX_VALUE

Maximum value of StatusFlags in BinaryInput cluster.

EZB_ZCL_BINARY_INPUT_APPLICATION_TYPE_MIN_VALUE

Minimum value of ApplicationType in BinaryInput cluster.

EZB_ZCL_BINARY_INPUT_APPLICATION_TYPE_MAX_VALUE

Maximum value of ApplicationType in BinaryInput cluster.

EZB_ZCL_CLUSTER_ID_BINARY_INPUT_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_BINARY_INPUT_SERVER_ROLE_INIT

5.2.6.3.1.15.5. Type Definitions

typedef struct ezb_zcl_binary_input_cluster_server_config_s ezb_zcl_binary_input_cluster_server_config_t

Configuration mandatory attributes for the BinaryInput server cluster.

typedef ezb_zcl_binary_input_cluster_server_config_t ezb_zcl_binary_input_cluster_config_t

5.2.6.3.1.15.6. Enumerations

enum ezb_zcl_binary_input_server_attr_t

Attribute identifiers for the binary_input server cluster.

Values:

enumerator EZB_ZCL_ATTR_BINARY_INPUT_ACTIVE_TEXT_ID

ActiveText attribute.

enumerator EZB_ZCL_ATTR_BINARY_INPUT_DESCRIPTION_ID

Description attribute.

enumerator EZB_ZCL_ATTR_BINARY_INPUT_INACTIVE_TEXT_ID

InactiveText attribute.

enumerator EZB_ZCL_ATTR_BINARY_INPUT_OUT_OF_SERVICE_ID

OutOfService attribute.

enumerator EZB_ZCL_ATTR_BINARY_INPUT_POLARITY_ID

Polarity attribute.

enumerator EZB_ZCL_ATTR_BINARY_INPUT_PRESENT_VALUE_ID

PresentValue attribute.

enumerator EZB_ZCL_ATTR_BINARY_INPUT_RELIABILITY_ID

Reliability attribute.

enumerator EZB_ZCL_ATTR_BINARY_INPUT_STATUS_FLAGS_ID

StatusFlags attribute.

enumerator EZB_ZCL_ATTR_BINARY_INPUT_APPLICATION_TYPE_ID

ApplicationType attribute.

enum ezb_zcl_binary_input_server_reliability_t

Enumeration for ZCL Reliability attribute of BinaryInput.

Values:

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_NO_FAULT_DETECTED

NoFaultDetected

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_NO_SENSOR

NoSensor

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_OVER_RANGE

OverRange

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_UNDER_RANGE

UnderRange

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_OPEN_LOOP

OpenLoop

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_SHORTED_LOOP

ShortedLoop

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_NO_OUTPUT

NoOutput

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_UNRELIABLE_OTHER

UnreliableOther

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_PROCESS_ERROR

ProcessError

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_MULTI_STATE_FAULT

MultiStateFault

enumerator EZB_ZCL_BINARY_INPUT_RELIABILITY_CONFIGURATION_ERROR

ConfigurationError

enum ezb_zcl_binary_input_server_application_type_t

Enumeration for ZCL ApplicationType attribute of BinaryInput.

Values:

enumerator EZB_ZCL_BINARY_INPUT_APPLICATION_TYPE_APP_DOMAIN_HVAC

AppDomainHVAC

enumerator EZB_ZCL_BINARY_INPUT_APPLICATION_TYPE_APP_DOMAIN_SECURITY

AppDomainSecurity

enum ezb_zcl_binary_input_server_status_flags_t

Bitmap for ZCL StatusFlags attribute of BinaryInput.

Values:

enumerator EZB_ZCL_BINARY_INPUT_STATUS_FLAGS_IN_ALARM

InAlarm

enumerator EZB_ZCL_BINARY_INPUT_STATUS_FLAGS_FAULT

Fault

enumerator EZB_ZCL_BINARY_INPUT_STATUS_FLAGS_OVERRIDDEN

Overridden

enumerator EZB_ZCL_BINARY_INPUT_STATUS_FLAGS_OUT_OF_SERVICE

OutOfService

5.2.6.3.1.15.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/binary_input.h

5.2.6.3.1.15.8. Macros

EZB_ZCL_BI_GROUP_ID

Macros for Group ID of ZCL Binary Input.

Binary Input cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Binary Input clusters have Group = 0x00.

Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.

Index = Bits 0 to 15 The specific application usage of the cluster.

EZB_ZCL_BI_SET_APP_TYPE_WITH_ID(_type, _id)

Macros for ApplicationType attribute of ZCL Binary Input.

5.2.6.3.1.15.9. Enumerations

enum ezb_zb_zcl_bi_domain_hvac_t

Values:

enumerator EZB_ZCL_BI_DOMAIN_HVAC_2_PIPE_PUMP_STATUS

2 Pipe Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_AIR_PROVING_SWITCH

Air Proving Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_ALARM_RESET

Alarm Reset BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOILER_STATUS

Boiler Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOILER_FLOW_STATUS

Boiler Flow Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOILER_GENERAL_ALARM

Boiler General Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOILER_HIGH_TEMPERATURE_ALARM

Boiler High Temperature Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOILER_ISOLATION_VALVE_STATUS

Boiler Isolation Valve Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOILER_MAINTENANCE_SWITCH

Boiler Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOILER_PUMP_OVERLOAD

Boiler Pump Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOILER_PUMP_STATUS

Boiler Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOILER_STATUS_2

Boiler Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_BOX_HEATING_ALARM

Box Heating Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLER_ALARM

Chiller Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLER_CHILLED_WATER_FLOW_STATUS

Chiller Chilled Water Flow Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLER_CHILLED_WATER_ISOLATION_VALVE_STATUS

Chiller Chilled Water Isolation Valve Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLER_CONDENSER_WATER_FLOW_STATUS

Chiller Condenser Water Flow Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLER_CONDENSER_WATER_ISOLATION_VALVE_STATUS

Chiller Condenser Water Isolation Valve Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLER_MAINTENANCE_SWITCH

Chiller Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLER_STATUS

Chiller Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLED_WATER_EXPANSION_TANK_ALARM

Chilled Water Expansion Tank Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLED_WATER_EXPANSION_TANK_HIGH_PRESSURE_ALARM

Chilled Water Expansion Tank High Pressure Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLED_WATER_EXPANSION_TANK_LOW_PRESSURE_ALARM

Chilled Water Expansion Tank Low Pressure Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CHILLED_WATER_EXPANSION_TANK_STATUS

Chilled Water Expansion Tank Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_COMBUSTION_DAMPER_STATUS

Combustion Damper Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_COOLING_ALARM

Cooling Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_COOLING_PUMP_MAINTENANCE_SWITCH

Cooling Pump Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_COOLING_PUMP_OVERLOAD

Cooling Pump Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_COOLING_PUMP_STATUS

Cooling Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CONDENSER_WATER_EXPANSION_TANK_ALARM

Condenser Water Expansion Tank Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CONDENSER_WATER_EXPANSION_TANK_HIGH_PRESSURE_ALARM

Condenser Water Expansion Tank High Pressure Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CONDENSER_WATER_EXPANSION_TANK_LOW_PRESSURE_ALARM

Condenser Water Expansion Tank Low Pressure Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CONDENSER_WATER_EXPANSION_TANK_STATUS

Condenser Water Expansion Tank Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CONDENSER_WATER_PUMP_MAINTENANCE_SWITCH

Condenser Water Pump Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CONDENSER_WATER_PUMP_OVERLOAD

Condenser Water Pump Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_CONDENSER_WATER_PUMP_STATUS

Condenser Water Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_DECOUPLE_LOOP_FLOW_DIRECTION

Decouple Loop Flow Direction BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_DISCHARGE_SMOKE

Discharge Smoke BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_DOOR_STATUS

Door Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_ECONOMIZER_COMMAND

Economizer Command BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EMERGENCY_SHUTDOWN

Emergency Shutdown BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EQUIPMENT_TAMPER

Equipment Tamper BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_ENERGY_HOLD_OFF

Energy Hold Off BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EXHAUST_FAN_MAINTENANCE_SWITCH

Exhaust Fan Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EXHAUST_FAN_OVERLOAD

Exhaust Fan Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EXHAUST_FAN_STATUS

Exhaust Fan Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EXHAUST_FILTER_STATUS

Exhaust Filter Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EXHAUST_SMOKE

Exhaust Smoke BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EXPANSION_TANK_ALARM

Expansion Tank Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EXPANSION_TANK_HIGH_PRESSURE_ALARM

Expansion Tank High Pressure Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EXPANSION_TANK_LOW_PRESSURE_ALARM

Expansion Tank Low Pressure Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_EXPANSION_TANK_STATUS

Expansion Tank Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_FAN_CONTROL_BY_OTHERS

Fan Control By Others BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_FAN_OVERLOAD

Fan Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_FILTER_MONITORING

Filter Monitoring BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_FINAL_FILTER_STATUS

Final Filter Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_FREE_COOLING_AVAILABILITY

Free Cooling Availability BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEAT_RECOVERY_PUMP_STATUS

Heat Recovery Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEAT_RECOVERY_WHEEL_ALARM

Heat Recovery Wheel Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEAT_RECOVERY_WHEEL_MAINTENANCE_SWITCH

Heat Recovery Wheel Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEAT_RECOVERY_WHEEL_OVERLOAD

Heat Recovery Wheel Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEAT_RECOVERY_WHEEL_STATUS

Heat Recovery Wheel Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEATING_ALARM

Heating Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEATING_COOLING_PUMP_MAINTENANCE_SWITCH

Heating/Cooling Pump Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEATING_COOLING_PUMP_OVERLOAD

Heating/Cooling Pump Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HIGH_HUMIDITY_LIMIT

High Humidity Limit BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HIGH_STATIC_PRESSURE_FAULT

High Static Pressure Fault BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HIGH_TEMPERATURE_LIMIT_FAULT

High Temperature Limit Fault BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HUMIDIFIER_ALARM

Humidifier Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HUMIDIFIER_MAINTENANCE_SWITCH

Humidifier Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HUMIDIFIER_OVERLOAD

Humidifier Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HUMIDIFIER_STATUS

Humidifier Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEAT_EXCHANGER_ALARM

Heat Exchanger Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEAT_EXCHANGER_ISOLATION_VALVE_STATUS

Heat Exchanger Isolation Valve Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_HEAT_EXCHANGER_MAINTENANCE_SWITCH

Heat Exchanger Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_LIGHTING_STATUS

Lighting Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_LOW_STATIC_PRESSURE_FAULT

Low Static Pressure Fault BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_LOW_TEMPERATURE_LIMIT_FAULT

Low Temperature Limit Fault BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_MINIMUM_OUTDOOR_AIR_DAMPER_END_SWITCH

Minimum Outdoor Air Damper End Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_MINIMUM_OUTDOOR_AIR_FAN_MAINTENANCE_SWITCH

Minimum Outdoor Air Fan Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_MINIMUM_OUTDOOR_AIR_FAN_OVERLOAD

Minimum Outdoor Air Fan Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_MINIMUM_OUTDOOR_AIR_FAN_STATUS

Minimum Outdoor Air Fan Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_MINIMUM_OUTDOOR_AIR_FAN_VARIABLE_FREQUENCY_DRIVE_FAULT

Minimum Outdoor Air Fan Variable Frequency Drive Fault BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_OCCUPANCY

Occupancy BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_OCCUPANCY_SENSOR

Occupancy Sensor BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PRIMARY_CHILLED_WATER_PUMP_MAINTENANCE_SWITCH

Primary Chilled Water Pump Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PRIMARY_CHILLED_WATER_PUMP_OVERLOAD

Primary Chilled Water Pump Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PRIMARY_CHILLED_WATER_PUMP_STATUS

Primary Chilled Water Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PRIMARY_CHILLED_WATER_PUMP_MAINTENANCE_SWITCH_2

Primary Chilled Water Pump Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PRIMARY_CHILLED_WATER_PUMP_OVERLOAD_2

Primary Chilled Water Pump Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PRIMARY_CHILLED_WATER_PUMP_STATUS_2

Primary Chilled Water Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PRE_FILTER_STATUS

Pre-Filter Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PREHEAT_ALARM

Preheat Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PREHEAT_BONNET_SWITCH

Preheat Bonnet Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PREHEAT_PUMP_MAINTENANCE_SWITCH

Preheat Pump Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PREHEAT_PUMP_OVERLOAD

Preheat Pump Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PREHEAT_PUMP_STATUS

Preheat Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_REFRIGERANT_ALARM

Refrigerant Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_REHEAT_ALARM

Reheat Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_REHEAT_BONNET_SWITCH

Reheat Bonnet Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_REHEAT_PUMP_MAINTENANCE_SWITCH

Reheat Pump Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_REHEAT_PUMP_OVERLOAD

Reheat Pump Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_REHEAT_PUMP_STATUS

Reheat Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RELIEF_FAN_MAINTENANCE_SWITCH

Relief Fan Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RELIEF_FAN_OVERLOAD

Relief Fan Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RELIEF_FAN_STATUS

Relief Fan Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RELIEF_FAN_VARIABLE_FREQUENCY_DRIVE_FAULT

Relief Fan Variable Frequency Drive Fault BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RETURN_AIR_SMOKE

Return Air Smoke BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RETURN_FAN_MAINTENANCE_SWITCH

Return Fan Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RETURN_FAN_OVERLOAD

Return Fan Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RETURN_FAN_STATUS

Return Fan Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RETURN_FAN_VFD_FAULT

Return Fan VFD Fault BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_RETURN_SMOKE

Return Smoke BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SECONDARY_CHILLED_WATER_PUMP_1_MAINTENANCE_SWITCH

Secondary Chilled Water Pump 1 Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SECONDARY_CHILLED_WATER_PUMP_1_OVERLOAD

Secondary Chilled Water Pump 1 Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SECONDARY_CHILLED_WATER_PUMP_1_STATUS

Secondary Chilled Water Pump 1 Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SECONDARY_CHILLED_WATER_PUMP_1_MAINTENANCE_SWITCH_2

Secondary Chilled Water Pump 1 Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SECONDARY_CHILLED_WATER_PUMP_1_OVERLOAD_2

Secondary Chilled Water Pump 1 Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SECONDARY_CHILLED_WATER_PUMP_1_STATUS_2

Secondary Chilled Water Pump 1 Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SIDELOOP

Sideloop BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_GENERIC_STATUS

Generic Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SUMMER_WINTER

Summer Winter BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SUPPLEMENTAL_HEATING_ALARM

Supplemental Heating Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SUPPLEMENTAL_HEATING_PUMP_MAINTENANCE_SWITCH

Supplemental Heating Pump Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SUPPLEMENTAL_HEATING_PUMP_OVERLOAD

Supplemental Heating Pump Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SUPPLEMENTAL_HEATING_PUMP_STATUS

Supplemental Heating Pump Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SUPPLY_FAN_MAINTENANCE_SWITCH

Supply Fan Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SUPPLY_FAN_OVERLOAD

Supply Fan Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SUPPLY_FAN_STATUS

Supply Fan Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_SUPPLY_FAN_VARIABLE_FREQUENCY_DRIVE_FAULT

Supply Fan Variable Frequency Drive Fault BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TEMPORARY_OCCUPANCY

Temporary Occupancy BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_LEVEL_ALARM

Tower Level Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_LEVEL_STATUS

Tower Level Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_TEMP

Tower Temp BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_VIBRATION_ALARM_STATUS

Tower Vibration Alarm Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_LEVEL_ALARM_2

Tower Level Alarm BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_LEVEL_SWITCH

Tower Level Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_TEMP_SWITCH

Tower Temp Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_FAN_ISOLATION_VALVE_STATUS

Tower Fan Isolation Valve Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_FAN_MAINTENANCE_SWITCH

Tower Fan Maintenance Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_FAN_OVERLOAD

Tower Fan Overload BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_TOWER_FAN_STATUS

Tower Fan Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_UNIT_ENABLE

Unit Enable BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_UNIT_RESET

Unit Reset BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_WINDOW_STATUS

Window Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_ZONE_SENSOR_TEMPORARY_OCCUPANCY

Zone Sensor Temporary Occupancy BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_AIR_PROVING_SWITCH_2

Air Proving Switch BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PRIMARY_HEATING_STATUS

Primary Heating Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_PRIMARY_COOLING_STATUS

Primary Cooling Status BI

enumerator EZB_ZCL_BI_DOMAIN_HVAC_OTHER

Other

enum ezb_zcl_bi_domain_security_t

Values:

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_GLASS_BREAKAGE_DETECTION_0

Glass Breakage Detection

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_INTRUSION_DETECTION

Intrusion Detection

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_MOTION_DETECTION

Motion Detection

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_GLASS_BREAKAGE_DETECTION_1

Glass Breakage Detection

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_ZONE_ARMED

Zone Armed

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_GLASS_BREAKAGE_DETECTION_2

Glass Breakage Detection

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_SMOKE_DETECTION

Smoke Detection

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_CARBON_DIOXIDE_DETECTION

Carbon Dioxide Detection

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_HEAT_DETECTION

Heat Detection

enumerator EZB_ZCL_BI_DOMAIN_SECURITY_OTHER

Other

5.2.6.3.1.16. Binary Output

5.2.6.3.1.16.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/binary_output_desc.h

5.2.6.3.1.16.2. Functions

ezb_err_t ezb_zcl_binary_output_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an binary_output cluster descriptor.

Parameters:

• cluster_desc -- [in] The binary_output cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_binary_output_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an binary_output cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the binary_output cluster configuration structure. Use ezb_zcl_binary_output_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_binary_output_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_binary_output_cluster_client_init(uint8_t ep_id)

Initialize the BinaryOutput cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_binary_output_cluster_server_init(uint8_t ep_id)

Initialize the BinaryOutput cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.16.3. Structures

struct ezb_zcl_binary_output_cluster_server_config_s

Configuration mandatory attributes for the BinaryOutput server cluster.

Public Members

bool out_of_service

Configurable mandatory OutOfService attribute

bool present_value

Configurable mandatory PresentValue attribute

uint8_t status_flags

Configurable mandatory StatusFlags attribute

5.2.6.3.1.16.4. Macros

EZB_ZCL_BINARY_OUTPUT_CLUSTER_REVISION

Cluster Revision of the binary_output cluster implementation.

EZB_ZCL_BINARY_OUTPUT_MINIMUM_OFF_TIME_DEFAULT_VALUE

Default value of MinimumOffTime in BinaryOutput cluster.

EZB_ZCL_BINARY_OUTPUT_MINIMUM_ON_TIME_DEFAULT_VALUE

Default value of MinimumOnTime in BinaryOutput cluster.

EZB_ZCL_BINARY_OUTPUT_OUT_OF_SERVICE_DEFAULT_VALUE

Default value of OutOfService in BinaryOutput cluster.

EZB_ZCL_BINARY_OUTPUT_POLARITY_DEFAULT_VALUE

Default value of Polarity in BinaryOutput cluster.

EZB_ZCL_BINARY_OUTPUT_RELIABILITY_DEFAULT_VALUE

Default value of Reliability in BinaryOutput cluster.

EZB_ZCL_BINARY_OUTPUT_STATUS_FLAGS_DEFAULT_VALUE

Default value of StatusFlags in BinaryOutput cluster.

EZB_ZCL_BINARY_OUTPUT_STATUS_FLAGS_MIN_VALUE

Minimum value of StatusFlags in BinaryOutput cluster.

EZB_ZCL_BINARY_OUTPUT_STATUS_FLAGS_MAX_VALUE

Maximum value of StatusFlags in BinaryOutput cluster.

EZB_ZCL_BINARY_OUTPUT_APPLICATION_TYPE_MIN_VALUE

Minimum value of ApplicationType in BinaryOutput cluster.

EZB_ZCL_BINARY_OUTPUT_APPLICATION_TYPE_MAX_VALUE

Maximum value of ApplicationType in BinaryOutput cluster.

EZB_ZCL_CLUSTER_ID_BINARY_OUTPUT_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_BINARY_OUTPUT_SERVER_ROLE_INIT

5.2.6.3.1.16.5. Type Definitions

typedef struct ezb_zcl_binary_output_cluster_server_config_s ezb_zcl_binary_output_cluster_server_config_t

Configuration mandatory attributes for the BinaryOutput server cluster.

typedef ezb_zcl_binary_output_cluster_server_config_t ezb_zcl_binary_output_cluster_config_t

5.2.6.3.1.16.6. Enumerations

enum ezb_zcl_binary_output_server_attr_t

Attribute identifiers for the binary_output server cluster.

Values:

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_ACTIVE_TEXT_ID

ActiveText attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_DESCRIPTION_ID

Description attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_INACTIVE_TEXT_ID

InactiveText attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_MINIMUM_OFF_TIME_ID

MinimumOffTime attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_MINIMUM_ON_TIME_ID

MinimumOnTime attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_OUT_OF_SERVICE_ID

OutOfService attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_POLARITY_ID

Polarity attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_PRESENT_VALUE_ID

PresentValue attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_PRIORITY_ARRAY_ID

PriorityArray attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_RELIABILITY_ID

Reliability attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_RELINQUISH_DEFAULT_ID

RelinquishDefault attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_STATUS_FLAGS_ID

StatusFlags attribute.

enumerator EZB_ZCL_ATTR_BINARY_OUTPUT_APPLICATION_TYPE_ID

ApplicationType attribute.

enum ezb_zcl_binary_output_server_reliability_t

Enumeration for ZCL Reliability attribute of BinaryOutput.

Values:

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_NO_FAULT_DETECTED

NoFaultDetected

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_NO_SENSOR

NoSensor

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_OVER_RANGE

OverRange

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_UNDER_RANGE

UnderRange

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_OPEN_LOOP

OpenLoop

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_SHORTED_LOOP

ShortedLoop

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_NO_OUTPUT

NoOutput

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_UNRELIABLE_OTHER

UnreliableOther

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_PROCESS_ERROR

ProcessError

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_MULTI_STATE_FAULT

MultiStateFault

enumerator EZB_ZCL_BINARY_OUTPUT_RELIABILITY_CONFIGURATION_ERROR

ConfigurationError

enum ezb_zcl_binary_output_server_application_type_t

Enumeration for ZCL ApplicationType attribute of BinaryOutput.

Values:

enumerator EZB_ZCL_BINARY_OUTPUT_APPLICATION_TYPE_APP_DOMAIN_HVAC

AppDomainHVAC

enumerator EZB_ZCL_BINARY_OUTPUT_APPLICATION_TYPE_APP_DOMAIN_SECURITY

AppDomainSecurity

enum ezb_zcl_binary_output_server_status_flags_t

Bitmap for ZCL StatusFlags attribute of BinaryOutput.

Values:

enumerator EZB_ZCL_BINARY_OUTPUT_STATUS_FLAGS_IN_ALARM

InAlarm

enumerator EZB_ZCL_BINARY_OUTPUT_STATUS_FLAGS_FAULT

Fault

enumerator EZB_ZCL_BINARY_OUTPUT_STATUS_FLAGS_OVERRIDDEN

Overridden

enumerator EZB_ZCL_BINARY_OUTPUT_STATUS_FLAGS_OUT_OF_SERVICE

OutOfService

5.2.6.3.1.16.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/binary_output.h

5.2.6.3.1.16.8. Macros

EZB_ZCL_BO_GROUP_ID

Macros for Group ID of ZCL Binary Output.

Binary Output cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Binary Input clusters have Group = 0x00.

Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.

Index = Bits 0 to 15 The specific application usage of the cluster.

EZB_ZCL_BO_SET_APP_TYPE_WITH_ID(_type, _id)

Macros for ApplicationType attribute of ZCL Binary Output.

5.2.6.3.1.16.9. Enumerations

enum ezb_zb_zcl_bo_domain_hvac_t

Values for Binary Output cluster HVAC application usages.

Values:

enumerator EZB_ZCL_BO_DOMAIN_HVAC_2_PIPE_CIRCULATION_PUMP_STATUS

2 Pipe Circulation Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_2_PIPE_VALVE

2 Pipe Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_2_PIPE_VALVE_COMMAND

2 Pipe Valve Command BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_BOILER

Boiler BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_BOILER_ISOLATION_VALVE

Boiler Isolation Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_BOILER_PUMP

Boiler Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_BOX_COOLING_2_POSITION

Box Cooling 2 Position BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_BOX_HEATING_2_POSITION

Box Heating 2 Position BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_BOX_HEATING_ENABLE

Box Heating Enable BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_BOX_HEATING_STAGE_1

Box Heating Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_BOX_HEATING_STAGE_2

Box Heating Stage 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_BOX_HEATING_STAGE_3

Box Heating Stage 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_CHILLER_1_ISOLATION_VALVE

Chiller 1 Isolation Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_CHILLER

Chiller BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_CHILLER_CHILLED_WATER_ISOLATION_VALVE

Chiller Chilled Water Isolation Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_CHILLER_CONDENSER_WATER_ISOLATION_VALVE

Chiller Condenser Water Isolation Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COMBUSTION_DAMPER

Combustion Damper BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COMPRESSOR_STAGE_1

Compressor Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COMPRESSOR_STAGE_2

Compressor Stage 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_CIRCULATION_PUMP

Cooling Circulation Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_STAGE_1

Cooling Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_STAGE_2

Cooling Stage 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_STAGE_3

Cooling Stage 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_STAGE_4

Cooling Stage 4 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_STAGE_5

Cooling Stage 5 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_STAGE_6

Cooling Stage 6 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_STAGE_7

Cooling Stage 7 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_STAGE_8

Cooling Stage 8 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_VALVE

Cooling Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_COOLING_VALVE_COMMAND

Cooling Valve Command BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_CHILLED_WATER_PUMP

Chilled Water Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_ECONOMIZER_ENABLE

Economizer Enable BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_EXHAUST_AIR_DAMPER

Exhaust Air Damper BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_EXHAUST_FAN

Exhaust Fan BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_FAN

Fan BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_FAN_SPEED_1

Fan Speed 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_FAN_SPEED_2

Fan Speed 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_FAN_SPEED_3

Fan Speed 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HEAT_RECOVERY_PUMP

Heat Recovery Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HEAT_RECOVERY_VALVE

Heat Recovery Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HEAT_RECOVERY_WHEEL

Heat Recovery Wheel BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HEATING_STAGE_1

Heating Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HEATING_STAGE_2

Heating Stage 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HEATING_STAGE_3

Heating Stage 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HEATING_VALVE

Heating Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HEATING_VALVE_COMMAND

Heating Valve Command BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HOT_GAS_BYPASS_VALVE

Hot Gas Bypass Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HUMIDIFICATION_STAGE_1

Humidification Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HUMIDIFICATION_STAGE_2

Humidification Stage 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HUMIDIFICATION_STAGE_3

Humidification Stage 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HUMIDIFICATION_STAGE_4

Humidification Stage 4 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HUMIDIFIER_ENABLE

Humidifier Enable BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_HEAT_EXCHANGER_ISOLATION_VALVE

Heat Exchanger Isolation Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_LIGHTING

Lighting BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_MINIMUM_OUTSIDE_AIR_DAMPER

Minimum Outside Air Damper BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_MINIMUM_OUTSIDE_AIR_FAN

Minimum Outside Air Fan BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_OUTSIDE_AIR_DAMPER

Outside Air Damper BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PRIMARY_CHILLED_WATER_PUMP_1

Primary Chilled Water Pump 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PLATE_AND_FRAME_HEAT_EXCHANGER_ISOLATION_VALVE

Plate-and-Frame Heat Exchanger Isolation Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PRIMARY_HOT_WATER_PUMP

Primary Hot Water Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PRIMARY_HEAT_EXCHANGE_PUMP

Primary Heat Exchange Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_CIRCULATION_PUMP

Preheat Circulation Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_ENABLE

Preheat Enable BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_STAGE_1

Preheat Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_STAGE_2

Preheat Stage 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_STAGE_3

Preheat Stage 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_STAGE_4

Preheat Stage 4 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_STAGE_5

Preheat Stage 5 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_STAGE_6

Preheat Stage 6 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_STAGE_7

Preheat Stage 7 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_STAGE_8

Preheat Stage 8 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_PREHEAT_VALVE

Preheat Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_CIRCULATION_PUMP

Reheat Circulation Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_ENABLE

Reheat Enable BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_STAGE_1

Reheat Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_STAGE_2

Reheat Stage 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_STAGE_3

Reheat Stage 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_STAGE_4

Reheat Stage 4 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_STAGE_5

Reheat Stage 5 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_STAGE_6

Reheat Stage 6 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_STAGE_7

Reheat Stage 7 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REHEAT_STAGE_8

Reheat Stage 8 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_RELIEF_FAN

Relief Fan BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_RETURN_FAN

Return Fan BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REVERSING_VALVE_1

Reversing Valve 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_REVERSING_VALVE_2

Reversing Valve 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SECONDARY_CHILLED_WATER_PUMP

Secondary Chilled Water Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SECONDARY_HOT_WATER_PUMP

Secondary Hot Water Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SECONDARY_HEAT_EXCHANGE_PUMP

Secondary Heat Exchange Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SIDELOOP

Sideloop BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SIDELOOP_STAGE_1

Sideloop Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SIDELOOP_STAGE_2

Sideloop Stage 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SIDELOOP_STAGE_3

Sideloop Stage 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SIDELOOP_STAGE_4

Sideloop Stage 4 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SIDELOOP_STAGE_5

Sideloop Stage 5 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SIDELOOP_STAGE_6

Sideloop Stage 6 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SIDELOOP_STAGE_7

Sideloop Stage 7 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SIDELOOP_STAGE_8

Sideloop Stage 8 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_STEAM_ISOLATION_VALVE

Steam Isolation Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SUPPLEMENTAL_HEATING_2_POSITION

Supplemental Heating 2 Position BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SUPPLEMENTAL_HEATING_STAGE_1

Supplemental Heating Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SUPPLEMENTAL_HEATING_VALVE

Supplemental Heating Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SUPPLEMENTAL_HEATING_ENABLE

Supplemental Heating Enable BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SUPPLEMENTAL_HEATING_PUMP

Supplemental Heating Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_SUPPLY_FAN

Supply Fan BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_TOWER_BASIN_HEATER_1

Tower Basin Heater BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_TOWER_BASIN_MAKEUP_1

Tower Basin Makeup BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_TOWER_BASIN_HEATER_2

Tower Basin Heater BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_TOWER_BASIN_MAKEUP_2

Tower Basin Makeup BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_TOWER_ISOLATION_VALVE

Tower Isolation Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_TOWER_FAN

Tower Fan BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_TOWER_FAN_SPEED_1

Tower Fan Speed 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_TOWER_FAN_SPEED_2

Tower Fan Speed 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_TOWER_FAN_SPEED_3

Tower Fan Speed 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_ZONE_HEATING_STAGE_1

Zone Heating Stage 1 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_ZONE_HEATING_STAGE_2

Zone Heating Stage 2 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_ZONE_HEATING_STAGE_3

Zone Heating Stage 3 BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_ZONE_HEATING_VALVE

Zone Heating Valve BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_2_PIPE_CIRCULATION_PUMP_2

2 Pipe Circulation Pump BO

enumerator EZB_ZCL_BO_DOMAIN_HVAC_OTHER

Other

enum ezb_zcl_bo_domain_security_t

Values for Binary Output cluster Security application usages.

Values:

enumerator EZB_ZCL_BO_DOMAIN_SECURITY_ARM_DISARM_COMMAND

Arm Disarm Command BO

enumerator EZB_ZCL_BO_DOMAIN_SECURITY_OCCUPANCY_CONTROL

Occupancy Control BO

enumerator EZB_ZCL_BO_DOMAIN_SECURITY_ENABLE_CONTROL

Enable Control BO

enumerator EZB_ZCL_BO_DOMAIN_SECURITY_ACCESS_CONTROL

Access Control BO

enumerator EZB_ZCL_BO_DOMAIN_SECURITY_OTHER

Other

5.2.6.3.1.17. Binary Value

5.2.6.3.1.17.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/binary_value_desc.h

5.2.6.3.1.17.2. Functions

ezb_err_t ezb_zcl_binary_value_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an binary_value cluster descriptor.

Parameters:

• cluster_desc -- [in] The binary_value cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_binary_value_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an binary_value cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the binary_value cluster configuration structure. Use ezb_zcl_binary_value_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_binary_value_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_binary_value_cluster_client_init(uint8_t ep_id)

Initialize the BinaryValue cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_binary_value_cluster_server_init(uint8_t ep_id)

Initialize the BinaryValue cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.17.3. Structures

struct ezb_zcl_binary_value_cluster_server_config_s

Configuration mandatory attributes for the BinaryValue server cluster.

Public Members

bool out_of_service

Configurable mandatory OutOfService attribute

bool present_value

Configurable mandatory PresentValue attribute

uint8_t status_flags

Configurable mandatory StatusFlags attribute

5.2.6.3.1.17.4. Macros

EZB_ZCL_BINARY_VALUE_CLUSTER_REVISION

Cluster Revision of the binary_value cluster implementation.

EZB_ZCL_BINARY_VALUE_MINIMUM_OFF_TIME_DEFAULT_VALUE

Default value of MinimumOffTime in BinaryValue cluster.

EZB_ZCL_BINARY_VALUE_MINIMUM_ON_TIME_DEFAULT_VALUE

Default value of MinimumOnTime in BinaryValue cluster.

EZB_ZCL_BINARY_VALUE_OUT_OF_SERVICE_DEFAULT_VALUE

Default value of OutOfService in BinaryValue cluster.

EZB_ZCL_BINARY_VALUE_RELIABILITY_DEFAULT_VALUE

Default value of Reliability in BinaryValue cluster.

EZB_ZCL_BINARY_VALUE_STATUS_FLAGS_DEFAULT_VALUE

Default value of StatusFlags in BinaryValue cluster.

EZB_ZCL_BINARY_VALUE_STATUS_FLAGS_MIN_VALUE

Minimum value of StatusFlags in BinaryValue cluster.

EZB_ZCL_BINARY_VALUE_STATUS_FLAGS_MAX_VALUE

Maximum value of StatusFlags in BinaryValue cluster.

EZB_ZCL_BINARY_VALUE_APPLICATION_TYPE_MIN_VALUE

Minimum value of ApplicationType in BinaryValue cluster.

EZB_ZCL_BINARY_VALUE_APPLICATION_TYPE_MAX_VALUE

Maximum value of ApplicationType in BinaryValue cluster.

EZB_ZCL_CLUSTER_ID_BINARY_VALUE_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_BINARY_VALUE_SERVER_ROLE_INIT

5.2.6.3.1.17.5. Type Definitions

typedef struct ezb_zcl_binary_value_cluster_server_config_s ezb_zcl_binary_value_cluster_server_config_t

Configuration mandatory attributes for the BinaryValue server cluster.

typedef ezb_zcl_binary_value_cluster_server_config_t ezb_zcl_binary_value_cluster_config_t

5.2.6.3.1.17.6. Enumerations

enum ezb_zcl_binary_value_server_attr_t

Attribute identifiers for the binary_value server cluster.

Values:

enumerator EZB_ZCL_ATTR_BINARY_VALUE_ACTIVE_TEXT_ID

ActiveText attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_DESCRIPTION_ID

Description attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_INACTIVE_TEXT_ID

InactiveText attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_MINIMUM_OFF_TIME_ID

MinimumOffTime attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_MINIMUM_ON_TIME_ID

MinimumOnTime attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_OUT_OF_SERVICE_ID

OutOfService attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_PRESENT_VALUE_ID

PresentValue attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_PRIORITY_ARRAY_ID

PriorityArray attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_RELIABILITY_ID

Reliability attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_RELINQUISH_DEFAULT_ID

RelinquishDefault attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_STATUS_FLAGS_ID

StatusFlags attribute.

enumerator EZB_ZCL_ATTR_BINARY_VALUE_APPLICATION_TYPE_ID

ApplicationType attribute.

enum ezb_zcl_binary_value_server_reliability_t

Enumeration for ZCL Reliability attribute of BinaryValue.

Values:

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_NO_FAULT_DETECTED

NoFaultDetected

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_NO_SENSOR

NoSensor

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_OVER_RANGE

OverRange

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_UNDER_RANGE

UnderRange

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_OPEN_LOOP

OpenLoop

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_SHORTED_LOOP

ShortedLoop

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_NO_OUTPUT

NoOutput

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_UNRELIABLE_OTHER

UnreliableOther

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_PROCESS_ERROR

ProcessError

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_MULTI_STATE_FAULT

MultiStateFault

enumerator EZB_ZCL_BINARY_VALUE_RELIABILITY_CONFIGURATION_ERROR

ConfigurationError

enum ezb_zcl_binary_value_server_status_flags_t

Bitmap for ZCL StatusFlags attribute of BinaryValue.

Values:

enumerator EZB_ZCL_BINARY_VALUE_STATUS_FLAGS_IN_ALARM

InAlarm

enumerator EZB_ZCL_BINARY_VALUE_STATUS_FLAGS_FAULT

Fault

enumerator EZB_ZCL_BINARY_VALUE_STATUS_FLAGS_OVERRIDDEN

Overridden

enumerator EZB_ZCL_BINARY_VALUE_STATUS_FLAGS_OUT_OF_SERVICE

OutOfService

5.2.6.3.1.17.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/binary_value.h

5.2.6.3.1.17.8. Macros

EZB_ZCL_BV_GROUP_ID

Macros for Group ID of ZCL Binary Value.

Binary Value cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Binary Input clusters have Group = 0x00.

Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.

Index = Bits 0 to 15 The specific application usage of the cluster.

EZB_ZCL_BV_SET_APP_TYPE_WITH_ID(_type, _id)

Macros for ApplicationType attribute of ZCL Binary Value.

5.2.6.3.1.17.9. Enumerations

enum ezb_zcl_bv_type_t

Values for Binary Value cluster HVAC application usages.

Values:

enumerator EZB_ZCL_BV_TYPE_FALSE_OFF_NORMAL

Present Value = 0 represents False, Off, Normal

enumerator EZB_ZCL_BV_TYPE_TRUE_ON_ALARM

Present Value = 1 represents True, On, Alarm

enumerator EZB_ZCL_BV_TYPE_OTHER

Other

5.2.6.3.1.18. Multistate Input

5.2.6.3.1.18.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/multistate_input_desc.h

5.2.6.3.1.18.2. Functions

ezb_err_t ezb_zcl_multistate_input_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an multistate_input cluster descriptor.

Parameters:

• cluster_desc -- [in] The multistate_input cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_multistate_input_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an multistate_input cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the multistate_input cluster configuration structure. Use ezb_zcl_multistate_input_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_multistate_input_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_multistate_input_cluster_client_init(uint8_t ep_id)

Initialize the MultistateInput cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_multistate_input_cluster_server_init(uint8_t ep_id)

Initialize the MultistateInput cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.18.3. Structures

struct ezb_zcl_multistate_input_cluster_server_config_s

Configuration mandatory attributes for the MultistateInput server cluster.

Public Members

uint16_t number_of_states

Configurable mandatory NumberOfStates attribute

bool out_of_service

Configurable mandatory OutOfService attribute

uint16_t present_value

Configurable mandatory PresentValue attribute

uint8_t status_flags

Configurable mandatory StatusFlags attribute

5.2.6.3.1.18.4. Macros

EZB_ZCL_MULTISTATE_INPUT_CLUSTER_REVISION

Cluster Revision of the multistate_input cluster implementation.

EZB_ZCL_MULTISTATE_INPUT_NUMBER_OF_STATES_DEFAULT_VALUE

Default value of NumberOfStates in MultistateInput cluster.

EZB_ZCL_MULTISTATE_INPUT_NUMBER_OF_STATES_MIN_VALUE

Minimum value of NumberOfStates in MultistateInput cluster.

EZB_ZCL_MULTISTATE_INPUT_NUMBER_OF_STATES_MAX_VALUE

Maximum value of NumberOfStates in MultistateInput cluster.

EZB_ZCL_MULTISTATE_INPUT_OUT_OF_SERVICE_DEFAULT_VALUE

Default value of OutOfService in MultistateInput cluster.

EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_DEFAULT_VALUE

Default value of Reliability in MultistateInput cluster.

EZB_ZCL_MULTISTATE_INPUT_STATUS_FLAGS_DEFAULT_VALUE

Default value of StatusFlags in MultistateInput cluster.

EZB_ZCL_MULTISTATE_INPUT_STATUS_FLAGS_MIN_VALUE

Minimum value of StatusFlags in MultistateInput cluster.

EZB_ZCL_MULTISTATE_INPUT_STATUS_FLAGS_MAX_VALUE

Maximum value of StatusFlags in MultistateInput cluster.

EZB_ZCL_MULTISTATE_INPUT_APPLICATION_TYPE_MIN_VALUE

Minimum value of ApplicationType in MultistateInput cluster.

EZB_ZCL_MULTISTATE_INPUT_APPLICATION_TYPE_MAX_VALUE

Maximum value of ApplicationType in MultistateInput cluster.

EZB_ZCL_CLUSTER_ID_MULTISTATE_INPUT_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_MULTISTATE_INPUT_SERVER_ROLE_INIT

5.2.6.3.1.18.5. Type Definitions

typedef struct ezb_zcl_multistate_input_cluster_server_config_s ezb_zcl_multistate_input_cluster_server_config_t

Configuration mandatory attributes for the MultistateInput server cluster.

typedef ezb_zcl_multistate_input_cluster_server_config_t ezb_zcl_multistate_input_cluster_config_t

5.2.6.3.1.18.6. Enumerations

enum ezb_zcl_multistate_input_server_attr_t

Attribute identifiers for the multistate_input server cluster.

Values:

enumerator EZB_ZCL_ATTR_MULTISTATE_INPUT_STATE_TEXT_ID

StateText attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_INPUT_DESCRIPTION_ID

Description attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_INPUT_NUMBER_OF_STATES_ID

NumberOfStates attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_INPUT_OUT_OF_SERVICE_ID

OutOfService attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_INPUT_PRESENT_VALUE_ID

PresentValue attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_INPUT_RELIABILITY_ID

Reliability attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_INPUT_RELINQUISH_DEFAULT_ID

RelinquishDefault attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_INPUT_STATUS_FLAGS_ID

StatusFlags attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_INPUT_APPLICATION_TYPE_ID

ApplicationType attribute.

enum ezb_zcl_multistate_input_server_reliability_t

Enumeration for ZCL Reliability attribute of MultistateInput.

Values:

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_NO_FAULT_DETECTED

NoFaultDetected

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_NO_SENSOR

NoSensor

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_OVER_RANGE

OverRange

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_UNDER_RANGE

UnderRange

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_OPEN_LOOP

OpenLoop

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_SHORTED_LOOP

ShortedLoop

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_NO_OUTPUT

NoOutput

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_UNRELIABLE_OTHER

UnreliableOther

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_PROCESS_ERROR

ProcessError

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_MULTI_STATE_FAULT

MultiStateFault

enumerator EZB_ZCL_MULTISTATE_INPUT_RELIABILITY_CONFIGURATION_ERROR

ConfigurationError

enum ezb_zcl_multistate_input_server_application_type_t

Enumeration for ZCL ApplicationType attribute of MultistateInput.

Values:

enumerator EZB_ZCL_MULTISTATE_INPUT_APPLICATION_TYPE_APP_DOMAIN_HVAC

AppDomainHVAC

enum ezb_zcl_multistate_input_server_status_flags_t

Bitmap for ZCL StatusFlags attribute of MultistateInput.

Values:

enumerator EZB_ZCL_MULTISTATE_INPUT_STATUS_FLAGS_IN_ALARM

InAlarm

enumerator EZB_ZCL_MULTISTATE_INPUT_STATUS_FLAGS_FAULT

Fault

enumerator EZB_ZCL_MULTISTATE_INPUT_STATUS_FLAGS_OVERRIDDEN

Overridden

enumerator EZB_ZCL_MULTISTATE_INPUT_STATUS_FLAGS_OUT_OF_SERVICE

OutOfService

5.2.6.3.1.18.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/multistate_input.h

5.2.6.3.1.18.8. Macros

EZB_ZCL_MI_GROUP_ID

Macros for Group ID of ZCL Multistate Input.

Multistate Input cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Multistate Input clusters have Group = 0x00.

Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.

Index = Bits 0 to 15 The specific application usage of the cluster.

EZB_ZCL_MI_SET_APP_TYPE_WITH_ID(_type, _id)

Macros for ApplicationType attribute of ZCL Multistate Input.

5.2.6.3.1.18.9. Enumerations

enum ezb_zcl_mi_domain_hvac_t

Values for Multistate Input cluster HVAC application usages.

Values:

enumerator EZB_ZCL_MI_DOMAIN_HVAC_OFF_ON_AUTO

Off, On, Auto

enumerator EZB_ZCL_MI_DOMAIN_HVAC_OFF_LOW_MEDIUM_HIGH

Off, Low, Medium, High

enumerator EZB_ZCL_MI_DOMAIN_HVAC_AUTO_HEAT_COOL_OFF_EMERGENCY_FAN_MAX

Auto, Heat, Cool, Off, Emergency Heat, Fan Only, Max Heat

enumerator EZB_ZCL_MI_DOMAIN_HVAC_OCCUPIED_UNOCCUPIED_STANDBY_BYPASS

Occupied, Unoccupied, Standby, Bypass

enumerator EZB_ZCL_MI_DOMAIN_HVAC_INACTIVE_ACTIVE_HOLD

Inactive, Active, Hold

enumerator EZB_ZCL_MI_DOMAIN_HVAC_AUTO_WARMUP_WATER_FLUSH_AUTOCAL_SHUTDOWNOPEN_SHUTDOWNCLOSED_LOWLIMIT_TEST_BALANCE

Auto, Warm-up, Water Flush, Autocalibration, Shutdown Open, Shutdown Closed, Low Limit, Test and Balance

enumerator EZB_ZCL_MI_DOMAIN_HVAC_OFF_AUTO_HEAT_COOL_HEATONLY_COOLONLY_FAN_ONLY

Off, Auto, Heat Cool, Heat Only, Cool Only, Fan Only

enumerator EZB_ZCL_MI_DOMAIN_HVAC_HIGH_NORMAL_LOW

High, Normal, Low

enumerator EZB_ZCL_MI_DOMAIN_HVAC_OCCUPIED_UNOCCUPIED_STARTUP_SHUTDOWN

Occupied, Unoccupied, Startup, Shutdown

enumerator EZB_ZCL_MI_DOMAIN_HVAC_NIGHT_DAY_HOLD

Night, Day, Hold

enumerator EZB_ZCL_MI_DOMAIN_HVAC_OFF_COOL_HEAT_AUTO_EMERGENCY

Off, Cool, Heat, Auto, Emergency Heat

enumerator EZB_ZCL_MI_DOMAIN_HVAC_SHUTDOWNCLOSED_SHUTDOWNOPEN_SATISFIED_MIXING_COOLING_HEATING_SUPPLEMENTAL_HEAT

Shutdown Closed, Shutdown Open, Satisfied, Mixing, Cooling, Heating, Supplemental Heat

enumerator EZB_ZCL_MI_DOMAIN_HVAC_OTHER

Other

5.2.6.3.1.19. Multistate Output

5.2.6.3.1.19.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/multistate_output_desc.h

5.2.6.3.1.19.2. Functions

ezb_err_t ezb_zcl_multistate_output_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an multistate_output cluster descriptor.

Parameters:

• cluster_desc -- [in] The multistate_output cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_multistate_output_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an multistate_output cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the multistate_output cluster configuration structure. Use ezb_zcl_multistate_output_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_multistate_output_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_multistate_output_cluster_client_init(uint8_t ep_id)

Initialize the MultistateOutput cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_multistate_output_cluster_server_init(uint8_t ep_id)

Initialize the MultistateOutput cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.19.3. Structures

struct ezb_zcl_multistate_output_cluster_server_config_s

Configuration mandatory attributes for the MultistateOutput server cluster.

Public Members

uint16_t number_of_states

Configurable mandatory NumberOfStates attribute

bool out_of_service

Configurable mandatory OutOfService attribute

uint16_t present_value

Configurable mandatory PresentValue attribute

uint8_t status_flags

Configurable mandatory StatusFlags attribute

5.2.6.3.1.19.4. Macros

EZB_ZCL_MULTISTATE_OUTPUT_CLUSTER_REVISION

Cluster Revision of the multistate_output cluster implementation.

EZB_ZCL_MULTISTATE_OUTPUT_NUMBER_OF_STATES_DEFAULT_VALUE

Default value of NumberOfStates in MultistateOutput cluster.

EZB_ZCL_MULTISTATE_OUTPUT_NUMBER_OF_STATES_MIN_VALUE

Minimum value of NumberOfStates in MultistateOutput cluster.

EZB_ZCL_MULTISTATE_OUTPUT_NUMBER_OF_STATES_MAX_VALUE

Maximum value of NumberOfStates in MultistateOutput cluster.

EZB_ZCL_MULTISTATE_OUTPUT_OUT_OF_SERVICE_DEFAULT_VALUE

Default value of OutOfService in MultistateOutput cluster.

EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_DEFAULT_VALUE

Default value of Reliability in MultistateOutput cluster.

EZB_ZCL_MULTISTATE_OUTPUT_STATUS_FLAGS_DEFAULT_VALUE

Default value of StatusFlags in MultistateOutput cluster.

EZB_ZCL_MULTISTATE_OUTPUT_STATUS_FLAGS_MIN_VALUE

Minimum value of StatusFlags in MultistateOutput cluster.

EZB_ZCL_MULTISTATE_OUTPUT_STATUS_FLAGS_MAX_VALUE

Maximum value of StatusFlags in MultistateOutput cluster.

EZB_ZCL_MULTISTATE_OUTPUT_APPLICATION_TYPE_MIN_VALUE

Minimum value of ApplicationType in MultistateOutput cluster.

EZB_ZCL_MULTISTATE_OUTPUT_APPLICATION_TYPE_MAX_VALUE

Maximum value of ApplicationType in MultistateOutput cluster.

EZB_ZCL_CLUSTER_ID_MULTISTATE_OUTPUT_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_MULTISTATE_OUTPUT_SERVER_ROLE_INIT

5.2.6.3.1.19.5. Type Definitions

typedef struct ezb_zcl_multistate_output_cluster_server_config_s ezb_zcl_multistate_output_cluster_server_config_t

Configuration mandatory attributes for the MultistateOutput server cluster.

typedef ezb_zcl_multistate_output_cluster_server_config_t ezb_zcl_multistate_output_cluster_config_t

5.2.6.3.1.19.6. Enumerations

enum ezb_zcl_multistate_output_server_attr_t

Attribute identifiers for the multistate_output server cluster.

Values:

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_STATE_TEXT_ID

StateText attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_DESCRIPTION_ID

Description attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_NUMBER_OF_STATES_ID

NumberOfStates attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_OUT_OF_SERVICE_ID

OutOfService attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_PRESENT_VALUE_ID

PresentValue attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_PRIORITY_ARRAY_ID

PriorityArray attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_RELIABILITY_ID

Reliability attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_RELINQUISH_DEFAULT_ID

RelinquishDefault attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_STATUS_FLAGS_ID

StatusFlags attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_OUTPUT_APPLICATION_TYPE_ID

ApplicationType attribute.

enum ezb_zcl_multistate_output_server_reliability_t

Enumeration for ZCL Reliability attribute of MultistateOutput.

Values:

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_NO_FAULT_DETECTED

NoFaultDetected

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_NO_SENSOR

NoSensor

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_OVER_RANGE

OverRange

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_UNDER_RANGE

UnderRange

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_OPEN_LOOP

OpenLoop

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_SHORTED_LOOP

ShortedLoop

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_NO_OUTPUT

NoOutput

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_UNRELIABLE_OTHER

UnreliableOther

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_PROCESS_ERROR

ProcessError

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_MULTI_STATE_FAULT

MultiStateFault

enumerator EZB_ZCL_MULTISTATE_OUTPUT_RELIABILITY_CONFIGURATION_ERROR

ConfigurationError

enum ezb_zcl_multistate_output_server_application_type_t

Enumeration for ZCL ApplicationType attribute of MultistateOutput.

Values:

enumerator EZB_ZCL_MULTISTATE_OUTPUT_APPLICATION_TYPE_APP_DOMAIN_HVAC

AppDomainHVAC

enum ezb_zcl_multistate_output_server_status_flags_t

Bitmap for ZCL StatusFlags attribute of MultistateOutput.

Values:

enumerator EZB_ZCL_MULTISTATE_OUTPUT_STATUS_FLAGS_IN_ALARM

InAlarm

enumerator EZB_ZCL_MULTISTATE_OUTPUT_STATUS_FLAGS_FAULT

Fault

enumerator EZB_ZCL_MULTISTATE_OUTPUT_STATUS_FLAGS_OVERRIDDEN

Overridden

enumerator EZB_ZCL_MULTISTATE_OUTPUT_STATUS_FLAGS_OUT_OF_SERVICE

OutOfService

5.2.6.3.1.19.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/multistate_output.h

5.2.6.3.1.19.8. Macros

EZB_ZCL_MO_GROUP_ID

Macros for Group ID of ZCL Multistate Output.

Multistate Output cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Analog Input clusters have Group = 0x00.

Type = Bits 16 to 23 The physical quantity that the PresentValue attribute of the cluster represents.

Index = Bits 0 to 15 The specific application usage of the cluster.

EZB_ZCL_MO_SET_APP_TYPE_WITH_ID(_type, _id)

Macros for ApplicationType attribute of ZCL Multistate Output.

5.2.6.3.1.19.9. Enumerations

enum ezb_zcl_mo_domain_hvac_t

Values for Multistate Output cluster HVAC application usages.

Values:

enumerator EZB_ZCL_MO_DOMAIN_HVAC_OFF_ON_AUTO

Off, On, Auto

enumerator EZB_ZCL_MO_DOMAIN_HVAC_OFF_LOW_MEDIUM_HIGH

Off, Low, Medium, High

enumerator EZB_ZCL_MO_DOMAIN_HVAC_AUTO_HEAT_COOL_OFF_EMERG_FAN_MAX

Auto, Heat, Cool, Off, Emerg Heat, Fan Only, Max Heat

enumerator EZB_ZCL_MO_DOMAIN_HVAC_OCCUPIED_UNOCCUPIED_STANDBY_BYPASS

Occupied, Unoccupied, Standby, Bypass

enumerator EZB_ZCL_MO_DOMAIN_HVAC_INACTIVE_ACTIVE_HOLD

Inactive, Active, Hold

enumerator EZB_ZCL_MO_DOMAIN_HVAC_AUTO_WARMUP_WATER_FLUSH_AUTOCAL_SHUTDOWNOPEN_SHUTDOWNCLOSED_LOWLIMIT_TEST_BALANCE

Auto, Warm-up, Water Flush, Autocalibration, Shutdown Open, Shutdown Closed, Low Limit, Test and Balance

enumerator EZB_ZCL_MO_DOMAIN_HVAC_OFF_AUTO_HEAT_COOL_HEAT_ONLY_COOL_ONLY_FAN_ONLY

Off, Auto, Heat Cool, Heat Only, Cool Only, Fan Only

enumerator EZB_ZCL_MO_DOMAIN_HVAC_HIGH_NORMAL_LOW

High, Normal, Low

enumerator EZB_ZCL_MO_DOMAIN_HVAC_OCCUPIED_UNOCCUPIED_STARTUP_SHUTDOWN

Occupied, Unoccupied, Startup, Shutdown

enumerator EZB_ZCL_MO_DOMAIN_HVAC_NIGHT_DAY_HOLD

Night, Day, Hold

enumerator EZB_ZCL_MO_DOMAIN_HVAC_OFF_COOL_HEAT_AUTO_EMERGENCY

Off, Cool, Heat, Auto, Emergency Heat

enumerator EZB_ZCL_MO_DOMAIN_HVAC_SHUTDOWNCLOSED_SHUTDOWNOPEN_SATISFIED_MIXING_COOLING_HEATING_SUPPL_HEAT

Shutdown Closed, Shutdown Open, Satisfied, Mixing, Cooling, Heating, Suppl Heat

enumerator EZB_ZCL_MO_DOMAIN_HVAC_OTHER

Other

5.2.6.3.1.20. Multistate Value

5.2.6.3.1.20.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/multistate_value_desc.h

5.2.6.3.1.20.2. Functions

ezb_err_t ezb_zcl_multistate_value_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an multistate_value cluster descriptor.

Parameters:

• cluster_desc -- [in] The multistate_value cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_multistate_value_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an multistate_value cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the multistate_value cluster configuration structure. Use ezb_zcl_multistate_value_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_multistate_value_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_multistate_value_cluster_client_init(uint8_t ep_id)

Initialize the MultistateValue cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_multistate_value_cluster_server_init(uint8_t ep_id)

Initialize the MultistateValue cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.20.3. Structures

struct ezb_zcl_multistate_value_cluster_server_config_s

Configuration mandatory attributes for the MultistateValue server cluster.

Public Members

uint16_t number_of_states

Configurable mandatory NumberOfStates attribute

bool out_of_service

Configurable mandatory OutOfService attribute

uint16_t present_value

Configurable mandatory PresentValue attribute

uint8_t status_flags

Configurable mandatory StatusFlags attribute

5.2.6.3.1.20.4. Macros

EZB_ZCL_MULTISTATE_VALUE_CLUSTER_REVISION

Cluster Revision of the multistate_value cluster implementation.

EZB_ZCL_MULTISTATE_VALUE_NUMBER_OF_STATES_DEFAULT_VALUE

Default value of NumberOfStates in MultistateValue cluster.

EZB_ZCL_MULTISTATE_VALUE_NUMBER_OF_STATES_MIN_VALUE

Minimum value of NumberOfStates in MultistateValue cluster.

EZB_ZCL_MULTISTATE_VALUE_NUMBER_OF_STATES_MAX_VALUE

Maximum value of NumberOfStates in MultistateValue cluster.

EZB_ZCL_MULTISTATE_VALUE_OUT_OF_SERVICE_DEFAULT_VALUE

Default value of OutOfService in MultistateValue cluster.

EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_DEFAULT_VALUE

Default value of Reliability in MultistateValue cluster.

EZB_ZCL_MULTISTATE_VALUE_STATUS_FLAGS_DEFAULT_VALUE

Default value of StatusFlags in MultistateValue cluster.

EZB_ZCL_MULTISTATE_VALUE_STATUS_FLAGS_MIN_VALUE

Minimum value of StatusFlags in MultistateValue cluster.

EZB_ZCL_MULTISTATE_VALUE_STATUS_FLAGS_MAX_VALUE

Maximum value of StatusFlags in MultistateValue cluster.

EZB_ZCL_MULTISTATE_VALUE_APPLICATION_TYPE_MIN_VALUE

Minimum value of ApplicationType in MultistateValue cluster.

EZB_ZCL_MULTISTATE_VALUE_APPLICATION_TYPE_MAX_VALUE

Maximum value of ApplicationType in MultistateValue cluster.

EZB_ZCL_CLUSTER_ID_MULTISTATE_VALUE_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_MULTISTATE_VALUE_SERVER_ROLE_INIT

5.2.6.3.1.20.5. Type Definitions

typedef struct ezb_zcl_multistate_value_cluster_server_config_s ezb_zcl_multistate_value_cluster_server_config_t

Configuration mandatory attributes for the MultistateValue server cluster.

typedef ezb_zcl_multistate_value_cluster_server_config_t ezb_zcl_multistate_value_cluster_config_t

5.2.6.3.1.20.6. Enumerations

enum ezb_zcl_multistate_value_server_attr_t

Attribute identifiers for the multistate_value server cluster.

Values:

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_STATE_TEXT_ID

StateText attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_DESCRIPTION_ID

Description attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_NUMBER_OF_STATES_ID

NumberOfStates attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_OUT_OF_SERVICE_ID

OutOfService attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_PRESENT_VALUE_ID

PresentValue attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_PRIORITY_ARRAY_ID

PriorityArray attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_RELIABILITY_ID

Reliability attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_RELINQUISH_DEFAULT_ID

RelinquishDefault attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_STATUS_FLAGS_ID

StatusFlags attribute.

enumerator EZB_ZCL_ATTR_MULTISTATE_VALUE_APPLICATION_TYPE_ID

ApplicationType attribute.

enum ezb_zcl_multistate_value_server_reliability_t

Enumeration for ZCL Reliability attribute of MultistateValue.

Values:

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_NO_FAULT_DETECTED

NoFaultDetected

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_NO_SENSOR

NoSensor

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_OVER_RANGE

OverRange

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_UNDER_RANGE

UnderRange

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_OPEN_LOOP

OpenLoop

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_SHORTED_LOOP

ShortedLoop

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_NO_OUTPUT

NoOutput

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_UNRELIABLE_OTHER

UnreliableOther

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_PROCESS_ERROR

ProcessError

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_MULTI_STATE_FAULT

MultiStateFault

enumerator EZB_ZCL_MULTISTATE_VALUE_RELIABILITY_CONFIGURATION_ERROR

ConfigurationError

enum ezb_zcl_multistate_value_server_application_type_t

Enumeration for ZCL ApplicationType attribute of MultistateValue.

Values:

enumerator EZB_ZCL_MULTISTATE_VALUE_APPLICATION_TYPE_APP_DOMAIN_HVAC

AppDomainHVAC

enum ezb_zcl_multistate_value_server_status_flags_t

Bitmap for ZCL StatusFlags attribute of MultistateValue.

Values:

enumerator EZB_ZCL_MULTISTATE_VALUE_STATUS_FLAGS_IN_ALARM

InAlarm

enumerator EZB_ZCL_MULTISTATE_VALUE_STATUS_FLAGS_FAULT

Fault

enumerator EZB_ZCL_MULTISTATE_VALUE_STATUS_FLAGS_OVERRIDDEN

Overridden

enumerator EZB_ZCL_MULTISTATE_VALUE_STATUS_FLAGS_OUT_OF_SERVICE

OutOfService

5.2.6.3.1.20.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/multistate_value.h

5.2.6.3.1.20.8. Macros

EZB_ZCL_MV_GROUP_ID

Macros for Group ID of ZCL Multistate Value.

Multistate Value cluster application types The ApplicationType attribute indicates the specific application usage for the cluster. ApplicationType is subdivided into Group, Type and an Index number, as follows:

Group = Bits 24 to 31 An indication of the cluster this attribute is part of. Multistate Value clusters have Group = 0x0d.

Type = Bits 16 to 23 The application usage domain.

Index = Bits 0 to 15 The specific application usage of the cluster.

EZB_ZCL_MV_SET_APP_TYPE_WITH_ID(_type, _id)

Macros for ApplicationType attribute of ZCL Multistate Value.

5.2.6.3.1.20.9. Enumerations

enum ezb_zcl_mv_domain_hvac_t

Values for Multistate Output cluster HVAC application usages.

Values:

enumerator EZB_ZCL_MV_DOMAIN_HVAC_OFF_ON_AUTO

Off, On, Auto

enumerator EZB_ZCL_MV_DOMAIN_HVAC_OFF_LOW_MEDIUM_HIGH

Off, Low, Medium, High

enumerator EZB_ZCL_MV_DOMAIN_HVAC_AUTO_HEAT_COOL_OFF_EMERG_FAN_MAX

Auto, Heat, Cool, Off, Emerg Heat, Fan Only, Max Heat

enumerator EZB_ZCL_MV_DOMAIN_HVAC_OCCUPIED_UNOCCUPIED_STANDBY_BYPASS

Occupied, Unoccupied, Standby, Bypass

enumerator EZB_ZCL_MV_DOMAIN_HVAC_INACTIVE_ACTIVE_HOLD

Inactive, Active, Hold

enumerator EZB_ZCL_MV_DOMAIN_HVAC_AUTO_WARMUP_WATER_FLUSH_AUTOCAL_SHUTDOWNOPEN_SHUTDOWNCLOSED_LOWLIMIT_TEST_BALANCE

Auto, Warm-up, Water Flush, Autocalibration, Shutdown Open, Shutdown Closed, Low Limit, Test and Balance

enumerator EZB_ZCL_MV_DOMAIN_HVAC_OFF_AUTO_HEAT_COOL_HEAT_ONLY_COOL_ONLY_FAN_ONLY

Off, Auto, Heat Cool, Heat Only, Cool Only, Fan Only

enumerator EZB_ZCL_MV_DOMAIN_HVAC_HIGH_NORMAL_LOW

High, Normal, Low

enumerator EZB_ZCL_MV_DOMAIN_HVAC_OCCUPIED_UNOCCUPIED_STARTUP_SHUTDOWN

Occupied, Unoccupied, Startup, Shutdown

enumerator EZB_ZCL_MV_DOMAIN_HVAC_NIGHT_DAY_HOLD

Night, Day, Hold

enumerator EZB_ZCL_MV_DOMAIN_HVAC_OFF_COOL_HEAT_AUTO_EMERGENCY

Off, Cool, Heat, Auto, Emergency Heat

enumerator EZB_ZCL_MV_DOMAIN_HVAC_SHUTDOWNCLOSED_SHUTDOWNOPEN_SATISFIED_MIXING_COOLING_HEATING_SUPPL_HEAT

Shutdown Closed, Shutdown Open, Satisfied, Mixing, Cooling, Heating, Suppl Heat

enumerator EZB_ZCL_MV_DOMAIN_HVAC_OTHER

Other

5.2.6.3.1.21. Poll Control

5.2.6.3.1.21.1. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/poll_control_desc.h

5.2.6.3.1.21.2. Functions

ezb_err_t ezb_zcl_poll_control_cluster_desc_add_attr(ezb_zcl_cluster_desc_t cluster_desc, uint16_t attr_id, const void *value)

Add an attribute to an poll_control cluster descriptor.

Parameters:

• cluster_desc -- [in] The poll_control cluster descriptor.

• attr_id -- [in] The identifier of the attribute to be added to cluster_desc.

• value -- [in] The pointer to the initial value of the attribute.

Returns:

Error code.

ezb_zcl_cluster_desc_t ezb_zcl_poll_control_create_cluster_desc(const void *cluster_cfg, uint8_t role_mask)

Create an poll_control cluster descriptor.

Parameters:

• cluster_cfg -- [in] The pointer to the poll_control cluster configuration structure. Use ezb_zcl_poll_control_cluster_server_config_t for EZB_ZCL_CLUSTER_SERVER, use ezb_zcl_poll_control_cluster_client_config_t for EZB_ZCL_CLUSTER_CLIENT, or use NULL for default configuration of the stack based on the role_mask.

• role_mask -- [in] The role of the cluster to create.

Returns:

Created cluster descriptor.

void ezb_zcl_poll_control_cluster_client_init(uint8_t ep_id)

Initialize the PollControl cluster client role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs initialization.

void ezb_zcl_poll_control_cluster_server_init(uint8_t ep_id)

Initialize the PollControl cluster server role for a given endpoint.

Parameters:

ep_id -- [in] The identifier of the endpoint hosting the cluster that needs de-initialization.

5.2.6.3.1.21.3. Structures

struct ezb_zcl_poll_control_cluster_server_config_s

Configuration mandatory attributes for the PollControl server cluster.

Public Members

uint32_t check_in_interval

Configurable mandatory CheckInInterval attribute

uint32_t long_poll_interval

Configurable mandatory LongPollInterval attribute

uint16_t short_poll_interval

Configurable mandatory ShortPollInterval attribute

uint16_t fast_poll_timeout

Configurable mandatory FastPollTimeout attribute

5.2.6.3.1.21.4. Macros

EZB_ZCL_POLL_CONTROL_CLUSTER_REVISION

Cluster Revision of the poll_control cluster implementation.

EZB_ZCL_POLL_CONTROL_CHECK_IN_INTERVAL_DEFAULT_VALUE

Default value of CheckInInterval in PollControl cluster.

EZB_ZCL_POLL_CONTROL_CHECK_IN_INTERVAL_MIN_VALUE

Minimum value of CheckInInterval in PollControl cluster.

EZB_ZCL_POLL_CONTROL_CHECK_IN_INTERVAL_MAX_VALUE

Maximum value of CheckInInterval in PollControl cluster.

EZB_ZCL_POLL_CONTROL_LONG_POLL_INTERVAL_DEFAULT_VALUE

Default value of LongPollInterval in PollControl cluster.

EZB_ZCL_POLL_CONTROL_LONG_POLL_INTERVAL_MIN_VALUE

Minimum value of LongPollInterval in PollControl cluster.

EZB_ZCL_POLL_CONTROL_LONG_POLL_INTERVAL_MAX_VALUE

Maximum value of LongPollInterval in PollControl cluster.

EZB_ZCL_POLL_CONTROL_SHORT_POLL_INTERVAL_DEFAULT_VALUE

Default value of ShortPollInterval in PollControl cluster.

EZB_ZCL_POLL_CONTROL_SHORT_POLL_INTERVAL_MIN_VALUE

Minimum value of ShortPollInterval in PollControl cluster.

EZB_ZCL_POLL_CONTROL_SHORT_POLL_INTERVAL_MAX_VALUE

Maximum value of ShortPollInterval in PollControl cluster.

EZB_ZCL_POLL_CONTROL_FAST_POLL_TIMEOUT_DEFAULT_VALUE

Default value of FastPollTimeout in PollControl cluster.

EZB_ZCL_POLL_CONTROL_FAST_POLL_TIMEOUT_MIN_VALUE

Minimum value of FastPollTimeout in PollControl cluster.

EZB_ZCL_POLL_CONTROL_FAST_POLL_TIMEOUT_MAX_VALUE

Maximum value of FastPollTimeout in PollControl cluster.

EZB_ZCL_POLL_CONTROL_CHECK_IN_INTERVAL_MIN_DEFAULT_VALUE

Default value of CheckInIntervalMin in PollControl cluster.

EZB_ZCL_POLL_CONTROL_LONG_POLL_INTERVAL_MIN_DEFAULT_VALUE

Default value of LongPollIntervalMin in PollControl cluster.

EZB_ZCL_POLL_CONTROL_FAST_POLL_TIMEOUT_MAX_DEFAULT_VALUE

Default value of FastPollTimeoutMax in PollControl cluster.

EZB_ZCL_CLUSTER_ID_POLL_CONTROL_CLIENT_ROLE_INIT

EZB_ZCL_CLUSTER_ID_POLL_CONTROL_SERVER_ROLE_INIT

5.2.6.3.1.21.5. Type Definitions

typedef struct ezb_zcl_poll_control_cluster_server_config_s ezb_zcl_poll_control_cluster_server_config_t

Configuration mandatory attributes for the PollControl server cluster.

typedef ezb_zcl_poll_control_cluster_server_config_t ezb_zcl_poll_control_cluster_config_t

5.2.6.3.1.21.6. Enumerations

enum ezb_zcl_poll_control_server_attr_t

Attribute identifiers for the poll_control server cluster.

Values:

enumerator EZB_ZCL_ATTR_POLL_CONTROL_CHECK_IN_INTERVAL_ID

CheckInInterval attribute.

enumerator EZB_ZCL_ATTR_POLL_CONTROL_LONG_POLL_INTERVAL_ID

LongPollInterval attribute.

enumerator EZB_ZCL_ATTR_POLL_CONTROL_SHORT_POLL_INTERVAL_ID

ShortPollInterval attribute.

enumerator EZB_ZCL_ATTR_POLL_CONTROL_FAST_POLL_TIMEOUT_ID

FastPollTimeout attribute.

enumerator EZB_ZCL_ATTR_POLL_CONTROL_CHECK_IN_INTERVAL_MIN_ID

CheckInIntervalMin attribute.

enumerator EZB_ZCL_ATTR_POLL_CONTROL_LONG_POLL_INTERVAL_MIN_ID

LongPollIntervalMin attribute.

enumerator EZB_ZCL_ATTR_POLL_CONTROL_FAST_POLL_TIMEOUT_MAX_ID

FastPollTimeoutMax attribute.

enumerator EZB_ZCL_ATTR_POLL_CONTROL_CHECK_IN_CONTEXT_ID

CheckInContext attribute.

enum ezb_zcl_poll_control_server_cmd_id_t

Received Command identifiers for the PollControl cluster.

Values:

enumerator EZB_ZCL_CMD_POLL_CONTROL_CHECK_IN_ID

CheckIn command.

enum ezb_zcl_poll_control_client_cmd_id_t

Received Command identifiers for the PollControl cluster.

Values:

enumerator EZB_ZCL_CMD_POLL_CONTROL_CHECK_IN_RESPONSE_ID

CheckInResponse command.

enumerator EZB_ZCL_CMD_POLL_CONTROL_FAST_POLL_STOP_ID

FastPollStop command.

enumerator EZB_ZCL_CMD_POLL_CONTROL_SET_LONG_POLL_INTERVAL_ID

SetLongPollInterval command.

enumerator EZB_ZCL_CMD_POLL_CONTROL_SET_SHORT_POLL_INTERVAL_ID

SetShortPollInterval command.

5.2.6.3.1.21.7. Header File

• components/esp-zigbee-lib/include/ezbee/zcl/cluster/poll_control.h

5.2.6.3.1.21.8. Functions

ezb_err_t ezb_zcl_poll_control_check_in_cmd_req(const ezb_zcl_poll_control_check_in_cmd_t *cmd_req)

Send ZCL Poll Control CheckIn command request.

Parameters:

cmd_req -- Pointer to the CheckIn command request structure, ezb_zcl_poll_control_check_in_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_poll_control_fast_poll_stop_cmd_req(const ezb_zcl_poll_control_fast_poll_stop_cmd_t *cmd_req)

Send ZCL Poll Control FastPollStop command request.

Parameters:

cmd_req -- Pointer to the FastPollStop command request structure, ezb_zcl_poll_control_fast_poll_stop_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_poll_control_set_long_poll_interval_cmd_req(const ezb_zcl_poll_control_set_long_poll_interval_cmd_t *cmd_req)

Send ZCL Poll Control SetLongPollInterval command request.

Parameters:

cmd_req -- Pointer to the SetLongPollInterval command request structure, ezb_zcl_poll_control_set_long_poll_interval_cmd_s.

Returns:

Error code.

ezb_err_t ezb_zcl_poll_control_set_short_poll_interval_cmd_req(const ezb_zcl_poll_control_set_short_poll_interval_cmd_t *cmd_req)

Send ZCL Poll Control SetShortPollInterval command request.

Parameters:

cmd_req -- Pointer to the SetShortPollInterval command request structure, ezb_zcl_poll_control_set_short_poll_interval_cmd_s.

Returns:

Error code.

5.2.6.3.1.21.9. Structures

struct ezb_zcl_poll_control_check_in_cmd_s

Structure for the ZCL Poll Control CheckIn command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_poll_control_fast_poll_stop_cmd_s

Structure for the ZCL Poll Control FastPollStop command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

struct ezb_zcl_poll_control_set_long_poll_interval_cmd_s

Structure for the ZCL Poll Control SetLongPollInterval command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint32_t long_poll_interval

Long poll interval (quarter-seconds).

struct ezb_zcl_poll_control_set_short_poll_interval_cmd_s

Structure for the ZCL Poll Control SetShortPollInterval command request.

Public Members

ezb_zcl_cluster_cmd_ctrl_t cmd_ctrl

Control information for the ZCL command.

uint16_t short_poll_interval

Short poll interval (quarter-seconds).

struct ezb_zcl_poll_control_check_in_message_s

Message for the ZCL Poll Control CheckIn message.

Public Members

ezb_zcl_message_info_t info

Basic information about the ZCL message.

const ezb_zcl_cmd_hdr_t *header

ZCL command header information. See ezb_zcl_cmd_hdr_s.

struct ezb_zcl_poll_control_check_in_message_s in

Input: parsed fields from the request.

ezb_zcl_status_t result

Status of processing in application.

bool start_fast_poll

Start fast poll.

uint16_t fast_poll_timeout

Fast poll timeout (quarter-seconds).

struct ezb_zcl_poll_control_check_in_message_s out

Output: result to send back.

5.2.6.3.1.21.10. Macros

EZB_ZCL_POLL_CONTROL_CHECK_IN_INTERVAL_NO_CHECK_IN_VALUE

CheckInInterval value meaning no check-in.

EZB_ZCL_POLL_CONTROL_PREDEFINED_CHECK_IN_TIMEOUT_DEFAULT_VALUE

Default value of manufacturer-specific predefined check-in timeout in milliseconds.

5.2.6.3.1.21.11. Type Definitions

typedef struct ezb_zcl_poll_control_check_in_cmd_s ezb_zcl_poll_control_check_in_cmd_t

Structure for the ZCL Poll Control CheckIn command request.

typedef struct ezb_zcl_poll_control_fast_poll_stop_cmd_s ezb_zcl_poll_control_fast_poll_stop_cmd_t

Structure for the ZCL Poll Control FastPollStop command request.

typedef struct ezb_zcl_poll_control_set_long_poll_interval_cmd_s ezb_zcl_poll_control_set_long_poll_interval_cmd_t

Structure for the ZCL Poll Control SetLongPollInterval command request.

typedef struct ezb_zcl_poll_control_set_short_poll_interval_cmd_s ezb_zcl_poll_control_set_short_poll_interval_cmd_t

Structure for the ZCL Poll Control SetShortPollInterval command request.

typedef struct ezb_zcl_poll_control_check_in_message_s ezb_zcl_poll_control_check_in_message_t

Message for the ZCL Poll Control CheckIn message.