can_utils/lib.rs
1//! This is a crate of handy modules and utilities for manipulating CAN data and interfaces.
2//!
3//! NOTE: this crate is not yet ready for prime time, but it will be soon, just publishing now to claim the name
4//!
5//! TODO: add real documentation here
6
7#![deny(missing_docs)]
8#![deny(warnings)]
9#![no_std]
10// #![cfg_attr(not(feature = "std"), no_std)]
11
12mod frames;
13pub mod interface;
14pub mod timing_calculator;
15
16pub use frames::*;
17
18/// A collection of `byteorder` types to facilitate unpacking values from frames.
19pub mod byte_orders {
20 extern crate byteorder;
21 /// Defines the byte order for CANOpen frames, for later use decoding values.
22 pub type CanOpenByteOrder = byteorder::LittleEndian;
23
24 /// Defines the byte order for J1939 frames, for later use decoding values.
25 pub type J1939ByteOrder = byteorder::LittleEndian;
26
27 // TODO: add more byte orders here
28}