Crate cmri

CMRI

Pure-Rust decoding/encoding of packets for CMRInet (as defined in NMRA Specification LCS-9.10.1).

Features

std

This is a std crate by default.

serde

The serde feature adds serializating and deserializating of all items using serde.

experimenter

The experimenter feature is intended for people who are using nonstandard packets/nodes, perhaps in their own experimentation. It enables the following changes:

• Instead of getting a packet::Error::InvalidMessageType for an otherwise valid message type (ASCII uppercase), you’ll get a packet::Payload::Unknown.
• Instead of getting a packet::Error::InvalidNodeType for an otherwise valid node definition parameter (ASCII alphabetic), you’ll get a node_configuration::NodeSort::Unknown.
• packet::Packet::try_new_unknown

Testing

The test suite is run for all Tier 1 targets from https://doc.rust-lang.org/nightly/rustc/platform-support.html on nightly (at time of pushing to GitHub) rust.

The ability to build is tested on nightly (at time of pushing to GitHub) rust, for tier 2 targets with host tools, plus:

• wasm32-unknown-emscripten
• wasm32-unknown-unknown
• wasm32-wasip1
• aarch64-apple-ios-macabi
• x86_64-apple-ios-macabi

Additionally nostd building is tested for:

• mips-unknown-linux-gnu only as no_std
• mips64-unknown-linux-gnuabi64 only as no_std
• mips64el-unknown-linux-gnuabi64 only as no_std
• mipsel-unknown-none only as no_std
• avr-unknown-gnu-atmega328 - AVR only as no_std

Re-exports

pub use packet::Packet;

pub use node_configuration::NodeSort;

pub use node_configuration::NodeConfiguration;

pub use frame::Raw as Frame;

Modules

frame

Handling of frames on a CMRInet network.

node_configuration

The configuration of nodes on a CMRInet.

packet

Handling of CMRInet packets.

Structs

Address

The address of a packet/node.

Constants

BAUDS

Valid speeds for serial communications.

DEFAULT_BAUD

Default speed for serial communications.