Skip to content

Repository files navigation

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:

ServiceExecuteHandle
Who Is / I Amyesyes¹
Who Has / I Haveyes¹yes¹
Time Syncyesyes¹
UTC Time Syncyesyes¹
Read Propertyyesyes¹
Read Property Multipleyesyes¹
Read Rangeyes¹yes¹
Write Propertyyesyes¹
Write Property Multipleyesyes¹
Add List Elementyes¹yes¹
Remove List Elementyes¹yes¹
Create Objectyes¹yes¹
Delete Objectyes¹yes¹
Subscribe COVyes¹yes¹
Subscribe Propertyyes¹yes¹
Atomic Read Fileyes¹yes¹
Atomic Write Fileyes¹yes¹
Reinitialize Deviceyesyes¹
Device Communication Controlyesyes¹
Get Alarm Summaryyes¹yes¹
Get Event Informationyes¹yes¹
Get Enrollment Summaryyes¹yes¹
Acknowledge Alarmyes¹yes¹
Confirmed Event Notificationyes¹yes¹
Unconfirmed Event Notificationyes¹yes¹
Unconfirmed Private Transferyes¹yes¹
Confirmed Private Transferyes¹yes¹

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

Example

constbacnet=require('bacstack');// Initialize BACStackconstclient=newbacnet({adpuTimeout: 6000});// Discover Devicesclient.on('iAm',(device)=>{console.log('address: ',device.address);console.log('deviceId: ',device.deviceId);console.log('maxAdpu: ',device.maxAdpu);console.log('segmentation: ',device.segmentation);console.log('vendorId: ',device.vendorId);});client.whoIs();// Read Device ObjectconstrequestArray=[{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

About

A BACnet protocol stack written in pure JavaScript

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages