etherage 0.5.1

An EtherCAT master in pure-Rust very close to the ethercat nature
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

/*!
    Etherage is a crate implementing an ethercat master, with an API as close as possible to the concepts of the ethercat protocol.

	The following scheme shows the ethernet topology of an ethercat bus. It is a ring considering directional arrows (which is the way data transits over the bus). And it is a tree considering bilateral links (which is the way the network is wired).

	![ethercat network topology](https://raw.githubusercontent.com/jimy-byerley/etherage/master/schemes/ethercat-network.svg)

	Each slave only has a very short time and very limited ressources to react & alter the datagrams transiting from one of its port to the next one, resulting in a realtime communcation bus. This library and the ethercat protocol are designed in this spirit. The idea is for the master to send datagrams and for the slaves to react and fill them, few bytes each slave. In order to control a vast amount of slaves concurrently in the same datagram, this library is deeply `async`.

    ## It mainly features

    - [Master] for protocol-safe and memory-safe access to the functions of the master
    - [Slave] for protocol-safe and memory-safe access to the functions of slaves
    - [RawMaster] and other structures based on it for memory-safe but protocol-unsafe access to lower level features of the protocol

    ## Complete feature list

    - [x] master over different sockets
        + [x] raw ethernet
        + [x] UDP
    - [x] minimalistic features
        - [x] PDU commands
        - [x] access to logical & physical memories
        - [x] slave information access
    - [x] mailbox
        + generic messaging
        + [x] COE
            - [x] SDO read/write
            - [ ] PDO read/write
            - [ ] informations
            - [x] tools for mapping
        + [ ] EOE
        + [ ] FOE
    - [x] distributed clock
        + [x] static drift
        + [x] dynamic drift
    - convenience
        + [x] logical memory & slave group management tools
        + [x] mapping tools
    - optimization features
        + [x] multiple PDUs per ethercat frame (speed up and compress transmissions)
        + [x] tasks for different slaves or for same slave are parallelized whenever possible
        + [x] no dynamic allocation in transmission and realtime functions
        + [x] async API and implementation to avoid threads context switches
*/

#![doc(html_favicon_url = "https://raw.githubusercontent.com/jimy-byerley/etherage/master/logo/etherage.svg")]
#![doc(html_logo_url = "https://raw.githubusercontent.com/jimy-byerley/etherage/master/logo/ethercotic.svg")]

pub mod data;
pub mod error;

#[allow(non_upper_case_globals)] 
#[allow(unused)]
pub mod registers;
#[allow(non_upper_case_globals)]
#[allow(unused)]
pub mod sdo;
#[allow(non_upper_case_globals)] 
#[allow(unused)]
pub mod eeprom;

pub mod socket;
pub mod rawmaster;
pub mod sii;
pub mod mailbox;
pub mod can;
pub mod master;
pub mod clock;
pub mod slave;
pub mod mapping;


pub use crate::data::{PduData, Field, BitField};
pub use crate::sdo::Sdo;
pub use crate::socket::*;
pub use crate::rawmaster::{RawMaster, SlaveAddress};
pub use crate::master::Master;
pub use crate::slave::{Slave, CommunicationState};
pub use crate::mapping::{Mapping, Group, Config};
pub use crate::error::{EthercatError, EthercatResult};