A BACnet protocol stack written in pure JavaScript
Clone or download
fh1ch Merge pull request #121 from fh1ch/chore/npm-version-bump
chore(npm): bump all dependencies to latest version
Latest commit 0458708 Sep 25, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github docs(faq): add frequently asked questions file Sep 25, 2018
lib fix(asn1): correct error object structure Sep 25, 2018
test fix(asn1): correct error object structure Sep 25, 2018
.codeclimate.yml chore(codeclimate): add sources to codeclimate rating Aug 20, 2017
.dockerignore test(compliance): add Docker test setup using C++ bacnet-stack Apr 2, 2018
.editorconfig feat: create initial project structure Jan 29, 2017
.gitignore feat: add JSDoc inline documentation and gh-page publishing May 27, 2017
.jscsrc chore(jscs): enforcing camel-case identifier via linter Jul 12, 2017
.jshintrc test(compliance): add Docker test setup using C++ bacnet-stack Apr 2, 2018
.travis.yml test(compliance): add Docker test setup using C++ bacnet-stack Apr 2, 2018
CHANGELOG.md release version 0.0.1-beta.13 Dec 24, 2017
CODE_OF_CONDUCT.md docs(code-of-conduct): add Code of Conduct Dec 30, 2017
CONTRIBUTING.md test(compliance): add Docker test setup using C++ bacnet-stack Apr 2, 2018
Dockerfile test(compliance): add Docker test setup using C++ bacnet-stack Apr 2, 2018
FAQ.md docs(faq): add frequently asked questions file Sep 25, 2018
LICENSE.md chore: bump copyright year to 2018 Dec 31, 2017
README.md docs(readme): drop prototype / early development warning Sep 25, 2018
docker-compose.yml test(compliance): add Docker test setup using C++ bacnet-stack Apr 2, 2018
index.js refactor: rework whole project to utilize ES6 Dec 30, 2017
package.json chore(npm): bump all dependencies to latest version Sep 25, 2018
yarn.lock chore(npm): bump all dependencies to latest version Sep 25, 2018

README.md

Node BACstack

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

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 Handle
Who Is yes yes
I Am yes¹ yes
Who Has yes¹ yes¹
I Have yes¹ yes¹
Time Sync yes yes
UTC Time Sync yes yes
Read Property yes yes¹
Read Property Multiple yes yes¹
Read Range yes¹ yes¹
Write Property yes yes¹
Write Property Multiple yes yes¹
Add List Element yes¹ yes¹
Remove List Element yes¹ yes¹
Create Object yes¹ yes¹
Delete Object yes¹ yes¹
Subscribe COV yes¹ yes¹
Subscribe Property yes¹ yes¹
Atomic Read File yes¹ yes¹
Atomic Write File yes¹ yes¹
Reinitialize Device yes yes¹
Device Communication Control yes yes¹
Get Alarm Summary yes¹ yes¹
Get Event Information yes¹ yes¹
Get Enrollment Summary yes¹ yes¹
Acknowledge Alarm yes¹ yes¹
Confirmed Event Notification yes¹ yes¹
Unconfirmed Event Notification yes¹ yes¹
Unconfirmed Private Transfer yes¹ yes¹
Confirmed Private Transfer yes¹ yes¹

¹ Support implemented as Beta (untested, undocumented, breaking interface)

Example

const bacnet = require('bacstack');

// Initialize BACStack
const client = new bacnet({apduTimeout: 6000});

// Discover Devices
client.on('iAm', (device) => {
  console.log('address: ', device.address);
  console.log('deviceId: ', device.deviceId);
  console.log('maxApdu: ', device.maxApdu);
  console.log('segmentation: ', device.segmentation);
  console.log('vendorId: ', device.vendorId);
});
client.whoIs();

// Read Device Object
const requestArray = [{
  objectId: {type: 8, instance: 4194303},
  properties: [{id: 8}]
}];
client.readPropertyMultiple('192.168.1.43', requestArray, (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 Contribution Guide when submitting any changes.

License

The MIT License

Copyright (c) 2017-2018 Fabio Huser fabio@fh1.ch

Note: This is not an official product of the BACnet Advocacy Group. BACnet® is a registered trademark of American Society of Heating, Refrigerating and Air-Conditioning Engineers (ASHRAE).