Struct profirust::fdl::Parameters

#[non_exhaustive]
pub struct Parameters {
    pub address: u8,
    pub baudrate: Baudrate,
    pub slot_bits: u16,
    pub token_rotation_bits: u32,
    pub gap_wait_rotations: u8,
    pub highest_station_address: u8,
    pub max_retry_limit: u8,
    pub min_tsdr_bits: u8,
    pub watchdog_factors: Option<(u8, u8)>,
}

FDL master parameters

These parameters configure the behavior of the FDL master.

You should use the ParametersBuilder to build the parameters struct. Check its documentation for detailed explanations of the individual parameters.

Example

use profirust::fdl;

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

address: u8

Station address for this master

baudrate: Baudrate

Baudrate

slot_bits: u16

T_SL: Slot time in bits

token_rotation_bits: u32

Time until the token should have rotated through all masters once.

gap_wait_rotations: u8

GAP: update factor (how many token rotations to wait before polling the gap again)

highest_station_address: u8

HSA: Highest station address

The HSA is only relevant for finding other masters who want to become part of the token ring. Peripherals are allows to have addresses higher than HSA. Masters must have an address less than HSA.

Important: The live-list service will only detect stations below the HSA as well.

max_retry_limit: u8

Maximum number of retries when no answer was received

min_tsdr_bits: u8

min T_SDR: Minimum delay before anyone is allowed to respond to a telegram

watchdog_factors: Option<(u8, u8)>

Watchdog timeout for peripherals monitoring the DP master

Implementations

impl Parameters

pub fn bits_to_time(&self, bits: u32) -> Duration

pub fn slot_time(&self) -> Duration

T_SL (slot time) converted to duration

pub fn min_tsdr_time(&self) -> Duration

min T_SDR (minimum time before responding) converted to duration

pub fn token_lost_timeout(&self) -> Duration

Timeout after which the token is considered lost.

Calculated as 6 * T_SL + 2 * Addr * T_SL.

pub fn token_rotation_time(&self) -> Duration

T_TR (projected token rotation time)

pub fn watchdog_timeout(&self) -> Option<Duration>

Watchdog timeout

Trait Implementations

impl Clone for Parameters

fn clone(&self) -> Parameters

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Parameters

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

Formats the value using the given formatter.

impl Default for Parameters

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Parameters

fn eq(&self, other: &Parameters) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Parameters

impl StructuralPartialEq for Parameters