bacnet-client 0.9.0

BACnet async client: TSM, segmentation, discovery, and service APIs
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
use super::*;
use bacnet_encoding::apdu::{ComplexAck, SimpleAck};
use bacnet_encoding::npdu::{decode_npdu, encode_npdu, Npdu};
use bacnet_transport::loopback::LoopbackTransport;
use bacnet_transport::port::TransportPort;
use std::net::Ipv4Addr;
use tokio::time::Duration;

async fn make_client() -> BACnetClient<BipTransport> {
    BACnetClient::builder()
        .interface(Ipv4Addr::LOCALHOST)
        .port(0)
        .apdu_timeout_ms(2000)
        .build()
        .await
        .unwrap()
}

async fn send_routed_response<T: TransportPort>(
    transport: &T,
    client_mac: &[u8],
    source_network: u16,
    source_mac: &[u8],
    apdu: Apdu,
) {
    let mut apdu_buf = BytesMut::new();
    encode_apdu(&mut apdu_buf, &apdu).expect("valid APDU encoding");
    let npdu = Npdu {
        source: Some(NpduAddress {
            network: source_network,
            mac_address: MacAddr::from_slice(source_mac),
        }),
        payload: apdu_buf.freeze(),
        ..Npdu::default()
    };
    let mut npdu_buf = BytesMut::new();
    encode_npdu(&mut npdu_buf, &npdu).unwrap();
    transport.send_unicast(&npdu_buf, client_mac).await.unwrap();
}

#[tokio::test]
async fn client_start_stop() {
    let mut client = make_client().await;
    assert!(!client.local_mac().is_empty());
    client.stop().await.unwrap();
}

#[tokio::test]
async fn client_rejects_invalid_max_apdu_length() {
    let result = BACnetClient::builder()
        .interface(Ipv4Addr::LOCALHOST)
        .port(0)
        .max_apdu_length(1000)
        .build()
        .await;

    assert!(result.is_err());
}

#[tokio::test]
async fn confirmed_request_simple_ack() {
    let mut client_a = make_client().await;

    let transport_b = BipTransport::new(Ipv4Addr::LOCALHOST, 0, Ipv4Addr::BROADCAST);
    let mut net_b = NetworkLayer::new(transport_b);
    let mut rx_b = net_b.start().await.unwrap();
    let b_mac = net_b.local_mac().to_vec();

    let b_handle = tokio::spawn(async move {
        let received = timeout(Duration::from_secs(2), rx_b.recv())
            .await
            .expect("B timed out")
            .expect("B channel closed");

        let decoded = apdu::decode_apdu(received.apdu.clone()).unwrap();
        if let Apdu::ConfirmedRequest(req) = decoded {
            let ack = Apdu::SimpleAck(SimpleAck {
                invoke_id: req.invoke_id,
                service_choice: req.service_choice,
            });
            let mut buf = BytesMut::new();
            encode_apdu(&mut buf, &ack).unwrap();
            net_b
                .send_apdu(&buf, &received.source_mac, false, NetworkPriority::NORMAL)
                .await
                .unwrap();
        }
        net_b.stop().await.unwrap();
    });

    let result = client_a
        .confirmed_request(
            &b_mac,
            ConfirmedServiceChoice::WRITE_PROPERTY,
            &[0x01, 0x02],
        )
        .await;

    assert!(result.is_ok());
    let response = result.unwrap();
    assert!(response.is_empty());

    b_handle.await.unwrap();
    client_a.stop().await.unwrap();
}

#[tokio::test]
async fn confirmed_request_complex_ack() {
    let mut client_a = make_client().await;

    let transport_b = BipTransport::new(Ipv4Addr::LOCALHOST, 0, Ipv4Addr::BROADCAST);
    let mut net_b = NetworkLayer::new(transport_b);
    let mut rx_b = net_b.start().await.unwrap();
    let b_mac = net_b.local_mac().to_vec();

    let b_handle = tokio::spawn(async move {
        let received = timeout(Duration::from_secs(2), rx_b.recv())
            .await
            .unwrap()
            .unwrap();

        let decoded = apdu::decode_apdu(received.apdu.clone()).unwrap();
        if let Apdu::ConfirmedRequest(req) = decoded {
            let ack = Apdu::ComplexAck(ComplexAck {
                segmented: false,
                more_follows: false,
                invoke_id: req.invoke_id,
                sequence_number: None,
                proposed_window_size: None,
                service_choice: req.service_choice,
                service_ack: Bytes::from_static(&[0xDE, 0xAD, 0xBE, 0xEF]),
            });
            let mut buf = BytesMut::new();
            encode_apdu(&mut buf, &ack).unwrap();
            net_b
                .send_apdu(&buf, &received.source_mac, false, NetworkPriority::NORMAL)
                .await
                .unwrap();
        }
        net_b.stop().await.unwrap();
    });

    let result = client_a
        .confirmed_request(&b_mac, ConfirmedServiceChoice::READ_PROPERTY, &[0x01])
        .await;

    assert!(result.is_ok());
    assert_eq!(result.unwrap(), vec![0xDE, 0xAD, 0xBE, 0xEF]);

    b_handle.await.unwrap();
    client_a.stop().await.unwrap();
}

#[tokio::test]
async fn confirmed_request_timeout() {
    let mut client = make_client().await;
    let fake_mac = vec![10, 99, 99, 99, 0xBA, 0xC0];
    let result = client
        .confirmed_request(&fake_mac, ConfirmedServiceChoice::READ_PROPERTY, &[0x01])
        .await;
    assert!(result.is_err());
    client.stop().await.unwrap();
}

#[tokio::test]
async fn segmented_complex_ack_reassembly() {
    let mut client = make_client().await;

    let transport_b = BipTransport::new(Ipv4Addr::LOCALHOST, 0, Ipv4Addr::BROADCAST);
    let mut net_b = NetworkLayer::new(transport_b);
    let mut rx_b = net_b.start().await.unwrap();
    let b_mac = net_b.local_mac().to_vec();

    let b_handle = tokio::spawn(async move {
        let received = timeout(Duration::from_secs(2), rx_b.recv())
            .await
            .unwrap()
            .unwrap();

        let decoded = apdu::decode_apdu(received.apdu.clone()).unwrap();
        let invoke_id = if let Apdu::ConfirmedRequest(req) = decoded {
            req.invoke_id
        } else {
            panic!("Expected ConfirmedRequest");
        };

        let service_choice = ConfirmedServiceChoice::READ_PROPERTY;
        let segments: Vec<Bytes> = vec![
            Bytes::from_static(&[0x01, 0x02, 0x03]),
            Bytes::from_static(&[0x04, 0x05, 0x06]),
            Bytes::from_static(&[0x07, 0x08]),
        ];

        for (i, seg) in segments.iter().enumerate() {
            let is_last = i == segments.len() - 1;
            let ack = Apdu::ComplexAck(ComplexAck {
                segmented: true,
                more_follows: !is_last,
                invoke_id,
                sequence_number: Some(i as u8),
                proposed_window_size: Some(1),
                service_choice,
                service_ack: seg.clone(),
            });
            let mut buf = BytesMut::new();
            encode_apdu(&mut buf, &ack).unwrap();
            net_b
                .send_apdu(&buf, &received.source_mac, false, NetworkPriority::NORMAL)
                .await
                .unwrap();

            let seg_ack_msg = timeout(Duration::from_secs(2), rx_b.recv())
                .await
                .unwrap()
                .unwrap();
            let decoded = apdu::decode_apdu(seg_ack_msg.apdu.clone()).unwrap();
            if let Apdu::SegmentAck(sa) = decoded {
                assert_eq!(sa.invoke_id, invoke_id);
                assert_eq!(sa.sequence_number, i as u8);
            } else {
                panic!("Expected SegmentAck, got {:?}", decoded);
            }
        }

        net_b.stop().await.unwrap();
    });

    let result = client
        .confirmed_request(&b_mac, ConfirmedServiceChoice::READ_PROPERTY, &[0x01])
        .await;

    assert!(result.is_ok());
    assert_eq!(
        result.unwrap(),
        vec![0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08]
    );

    b_handle.await.unwrap();
    client.stop().await.unwrap();
}

#[tokio::test]
async fn segmented_confirmed_request_sends_segments() {
    let mut client = BACnetClient::builder()
        .interface(Ipv4Addr::LOCALHOST)
        .port(0)
        .apdu_timeout_ms(5000)
        .max_apdu_length(50)
        .build()
        .await
        .unwrap();

    let transport_b = BipTransport::new(Ipv4Addr::LOCALHOST, 0, Ipv4Addr::BROADCAST);
    let mut net_b = NetworkLayer::new(transport_b);
    let mut rx_b = net_b.start().await.unwrap();
    let b_mac = net_b.local_mac().to_vec();

    let service_data: Vec<u8> = (0u8..100).collect();
    let expected_data = service_data.clone();

    let b_handle = tokio::spawn(async move {
        let mut all_service_data = Vec::new();
        let mut client_mac;
        let mut invoke_id;

        loop {
            let received = timeout(Duration::from_secs(3), rx_b.recv())
                .await
                .expect("server timed out waiting for segment")
                .expect("server channel closed");

            let decoded = apdu::decode_apdu(received.apdu.clone()).unwrap();
            if let Apdu::ConfirmedRequest(req) = decoded {
                assert!(req.segmented, "expected segmented request");
                invoke_id = req.invoke_id;
                client_mac = received.source_mac.clone();
                let seq = req.sequence_number.unwrap();
                all_service_data.extend_from_slice(&req.service_request);

                let seg_ack = Apdu::SegmentAck(SegmentAckPdu {
                    negative_ack: false,
                    sent_by_server: true,
                    invoke_id,
                    sequence_number: seq,
                    actual_window_size: 1,
                });
                let mut buf = BytesMut::new();
                encode_apdu(&mut buf, &seg_ack).unwrap();
                net_b
                    .send_apdu(&buf, &received.source_mac, false, NetworkPriority::NORMAL)
                    .await
                    .unwrap();

                if !req.more_follows {
                    break;
                }
            } else {
                panic!("Expected ConfirmedRequest, got {:?}", decoded);
            }
        }

        let ack = Apdu::SimpleAck(SimpleAck {
            invoke_id,
            service_choice: ConfirmedServiceChoice::WRITE_PROPERTY,
        });
        let mut buf = BytesMut::new();
        encode_apdu(&mut buf, &ack).unwrap();
        net_b
            .send_apdu(&buf, &client_mac, false, NetworkPriority::NORMAL)
            .await
            .unwrap();

        net_b.stop().await.unwrap();
        all_service_data
    });

    let result = client
        .confirmed_request(
            &b_mac,
            ConfirmedServiceChoice::WRITE_PROPERTY,
            &service_data,
        )
        .await;

    assert!(result.is_ok());
    assert!(result.unwrap().is_empty());

    let received_data = b_handle.await.unwrap();
    assert_eq!(received_data, expected_data);

    client.stop().await.unwrap();
}

#[tokio::test]
async fn segmented_request_with_complex_ack_response() {
    let mut client = BACnetClient::builder()
        .interface(Ipv4Addr::LOCALHOST)
        .port(0)
        .apdu_timeout_ms(5000)
        .max_apdu_length(50)
        .build()
        .await
        .unwrap();

    let transport_b = BipTransport::new(Ipv4Addr::LOCALHOST, 0, Ipv4Addr::BROADCAST);
    let mut net_b = NetworkLayer::new(transport_b);
    let mut rx_b = net_b.start().await.unwrap();
    let b_mac = net_b.local_mac().to_vec();

    let service_data: Vec<u8> = (0u8..60).collect();

    let b_handle = tokio::spawn(async move {
        let mut client_mac;
        let mut invoke_id;

        loop {
            let received = timeout(Duration::from_secs(3), rx_b.recv())
                .await
                .unwrap()
                .unwrap();

            let decoded = apdu::decode_apdu(received.apdu.clone()).unwrap();
            if let Apdu::ConfirmedRequest(req) = decoded {
                invoke_id = req.invoke_id;
                client_mac = received.source_mac.clone();
                let seq = req.sequence_number.unwrap();

                let seg_ack = Apdu::SegmentAck(SegmentAckPdu {
                    negative_ack: false,
                    sent_by_server: true,
                    invoke_id,
                    sequence_number: seq,
                    actual_window_size: 1,
                });
                let mut buf = BytesMut::new();
                encode_apdu(&mut buf, &seg_ack).unwrap();
                net_b
                    .send_apdu(&buf, &received.source_mac, false, NetworkPriority::NORMAL)
                    .await
                    .unwrap();

                if !req.more_follows {
                    break;
                }
            }
        }

        let ack = Apdu::ComplexAck(ComplexAck {
            segmented: false,
            more_follows: false,
            invoke_id,
            sequence_number: None,
            proposed_window_size: None,
            service_choice: ConfirmedServiceChoice::READ_PROPERTY,
            service_ack: Bytes::from_static(&[0xCA, 0xFE]),
        });
        let mut buf = BytesMut::new();
        encode_apdu(&mut buf, &ack).unwrap();
        net_b
            .send_apdu(&buf, &client_mac, false, NetworkPriority::NORMAL)
            .await
            .unwrap();

        net_b.stop().await.unwrap();
    });

    let result = client
        .confirmed_request(&b_mac, ConfirmedServiceChoice::READ_PROPERTY, &service_data)
        .await;

    assert!(result.is_ok());
    assert_eq!(result.unwrap(), vec![0xCA, 0xFE]);

    b_handle.await.unwrap();
    client.stop().await.unwrap();
}

#[tokio::test]
async fn routed_segmented_request_uses_routed_tsm_key() {
    let client_mac = vec![0x01];
    let router_mac = vec![0x02];
    let remote_network = 100;
    let remote_mac = vec![0x03];
    let (client_transport, mut router_transport) =
        LoopbackTransport::pair(client_mac.clone(), router_mac.clone());
    let mut router_rx = router_transport.start().await.unwrap();

    let mut client = BACnetClient::generic_builder()
        .transport(client_transport)
        .apdu_timeout_ms(2000)
        .max_apdu_length(50)
        .build()
        .await
        .unwrap();

    let service_data: Vec<u8> = (0u8..100).collect();
    let expected_data = service_data.clone();
    let router_mac_for_request = router_mac.clone();
    let remote_mac_for_request = remote_mac.clone();

    let request_task = tokio::spawn(async move {
        let result = client
            .confirmed_request_routed(
                &router_mac_for_request,
                remote_network,
                &remote_mac_for_request,
                ConfirmedServiceChoice::WRITE_PROPERTY,
                &service_data,
            )
            .await;
        client.stop().await.unwrap();
        result
    });

    let mut all_service_data = Vec::new();
    let invoke_id = loop {
        let received = timeout(Duration::from_secs(2), router_rx.recv())
            .await
            .expect("router timed out waiting for routed segment")
            .expect("router channel closed");
        assert_eq!(&received.source_mac[..], &client_mac[..]);

        let npdu = decode_npdu(received.npdu).unwrap();
        let destination = npdu.destination.expect("routed NPDU destination");
        assert_eq!(destination.network, remote_network);
        assert_eq!(&destination.mac_address[..], &remote_mac[..]);

        let decoded = apdu::decode_apdu(npdu.payload).unwrap();
        let Apdu::ConfirmedRequest(req) = decoded else {
            panic!("Expected ConfirmedRequest, got {:?}", decoded);
        };
        assert!(req.segmented, "expected routed request to be segmented");
        let seq = req.sequence_number.unwrap();
        all_service_data.extend_from_slice(&req.service_request);

        let seg_ack = Apdu::SegmentAck(SegmentAckPdu {
            negative_ack: false,
            sent_by_server: true,
            invoke_id: req.invoke_id,
            sequence_number: seq,
            actual_window_size: 1,
        });
        send_routed_response(
            &router_transport,
            &client_mac,
            remote_network,
            &remote_mac,
            seg_ack,
        )
        .await;

        if !req.more_follows {
            break req.invoke_id;
        }
    };

    assert_eq!(all_service_data, expected_data);

    let ack = Apdu::SimpleAck(SimpleAck {
        invoke_id,
        service_choice: ConfirmedServiceChoice::WRITE_PROPERTY,
    });
    send_routed_response(
        &router_transport,
        &client_mac,
        remote_network,
        &remote_mac,
        ack,
    )
    .await;

    let result = request_task.await.unwrap();
    assert!(result.unwrap().is_empty());
    router_transport.stop().await.unwrap();
}

#[tokio::test]
async fn segment_overflow_guard() {
    let mut client = BACnetClient::builder()
        .interface(Ipv4Addr::LOCALHOST)
        .port(0)
        .apdu_timeout_ms(2000)
        .max_apdu_length(50)
        .build()
        .await
        .unwrap();

    let huge_payload = vec![0u8; 257 * 44];
    let fake_mac = vec![10, 99, 99, 99, 0xBA, 0xC0];

    let result = client
        .confirmed_request(
            &fake_mac,
            ConfirmedServiceChoice::READ_PROPERTY,
            &huge_payload,
        )
        .await;

    assert!(
        result.is_err(),
        "expected error for oversized payload, got success"
    );

    client.stop().await.unwrap();
}

#[test]
fn seg_receiver_timeout_is_4s() {
    assert_eq!(SEG_RECEIVER_TIMEOUT, Duration::from_secs(4));
}