@robdobsn/raftjs 1.1.1

package/.editorconfig

@@ -0,0 +1,14 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = true

package/.gitattributes

@@ -0,0 +1,11 @@
+# Set the default behavior, in case users don't have core.autocrlf set.
+* text=auto
+
+# Declare files that will always have LF line endings on checkout.
+* text eol=lf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.gif binary
+*.pdf binary

package/.nvmrc

@@ -0,0 +1 @@
+20.11.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021-2024 Rob Dobson
+Examples copyright (c) 2021-2024 Robotical
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,11 @@
+# raftjs is a typescript/javascript library to support the Raft ESP32 app framework
+
+## Install
+
+```bash
+$ npm install @robdobsn/raftjs
+```
+
+## Usage
+
+See the dashboard example in the examples folder

package/TODO.md

@@ -0,0 +1 @@
+[] Previously there was a function called retrieveMartySystemInfo() on RICConnector - this is removed - it used to call RICSystem (now RaftSystemUtils).retrieve info and that used to ge to getHWElems() etc as the code to do that was in RICSystem. This now needs to be split out and getHWElems(), etc handled directly in the target library and not RaftJS

package/dist/RaftAttributeHandler.d.ts

@@ -0,0 +1,12 @@
+import { DeviceTypePollRespMetadata } from "./RaftDeviceInfo";
+import { DeviceAttributesState, DeviceTimeline } from "./RaftDeviceStates";
+export default class AttributeHandler {
+    private _customAttrHandler;
+    private POLL_RESULT_TIMESTAMP_SIZE;
+    private POLL_RESULT_WRAP_VALUE;
+    private POLL_RESULT_RESOLUTION_US;
+    processMsgAttrGroup(msgBuffer: Buffer, msgBufIdx: number, deviceTimeline: DeviceTimeline, pollRespMetadata: DeviceTypePollRespMetadata, devAttrsState: DeviceAttributesState, maxDataPoints: number): number;
+    private processMsgAttribute;
+    private signExtend;
+    private extractTimestampAndAdvanceIdx;
+}

package/dist/RaftAttributeHandler.js

@@ -0,0 +1,241 @@
+"use strict";
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// RaftAttributeHandler
+// Attribute handler for Raft devices
+//
+// Rob Dobson (C) 2024
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const RaftCustomAttrHandler_1 = tslib_1.__importDefault(require("./RaftCustomAttrHandler"));
+const RaftDeviceInfo_1 = require("./RaftDeviceInfo");
+const python_struct_1 = tslib_1.__importDefault(require("python-struct"));
+class AttributeHandler {
+    constructor() {
+        // Custom attribute handler
+        this._customAttrHandler = new RaftCustomAttrHandler_1.default();
+        // Message timestamp size
+        this.POLL_RESULT_TIMESTAMP_SIZE = 2;
+        this.POLL_RESULT_WRAP_VALUE = this.POLL_RESULT_TIMESTAMP_SIZE === 2 ? 65536 : 4294967296;
+        this.POLL_RESULT_RESOLUTION_US = 1000;
+    }
+    processMsgAttrGroup(msgBuffer, msgBufIdx, deviceTimeline, pollRespMetadata, devAttrsState, maxDataPoints) {
+        // console.log(`processMsgAttrGroup msg ${msgHexStr} timestamp ${timestamp} origTimestamp ${origTimestamp} msgBufIdx ${msgBufIdx}`)
+        // Extract msg timestamp
+        let { newBufIdx, timestampUs } = this.extractTimestampAndAdvanceIdx(msgBuffer, msgBufIdx, deviceTimeline);
+        if (newBufIdx < 0)
+            return -1;
+        msgBufIdx = newBufIdx;
+        // Start of message data
+        const msgDataStartIdx = msgBufIdx;
+        // New attribute values (in order as they appear in the attributes JSON)
+        let newAttrValues = [];
+        if ("c" in pollRespMetadata) {
+            // Extract attribute values using custom handler
+            newAttrValues = this._customAttrHandler.handleAttr(pollRespMetadata, msgBuffer, msgBufIdx);
+        }
+        else {
+            // Iterate over attributes
+            for (let attrIdx = 0; attrIdx < pollRespMetadata.a.length; attrIdx++) {
+                // Get the attribute definition
+                const attrDef = pollRespMetadata.a[attrIdx];
+                if (!("t" in attrDef)) {
+                    console.warn(`DeviceManager msg unknown msgBuffer ${msgBuffer} tsUs ${timestampUs} attrDef ${JSON.stringify(attrDef)}`);
+                    newAttrValues.push([]);
+                    continue;
+                }
+                // Process the attribute
+                const { values, newMsgBufIdx } = this.processMsgAttribute(attrDef, msgBuffer, msgBufIdx, msgDataStartIdx);
+                if (newMsgBufIdx < 0) {
+                    newAttrValues.push([]);
+                    continue;
+                }
+                msgBufIdx = newMsgBufIdx;
+                newAttrValues.push(values);
+            }
+        }
+        // Number of bytes in group
+        const pollRespSizeBytes = pollRespMetadata.b;
+        // Check if any attributes were added (in addition to timestamp)
+        if (newAttrValues.length === 0) {
+            console.warn(`DeviceManager msg attrGroup ${JSON.stringify(pollRespMetadata)} newAttrValues ${newAttrValues} is empty`);
+            return msgDataStartIdx + pollRespSizeBytes;
+        }
+        // All attributes must have the same number of new values
+        let numNewDataPoints = newAttrValues[0].length;
+        for (let i = 1; i < newAttrValues.length; i++) {
+            if (newAttrValues[i].length !== numNewDataPoints) {
+                console.warn(`DeviceManager msg attrGroup ${pollRespMetadata} attrName ${pollRespMetadata.a[i].n} newAttrValues ${newAttrValues} do not have the same length`);
+                return msgDataStartIdx + pollRespSizeBytes;
+            }
+        }
+        // All attributes in the schema should have values
+        if (newAttrValues.length !== pollRespMetadata.a.length) {
+            console.warn(`DeviceManager msg attrGroup ${pollRespMetadata} newAttrValues ${newAttrValues} length does not match attrGroup.a length`);
+            return msgDataStartIdx + pollRespSizeBytes;
+        }
+        // Add the new attribute values to the device state
+        for (let attrIdx = 0; attrIdx < pollRespMetadata.a.length; attrIdx++) {
+            // Check if attribute already exists in the device state
+            const attrDef = pollRespMetadata.a[attrIdx];
+            if (!(attrDef.n in devAttrsState)) {
+                devAttrsState[attrDef.n] = {
+                    name: attrDef.n,
+                    newAttribute: true,
+                    newData: true,
+                    values: [],
+                    units: (0, RaftDeviceInfo_1.decodeAttrUnitsEncoding)(attrDef.u || ""),
+                    range: attrDef.r || [0, 0],
+                    format: ("f" in attrDef && typeof attrDef.f == "string") ? attrDef.f : "",
+                    visibleSeries: "v" in attrDef ? attrDef.v === 0 || attrDef.v === false : ("vs" in attrDef ? (attrDef.vs === 0 || attrDef.vs === false ? false : !!attrDef.vs) : true),
+                    visibleForm: "v" in attrDef ? attrDef.v === 0 || attrDef.v === false : ("vf" in attrDef ? (attrDef.vf === 0 || attrDef.vf === false ? false : !!attrDef.vf) : true),
+                };
+            }
+            // Check if any data points need to be discarded
+            const discardCount = Math.max(0, devAttrsState[attrDef.n].values.length + newAttrValues[attrIdx].length - maxDataPoints);
+            if (discardCount > 0) {
+                devAttrsState[attrDef.n].values.splice(0, discardCount);
+            }
+            // Add the new values
+            devAttrsState[attrDef.n].values.push(...newAttrValues[attrIdx]);
+            devAttrsState[attrDef.n].newData = newAttrValues[attrIdx].length > 0;
+        }
+        // Handle the timestamps with increments if specified
+        const timeIncUs = pollRespMetadata.us ? pollRespMetadata.us : 1000;
+        let timestampsUs = Array(numNewDataPoints).fill(0);
+        for (let i = 0; i < numNewDataPoints; i++) {
+            timestampsUs[i] = timestampUs + i * timeIncUs;
+        }
+        // Check if timeline points need to be discarded
+        const discardCount = Math.max(0, deviceTimeline.timestampsUs.length + timestampsUs.length - maxDataPoints);
+        if (discardCount > 0) {
+            deviceTimeline.timestampsUs.splice(0, discardCount);
+        }
+        // Add the new timestamps
+        deviceTimeline.timestampsUs.push(...timestampsUs);
+        // Return the next message buffer index
+        return msgDataStartIdx + pollRespSizeBytes;
+    }
+    processMsgAttribute(attrDef, msgBuffer, msgBufIdx, msgDataStartIdx) {
+        // Current field message string index
+        let curFieldBufIdx = msgBufIdx;
+        let attrUsesAbsPos = false;
+        // Check for "at": N which means start reading from byte N of the message (after the timestamp bytes)
+        if (attrDef.at !== undefined) {
+            curFieldBufIdx = msgDataStartIdx + attrDef.at;
+            attrUsesAbsPos = true;
+        }
+        // Check if outside bounds of message
+        if (curFieldBufIdx >= msgBuffer.length) {
+            console.warn(`DeviceManager msg outside bounds msgBuffer ${msgBuffer} attrName ${attrDef.n}`);
+            return { values: [], newMsgBufIdx: -1 };
+        }
+        // Attribute type
+        const attrTypesOnly = attrDef.t;
+        // Slice into buffer
+        const attrBuf = msgBuffer.slice(curFieldBufIdx);
+        // Check if a mask is used and the value is signed
+        const maskOnSignedValue = "m" in attrDef && (0, RaftDeviceInfo_1.isAttrTypeSigned)(attrTypesOnly);
+        // Extract the value using python-struct
+        let unpackValues = python_struct_1.default.unpack(maskOnSignedValue ? attrTypesOnly.toUpperCase() : attrTypesOnly, attrBuf);
+        let attrValues = unpackValues;
+        // Get number of bytes consumed
+        const numBytesConsumed = python_struct_1.default.sizeOf(attrTypesOnly);
+        // // Check if sign extendable mask specified on signed value
+        // if (mmSpecifiedOnSignedValue) {
+        //     const signBitMask = 1 << (signExtendableMaskSignPos - 1);
+        //     const valueOnlyMask = signBitMask - 1;
+        //     if (value & signBitMask) {
+        //         value = (value & valueOnlyMask) - signBitMask;
+        //     } else {
+        //         value = value & valueOnlyMask;
+        //     }
+        // }
+        // Check for XOR mask
+        if ("x" in attrDef) {
+            const mask = typeof attrDef.x === "string" ? parseInt(attrDef.x, 16) : attrDef.x;
+            attrValues = attrValues.map((value) => value ^ mask);
+        }
+        // Check for AND mask
+        if ("m" in attrDef) {
+            const mask = typeof attrDef.m === "string" ? parseInt(attrDef.m, 16) : attrDef.m;
+            attrValues = attrValues.map((value) => (maskOnSignedValue ? this.signExtend(value, mask) : value & mask));
+        }
+        // Check for a sign-bit
+        if ("sb" in attrDef) {
+            const signBitPos = attrDef.sb;
+            const signBitMask = 1 << signBitPos;
+            if ("ss" in attrDef) {
+                const signBitSubtract = attrDef.ss;
+                attrValues = attrValues.map((value) => (value & signBitMask) ? signBitSubtract - value : value);
+            }
+            else {
+                attrValues = attrValues.map((value) => (value & signBitMask) ? value - (signBitMask << 1) : value);
+            }
+        }
+        // Check for bit shift required
+        if ("s" in attrDef && attrDef.s) {
+            const bitshift = attrDef.s;
+            if (bitshift > 0) {
+                attrValues = attrValues.map((value) => (value) >> bitshift);
+            }
+            else if (bitshift < 0) {
+                attrValues = attrValues.map((value) => (value) << -bitshift);
+            }
+        }
+        // Check for divisor
+        if ("d" in attrDef && attrDef.d) {
+            const divisor = attrDef.d;
+            attrValues = attrValues.map((value) => (value) / divisor);
+        }
+        // Check for value to add
+        if ("a" in attrDef && attrDef.a !== undefined) {
+            const addValue = attrDef.a;
+            attrValues = attrValues.map((value) => (value) + addValue);
+        }
+        // console.log(`DeviceManager msg attrGroup ${attrGroup} devkey ${deviceKey} valueHexChars ${valueHexChars} msgHexStr ${msgHexStr} ts ${timestamp} attrName ${attrDef.n} type ${attrDef.t} value ${value} signExtendableMaskSignPos ${signExtendableMaskSignPos} attrTypeDefForStruct ${attrTypeDefForStruct} attrDef ${attrDef}`);
+        // Move buffer position if using relative positioning
+        msgBufIdx += attrUsesAbsPos ? 0 : numBytesConsumed;
+        // Return the value
+        return { values: attrValues, newMsgBufIdx: msgBufIdx };
+    }
+    signExtend(value, mask) {
+        const signBitMask = (mask + 1) >> 1;
+        const signBit = value & signBitMask;
+        if (signBit !== 0) { // If sign bit is set
+            const highBitsMask = ~mask & ~((mask + 1) >> 1);
+            value |= highBitsMask; // Apply the sign extension
+        }
+        return value;
+    }
+    extractTimestampAndAdvanceIdx(msgBuffer, msgBufIdx, timestampWrapHandler) {
+        // Check there are enough characters for the timestamp
+        if (msgBufIdx + this.POLL_RESULT_TIMESTAMP_SIZE > msgBuffer.length) {
+            return { newBufIdx: -1, timestampUs: 0 };
+        }
+        // Use struct to extract the timestamp
+        const tsBuffer = msgBuffer.slice(msgBufIdx, msgBufIdx + this.POLL_RESULT_TIMESTAMP_SIZE);
+        let timestampUs;
+        if (this.POLL_RESULT_TIMESTAMP_SIZE === 2) {
+            timestampUs = python_struct_1.default.unpack(">H", tsBuffer)[0] * this.POLL_RESULT_RESOLUTION_US;
+        }
+        else {
+            timestampUs = python_struct_1.default.unpack(">I", tsBuffer)[0] * this.POLL_RESULT_RESOLUTION_US;
+        }
+        // Check if time is before lastReportTimeMs - in which case a wrap around occurred to add on the max value
+        if (timestampUs < timestampWrapHandler.lastReportTimestampUs) {
+            timestampWrapHandler.reportTimestampOffsetUs += this.POLL_RESULT_WRAP_VALUE * this.POLL_RESULT_RESOLUTION_US;
+        }
+        timestampWrapHandler.lastReportTimestampUs = timestampUs;
+        // Offset timestamp
+        timestampUs += timestampWrapHandler.reportTimestampOffsetUs;
+        // Advance the index
+        msgBufIdx += this.POLL_RESULT_TIMESTAMP_SIZE;
+        // Return the timestamp
+        return { newBufIdx: msgBufIdx, timestampUs: timestampUs };
+    }
+}
+exports.default = AttributeHandler;
+//# sourceMappingURL=RaftAttributeHandler.js.map

package/dist/RaftAttributeHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RaftAttributeHandler.js","sourceRoot":"","sources":["../src/RaftAttributeHandler.ts"],"names":[],"mappings":";AAAA,iHAAiH;AACjH,EAAE;AACF,uBAAuB;AACvB,qCAAqC;AACrC,EAAE;AACF,sBAAsB;AACtB,EAAE;AACF,iHAAiH;;;AAEjH,4FAAwD;AACxD,qDAA8H;AAE9H,0EAAmC;AAEnC,MAAqB,gBAAgB;IAArC;QAEI,2BAA2B;QACnB,uBAAkB,GAAG,IAAI,+BAAiB,EAAE,CAAC;QAErD,yBAAyB;QACjB,+BAA0B,GAAG,CAAC,CAAC;QAC/B,2BAAsB,GAAG,IAAI,CAAC,0BAA0B,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,UAAU,CAAC;QACpF,8BAAyB,GAAG,IAAI,CAAC;IA0Q7C,CAAC;IAxQU,mBAAmB,CAAC,SAAiB,EAAE,SAAiB,EAAE,cAA8B,EAAE,gBAA4C,EACzH,aAAoC,EAAE,aAAqB;QAE3E,mIAAmI;QAEnI,wBAAwB;QACxB,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,6BAA6B,CAAC,SAAS,EAAE,SAAS,EAAE,cAAc,CAAC,CAAC;QAC1G,IAAI,SAAS,GAAG,CAAC;YACb,OAAO,CAAC,CAAC,CAAC;QACd,SAAS,GAAG,SAAS,CAAC;QAEtB,wBAAwB;QACxB,MAAM,eAAe,GAAG,SAAS,CAAC;QAElC,wEAAwE;QACxE,IAAI,aAAa,GAAe,EAAE,CAAC;QACnC,IAAI,GAAG,IAAI,gBAAgB,EAAE,CAAC;YAE1B,gDAAgD;YAChD,aAAa,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC,gBAAgB,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;QAE/F,CAAC;aAAM,CAAC;YAEJ,0BAA0B;YAC1B,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC;gBAEnE,+BAA+B;gBAC/B,MAAM,OAAO,GAAwB,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBACjE,IAAI,CAAC,CAAC,GAAG,IAAI,OAAO,CAAC,EAAE,CAAC;oBACpB,OAAO,CAAC,IAAI,CAAC,uCAAuC,SAAS,SAAS,WAAW,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;oBACxH,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBACvB,SAAS;gBACb,CAAC;gBAED,wBAAwB;gBACxB,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;gBAC1G,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;oBACnB,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBACvB,SAAS;gBACb,CAAC;gBACD,SAAS,GAAG,YAAY,CAAC;gBACzB,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC/B,CAAC;QAEL,CAAC;QAED,2BAA2B;QAC3B,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,CAAC,CAAC;QAE7C,gEAAgE;QAChE,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,CAAC,IAAI,CAAC,+BAA+B,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,kBAAkB,aAAa,WAAW,CAAC,CAAC;YACxH,OAAO,eAAe,GAAC,iBAAiB,CAAC;QAC7C,CAAC;QAED,yDAAyD;QACzD,IAAI,gBAAgB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;QAC/C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,IAAI,aAAa,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,gBAAgB,EAAE,CAAC;gBAC/C,OAAO,CAAC,IAAI,CAAC,+BAA+B,gBAAgB,aAAa,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,kBAAkB,aAAa,8BAA8B,CAAC,CAAC;gBAC/J,OAAO,eAAe,GAAC,iBAAiB,CAAC;YAC7C,CAAC;QACL,CAAC;QAED,kDAAkD;QAClD,IAAI,aAAa,CAAC,MAAM,KAAK,gBAAgB,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;YACrD,OAAO,CAAC,IAAI,CAAC,+BAA+B,gBAAgB,kBAAkB,aAAa,2CAA2C,CAAC,CAAC;YACxI,OAAO,eAAe,GAAC,iBAAiB,CAAC;QAC7C,CAAC;QAED,mDAAmD;QACnD,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC;YACnE,wDAAwD;YACxD,MAAM,OAAO,GAAwB,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YACjE,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,aAAa,CAAC,EAAE,CAAC;gBAChC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG;oBACvB,IAAI,EAAE,OAAO,CAAC,CAAC;oBACf,YAAY,EAAE,IAAI;oBAClB,OAAO,EAAE,IAAI;oBACb,MAAM,EAAE,EAAE;oBACV,KAAK,EAAE,IAAA,wCAAuB,EAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;oBAC/C,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC;oBAC1B,MAAM,EAAE,CAAC,GAAG,IAAI,OAAO,IAAI,OAAO,OAAO,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;oBACzE,aAAa,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;oBACrK,WAAW,EAAE,GAAG,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,IAAI,OAAO,CAAC,EAAE,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;iBACtK,CAAC;YACN,CAAC;YAED,gDAAgD;YAChD,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC;YACzH,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;gBACnB,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;YAC5D,CAAC;YAED,qBAAqB;YACrB,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;YAChE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;QACzE,CAAC;QAED,qDAAqD;QACrD,MAAM,SAAS,GAAW,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC3E,IAAI,YAAY,GAAG,KAAK,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACnD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,YAAY,CAAC,CAAC,CAAC,GAAI,WAAW,GAAG,CAAC,GAAG,SAAS,CAAC;QACnD,CAAC;QAED,gDAAgD;QAChD,MAAM,YAAY,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,CAAC,YAAY,CAAC,MAAM,GAAG,YAAY,CAAC,MAAM,GAAG,aAAa,CAAC,CAAC;QAC3G,IAAI,YAAY,GAAG,CAAC,EAAE,CAAC;YACnB,cAAc,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,EAAE,YAAY,CAAC,CAAC;QACxD,CAAC;QAED,yBAAyB;QACzB,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC;QAElD,uCAAuC;QACvC,OAAO,eAAe,GAAC,iBAAiB,CAAC;IAC7C,CAAC;IAEO,mBAAmB,CAAC,OAA4B,EAAE,SAAiB,EAAE,SAAiB,EAAE,eAAuB;QAEnH,qCAAqC;QACrC,IAAI,cAAc,GAAG,SAAS,CAAC;QAC/B,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,qGAAqG;QACrG,IAAI,OAAO,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC3B,cAAc,GAAG,eAAe,GAAG,OAAO,CAAC,EAAE,CAAC;YAC9C,cAAc,GAAG,IAAI,CAAC;QAC1B,CAAC;QAED,qCAAqC;QACrC,IAAI,cAAc,IAAI,SAAS,CAAC,MAAM,EAAE,CAAC;YACrC,OAAO,CAAC,IAAI,CAAC,8CAA8C,SAAS,aAAa,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;YAC9F,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAC,EAAE,CAAC;QAC5C,CAAC;QAED,iBAAiB;QACjB,MAAM,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC;QAEhC,oBAAoB;QACpB,MAAM,OAAO,GAAG,SAAS,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAEhD,kDAAkD;QAClD,MAAM,iBAAiB,GAAG,GAAG,IAAI,OAAO,IAAI,IAAA,iCAAgB,EAAC,aAAa,CAAC,CAAC;QAE5E,wCAAwC;QACxC,IAAI,YAAY,GAAG,uBAAM,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;QAC3G,IAAI,UAAU,GAAG,YAAwB,CAAC;QAE1C,+BAA+B;QAC/B,MAAM,gBAAgB,GAAG,uBAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAEtD,6DAA6D;QAC7D,kCAAkC;QAClC,gEAAgE;QAChE,6CAA6C;QAC7C,iCAAiC;QACjC,yDAAyD;QACzD,eAAe;QACf,yCAAyC;QACzC,QAAQ;QACR,IAAI;QAEJ,qBAAqB;QACrB,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,OAAO,OAAO,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAW,CAAC;YAC3F,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;QACzD,CAAC;QAED,qBAAqB;QACrB,IAAI,GAAG,IAAI,OAAO,EAAE,CAAC;YACjB,MAAM,IAAI,GAAG,OAAO,OAAO,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAW,CAAC;YAC3F,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;QAC9G,CAAC;QAED,uBAAuB;QACvB,IAAI,IAAI,IAAI,OAAO,EAAE,CAAC;YAClB,MAAM,UAAU,GAAG,OAAO,CAAC,EAAY,CAAC;YACxC,MAAM,WAAW,GAAG,CAAC,IAAI,UAAU,CAAC;YACpC,IAAI,IAAI,IAAI,OAAO,EAAE,CAAC;gBAClB,MAAM,eAAe,GAAG,OAAO,CAAC,EAAY,CAAC;gBAC7C,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACpG,CAAC;iBAAM,CAAC;gBACJ,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;YACvG,CAAC;QACL,CAAC;QAED,+BAA+B;QAC/B,IAAI,GAAG,IAAI,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;YAC9B,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAW,CAAC;YACrC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;gBACf,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,CAAC;YAChE,CAAC;iBAAM,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;gBACtB,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACjE,CAAC;QACL,CAAC;QAED,oBAAoB;QACpB,IAAI,GAAG,IAAI,OAAO,IAAI,OAAO,CAAC,CAAC,EAAE,CAAC;YAC9B,MAAM,OAAO,GAAG,OAAO,CAAC,CAAW,CAAC;YACpC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC;QAC9D,CAAC;QAED,yBAAyB;QACzB,IAAI,GAAG,IAAI,OAAO,IAAI,OAAO,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;YAC5C,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAW,CAAC;YACrC,UAAU,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,CAAC;QAC/D,CAAC;QAED,mUAAmU;QACnU,qDAAqD;QACrD,SAAS,IAAI,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC;QAEnD,mBAAmB;QACnB,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,CAAC;IAC3D,CAAC;IAEO,UAAU,CAAC,KAAa,EAAE,IAAY;QAC1C,MAAM,WAAW,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,OAAO,GAAG,KAAK,GAAG,WAAW,CAAC;QAEpC,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC,CAAE,qBAAqB;YACvC,MAAM,YAAY,GAAG,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YAChD,KAAK,IAAI,YAAY,CAAC,CAAE,2BAA2B;QACvD,CAAC;QAED,OAAO,KAAK,CAAC;IACjB,CAAC;IAEO,6BAA6B,CAAC,SAAiB,EAAE,SAAiB,EAAE,oBAAoC;QAG5G,sDAAsD;QACtD,IAAI,SAAS,GAAG,IAAI,CAAC,0BAA0B,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC;YACjE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC;QAC7C,CAAC;QAED,sCAAsC;QACtC,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE,SAAS,GAAG,IAAI,CAAC,0BAA0B,CAAC,CAAC;QACzF,IAAI,WAAmB,CAAC;QACxB,IAAI,IAAI,CAAC,0BAA0B,KAAK,CAAC,EAAE,CAAC;YACxC,WAAW,GAAG,uBAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAW,GAAG,IAAI,CAAC,yBAAyB,CAAC;QAC9F,CAAC;aAAM,CAAC;YACJ,WAAW,GAAG,uBAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAW,GAAG,IAAI,CAAC,yBAAyB,CAAC;QAC9F,CAAC;QAED,0GAA0G;QAC1G,IAAI,WAAW,GAAG,oBAAoB,CAAC,qBAAqB,EAAE,CAAC;YAC3D,oBAAoB,CAAC,uBAAuB,IAAI,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,yBAAyB,CAAC;QACjH,CAAC;QACD,oBAAoB,CAAC,qBAAqB,GAAG,WAAW,CAAC;QAEzD,mBAAmB;QACnB,WAAW,IAAI,oBAAoB,CAAC,uBAAuB,CAAC;QAE5D,oBAAoB;QACpB,SAAS,IAAI,IAAI,CAAC,0BAA0B,CAAC;QAE7C,uBAAuB;QACvB,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;IAC9D,CAAC;CAGJ;AAlRD,mCAkRC"}

package/dist/RaftChannel.d.ts

@@ -0,0 +1,18 @@
+import { RaftConnEventFn } from "./RaftConnEvents";
+import RaftMsgHandler from "./RaftMsgHandler";
+import { ConnectorOptions } from "./RaftSystemType";
+export default interface RaftChannel {
+    isConnected(): boolean;
+    connect(locator: string | object, connectorOptions: ConnectorOptions): Promise<boolean>;
+    disconnect(): Promise<void>;
+    getConnectedLocator(): string | object;
+    setOnConnEvent(connEventFn: RaftConnEventFn): void;
+    setMsgHandler(raftMsgHandler: RaftMsgHandler): void;
+    sendTxMsg(msg: Uint8Array, sendWithResponse: boolean): Promise<boolean>;
+    sendTxMsgNoAwait(msg: Uint8Array, sendWithResponse: boolean): Promise<boolean>;
+    requiresSubscription(): boolean;
+    ricRestCmdBeforeDisconnect(): string | null;
+    fhBatchAckSize(): number;
+    fhFileBlockSize(): number;
+    pauseConnection(pause: boolean): void;
+}

package/dist/RaftChannel.js

@@ -0,0 +1,12 @@
+"use strict";
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// RaftChannel
+// Part of RaftJS
+//
+// Rob Dobson & Chris Greening 2020-2024
+// (C) 2020-2024 All rights reserved
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RaftChannel.js.map

package/dist/RaftChannel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RaftChannel.js","sourceRoot":"","sources":["../src/RaftChannel.ts"],"names":[],"mappings":";AAAA,iHAAiH;AACjH,EAAE;AACF,cAAc;AACd,iBAAiB;AACjB,EAAE;AACF,wCAAwC;AACxC,oCAAoC;AACpC,EAAE;AACF,iHAAiH"}

package/dist/RaftChannelWebBLE.d.ts

@@ -0,0 +1,38 @@
+import RaftChannel from "./RaftChannel";
+import { RaftConnEventFn } from "./RaftConnEvents";
+import RaftMsgHandler from "./RaftMsgHandler";
+import { ConnectorOptions } from "./RaftSystemType";
+export default class RaftChannelWebBLE implements RaftChannel {
+    static ServiceUUID: string;
+    static CmdUUID: string;
+    static RespUUID: string;
+    private _bleDevice;
+    private _characteristicTx;
+    private _characteristicRx;
+    private _raftMsgHandler;
+    private _onConnEvent;
+    private _msgTxTimeLast;
+    private _msgTxMinTimeBetweenMs;
+    private readonly maxRetries;
+    private _isConnected;
+    private readonly _maxConnRetries;
+    private _eventListenerFn;
+    private _requestedBatchAckSize;
+    private _requestedFileBlockSize;
+    fhBatchAckSize(): number;
+    fhFileBlockSize(): number;
+    setMsgHandler(raftMsgHandler: RaftMsgHandler): void;
+    requiresSubscription(): boolean;
+    ricRestCmdBeforeDisconnect(): string | null;
+    isEnabled(): boolean;
+    isConnected(): boolean;
+    setOnConnEvent(connEventFn: RaftConnEventFn): void;
+    onDisconnected(event: Event): void;
+    getConnectedLocator(): string | object;
+    connect(locator: string | object, _connectorOptions: ConnectorOptions): Promise<boolean>;
+    disconnect(): Promise<void>;
+    pauseConnection(pause: boolean): void;
+    _onMsgRx(event: Event): void;
+    sendTxMsg(msg: Uint8Array): Promise<boolean>;
+    sendTxMsgNoAwait(msg: Uint8Array): Promise<boolean>;
+}