bacnet-js / client / 22664488652

85%

push

github

feat: foreign device registration (#74)

## Summary

This PR adds BACnet Foreign Device Registration (FDR) support and
BBMD-based Who-Is discovery to `@bacnet-js/client`, including forwarded
response handling and examples for manual validation.

Fixes #54 

## What changed

- Added `registerForeignDevice(receiver, ttl)` to `BACnetClient`:
  - Sends BVLC `REGISTER_FOREIGN_DEVICE` (`0x05`)
  - Resolves/rejects based on `BVLC_RESULT` from the target BBMD
  - Validates TTL range (`1..65535`)
  - Requires BBMD address format `host:port`
- Serializes parallel registrations per BBMD target to avoid ambiguous
result correlation
- Added `whoIsThroughBBMD(bbmd, options?)` to `BACnetClient`:
- Sends Who-Is wrapped in BVLC `DISTRIBUTE_BROADCAST_TO_NETWORK`
(`0x09`)
- Extended outbound BVLC encode path:
- Added support for `distributeBroadcastToNetwork` receiver flag in
`sendBvlc`
- Extended inbound BVLC handling:
  - Added `BVLC_RESULT` parsing/emission via `bvlcResult` event
  - Added guard to require BVLC-Result payload length before decode
  - Preserved `FORWARDED_NPDU` origin metadata (`forwardedFrom`)
- Improved decode robustness:
- Added guard for invalid BVLC header length (`msgLength <
BVLC_HEADER_LENGTH`)
  - `IAm.decode` now reports correct decoded `len`
- Added examples:
  - `examples/register-foreign-device.ts`
  - `examples/discover-devices-via-bbmd.ts`
- Added/extended tests:
  - Unit coverage for FDR success/NAK/timeout/address validation
- Unit coverage for dedupe + serialized handling of parallel
registrations
- Unit coverage for queued retry behavior after failed prior
registration
  - Unit coverage for BBMD Who-Is (`0x09`)
  - BVLC strict-length behavior test (reject trailing bytes)
  - `IAm` decode-length assertion
  - Improved `register-foreign-device` integration payload assertions

## Type consistency

- Added `BACnetClientEvents.bvlcResult` typing
- Added `BvlcResultPayload` type
- Added `BACNetAddress.distributeBroadcastToNetwork?: boolea... (continued)

1045 of 1543 branches covered (67.73%)

Branch coverage included in aggregate %.

94 of 112 new or added lines in 4 files covered. (83.93%)

5569 of 6224 relevant lines covered (89.48%)

37.4 hits per line