autd3_link_soem/
lib.rs

1// Copyright (c) 2022-2025 Shun Suzuki
2//
3// This file is part of autd3-link-soem.
4//
5// autd3-link-soem is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License.
6//
7// autd3-link-soem is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
8//
9// You should have received a copy of the GNU General Public License along with Foobar. If not, see <https://www.gnu.org/licenses/>.
10
11#![cfg_attr(docsrs, feature(doc_cfg))]
12#![warn(missing_docs)]
13#![warn(rustdoc::missing_crate_level_docs)]
14#![warn(rustdoc::unescaped_backticks)]
15
16//! This crate provides a link to AUTD using [SOEM](https://github.com/OpenEtherCATsociety/SOEM).
17
18#[cfg_attr(docsrs, doc(cfg(feature = "local")))]
19#[cfg(feature = "local")]
20/// Using SOEM on the local machine.
21pub mod local;
22#[cfg_attr(docsrs, doc(cfg(feature = "local")))]
23#[cfg(feature = "local")]
24pub use local::{
25    CoreId, EthernetAdapters, SOEM, SOEMOption, Status, ThreadPriority, ThreadPriorityValue,
26};
27
28#[cfg_attr(docsrs, doc(cfg(feature = "remote")))]
29#[cfg(feature = "remote")]
30/// Using SOEM on a remote machine.
31pub mod remote;
32#[cfg_attr(docsrs, doc(cfg(feature = "remote")))]
33#[cfg(feature = "remote")]
34pub use remote::RemoteSOEM;