isatdatapro-microservices

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Module: messageCodecs/coreModem</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script> <script src="scripts/jquery.min.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css"> <link type="text/css" rel="stylesheet" href="styles/jaguar.css"> <script> var config = {"monospaceLinks":false,"cleverLinks":true,"default":{}}; </script> </head> <body> <div id="wrap" class="clearfix"> <div class="navigation"> <h3 class="applicationName"><a href="index.html"></a></h3> <div class="search"> <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations"> </div> <ul class="list"> <li class="item" data-name="ApiCallLog"> <span class="title"> <a href="ApiCallLog.html">ApiCallLog</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Field"> <span class="title"> <a href="Field.html">Field</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Mailbox"> <span class="title"> <a href="Mailbox.html">Mailbox</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Mailbox#passwordGet"><a href="Mailbox.html#passwordGet">passwordGet</a></li> <li data-name="Mailbox#passwordSet"><a href="Mailbox.html#passwordSet">passwordSet</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Message"> <span class="title"> <a href="Message.html">Message</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Message#getCodecMessageId"><a href="Message.html#getCodecMessageId">getCodecMessageId</a></li> <li data-name="Message#getCodecServiceId"><a href="Message.html#getCodecServiceId">getCodecServiceId</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="MessageForward"> <span class="title"> <a href="MessageForward.html">MessageForward</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="MessageForward#getStateName"><a href="MessageForward.html#getStateName">getStateName</a></li> <li data-name="MessageForward#getStateReason"><a href="MessageForward.html#getStateReason">getStateReason</a></li> <li data-name="MessageForward#submit"><a href="MessageForward.html#submit">submit</a></li> <li data-name="MessageForward#updateStatus"><a href="MessageForward.html#updateStatus">updateStatus</a></li> <li data-name="MessageForward#wakeupPeriodEnum"><a href="MessageForward.html#wakeupPeriodEnum">wakeupPeriodEnum</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="MessageReturn"> <span class="title"> <a href="MessageReturn.html">MessageReturn</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Mobile"> <span class="title"> <a href="Mobile.html">Mobile</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="module:repositories/azureCosmosRepository~DatabaseContext"> <span class="title"> <a href="module-repositories_azureCosmosRepository-DatabaseContext.html">module:repositories/azureCosmosRepository~DatabaseContext</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="module:repositories/azureCosmosRepository~DatabaseContext#close"><a href="module-repositories_azureCosmosRepository-DatabaseContext.html#close">close</a></li> <li data-name="module:repositories/azureCosmosRepository~DatabaseContext#delete"><a href="module-repositories_azureCosmosRepository-DatabaseContext.html#delete">delete</a></li> <li data-name="module:repositories/azureCosmosRepository~DatabaseContext#find"><a href="module-repositories_azureCosmosRepository-DatabaseContext.html#find">find</a></li> <li data-name="module:repositories/azureCosmosRepository~DatabaseContext#initialize"><a href="module-repositories_azureCosmosRepository-DatabaseContext.html#initialize">initialize</a></li> <li data-name="module:repositories/azureCosmosRepository~DatabaseContext#upsert"><a href="module-repositories_azureCosmosRepository-DatabaseContext.html#upsert">upsert</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="module:repositories/mysqlRepository~DatabaseContext"> <span class="title"> <a href="module-repositories_mysqlRepository-DatabaseContext.html">module:repositories/mysqlRepository~DatabaseContext</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="module:repositories/mysqlRepository~DatabaseContext#close"><a href="module-repositories_mysqlRepository-DatabaseContext.html#close">close</a></li> <li data-name="module:repositories/mysqlRepository~DatabaseContext#delete"><a href="module-repositories_mysqlRepository-DatabaseContext.html#delete">delete</a></li> <li data-name="module:repositories/mysqlRepository~DatabaseContext#find"><a href="module-repositories_mysqlRepository-DatabaseContext.html#find">find</a></li> <li data-name="module:repositories/mysqlRepository~DatabaseContext#initialize"><a href="module-repositories_mysqlRepository-DatabaseContext.html#initialize">initialize</a></li> <li data-name="module:repositories/mysqlRepository~DatabaseContext#upsert"><a href="module-repositories_mysqlRepository-DatabaseContext.html#upsert">upsert</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="Payload"> <span class="title"> <a href="Payload.html">Payload</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> <span class="subtitle">Methods</span> <li data-name="Payload#addField"><a href="Payload.html#addField">addField</a></li> </ul> <ul class="events itemMembers"> </ul> </li> <li class="item" data-name="SatelliteGateway"> <span class="title"> <a href="SatelliteGateway.html">SatelliteGateway</a> </span> <ul class="members itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="typedefs itemMembers"> </ul> <ul class="methods itemMembers"> </ul> <ul class="events itemMembers"> </ul> </li> </ul> </div> <div class="main"> <h1 class="page-title" data-filename="module-messageCodecs_coreModem.html">Module: messageCodecs/coreModem</h1> <section> <header> <h2> messageCodecs/coreModem </h2> </header> <article> <div class="container-overview"> <div class="description"><p>Core Modem Codec module</p></div> <dl class="details"> </dl> </div> <h3 class="subsection-title">Methods</h3> <dl> <dt> <div class="nameContainer"> <h4 class="name" id="~commandGetBroadcastIds"> <span class="type-signature ">inner</span>commandGetBroadcastIds<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MessageForward.html">MessageForward</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 872 </div> </div> </dt> <dd> <div class="description"> <p>Gets provisioned Broadcast IDs</p> </div> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="MessageForward.html">MessageForward</a> </td> <td class="description last">The forward message</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~commandGetLastRxInfo"> <span class="type-signature ">inner</span>commandGetLastRxInfo<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MessageForward.html">MessageForward</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 811 </div> </div> </dt> <dd> <div class="description"> <p>Gets modem last receive information</p> </div> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="MessageForward.html">MessageForward</a> </td> <td class="description last">The message</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~commandGetLocation"> <span class="type-signature ">inner</span>commandGetLocation<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 791 </div> </div> </dt> <dd> <div class="description"> <p>Returns payload for location request</p> </div> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Object </td> <td class="description last">payload</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~commandGetModemConfiguration"> <span class="type-signature ">inner</span>commandGetModemConfiguration<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MessageForward.html">MessageForward</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 801 </div> </div> </dt> <dd> <div class="description"> <p>Gets modem configuration</p> </div> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="MessageForward.html">MessageForward</a> </td> <td class="description last">The message</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~commandGetRxMetrics"> <span class="type-signature ">inner</span>commandGetRxMetrics<span class="signature">(<span class="optional">metricsPeriod</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MessageForward.html">MessageForward</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 823 </div> </div> </dt> <dd> <div class="description"> <p>Returns a JSON payload to query modem Transmit metrics</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>metricsPeriod</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'LastPartialMinute' </td> <td class="description last"> <span class="optional">optional</span> </td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="MessageForward.html">MessageForward</a> </td> <td class="description last">The forward message</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~commandGetTxMetrics"> <span class="type-signature ">inner</span>commandGetTxMetrics<span class="signature">(<span class="optional">metricsPeriod</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MessageForward.html">MessageForward</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 842 </div> </div> </dt> <dd> <div class="description"> <p>Returns a JSON payload to query modem Transmit metrics</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>metricsPeriod</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="default"> 'LastPartialMinute' </td> <td class="description last"> <span class="optional">optional</span> </td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="MessageForward.html">MessageForward</a> </td> <td class="description last">The forward message</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~commandModemPing"> <span class="type-signature ">inner</span>commandModemPing<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MessageForward.html">MessageForward</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 860 </div> </div> </dt> <dd> <div class="description"> <p>Returns payload for a modem ping request</p> </div> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="MessageForward.html">MessageForward</a> </td> <td class="description last">The forward message</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~commandMute"> <span class="type-signature ">inner</span>commandMute<span class="signature">(muteFlag)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MessageForward.html">MessageForward</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 779 </div> </div> </dt> <dd> <div class="description"> <p>Mutes or unmutes the modem transmitter</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>muteFlag</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="description last"> <p>Set or clear transmit mute</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="MessageForward.html">MessageForward</a> </td> <td class="description last">The forward message</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~commandReset"> <span class="type-signature ">inner</span>commandReset<span class="signature">(<span class="optional">resetType</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MessageForward.html">MessageForward</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 696 </div> </div> </dt> <dd> <div class="description"> <p>Encodes the modem reset message based on the reset type</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Default</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>resetType</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">number</span> </td> <td class="default"> 'ModemFlush' </td> <td class="description last"> <span class="optional">optional</span> </td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Throws:</h5> <dl> <dt> <div class="param-desc"> <p>on invalid resetType</p> </div> </dt> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span> </dd> </dl> </dt> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="MessageForward.html">MessageForward</a> </td> <td class="description last">Message and raw payload number array</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~commandSetMobileWakeupPeriod"> <span class="type-signature ">inner</span>commandSetMobileWakeupPeriod<span class="signature">(mobileWakeupPeriod)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MessageForward.html">MessageForward</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 730 </div> </div> </dt> <dd> <div class="description"> <p>Returns a setWakeupPeriod message</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>mobileWakeupPeriod</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">number</span> </td> <td class="description last"> <p>A valid wakeupPeriod</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Throws:</h5> <dl> <dt> <div class="param-desc"> <p>if mobileWakeupPeriod is invalid</p> </div> </dt> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span> </dd> </dl> </dt> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="MessageForward.html">MessageForward</a> </td> <td class="description last">The forward message</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~getMetricsPeriod"> <span class="type-signature ">inner</span>getMetricsPeriod<span class="signature">(periodCode)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 394 </div> </div> </dt> <dd> <div class="description"> <p>Returns a string value of the metrics period, since it may not be an integer (e.g. 'partial minute' is non-specific)</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>periodCode</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">number</span> </td> <td class="description last"> <p>The period over which metrics were calculated by the modem</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Throws:</h5> <dl> <dt> <div class="param-desc"> <p>if periodCode invalid</p> </div> </dt> <dt> <dl> <dt> Type </dt> <dd> <span class="param-type">Error</span> </dd> </dl> </dt> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> string </td> <td class="description last">the enumerated period</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~handleUnknownField"> <span class="type-signature ">inner</span>handleUnknownField<span class="signature">(fieldName, messageId)</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 63 </div> </div> </dt> <dd> <div class="description"> <p>Logs a warning for parsing unknown field names</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>fieldName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>The field name</p></td> </tr> <tr> <td class="name"><code>messageId</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"> <p>The message ID</p></td> </tr> </tbody> </table> <dl class="details"> </dl> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~parseCoreModem"> <span class="type-signature ">inner</span>parseCoreModem<span class="signature">(message)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 74 </div> </div> </dt> <dd> <div class="description"> <p>Parses Inmarsat-defined standard modem Mobile-Originated messages and emits various events</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>message</code></td> <td class="type"> <span class="param-type"><a href="MessageReturn.html">MessageReturn</a></span> </td> <td class="description last"> <p>The message with metadata</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Object </td> <td class="description last">mobile metadata</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~pingTime"> <span class="type-signature ">inner</span>pingTime<span class="signature">(timestamp)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 573 </div> </div> </dt> <dd> <div class="description"> <p>Returns the converted pingTime field value from timestamp</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>timestamp</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"> <p>datestamp</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> number </td> <td class="description last"></td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~populateMobile"> <span class="type-signature ">inner</span>populateMobile<span class="signature">(message)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Mobile.html">Mobile</a>}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 45 </div> </div> </dt> <dd> <div class="description"> <p>Sets up mobile metadata template for update</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>message</code></td> <td class="type"> <span class="param-type"><a href="Message.html">Message</a></span> </td> <td class="description last"> <p>A Return or Forward message</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> <a href="Mobile.html">Mobile</a> </td> <td class="description last">A Mobile object</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~roundTo"> <span class="type-signature ">inner</span>roundTo<span class="signature">(num, places)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 20 </div> </div> </dt> <dd> <div class="description"> <p>Rounds a number to a certain decimal precision</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>num</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"> <p>A decimal number</p></td> </tr> <tr> <td class="name"><code>places</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"> <p>The number of decimal places to round to</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> number </td> <td class="description last">rounded</td> </tr> </tbody> </table> </dd> <dt> <div class="nameContainer"> <h4 class="name" id="~timestampFromMinuteDay"> <span class="type-signature ">inner</span>timestampFromMinuteDay<span class="signature">(year, month, dayOfMonth, minuteOfDay)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Date}</span> </h4> <div class="tag-source"> infra/messageCodecs/coreModem.js, line 33 </div> </div> </dt> <dd> <div class="description"> <p>Returns a datestamp from a day and minute, assuming the current year</p> </div> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>year</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"> <p>Full year UTC</p></td> </tr> <tr> <td class="name"><code>month</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"> <p>From 0..11 UTC</p></td> </tr> <tr> <td class="name"><code>dayOfMonth</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"> <p>Day of month from 1..31 UTC</p></td> </tr> <tr> <td class="name"><code>minuteOfDay</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"> <p>Minute of day from 0..1439 UTC</p></td> </tr> </tbody> </table> <dl class="details"> </dl> <h5>Returns:</h5> <table class="params"> <thead> <tr> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="type"> Date </td> <td class="description last"></td> </tr> </tbody> </table> </dd> </dl> </article> </section> <footer> Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.4</a> on Sat Oct 24 2020 14:53:36 GMT-0400 (Eastern Daylight Time) </footer> </div> </div> <script>prettyPrint();</script> <script src="scripts/jaguar.js"></script> </body> </html>