rustbac-core 0.1.1

Core BACnet protocol types, encoders, and service codecs for rustbac.
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

# rust-bac

Rust BACnet/IP workspace with a `no_std` core encoder/decoder, async BACnet/IP transport, high-level client API, and CLI tools.

## Crates

- `crates/rustbac-core`: BACnet encoding, NPDU/APDU, types, and service payloads.
- `crates/rustbac-datalink`: BACnet/IP datalink (BVLC/BIP), BBMD/FDR helpers.
- `crates/rustbac-bacnet-sc`: BACnet/SC WebSocket transport adapter (ws/wss backend wiring).
- `crates/rustbac-client`: high-level async client API.
- `crates/rustbac-tools`: CLI binaries (`whois`, `whohas`, `readprop`, `writeprop`, `subcov`, `readrange`, `readfile`, `writefile`, `dcc`, `reinit`, `timesync`, `ackalarm`, `alarmsummary`, `enrollsummary`, `eventinfo`, `eventnotify`, `readbdt`, `writebdt`, `readfdt`, `deletefdt`, `createobj`, `deleteobj`, `addlist`, `removelist`, `listen`, `privatetransfer`, `simulator`, `walkdevice`).

## Quick Start

```bash
cargo test --workspace
```

```bash
bash scripts/run_interop_matrix.sh
```

```bash
cargo run -p rustbac-tools --bin whois -- --help
cargo run -p rustbac-tools --bin whohas -- --help
cargo run -p rustbac-tools --bin readprop -- --help
cargo run -p rustbac-tools --bin writeprop -- --help
cargo run -p rustbac-tools --bin subcov -- --help
cargo run -p rustbac-tools --bin readrange -- --help
cargo run -p rustbac-tools --bin readfile -- --help
cargo run -p rustbac-tools --bin writefile -- --help
cargo run -p rustbac-tools --bin dcc -- --help
cargo run -p rustbac-tools --bin reinit -- --help
cargo run -p rustbac-tools --bin timesync -- --help
cargo run -p rustbac-tools --bin ackalarm -- --help
cargo run -p rustbac-tools --bin alarmsummary -- --help
cargo run -p rustbac-tools --bin enrollsummary -- --help
cargo run -p rustbac-tools --bin eventinfo -- --help
cargo run -p rustbac-tools --bin eventnotify -- --help
cargo run -p rustbac-tools --bin readbdt -- --help
cargo run -p rustbac-tools --bin writebdt -- --help
cargo run -p rustbac-tools --bin readfdt -- --help
cargo run -p rustbac-tools --bin deletefdt -- --help
cargo run -p rustbac-tools --bin createobj -- --help
cargo run -p rustbac-tools --bin deleteobj -- --help
cargo run -p rustbac-tools --bin addlist -- --help
cargo run -p rustbac-tools --bin removelist -- --help
cargo run -p rustbac-tools --bin listen -- --help
cargo run -p rustbac-tools --bin privatetransfer -- --help
cargo run -p rustbac-tools --bin simulator -- --help
cargo run -p rustbac-tools --bin walkdevice -- --help
```

## Current Highlights

- Who-Is / I-Am discovery
- Who-Has / I-Have object discovery
- Read/Write Property
- Read/Write Property Multiple
- ReadRange (by-position, by-sequence, by-time)
- Atomic Read File (stream + record)
- Atomic Write File (stream + record)
- Create Object / Delete Object
- Add List Element / Remove List Element
- Subscribe COV and Subscribe COV Property
- COV notification handling (confirmed + unconfirmed)
- Event notification handling (confirmed + unconfirmed)
- Event/Alarm services:
  - AcknowledgeAlarm
  - GetAlarmSummary
  - GetEnrollmentSummary
  - GetEventInformation
- Device management services:
  - DeviceCommunicationControl
  - ReinitializeDevice
- Time synchronization services:
  - TimeSynchronization
  - UTCTimeSynchronization
- Segmented ComplexAck reassembly
- Duplicate segmented ComplexAck tolerance during reassembly
- Segmented confirmed-request transmit (for oversized confirmed requests, configurable window + bounded retransmit retries)
- Confirmed-service receive loops tolerate transient invalid frames while awaiting responses
- Foreign Device Registration + BBMD table operations (BDT/FDT)
- ConfirmedPrivateTransfer (vendor-specific service invocation)
- Device walk (enumerate all objects and properties on a device)
- Simulated BACnet device for testing (`SimulatedDevice`)
- Async notification listener for COV and event notifications (`NotificationListener`)
- BBMD/FDR admin CLI tools (`readbdt`, `writebdt`, `readfdt`, `deletefdt`)
- BACnet/SC websocket transport (`BacnetScTransport`, `BacnetClient::new_sc`)
- Typed remote BACnet error detail mapping (class/code when present)
- Golden packet fixtures in `crates/rustbac-core/tests/golden_packets.rs`
- Golden corpus fixture loader test in `crates/rustbac-core/tests/golden_corpus.rs` (loads `fixtures/golden/*.hex`)

## Delivery Docs

- `docs/BIBBS.md`: current BIBBs coverage map
- `docs/INTEROP_MATRIX.md`: interop execution matrix template
- `docs/INTEROP_RESULTS.md`: latest automated interop matrix run output
- `docs/INTEROP_RUNBOOK.md`: step-by-step completion checklist for BACnet/IP + BACnet/SC hardening
- `docs/INTEROP_RESULTS_LIVE.md`: live simulator/device run results

## Live Interop Command

```bash
bash scripts/run_live_interop.sh --ip <TARGET_IP>
```

## MSRV

- Rust `1.75.0` (pinned by `rust-toolchain.toml`)