Struct Ncp 

pub struct Ncp<T> { /* private fields */ }

Host-side helper for an EZSP Network Co-Processor.

Ncp<T> owns a communicator. Its methods provide higher-level operations that need callback correlation or local host state, such as scans, outgoing APS message confirmation, and automatic source endpoint selection from the configured endpoint cluster lists. The apis-saltans startup path supplies an Arc<tokio::sync::Mutex<T>> shared with the callback event handler.

Implementations

impl<T> Ncp<T>

pub const fn new( transport: T, aps_options: Options, event_handler_proxy: Sender<Message>, endpoints: Box<[Clusters]>, ) -> Self

Creates a new Ncp with the given transport, event handler, and endpoints.

endpoints must contain the local endpoint cluster metadata in endpoint order. Outgoing APS helpers use this list to select the source endpoint for a cluster.

pub fn source_endpoint( &self, profile_id: u16, cluster_id: u16, ) -> Result<u8, Error>

Returns the first local endpoint that lists the given cluster as an output cluster.

Endpoints are stored in the same order they were supplied to the builder. The returned endpoint number is one-based, matching the EZSP endpoint numbering used for outgoing APS frames.

Errors

Returns Error::NoMatchingSourceEndpoint when no configured local endpoint advertises cluster_id as an output cluster.

pub async fn terminate(self) -> Result<(), SendError<Message>>

Sends a termination request to the background event handler.

Errors

Returns SendError if the termination request cannot be sent to the message handler.

impl<T> Ncp<T>

where T: Messaging,

pub async fn unicast( &mut self, short_id: u16, profile_id: u16, cluster_id: u16, destination_endpoint: u8, payload: impl AsRef<[u8]>, ) -> Result<StackResponse, Error>

Starts a unicast APS send and returns its deferred StackResponse.

Payloads larger than the EZSP maximum APS payload length are fragmented for unicast delivery. The stack-assigned APS sequence from the first fragment is reused for follow-up fragments, matching EZSP host fragmentation behavior. Responses for all non-final fragments are awaited before this method returns the response for the final fragment. Await the returned StackResponse to confirm that final response.

Errors

Returns an Error if no matching source endpoint exists, payload fragmentation would exceed 255 fragments, registering a message tag or sending an EZSP command fails, or a non-final fragment’s stack response reports failure. Errors reported by the returned StackResponse occur when that value is awaited.

pub async fn multicast( &mut self, group_id: u16, options: MulticastOptions, profile_id: u16, cluster_id: u16, destination_endpoint: u8, payload: impl AsRef<[u8]>, ) -> Result<(StackResponse, u8), Error>

Starts a multicast APS send.

Returns the deferred StackResponse and the APS sequence assigned by the NCP. Await the response to confirm the matching messageSent callback.

Errors

Returns an Error if no matching source endpoint exists, the payload is larger than the EZSP maximum APS payload length, registering the message tag fails, or sending the EZSP command fails. Errors reported by the returned StackResponse occur when that value is awaited.

pub async fn broadcast( &mut self, short_id: u16, radius: u8, profile_id: u16, cluster_id: u16, destination_endpoint: u8, payload: impl AsRef<[u8]>, ) -> Result<StackResponse, Error>

Starts a broadcast APS send and returns its deferred StackResponse.

Await the returned response to confirm the matching messageSent callback.

Errors

Returns an Error if no matching source endpoint exists, the payload is larger than the EZSP maximum APS payload length, registering the message tag fails, or sending the EZSP command fails. Errors reported by the returned StackResponse occur when that value is awaited.

impl<T> Ncp<T>

where T: Networking,

pub async fn scan_networks( &mut self, channel_mask: u32, duration: u8, ) -> Result<Vec<NetworkFound>, Error>

Starts an active network scan and returns all networkFound callback results.

Errors

Returns an Error if registering the scan, sending startScan, or receiving the scan result fails.

pub async fn scan_channels( &mut self, channel_mask: u32, duration: u8, ) -> Result<Vec<EnergyScanResult>, Error>

Starts an energy scan and returns all energyScanResult callback results.

Errors

Returns an Error if registering the scan, sending startScan, or receiving the scan result fails.

impl Ncp<Uart>

pub fn ashv2<T>(serial_port: T, startup: Startup) -> (Builder<Uart>, Futures<T>)

where T: SerialPort + Sync + 'static,

Creates a new Builder backed by an ASHv2 UART transport.

The serial port must implement SerialPort, which is re-exported by the UART module from the ASHv2 transport crate. The returned Futures value must be spawned or otherwise polled by the caller for the UART transport to make progress. Use crate::Startup::Resume to restore a persisted network or crate::Startup::Initialize to form a new one.

Trait Implementations

impl<T: Debug> Debug for Ncp<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Driver for Ncp<T>

where T: Messaging + Networking + Utilities + Send + Sync,

async fn get_endpoints(&self) -> Result<BTreeMap<Application, Clusters>, Error>

Return the local endpoint cluster sets registered with the NCP.

async fn get_pan_id(&mut self) -> Result<u16, Error>

Get the PAN ID of the network.

async fn get_ieee_address(&mut self) -> Result<IeeeAddress, Error>

Get the IEEE address of the coordinator.

async fn scan_networks( &mut self, channel_mask: u32, duration: u8, ) -> Result<Vec<FoundNetwork>, Error>

Scan for available networks.

async fn scan_channels( &mut self, channel_mask: u32, duration: u8, ) -> Result<Vec<ScannedChannel>, Error>

Scan channels for activity.

async fn allow_joins(&mut self, duration: Duration) -> Result<Duration, Error>

Allow devices to join the network for the specified duration.

async fn route_request(&mut self, radius: u8) -> Result<(), Error>

Send a route request.

async fn short_id_to_ieee_address( &mut self, short_id: u16, ) -> Result<IeeeAddress, Error>

Get the IEEE address of the device with the specified short ID.

async fn ieee_address_to_short_id( &mut self, ieee_address: IeeeAddress, ) -> Result<u16, Error>

Get the short ID of the device with the specified IEEE address.

async fn transmit( &mut self, destination: Destination, datagram: Datagram, ) -> Result<HwResponse, Error>

Transmit an application datagram to the specified destination.

fn run( self, channel_size: usize, ) -> (Sender<Message>, impl Future<Output = Self> + Send)

where Self: Sized + SealedDriver + 'static,

Spawn the actor in a tokio task.