Struct canadensis_pnp_client::PnpClient

pub struct PnpClient<C: Clock, M, T: Transmitter<C>, R: Receiver<C>> { /* private fields */ }

A plug-and-play allocation client that can be used to find a node ID

Implementations

impl<C, M, T, R, P> PnpClient<C, M, T, R>where C: Clock, M: AllocationMessage<P>, T: Transmitter<C, Transport = P>, R: Receiver<C, Transport = P>, P: Transport,

pub fn new( transmitter: T, receiver: R, unique_id: [u8; 16], driver: &mut R::Driver ) -> Result<Self, R::Error>

Creates a new plug-and-play client

• unique_id: The unique ID of this node

pub fn send_request(&mut self, clock: &mut C, driver: &mut T::Driver)

Creates an outgoing node ID allocation message and gives it to the transmitter

pub fn receive( &mut self, clock: &mut C, driver: &mut R::Driver ) -> Result<Option<P::NodeId>, R::Error>

Handles an incoming frame and checks if it provides an ID for this node

This function returns the node ID if one was assigned.

pub fn transmitter(&self) -> &T

Returns a reference to the transmitter

pub fn transmitter_mut(&mut self) -> &mut T

Returns a mutable reference to the transmitter

pub fn receiver(&self) -> &R

Returns a reference to the receiver

pub fn receiver_mut(&mut self) -> &mut R

Returns a mutable reference to the receiver