<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>services/i-am.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/i-am.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>/**
* The iAm event represents the response to a whoIs request to detect all
* devices in a BACNET network.
*
* @event bacnet.iAm
* @param {number} deviceId - The BACNET device-id of the detected device.
* @param {number} maxApdu - The max APDU size the detected device supports.
* @param {number} segmentation - The type of segmentation the detected device supports.
* @param {number} vendorId - The BACNET vendor-id of the detected device.
*
* @example
* const bacnet = require('node-bacnet');
* const client = new bacnet();
*
* client.on('iAm', (msg) => {
* console.log(
* 'address: ', msg.header.address,
* ' - deviceId: ', msg.payload.deviceId,
* ' - maxApdu: ', msg.payload.maxApdu,
* ' - segmentation: ', msg.payload.segmentation,
* ' - vendorId: ', msg.payload.vendorId
* );
* });
*/
'use strict';
const baAsn1 = require('../asn1');
const baEnum = require('../enum');
module.exports.encode = (buffer, deviceId, maxApdu, segmentation, vendorId) => {
baAsn1.encodeApplicationObjectId(buffer, baEnum.ObjectType.DEVICE, deviceId);
baAsn1.encodeApplicationUnsigned(buffer, maxApdu);
baAsn1.encodeApplicationEnumerated(buffer, segmentation);
baAsn1.encodeApplicationUnsigned(buffer, vendorId);
};
module.exports.decode = (buffer, offset) => {
let result;
let apduLen = 0;
const orgOffset = offset;
result = baAsn1.decodeTagNumberAndValue(buffer, offset + apduLen);
apduLen += result.len;
if (result.tagNumber !== baEnum.ApplicationTag.OBJECTIDENTIFIER) {
return undefined;
}
result = baAsn1.decodeObjectId(buffer, offset + apduLen);
apduLen += result.len;
if (result.objectType !== baEnum.ObjectType.DEVICE) {
return undefined;
}
const deviceId = result.instance;
result = baAsn1.decodeTagNumberAndValue(buffer, offset + apduLen);
apduLen += result.len;
if (result.tagNumber !== baEnum.ApplicationTag.UNSIGNED_INTEGER) {
return undefined;
}
result = baAsn1.decodeUnsigned(buffer, offset + apduLen, result.value);
apduLen += result.len;
const maxApdu = result.value;
result = baAsn1.decodeTagNumberAndValue(buffer, offset + apduLen);
apduLen += result.len;
if (result.tagNumber !== baEnum.ApplicationTag.ENUMERATED) {
return undefined;
}
result = baAsn1.decodeEnumerated(buffer, offset + apduLen, result.value);
apduLen += result.len;
if (result.value > baEnum.Segmentation.NO_SEGMENTATION) {
return undefined;
}
const segmentation = result.value;
result = baAsn1.decodeTagNumberAndValue(buffer, offset + apduLen);
apduLen += result.len;
if (result.tagNumber !== baEnum.ApplicationTag.UNSIGNED_INTEGER) {
return undefined;
}
result = baAsn1.decodeUnsigned(buffer, offset + apduLen, result.value);
apduLen += result.len;
if (result.value > 0xFFFF) {
return undefined;
}
const vendorId = result.value;
return {
len: offset - orgOffset,
deviceId,
maxApdu,
segmentation,
vendorId
};
};
</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>