Developing with ZBOSS for Zigbee
API Reference
Here is a list of all modules:
[detail level
1
2
3
4
5
6
7
]
▼
Zigbee stack API
Application Programming Interface for the Zigbee stack
▼
HA API
HA Device types
►
HA Devices
IAS Control with security
Comcast security sensor
Configuration Tool
Dimmable Light
Dimmer Switch
Door Lock Controller
IAS Ancillary Control Equipment
IAS Control and Indicating Equipment
IAS Zone
Level Control Switch
Level Controllable Output
Mains Power Outlet
On/Off Switch
Range Extender
Scene Selector
Shade
Shade Controller
Simple Sensor
Smart Plug
Temperature Sensor
Thermostat
Window Covering
Window Covering Controller
Combined Interface
Door Lock
On/Off Output
▼
ZCL API
ZCL initialization data and API
►
ZCL common types and definitions
►
ZCL common types
General attributes' description
General frame description
Fill ZCL packet low-level API
ZCL Touchlink common types and definitions
ZCL attributes reporting
►
ZCL commands shared by all clusters
Default response command sending and parsing.
Read attributes request and response sending and parsing.
Write attributes command sending and parsing.
Discover attributes request and response sending and parsing.
Configure reporting command sending and parsing
Report attribute command parsing
Read reporting configuration command sending and parsing
►
ZCL clusters
ZCL Basic cluster
ZCL Binary Input cluster
ZCL Color control cluster
ZCL Diagnostics cluster
ZCL DoorLock cluster
ZCL Electrical Measurement cluster
►
ZCL Groups cluster
Add group command definitions
View group command definitions
Get Group Membership command definitions
Remove Group command definitions
Remove All Groups command definitions
Add group if identifying command definitions
ZCL IAS ACE cluster
ZCL IAS WD cluster
ZCL IAS Zone cluster
ZCL Identify cluster
ZCL Illuminance Measurement cluster
ZCL Keep Alive Cluster
ZCL Level control cluster
►
ZCL Metering Cluster
Metering cluster client attributes and enumerations
Metering cluster server attributes and enumerations
Metering cluster commands
ZCL On/Off cluster
ZCL On/Off switch configuration cluster
ZCL OTA Upgrade cluster
ZCL Poll Control cluster
ZCL Power Configuration cluster
ZCL Water Content Measurement cluster
ZCL Scenes cluster
ZCL Shade Configuration cluster
ZCL Temperature Measurement cluster
ZCL Thermostat cluster
ZCL Fan Control cluster
ZCL Thermostat UI Control cluster
ZCL Window Covering cluster
ZCL Meter Identification cluster
►
ZCL Time cluster
Time cluster attributes
Time cluster commands
►
ZCL Tunneling cluster
Tunneling cluster attributes
Tunneling cluster commands
►
ZCL Price cluster
►
Price cluster attributes
►
Price cluster server attributes
Tier Label
Block Threshold
Block Period
Commodity
Block Price Information
Extended Price Information
Tariff Information
Billing Information
Credit Payment
Tier Label
Received Block Threshold
Received Block Period
Received Block Price Information
Received Extended Price Information
Received Tariff Information
Received Billing Information
Price cluster client attributes
Price cluster commands
►
ZCL Messaging cluster
Messaging cluster commands
ZCL Dehumidification cluster
ZCL Alarms cluster
►
ZCL Demand Response and Load Control (DRLC) cluster
DRLC attributes and enumerations
DRLC commands
EN50523 Appliance events and alerts cluster
ZCL Control4 Network cluster
►
ZCL Work With All Hubs (WWAH) cluster
WWAH cluster attributes
WWAH cluster commands
ZCL Occupancy Sensing cluster
ZCL Touchlink Commissioning cluster
ZCL Tunnel cluster
►
ZCL Daily Schedule cluster
Daily Schedule cluster attributes
Daily Schedule cluster commands
ZCL Pressure Measurement cluster
ZCL Zigbee Direct Configuration Cluster
▼
ZDO API
ZDO base constants and definitions
ZDO address discovery
ZDO services discovery
ZDO binding management
ZDO groups management
ZDO miscellaneous management services
ZDO poll control
ZDO distributed security
ZDO security level
▼
BDB commissioning API
BDB commissioning parameters
BDB commissioning start & status
BDB Finding and Binding
▼
AF functions visible to applications
AF data service
AF device types
AF common constants
AF management service
▼
APS functions visible to applications
APS common constants
APS data service
APS management service
APS user payload
▼
NWK functions visible to applications
NWK common constants
NWK management service
NWK PAN ID conflicts
NWK MTORR functionality
▼
Security subsystem API
NWK keys settings
TC rejoin settings
Install code usage
▼
Application structure & commissioning start
General parameters to be set before start
ZBOSS kernel initialization and start
ZBOSS main loop
ZBOSS commissioning signals handler
Get general parameters
NWK Address translation table access
▼
ZBOSS framework
Compile-time configuration parameters
Base typedefs
Internal ZBOSS error codes
Configurable ZBOSS memory sizes
Sleep API
Packet buffers pool
Scheduler
Time
Random numbers generator
NVRAM
HW platform support - misc
▼
ZBOSS debug capabilities
►
MAC traffic dump
Switching dump on and off
win_com_dump terminal utility
Dump converter
Wireshark usage
Dynamic (run-time) asserts
Static (compile-time) asserts
▼
SE API
SE security subsystem
SE commissioning API
►
SE devices
Energy Service Interface (ESI)
In-home Display
Metering
Metering Load Control device
Programmable Communicating Thermostat (PCT) Device
SE device identifiers
►
SE clusters
SE Key Establishment Cluster
SE Keep Alive Cluster - moved to ZCL API
►
SE Calendar cluster
Calendar cluster attributes
Calendar cluster commands
►
SE Device Management cluster
Device Management cluster attributes
Device Management cluster commands
►
SE Energy Management cluster
Energy Management cluster attributes
Energy Management cluster commands
►
SE Events cluster
Events cluster commands
►
SE MDU Pairing cluster
MDU Pairing cluster attributes
MDU Pairing cluster attribute identifiers
MDU Pairing cluster commands
►
SE Prepayment cluster
Prepayment cluster attributes
Prepayment cluster commands
►
ZCL Sub-GHz cluster
Sub-GHz cluster attributes
Sub-GHz cluster commands
▼
ZGP API
ZGP common definitions
ZGP Sink API
Float_types
▼
ZB_ZCL_ANALOG_INPUT
▼
Analog Input cluster attributes
►
Analog Input cluster application types
Analog Input cluster representing temperature
Analog Input cluster representing humidity
Analog Input cluster representing pressure
Analog Input cluster representing flow
Analog Input cluster representing percentage
Analog Input cluster representing parts per million
Analog Input cluster representing rotational speed
Analog Input cluster representing current
Analog Input cluster representing frequency
Analog Input cluster representing power in Watts
Analog Input cluster representing power in kiloWatts
Analog Input cluster representing energy
Analog Input cluster representing unitless count
Analog Input cluster representing enthalpy
Analog Input cluster representing time
Analog Input cluster attribute value manipulation API
▼
ZB_ZCL_ANALOG_VALUE
Analog Value cluster application types
ZB_ZCL_CONCENTRATION_MEASUREMENT
ZB_ZCL_DEVICE_TEMP_CONFIG
▼
ZB_ZCL_MULTISTATE_INPUT
▼
Multistate Input cluster attributes
►
Multistate Input cluster application types
Multistate Input cluster representing HVAC domain
Multistate Input cluster attribute value manipulation API
ZB_ZCL_MULTISTATE_VALUE
Copyright (c) 2012-2022 DSR Corporation, Golden CO, USA.
http://www.dsr-zboss.com
http://www.dsr-corporation.com
ZBOSS documentation. Wed Oct 29 2025.