Note: This is an early prototype and shall not be considered as stable. Use it with caution and at your own risk!
Add Node BACstack to your project by using:
npm install --save bacstack
The API documentation is available under fh1ch.github.io/node-bacstack.
The BACNET standard defines a wide variety of services as part of it's specification. While Node BACstack tries to be as complete as possible, following services are already supported at this point in time:
|Who Is / I Am||yes||yes¹|
|Who Has / I Have||yes¹||yes¹|
|UTC Time Sync||yes||yes¹|
|Read Property Multiple||yes||yes¹|
|Write Property Multiple||yes||yes¹|
|Add List Element||yes¹|
|Remove List Element||yes¹|
|Atomic Read File||yes¹||yes¹|
|Atomic Write File||yes¹||yes¹|
|Device Communication Control||yes||yes¹|
|Get Alarm Summary||yes¹|
|Get Event Information||yes¹|
|Get Enrollment Summary|
|Confirmed Event Notification||yes¹|
|Unconfirmed Event Notification||yes¹|
|Unconfirmed Private Transfer|
|Confirmed Private Transfer|
¹ Support implemented as Beta (untested, undocumented, breaking interface)
var bacnet = ;// Initialize BACStackvar client = adpuTimeout: 6000;// Discover Devicesclient;client;// Read Device Objectvar requestArray =objectId: type: 8 instance: 4194303properties: id: 8;client;
Implementing and maintaining a protocol stack is a lot of work, therefore any help is appreciated, from creating issues, to contributing documentation, fixing issues and adding new features.
Please follow the best-practice contribution guidelines as mentioned below when submitting any changes.
This module has a changelog which is automatically generated based on Git commit messages. This mechanism requires that all commit messages comply with the Conventional Changelog. You can check if your commit messages complies with those guidelines by using:
npm run changelog
npm run lint
Testing and Coverage
Testing is done using Mocha and is separated into two
integration. While unit tries to test on function level,
including synthetic decoding and encoding, the integration tests are using real
recorded data and are only mocking the transport layer.
For both sets, the test-coverage is calculated using Istanbul. Running the tests and calculating the coverage can be done locally by executing:
npm run testnpm run integration
It is expected that new features or fixes do not negatively impact the test results or the coverage.
The API documentation is generated using JSDoc and relies on in-line JSDoc3 syntax. The documentation can also be built locally by executing:
npm run docs
It is expected that new features or changes are reflected in the documentation as well.
Copyright (c) 2017 Fabio Huser firstname.lastname@example.org