npm - @bitpoolos/edge-bacnet - Versions diffs - 1.0.6 → 1.1.0 - Mend

@bitpoolos/edge-bacnet 1.0.6 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (181) hide show

package/resources/node-bacnet/docs/services_who-is.js.html ADDED Viewed

@@ -0,0 +1,138 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <title>services/who-is.js - 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">services/who-is.js</h1>
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>/**
+ * The whoIs event represents the request for an IAm reponse to detect all
+ * devices in a BACNET network.
+ *
+ * @event bacnet.whoIs
+ * @param {number=} lowLimit - The lowest BACnet ID being queried.
+ * @param {number=} highLimit - The highest BACnet ID being queried.
+ *
+ * @example
+ * const bacnet = require('node-bacnet');
+ * const client = new bacnet();
+ *
+ * client.on('whoIs', (msg) => {
+ *   console.log(
+ *     'address: ', msg.header.address,
+ *     ' - lowLimit: ', msg.payload.lowLimit,
+ *     ' - highLimit: ', msg.payload.highLimit
+ *   );
+ * });
+ */
+'use strict';
+const baAsn1      = require('../asn1');
+const baEnum      = require('../enum');
+module.exports.encode = (buffer, lowLimit, highLimit) => {
+  if ((lowLimit >= 0) &amp;&amp; (lowLimit &lt;= baEnum.ASN1_MAX_INSTANCE) &amp;&amp; (highLimit >= 0) &amp;&amp; (highLimit &lt;= baEnum.ASN1_MAX_INSTANCE)) {
+    baAsn1.encodeContextUnsigned(buffer, 0, lowLimit);
+    baAsn1.encodeContextUnsigned(buffer, 1, highLimit);
+  }
+};
+module.exports.decode = (buffer, offset, apduLen) => {
+  let len = 0;
+  let value = {};
+  if (apduLen &lt;= 0) {
+    return {}; // TODO: why??
+  }
+  let result = baAsn1.decodeTagNumberAndValue(buffer, offset + len);
+  len += result.len;
+  if (result.tagNumber !== 0) {
+    return undefined;
+  }
+  if (apduLen &lt;= len) {
+    return undefined;
+  }
+  let decodedValue = baAsn1.decodeUnsigned(buffer, offset + len, result.value);
+  len += decodedValue.len;
+  if (decodedValue.value &lt;= baEnum.ASN1_MAX_INSTANCE) {
+    value.lowLimit = decodedValue.value;
+  }
+  if (apduLen &lt;= len) {
+    return undefined;
+  }
+  result = baAsn1.decodeTagNumberAndValue(buffer, offset + len);
+  len += result.len;
+  if (result.tagNumber !== 1) {
+    return undefined;
+  }
+  if (apduLen &lt;= len) {
+    return undefined;
+  }
+  decodedValue = baAsn1.decodeUnsigned(buffer, offset + len, result.value);
+  len += decodedValue.len;
+  if (decodedValue.value &lt;= baEnum.ASN1_MAX_INSTANCE) {
+    value.highLimit = decodedValue.value;
+  }
+  value.len = len;
+  return value;
+};
+</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>