Skip to main content

Crate apis_saltans_zcl

Crate apis_saltans_zcl 

Source
Expand description

Zigbee Cluster Library (ZCL) frame, command, cluster, and attribute models.

The crate provides typed ZCL frame parsing and serialization, global commands, selected cluster-specific commands, and generated access-specific attribute enums.

Runtime command dispatch currently covers global commands plus the Basic, Groups, Identify, On/Off, Level Control, Alarms, Scenes, Color Control, and IAS Zone clusters. Attribute modules are broader and currently cover implemented General, Lighting, Measurement and Sensing, and IAS clusters. Use AttributeReport::parse to construct a typed reportable attribute from a cluster ID, attribute ID, and raw zb_core::types::Type.

Set ZCL_DISABLE_DEFAULT_RESPONSE=true in the build environment to make commands that do not specify their own default-response behavior set the disable-default-response bit in outgoing frame control fields.

Modules§

alarms
Alarms cluster implementation.
ballast_configuration
Ballast Configuration Cluster.
basic
Zigbee Cluster Library (ZCL) Basic Cluster.
color_control
The Color Control cluster provides control over the color of a light source.
device_temperature_configuration
Device Temperature Configuration Cluster.
global
General commands that are not specific to any cluster.
groups
The Groups cluster.
ias
IAS related clusters.
identify
Identify Cluster.
illuminance_level_sensing
Illuminance Level Sensing cluster.
illuminance_measurement
Illuminance Measurement Cluster.
level
Level Control Cluster.
occupancy_sensing
Occupancy sensing cluster.
on_off
On/Off cluster.
power_configuration
Power configuration cluster.
scenes
Scenes cluster.
time
Time cluster implementation.

Structs§

Analog
Reporting parameters for an analog attribute.
Control
ZCL frame control flags.
Discrete
Reporting parameters for a discrete attribute.
Frame
A ZCL frame.
Header
A ZCL frame header.
InvalidType
The data type is invalid for the given attribute ID.
Options
Options struct for cluster commands.

Enums§

AttributeReport
Reportable attributes of all implemented ZCL clusters.
Cluster
Available ZCL clusters.
Direction
Frame direction.
ParseAttributeError
An error that occurs when parsing an attribute fails.
ParseDirection
Direction matching rule used when parsing incoming command frames.
ParseFrameError
Frame parsing error.
Scope
Command scope.
Status
Available ZCL status codes.

Traits§

Command
Trait to identify a Zigbee command.
Directed
Trait for commands that have a single direction when sent.
Readable
A trait to allow the reading of attributes by their respective IDs in a type-safe manner.
Reportable
A trait for reportable attribute identifiers and their ZCL wire types.
Scoped
Trait to associate a scope with a command.
Writable
A trait to allow the writing of attribute values in a type-safe manner.