Crate apis_saltans_hw 

Zigbee hardware abstraction API.

This crate defines the boundary between coordinator-level logic and concrete Zigbee network co-processor (NCP) drivers.

No default features are enabled. Enable exactly the API surface needed by the depending crate:

• coordinator exposes Ncp, Driver, NcpHandle, WeakNcpHandle, common errors, hardware events, access to the NCP’s local simple descriptors, scan results, transmit datagram types, and the deferred HwResponse returned by transmission requests for coordinator and application code that sends commands to a running NCP actor.
• driver exposes Driver, shared driver/coordinator data types, the required local-endpoint API, command handles, HwResponse, common errors, and the aps, core, nwk, and zdp protocol re-export modules for hardware backend implementations.

Driver is part of the shared API and is therefore available with either feature. Event translation and startup wiring are backend concerns; this crate does not prescribe backend configuration or provide an event-translator abstraction.

The protocol re-export modules are available only with driver. They let driver crates refer to APIS Saltans protocol types through this crate, for example apis_saltans_hw::core::IeeeAddress or apis_saltans_hw::zdp::SimpleDescriptor, without adding direct dependencies on each protocol crate.

Ncp::transmit is a two-stage operation. Awaiting the method hands the datagram to the driver actor and returns an HwResponse; awaiting that response observes completion of the hardware transmission.

Every Driver implementation must provide the NCP’s local application endpoints through Driver::get_endpoints. Each endpoint is represented by a complete zb_zdp::SimpleDescriptor; coordinator code retrieves the same descriptors through Ncp::get_endpoints.

Modules

apsdriver

APS frame and payload types.

coredriver

Core Zigbee domain types.

nwkdriver

NWK receive context types.

zdpdriver

ZDP descriptor and service types.

Structs

Clusterscoordinator or driver

Input and output cluster set advertised by one local application endpoint.

Datagramcoordinator or driver

Serialized application payload plus APS metadata for transmission.

FoundNetworkcoordinator or driver

A found network with additional link quality information.

HwResponsecoordinator or driver

A deferred hardware-operation result.

Metadatacoordinator or driver

APS metadata and transmission options associated with a serialized application payload.

Networkcoordinator or driver

Information about a found network during a network scan.

ScannedChannelcoordinator or driver

A structure representing the result of a channel scan operation.

TxOptionscoordinator or driver

Transmission options for an APSDE-DATA request.

Enums

Errorcoordinator or driver

A generic error type for Zigbee hardware drivers.

Eventcoordinator or driver

Events emitted by the hardware layer.

RouteErrorcoordinator or driver

Route errors.

Traits

Drivercoordinator or driver

A common Zigbee NCP driver interface.

Ncpcoordinator

Proxy trait for sending commands to a Zigbee NCP driver actor.

Type Aliases

NcpHandlecoordinator or driver

A handle on the NCP.

WeakNcpHandlecoordinator or driver

A weak handle on the NCP.