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

//! Work with PLCs using the ADS protocol
//!
//! # Introduction
//!
//! ADS is the native protocol used by programmable logic controllers (PLCs) and
//! the TwinCAT automation system produced by [Beckhoff GmbH](https://www.beckhoff.com/).
//!
//! The [specification](https://infosys.beckhoff.de/content/1031/tc3_adscommon/html/tcadscommon_introads.htm)
//! can be found on their Information System pages.
//!
//! # Example
//!
//! ```rust,ignore
//! // Open a connection to an ADS device identified by hostname/IP and port.
//! // For TwinCAT devices, a route must be set to allow the client to connect.
//! // The source AMS address is automatically generated from the local IP,
//! // but can be explicitly specified as the third argument.
//! let client = ads::Client::new(("plc", ads::PORT), ads::Timeouts::none(), None)?;
//!
//! // Specify the target ADS device to talk to, by NetID and AMS port.
//! // Port 851 usually refers to the first PLC instance.
//! let device = client.device(ads::AmsAddr::new([5, 32, 116, 5, 1, 1].into(), 851));
//!
//! // Ensure that the PLC instance is running.
//! assert!(device.get_state()?.0 == ads::AdsState::Run);
//!
//! // Request a handle to a named symbol in the PLC instance.
//! let handle = Handle::new(device, "MY_SYMBOL")?;
//! // Read data in form of an u32 from the handle.
//! let mut data = [0; 4];
//! handle.read(&mut data)?;
//! println!("MY_SYMBOL value is {}", u32::from_le_bytes(data));
//! ```

#![deny(missing_docs)]
#![cfg_attr(not(test), deny(clippy::unwrap_used))]

pub mod netid;
pub mod client;
pub mod notif;
pub mod udp;
pub mod errors;
pub mod ports;
pub mod index;
pub mod file;
pub mod symbol;
#[cfg(test)]
mod test;

pub use client::{AdsState, Client, Device, Timeouts};
pub use errors::{Error, Result};
pub use file::File;
pub use netid::{AmsAddr, AmsNetId, AmsPort};
pub use symbol::Handle;

/// The default port for TCP communication.
pub const PORT: u16 = 0xBF02;
/// The default port for UDP communication.
pub const UDP_PORT: u16 = 0xBF03;