nord-usb 0.5.0

Talk to Clavia / Nord keyboards over USB — the vendor protocol behind Nord Sound Manager, on desktop and in the browser
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! Clavia / Nord device transport and vendor protocol over USB.
//!
//! > This is an unofficial, community project: **not affiliated with, endorsed
//! > by, or supported by Clavia DMI AB**. "Nord" and the instrument names are
//! > Clavia's trademarks, used here only to identify which files this crate
//! > reads.
//!
//! Layered so the protocol is testable without hardware:
//!
//! - [`wire`] — message framing and codec. Pure, fully decoded, no I/O.
//! - [`transport`] — the byte pipe. The only part that touches a device.
//! - [`session`] — the transaction wrapper every operation runs inside.
//! - [`op`] — typed operations.
//! - [`device`] — an instrument as a value: session brackets and its own geometry.
//!
//! The wire format was reverse-engineered from a corpus of NSM captures and is
//! verified against every message in it.
//!
//! # Portability
//!
//! Desktop (macOS/Linux/Windows) via `nusb`, browsers via WebUSB. WebUSB is the
//! binding constraint on the API shape — see [`transport::Transport`] for why there
//! are no `Send` bounds, and why enumeration is deliberately backend-specific rather
//! than part of the portable core.

#[cfg(feature = "nusb")]
pub mod deadline;
pub mod device;
pub mod envelope;
pub mod error;
pub mod op;
pub mod session;
pub mod sleep;
pub mod transport;
pub mod wire;

pub use device::{Device, Geometry};
pub use error::{Error, Result};
pub use session::{ReadOnly, ReadWrite, Session};
pub use transport::Transport;
pub use wire::{Location, Message, ObjectClass, Service, Status};

#[cfg(feature = "replay")]
pub use transport::ReplayTransport;

/// Block on a future without pulling in a full async runtime.
///
/// The crate is deliberately runtime-agnostic (see [`transport::Transport`] for why
/// there are no `Send` bounds), so this exists for CLIs and tests that just want the
/// answer. Browser callers already have an executor and should not use it.
#[cfg(feature = "blocking")]
pub fn block_on<F: std::future::Future>(fut: F) -> F::Output {
    pollster::block_on(fut)
}