profirust 0.6.0

PROFIBUS-DP compatible communication stack in pure Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

//! FDL - Fieldbus data link
//!
//! The central type in the `fdl` module is the [`FdlActiveStation`], the implementation of the FDL
//! active station.  It is configured using the [`ParametersBuilder`].
//!
//! You can also find the representations of PROFIBUS telegrams and related data structures here.
mod active;
pub mod live_list;
mod parameters;
mod telegram;
mod token_ring;

#[cfg(test)]
mod test_active;

pub use active::{ConnectivityState, FdlActiveStation};
pub use parameters::{Parameters, ParametersBuilder};
pub(crate) use token_ring::TokenRing;

// Hide these for now until they get a cleaner interface
#[doc(hidden)]
pub use telegram::{
    DataTelegram, DataTelegramHeader, FrameCountBit, FunctionCode, RequestType, ResponseState,
    ResponseStatus, ShortConfirmation, Telegram, TelegramTx, TelegramTxResponse, TokenTelegram,
};

/// The interface for application layer components.
///
/// Only one application layer component is permitted per FDL master.
pub trait FdlApplication {
    /// Possibly transmit a telegram.
    ///
    /// The FDL layer will know whether a reply is expected based on the telegram that is sent.  If
    /// a reply is received, `receive_reply()` will be called to handle it.  If no reply is
    /// received in Tsl time, `transmit_telegram()` is called again.  It should then retry
    /// transmission according to the retry count configured in `fdl.parameters().max_retry_limit`.
    ///
    /// When `transmit_telegram()` returns `None`, the FDL master will interpret this as end of
    /// cycle and will pass on the token.
    fn transmit_telegram(
        &mut self,
        now: crate::time::Instant,
        fdl: &FdlActiveStation,
        tx: TelegramTx,
        high_prio_only: bool,
    ) -> Option<TelegramTxResponse>;

    /// Receive the reply for the telegram that was last transmitted.
    fn receive_reply(
        &mut self,
        now: crate::time::Instant,
        fdl: &FdlActiveStation,
        addr: u8,
        telegram: Telegram,
    );

    /// Handle a timeout while waiting for a reply from the given address.
    fn handle_timeout(&mut self, now: crate::time::Instant, fdl: &FdlActiveStation, addr: u8);
}

// A sort of placeholder when no application is used.
impl FdlApplication for () {
    fn transmit_telegram(
        &mut self,
        now: crate::time::Instant,
        fdl: &FdlActiveStation,
        tx: TelegramTx,
        high_prio_only: bool,
    ) -> Option<TelegramTxResponse> {
        None
    }

    fn receive_reply(
        &mut self,
        now: crate::time::Instant,
        fdl: &FdlActiveStation,
        addr: u8,
        telegram: Telegram,
    ) {
        ()
    }

    fn handle_timeout(&mut self, now: crate::time::Instant, fdl: &FdlActiveStation, addr: u8) {
        // ignore
    }
}