osdp-rs

osdp-rs is a pure-Rust, no_std-friendly implementation of the Security Industry Association's Open Supervised Device Protocol (OSDP) v2.2.

Status

v0.2.x is a ground-up rewrite focused on:

• Pure Rust, no C FFI. Trivially cross-compiles to bare-metal targets.
• no_std + alloc by default, std and secure-channel opt-in.
• Total parser — every error path returns an Error; no panics on malformed input.
• Type-state secure session — invalid SCS sequences (e.g. sending SCS_15 before SCS_14) are compile errors, not runtime errors.

Crate features

Implementation matrix

Commands (Annex A.1)

Replies (Annex A.2)

Other components

Quick start

use osdp::clock::SystemClock;
use osdp::command::{Command, Poll};
use osdp::driver::acu::{Acu, ExchangeOutcome, PdState};
use osdp::reply::Reply;
use osdp::transport::VecTransport;

let mut acu = Acu::new(VecTransport::new(), SystemClock::new());
let mut pd = PdState::default();
match acu.exchange(0x05, &mut pd, &Command::Poll(Poll))? {
    ExchangeOutcome::Reply(Reply::Ack(_)) => println!("PD alive"),
    ExchangeOutcome::Busy => println!("retry later"),
    ExchangeOutcome::Timeout => println!("missed reply"),
    ExchangeOutcome::Offline => println!("declared off-line"),
    _ => {}
}
# Ok::<(), osdp::Error>(())

For the secure-channel walk, see examples/handshake.rs. For an end-to-end loopback that exercises SQN cycling, see examples/loopback_poll.rs.

Testing

cargo test                              # 71 unit + 14 integration tests
cargo test --no-default-features        # `no_std` slice still compiles
cargo clippy --all-targets --all-features
cargo run --example loopback_poll
cargo run --example handshake

License

BSD-3-Clause.