Node BACstack

A BACnet protocol stack written in pure JavaScript. BACnet is a protocol to interact with building automation devices defined by ASHRAE.

Note: This is an early prototype and shall not be considered as stable. Use it with caution and at your own risk!

Usage

Add Node BACstack to your project by using:

$ npm install --save bacstack

The API documentation is available under fh1ch.github.io/node-bacstack.

Features

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:

| Service | Execute | |------------------------------|:-------:| | Who Is | yes | | Time Sync | yes | | UTC Time Sync | yes | | Read Property | yes | | Read Property Multiple | yes | | Write Property | yes | | Write Property Multiple | yes | | Reinitialize Device | yes | | Device Communication Control | yes |

Example

var bacnet = require('bacstack');

// Initialize BACStack
var client = new bacnet({adpuTimeout: 6000});

// Discover Devices
client.on('iAm', function(address, deviceId, maxAdpu, segmentation, vendorId) {
  console.log('address: ', address, ' - deviceId: ', deviceId, ' - maxAdpu: ', maxAdpu, ' - segmentation: ', segmentation, ' - vendorId: ', vendorId);
});
client.whoIs();

// Read Device Object
var requestArray = [
  {objectIdentifier: {type: 8, instance: 4194303}, propertyReferences: [{propertyIdentifier: 8}]}
];
client.readPropertyMultiple('192.168.1.43', requestArray, function(err, value) {
  console.log('value: ', value);
});

Contributing

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.

Code Style

This module uses the Google JavaScript Code-Style and enforces it using JSCS as additional linter beneath JSHint. You can test if your changes comply with the code style by executing:

$ npm run lint

Testing and Coverage

Testing is done using Mocha and is separated into two sets, unit and 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 test
$ npm run integration

It is expected that new features or fixes do not negatively impact the test results or the coverage.

Documentation

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.

License

The MIT License

Copyright (c) 2017 Fabio Huser [email protected]