prisme-flow
Version:
prisme platform flow engine
104 lines (73 loc) • 3.4 kB
Markdown
A BACnet protocol stack written in pure JavaScript. BACnet is a protocol to
interact with building automation devices defined by ASHRAE.
[](http://badge.fury.io/js/bacstack)
[](https://travis-ci.org/fh1ch/node-bacstack)
[](https://coveralls.io/r/fh1ch/node-bacstack?branch=master)
[](https://codeclimate.com/github/fh1ch/node-bacstack)
[](https://david-dm.org/fh1ch/node-bacstack)
> **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:
``` sh
$ npm install --save bacstack
```
The API documentation is available under **[fh1ch.github.io/node-bacstack](https://fh1ch.github.io/node-bacstack)**.
``` js
var bacnet = require('bacstack');
// Initialize BACStack
var client = 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);
});
```
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 uses the [Google JavaScript Code-Style](https://google.github.io/styleguide/javascriptguide.xml)
and enforces it using [JSCS](http://jscs.info/) as additional linter beneath
[](http://jshint.com/). You can test if your changes comply with the code
style by executing:
``` sh
$ npm run lint
```
Testing is done using [Mocha](https://mochajs.org/) 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](https://istanbul.js.org/).
Running the tests and calculating the coverage can be done locally by executing:
``` sh
$ npm run test
$ npm 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](http://usejsdoc.org/) and
relies on in-line JSDoc3 syntax. The documentation can also be built locally by
executing:
``` sh
$ npm run docs
```
It is expected that new features or changes are reflected in the documentation
as well.
[](http://opensource.org/licenses/MIT)
Copyright (c) 2017 Fabio Huser <fabio@fh1.ch>