dmx512_rdm_protocol/lib.rs
1//! DMX512 and Remote Device Management (RDM) protocol written in Rust
2//!
3//! ## About the project
4//!
5//! DMX512 is a unidirectional packet based communication protocol commonly used to control lighting and effects.
6//!
7//! Remote Device Management (RDM) is a backward-compatible extension of DMX512, enabling bi-directional communication with compatible devices for the purpose of discovery, identification, reporting, and configuration.
8//!
9//! ### Included
10//!
11//! Data-types and functionality for encoding and decoding DMX512 and RDM packets.
12//!
13//! ### Not included
14//!
15//! Driver implementations: DMX512 / RDM packets are transmitted over an RS485 bus but interface devices like the Enttec DMX USB PRO exist to communicate with devices via USB. These interface devices usually require extra packet framing ontop of the standard DMX512 / RDM packets, which is out of scope of this project.
16//!
17//! ### Implemented specifications
18//!
19//! - ANSI E1.11 (2008): Asynchronous Serial Digital Data Transmission Standard for Controlling Lighting Equipment and Accessories
20//! - ANSI E1.20 (2010): RDM Remote Device Management Over DMX512 Networks
21//!
22//! ## Usage
23//!
24//! See module documentation or test suite for examples.
25
26#![cfg_attr(not(feature = "alloc"), no_std)]
27
28#[cfg(feature = "alloc")]
29extern crate alloc;
30
31pub mod dmx;
32
33#[cfg(feature = "rdm")]
34pub mod rdm;