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.
[](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)
## Usage
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)**.
### 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](https://fh1ch.github.io/node-bacstack/bacstack.html#.whoIs) | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.event:whoIs) |
| I Am | yes¹ | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.event:iAm) |
| Who Has | yes¹ | yes¹ |
| I Have | yes¹ | yes¹ |
| Time Sync | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.timeSync) | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.event:timeSync) |
| UTC Time Sync | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.timeSyncUTC) | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.event:timeSyncUTC) |
| Read Property | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.readProperty) | yes¹ |
| Read Property Multiple | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.readPropertyMultiple) | yes¹ |
| Read Range | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.readRange) | yes¹ |
| Write Property | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.writeProperty) | yes¹ |
| Write Property Multiple | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.writePropertyMultiple) | yes¹ |
| Add List Element | yes¹ | yes¹ |
| Remove List Element | yes¹ | yes¹ |
| Create Object | yes¹ | yes¹ |
| Delete Object | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.deleteObject) | yes¹ |
| Subscribe COV | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.subscribeCOV) | yes¹ |
| Subscribe Property | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.subscribeProperty) | yes¹ |
| Atomic Read File | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.readFile) | yes¹ |
| Atomic Write File | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.writeFile) | yes¹ |
| Reinitialize Device | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.reinitializeDevice) | yes¹ |
| Device Communication Control | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.deviceCommunicationControl) | yes¹ |
| Get Alarm Summary² | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.getAlarmSummary) | yes¹ |
| Get Event Information | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.getEventInformation) | yes¹ |
| Get Enrollment Summary² | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.getEnrollmentSummary) | yes¹ |
| Acknowledge Alarm | yes¹ | yes¹ |
| Confirmed Event Notification | yes¹ | yes¹ |
| Unconfirmed Event Notification | yes¹ | yes¹ |
| Unconfirmed Private Transfer | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.unconfirmedPrivateTransfer) | yes¹ |
| Confirmed Private Transfer | [yes](https://fh1ch.github.io/node-bacstack/bacstack.html#.confirmedPrivateTransfer) | yes¹ |
¹ Support implemented as Beta (untested, undocumented, breaking interface)
² Deprecated BACnet function, available for backwards compatibility
### Example
``` js
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](CONTRIBUTING.md) when submitting any
changes.
## License
[The MIT License](http://opensource.org/licenses/MIT)
Copyright (c) 2017-2021 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).