zencan-client 0.0.5

Library for communicating with CANOpen devices on a CAN bus
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

//! A client for communicating with zencan nodes
//!
//! The crate provides utilities for communicating with nodes, including:
//!
//! - An [SDO client](SdoClient) for reading/writing a node's object dictionary via it's SDO server
//! - An [LSS master](LssMaster) for discovering and configuring un-configured nodes with IDs
//! - A [BusManager] which is intended to be the engine behind an application, such as `zencan-cli`,
//!   keeping track of nodes, and providing an API for managing them.
//! - Defining a [NodeConfig](crate::common::node_configuration::NodeConfig) TOML file format, which allows for storing and loading node configuration (primarily
//!   PDOs, but any objects can be written)
//!
//! This library is currently based on tokio/async. The plan is to also include blocking APIs in the
//! future.
//!
//! This should be considered very alpha, with important missing features, and potentially frequent
//! breaking API changes.
#![warn(
    missing_docs,
    missing_debug_implementations,
    missing_copy_implementations
)]
#![allow(clippy::single_match)]
#![cfg_attr(docsrs, feature(doc_cfg))]

mod bus_manager;
mod lss_master;
pub mod nmt_master;
mod sdo_client;
pub use zencan_common as common;

pub use bus_manager::BusManager;
#[cfg(all(feature = "socketcan", target_os = "linux"))]
pub use common::open_socketcan;
pub use lss_master::{LssError, LssMaster};
pub use sdo_client::{RawAbortCode, SdoClient, SdoClientError};