node-bacnet

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Global - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <link type="text/css" rel="stylesheet" href="https://fonts.googleapis.com/css?family=Montserrat:400,700"> <link type="text/css" rel="stylesheet" href="styles/prettify.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc.css"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav > <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="bacnet.html">bacnet</a><ul class='methods'><li data-type='method'><a href="bacnet.html#.close">close</a></li><li data-type='method'><a href="bacnet.html#.confirmedCOVNotification">confirmedCOVNotification</a></li><li data-type='method'><a href="bacnet.html#.deviceCommunicationControl">deviceCommunicationControl</a></li><li data-type='method'><a href="bacnet.html#.iAmResponse">iAmResponse</a></li><li data-type='method'><a href="bacnet.html#.readProperty">readProperty</a></li><li data-type='method'><a href="bacnet.html#.readPropertyMultiple">readPropertyMultiple</a></li><li data-type='method'><a href="bacnet.html#.readPropertyResponse">readPropertyResponse</a></li><li data-type='method'><a href="bacnet.html#.reinitializeDevice">reinitializeDevice</a></li><li data-type='method'><a href="bacnet.html#.resultResponse">resultResponse</a></li><li data-type='method'><a href="bacnet.html#.timeSync">timeSync</a></li><li data-type='method'><a href="bacnet.html#.timeSyncUTC">timeSyncUTC</a></li><li data-type='method'><a href="bacnet.html#.unconfirmedCOVNotification">unconfirmedCOVNotification</a></li><li data-type='method'><a href="bacnet.html#.whoIs">whoIs</a></li><li data-type='method'><a href="bacnet.html#.writeProperty">writeProperty</a></li><li data-type='method'><a href="bacnet.html#.writePropertyMultiple">writePropertyMultiple</a></li></ul></li><li><a href="Client.html">Client</a><ul class='methods'><li data-type='method'><a href="Client.html#.createBitstring">createBitstring</a></li><li data-type='method'><a href="Client.html#acknowledgeAlarm">acknowledgeAlarm</a></li><li data-type='method'><a href="Client.html#addListElement">addListElement</a></li><li data-type='method'><a href="Client.html#confirmedEventNotification">confirmedEventNotification</a></li><li data-type='method'><a href="Client.html#confirmedPrivateTransfer">confirmedPrivateTransfer</a></li><li data-type='method'><a href="Client.html#createObject">createObject</a></li><li data-type='method'><a href="Client.html#deleteObject">deleteObject</a></li><li data-type='method'><a href="Client.html#errorResponse">errorResponse</a></li><li data-type='method'><a href="Client.html#getAlarmSummary">getAlarmSummary</a></li><li data-type='method'><a href="Client.html#getEnrollmentSummary">getEnrollmentSummary</a></li><li data-type='method'><a href="Client.html#getEventInformation">getEventInformation</a></li><li data-type='method'><a href="Client.html#iHaveResponse">iHaveResponse</a></li><li data-type='method'><a href="Client.html#readFile">readFile</a></li><li data-type='method'><a href="Client.html#readRange">readRange</a></li><li data-type='method'><a href="Client.html#removeListElement">removeListElement</a></li><li data-type='method'><a href="Client.html#sendBvlc">sendBvlc</a></li><li data-type='method'><a href="Client.html#simpleAckResponse">simpleAckResponse</a></li><li data-type='method'><a href="Client.html#subscribeCov">subscribeCov</a></li><li data-type='method'><a href="Client.html#subscribeProperty">subscribeProperty</a></li><li data-type='method'><a href="Client.html#unconfirmedEventNotification">unconfirmedEventNotification</a></li><li data-type='method'><a href="Client.html#unconfirmedPrivateTransfer">unconfirmedPrivateTransfer</a></li><li data-type='method'><a href="Client.html#writeFile">writeFile</a></li></ul></li></ul><h3>Events</h3><ul><li><a href="bacnet.html#.event:error">error</a></li><li><a href="bacnet.html#.event:iAm">iAm</a></li><li><a href="bacnet.html#.event:timeSync">timeSync</a></li><li><a href="bacnet.html#.event:whoIs">whoIs</a></li></ul><h3>Global</h3><ul><li><a href="global.html#ApplicationTag">ApplicationTag</a></li><li><a href="global.html#EnableDisable">EnableDisable</a></li><li><a href="global.html#MaxApduLengthAccepted">MaxApduLengthAccepted</a></li><li><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></li><li><a href="global.html#ReinitializedState">ReinitializedState</a></li><li><a href="global.html#usc">usc</a></li></ul> </nav> <div id="main"> <h1 class="page-title">Global</h1> <section> <header> <h2> </h2> </header> <article> <div class="container-overview"> <dl class="details"> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="ApplicationTag"><span class="type-signature">(readonly) </span>ApplicationTag<span class="type-signature"> :<a href="global.html#ApplicationTag">ApplicationTag</a></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enum.js.html">enum.js</a>, <a href="enum.js.html#line2149">line 2149</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>NULL</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>BOOLEAN</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>UNSIGNED_INTEGER</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SIGNED_INTEGER</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>REAL</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DOUBLE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OCTET_STRING</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>CHARACTER_STRING</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>BIT_STRING</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>ENUMERATED</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DATE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>TIME</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OBJECTIDENTIFIER</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>EMPTYLIST</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>WEEKNDAY</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DATERANGE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DATETIME</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>TIMESTAMP</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>ERROR</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DEVICE_OBJECT_PROPERTY_REFERENCE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DEVICE_OBJECT_REFERENCE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OBJECT_PROPERTY_REFERENCE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DESTINATION</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>RECIPIENT</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>COV_SUBSCRIPTION</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>CALENDAR_ENTRY</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>WEEKLY_SCHEDULE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SPECIAL_EVENT</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>READ_ACCESS_SPECIFICATION</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>READ_ACCESS_RESULT</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>LIGHTING_COMMAND</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>CONTEXT_SPECIFIC_DECODED</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>CONTEXT_SPECIFIC_ENCODED</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>LOG_RECORD</code></td> <td class="type"> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="global.html#ApplicationTag">ApplicationTag</a></span> </li> </ul> <h4 class="name" id="EnableDisable"><span class="type-signature">(readonly) </span>EnableDisable<span class="type-signature"> :<a href="global.html#EnableDisable">EnableDisable</a></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enum.js.html">enum.js</a>, <a href="enum.js.html#line2246">line 2246</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>ENABLE</code></td> <td class="type"> <span class="param-type"><a href="global.html#EnableDisable">EnableDisable</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DISABLE</code></td> <td class="type"> <span class="param-type"><a href="global.html#EnableDisable">EnableDisable</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>DISABLE_INITIATION</code></td> <td class="type"> <span class="param-type"><a href="global.html#EnableDisable">EnableDisable</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="global.html#EnableDisable">EnableDisable</a></span> </li> </ul> <h4 class="name" id="MaxApduLengthAccepted"><span class="type-signature">(readonly) </span>MaxApduLengthAccepted<span class="type-signature"> :<a href="global.html#MaxApduLengthAccepted">MaxApduLengthAccepted</a></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enum.js.html">enum.js</a>, <a href="enum.js.html#line2259">line 2259</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>OCTETS_50</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxApduLengthAccepted">MaxApduLengthAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OCTETS_128</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxApduLengthAccepted">MaxApduLengthAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OCTETS_206</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxApduLengthAccepted">MaxApduLengthAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OCTETS_480</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxApduLengthAccepted">MaxApduLengthAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OCTETS_1024</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxApduLengthAccepted">MaxApduLengthAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OCTETS_1476</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxApduLengthAccepted">MaxApduLengthAccepted</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="global.html#MaxApduLengthAccepted">MaxApduLengthAccepted</a></span> </li> </ul> <h4 class="name" id="MaxSegmentsAccepted"><span class="type-signature">(readonly) </span>MaxSegmentsAccepted<span class="type-signature"> :<a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enum.js.html">enum.js</a>, <a href="enum.js.html#line2275">line 2275</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>SEGMENTS_0</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SEGMENTS_2</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SEGMENTS_4</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SEGMENTS_8</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SEGMENTS_16</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SEGMENTS_32</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SEGMENTS_64</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SEGMENTS_65</code></td> <td class="type"> <span class="param-type"><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="global.html#MaxSegmentsAccepted">MaxSegmentsAccepted</a></span> </li> </ul> <h4 class="name" id="ReinitializedState"><span class="type-signature">(readonly) </span>ReinitializedState<span class="type-signature"> :<a href="global.html#ReinitializedState">ReinitializedState</a></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enum.js.html">enum.js</a>, <a href="enum.js.html#line2443">line 2443</a> </li></ul></dd> </dl> <h5 class="subsection-title">Properties:</h5> <table class="props"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>COLDSTART</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReinitializedState">ReinitializedState</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>WARMSTART</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReinitializedState">ReinitializedState</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>STARTBACKUP</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReinitializedState">ReinitializedState</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>ENDBACKUP</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReinitializedState">ReinitializedState</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>STARTRESTORE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReinitializedState">ReinitializedState</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>ENDRESTORE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReinitializedState">ReinitializedState</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>ABORTRESTORE</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReinitializedState">ReinitializedState</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>ACTIVATE_CHANGES</code></td> <td class="type"> <span class="param-type"><a href="global.html#ReinitializedState">ReinitializedState</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="global.html#ReinitializedState">ReinitializedState</a></span> </li> </ul> <h4 class="name" id="usc"><span class="type-signature">(constant) </span>usc<span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="enum.js.html">enum.js</a>, <a href="enum.js.html#line28">line 28</a> </li></ul></dd> </dl> <div class="description"> Turn an enum into a string suitable for debugging. If value is not found in the enum the value itself is returned as string </div> <h5>Example</h5> <pre class="prettyprint"><code>const s = bacnet.enum.getEnumName( bacnet.enum.PropertyIdentifier, bacnet.enum.PropertyIdentifier.PRESENT_VALUE ); console.log(s); // "PRESENT_VALUE(85)"</code></pre> </article> </section> </div> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Tue Jun 02 2020 20:24:55 GMT+0200 (Central European Summer Time) using the <a href="https://github.com/mochajs/mocha-docdash">@mocha/docdash</a> theme. </footer> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>