Struct profirust::fdl::FdlMaster

pub struct FdlMaster { /* private fields */ }

FDL master implementation

The FDL master starts in the Offline state. To start bus interaction, you must first move it into Online state (using .set_online()).

Example

use profirust::{Baudrate, fdl};

let master_address = 2;
let mut fdl_master = fdl::FdlMaster::new(
    fdl::ParametersBuilder::new(master_address, Baudrate::B19200)
        .slot_bits(300)
        .build_verified(&dp_master)
);

fdl_master.set_online();

Implementations

impl FdlMaster

pub fn new(param: Parameters) -> Self

Construct a new FDL master with the given parameters.

pub fn parameters(&self) -> &Parameters

Return a reference to the parameters configured for this FDL master.

pub fn is_in_ring(&self) -> bool

Returns true when this FDL master believes to be in the token ring.

pub fn check_address_live(&self, addr: u8) -> bool

Returns true when the given address is believed to be “alive” (responds on the bus).

pub fn iter_live_stations(&self) -> impl Iterator<Item = u8> + '_

Iterator over all station addresses which are currently responding on the bus.

pub fn connectivity_state(&self) -> ConnectivityState

pub fn set_state(&mut self, state: ConnectivityState)

pub fn set_offline(&mut self)

Enter the Offline connectivity state.

This is equivalent to calling .set_state(ConnectivityState::Offline).

pub fn set_passive(&mut self)

Enter the Passive connectivity state.

This is equivalent to calling .set_state(ConnectivityState::Passive).

pub fn set_online(&mut self)

Enter the Online connectivity state.

This is equivalent to calling .set_state(ConnectivityState::Online).

impl FdlMaster

pub fn poll<'a, PHY: ProfibusPhy, APP: FdlApplication>( &mut self, now: Instant, phy: &mut PHY, app: &mut APP ) -> APP::Events

Main API for driving the communication stack.

You need to cyclically call this poll() function to perform bus communication. The time between poll calls should not exceed half T_SLOT, or in code:

fdl_master.parameters().slot_time() / 2

In the future, profirust may give an indication about the next time a poll will be necessary.

poll() returns events from the application layer, if any occurred.

Trait Implementations

impl Debug for FdlMaster

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

Formats the value using the given formatter.