@robdobsn/raftjs 1.1.1

package/dist/RaftProtocolDefs.js

@@ -0,0 +1,48 @@
+"use strict";
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// Raft Protocol Definitions
+// Part of RaftJS
+//
+// Rob Dobson & Chris Greening 2020-2024
+// (C) 2020-2024 All rights reserved
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RaftCommsMsgProtocol = exports.RaftCommsMsgTypeCode = exports.RICRESTElemCode = exports.RICREST_BRIDGE_PAYLOAD_POS = exports.RICREST_BRIDGE_ID_POS = exports.RICREST_FILEBLOCK_PAYLOAD_POS = exports.RICREST_FILEBLOCK_FILEPOS_POS_BYTES = exports.RICREST_FILEBLOCK_FILEPOS_POS = exports.RICREST_FILEBLOCK_CHANNEL_POS = exports.RICREST_HEADER_PAYLOAD_POS = exports.RICREST_REST_ELEM_CODE_POS = exports.RICSERIAL_PAYLOAD_POS = exports.RICSERIAL_PROTOCOL_POS = exports.RICSERIAL_MSG_NUM_POS = void 0;
+// RIC Protocols
+exports.RICSERIAL_MSG_NUM_POS = 0;
+exports.RICSERIAL_PROTOCOL_POS = 1;
+exports.RICSERIAL_PAYLOAD_POS = 2;
+exports.RICREST_REST_ELEM_CODE_POS = 0;
+exports.RICREST_HEADER_PAYLOAD_POS = 1;
+exports.RICREST_FILEBLOCK_CHANNEL_POS = 0;
+exports.RICREST_FILEBLOCK_FILEPOS_POS = 0;
+exports.RICREST_FILEBLOCK_FILEPOS_POS_BYTES = 4;
+exports.RICREST_FILEBLOCK_PAYLOAD_POS = 4;
+exports.RICREST_BRIDGE_ID_POS = 2;
+exports.RICREST_BRIDGE_PAYLOAD_POS = 3;
+// Protocol enums
+var RICRESTElemCode;
+(function (RICRESTElemCode) {
+    RICRESTElemCode[RICRESTElemCode["RICREST_ELEM_CODE_URL"] = 0] = "RICREST_ELEM_CODE_URL";
+    RICRESTElemCode[RICRESTElemCode["RICREST_ELEM_CODE_CMDRESPJSON"] = 1] = "RICREST_ELEM_CODE_CMDRESPJSON";
+    RICRESTElemCode[RICRESTElemCode["RICREST_ELEM_CODE_BODY"] = 2] = "RICREST_ELEM_CODE_BODY";
+    RICRESTElemCode[RICRESTElemCode["RICREST_ELEM_CODE_COMMAND_FRAME"] = 3] = "RICREST_ELEM_CODE_COMMAND_FRAME";
+    RICRESTElemCode[RICRESTElemCode["RICREST_ELEM_CODE_FILEBLOCK"] = 4] = "RICREST_ELEM_CODE_FILEBLOCK";
+})(RICRESTElemCode || (exports.RICRESTElemCode = RICRESTElemCode = {}));
+var RaftCommsMsgTypeCode;
+(function (RaftCommsMsgTypeCode) {
+    RaftCommsMsgTypeCode[RaftCommsMsgTypeCode["MSG_TYPE_COMMAND"] = 0] = "MSG_TYPE_COMMAND";
+    RaftCommsMsgTypeCode[RaftCommsMsgTypeCode["MSG_TYPE_RESPONSE"] = 1] = "MSG_TYPE_RESPONSE";
+    RaftCommsMsgTypeCode[RaftCommsMsgTypeCode["MSG_TYPE_PUBLISH"] = 2] = "MSG_TYPE_PUBLISH";
+    RaftCommsMsgTypeCode[RaftCommsMsgTypeCode["MSG_TYPE_REPORT"] = 3] = "MSG_TYPE_REPORT";
+})(RaftCommsMsgTypeCode || (exports.RaftCommsMsgTypeCode = RaftCommsMsgTypeCode = {}));
+var RaftCommsMsgProtocol;
+(function (RaftCommsMsgProtocol) {
+    RaftCommsMsgProtocol[RaftCommsMsgProtocol["MSG_PROTOCOL_ROSSERIAL"] = 0] = "MSG_PROTOCOL_ROSSERIAL";
+    RaftCommsMsgProtocol[RaftCommsMsgProtocol["MSG_PROTOCOL_RESERVED_1"] = 1] = "MSG_PROTOCOL_RESERVED_1";
+    RaftCommsMsgProtocol[RaftCommsMsgProtocol["MSG_PROTOCOL_RICREST"] = 2] = "MSG_PROTOCOL_RICREST";
+    RaftCommsMsgProtocol[RaftCommsMsgProtocol["MSG_PROTOCOL_BRIDGE_RICREST"] = 3] = "MSG_PROTOCOL_BRIDGE_RICREST";
+})(RaftCommsMsgProtocol || (exports.RaftCommsMsgProtocol = RaftCommsMsgProtocol = {}));
+//# sourceMappingURL=RaftProtocolDefs.js.map

package/dist/RaftProtocolDefs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RaftProtocolDefs.js","sourceRoot":"","sources":["../src/RaftProtocolDefs.ts"],"names":[],"mappings":";AAAA,iHAAiH;AACjH,EAAE;AACF,4BAA4B;AAC5B,iBAAiB;AACjB,EAAE;AACF,wCAAwC;AACxC,oCAAoC;AACpC,EAAE;AACF,iHAAiH;;;AAEjH,gBAAgB;AACH,QAAA,qBAAqB,GAAG,CAAC,CAAC;AAC1B,QAAA,sBAAsB,GAAG,CAAC,CAAC;AAC3B,QAAA,qBAAqB,GAAG,CAAC,CAAC;AAC1B,QAAA,0BAA0B,GAAG,CAAC,CAAC;AAC/B,QAAA,0BAA0B,GAAG,CAAC,CAAC;AAC/B,QAAA,6BAA6B,GAAG,CAAC,CAAC;AAClC,QAAA,6BAA6B,GAAG,CAAC,CAAC;AAClC,QAAA,mCAAmC,GAAG,CAAC,CAAC;AACxC,QAAA,6BAA6B,GAAG,CAAC,CAAC;AAClC,QAAA,qBAAqB,GAAG,CAAC,CAAC;AAC1B,QAAA,0BAA0B,GAAG,CAAC,CAAC;AAE5C,iBAAiB;AACjB,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,uFAAqB,CAAA;IACrB,uGAA6B,CAAA;IAC7B,yFAAsB,CAAA;IACtB,2GAA+B,CAAA;IAC/B,mGAA2B,CAAA;AAC7B,CAAC,EANW,eAAe,+BAAf,eAAe,QAM1B;AAED,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,uFAAgB,CAAA;IAChB,yFAAiB,CAAA;IACjB,uFAAgB,CAAA;IAChB,qFAAe,CAAA;AACjB,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B;AAED,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,mGAA0B,CAAA;IAC1B,qGAA2B,CAAA;IAC3B,+FAAwB,CAAA;IACxB,6GAA+B,CAAA;AACjC,CAAC,EALW,oBAAoB,oCAApB,oBAAoB,QAK/B"}

package/dist/RaftStreamHandler.d.ts

@@ -0,0 +1,38 @@
+import RaftMsgHandler from './RaftMsgHandler';
+import RaftCommsStats from './RaftCommsStats';
+import RaftConnector from './RaftConnector';
+export default class RaftStreamHandler {
+    private _streamID;
+    DEFAULT_MAX_BLOCK_SIZE: number;
+    private _maxBlockSize;
+    private _msgHandler;
+    private _commsStats;
+    private _raftConnector;
+    private _soktoReceived;
+    private _soktoPos;
+    private _streamIsStarting;
+    private _lastStreamStartTime;
+    private _isStreaming;
+    private _isPaused;
+    private _streamBuffer;
+    private _audioDuration;
+    private _audioByteRate;
+    private _streamPos;
+    private _numBlocksWithoutPause;
+    private _legacySoktoMode;
+    private soundFinishPoint;
+    constructor(msgHandler: RaftMsgHandler, commsStats: RaftCommsStats, raftConnector: RaftConnector);
+    setNumBlocksWithoutPause(numBlocks: number): void;
+    setLegacySoktoMode(legacyMode: boolean): void;
+    streamAudio(streamContents: Uint8Array, clearExisting: boolean, audioDuration: number): void;
+    streamCancel(): Promise<void>;
+    isStreamStarting(): boolean;
+    clearFinishPointTimeout(): void;
+    streamingPerformanceChecker(): void;
+    private _sendStreamStartMsg;
+    get maxBlockSize(): number;
+    set maxBlockSize(maxBlockSize: number);
+    private _sendStreamEndMsg;
+    private _sendStreamBuffer;
+    onSoktoMsg(soktoPos: number): void;
+}

package/dist/RaftStreamHandler.js

@@ -0,0 +1,257 @@
+"use strict";
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// RafStreamHandler
+// Part of RaftJS
+//
+// Rob Dobson & Chris Greening 2020-2024
+// (C) 2020-2024 All rights reserved
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const RaftLog_1 = tslib_1.__importDefault(require("./RaftLog"));
+const RaftTypes_1 = require("./RaftTypes");
+const RaftConnEvents_1 = require("./RaftConnEvents");
+const RaftProtocolDefs_1 = require("./RaftProtocolDefs");
+class RaftStreamHandler {
+    constructor(msgHandler, commsStats, raftConnector) {
+        // Queue of audio stream requests
+        /*
+        private _streamAudioQueue: {
+          streamContents: Uint8Array;
+          audioDuration: number;
+        }[] = [];
+        */
+        // Stream state
+        this._streamID = null;
+        this.DEFAULT_MAX_BLOCK_SIZE = 475;
+        this._maxBlockSize = this.DEFAULT_MAX_BLOCK_SIZE;
+        // Flow control
+        this._soktoReceived = false;
+        this._soktoPos = 0;
+        this._streamIsStarting = false;
+        this._lastStreamStartTime = 0;
+        this._isStreaming = false;
+        this._isPaused = false;
+        this._streamBuffer = new Uint8Array();
+        this._audioDuration = 0;
+        this._audioByteRate = 0;
+        this._streamPos = 0;
+        this._numBlocksWithoutPause = 15;
+        this._legacySoktoMode = false;
+        // soundFinishPoint timer
+        this.soundFinishPoint = null;
+        this._raftConnector = raftConnector;
+        this._msgHandler = msgHandler;
+        this._commsStats = commsStats;
+        this.onSoktoMsg = this.onSoktoMsg.bind(this);
+    }
+    setNumBlocksWithoutPause(numBlocks) {
+        this._numBlocksWithoutPause = numBlocks;
+    }
+    setLegacySoktoMode(legacyMode) {
+        RaftLog_1.default.debug(`Setting legacy sokto mode to ${legacyMode}`);
+        this._legacySoktoMode = legacyMode;
+    }
+    // Start streaming audio
+    streamAudio(streamContents, clearExisting, audioDuration) {
+        if (!clearExisting)
+            RaftLog_1.default.debug(`only clearExisting = true is supported right now.`);
+        // TODO - if clearExisting is not set, form a queue
+        if (this._streamIsStarting || this._lastStreamStartTime > (Date.now() - 500)) {
+            RaftLog_1.default.error(`Unable to start sound, too soon since last request`);
+            return;
+        }
+        this._isPaused = true;
+        this._streamIsStarting = true;
+        this._lastStreamStartTime = Date.now();
+        this._soktoReceived = false;
+        this._soktoPos = 0;
+        this._streamPos = 0;
+        this._streamBuffer = streamContents;
+        this._audioDuration = audioDuration;
+        this._audioByteRate = (streamContents.length / audioDuration) * 1000;
+        this.clearFinishPointTimeout();
+        this._sendStreamStartMsg("audio.mp3", "streamaudio", RaftTypes_1.RaftStreamType.REAL_TIME_STREAM, streamContents).then((result) => {
+            this._isPaused = false;
+            this._streamIsStarting = false;
+            if (!result) {
+                RaftLog_1.default.error(`Unable to start stream. ufStart message send failed`);
+                return;
+            }
+            //this.streamingPerformanceChecker();
+            if (!this._isStreaming) {
+                this._isStreaming = true;
+                this._sendStreamBuffer();
+            }
+        });
+    }
+    async streamCancel() {
+        this._streamBuffer = new Uint8Array();
+        this.clearFinishPointTimeout();
+    }
+    isStreamStarting() {
+        return this._streamIsStarting;
+    }
+    clearFinishPointTimeout() {
+        if (this.soundFinishPoint) {
+            clearTimeout(this.soundFinishPoint);
+            this.soundFinishPoint = null;
+        }
+    }
+    streamingPerformanceChecker() {
+        if (this._audioDuration) {
+            this.clearFinishPointTimeout();
+            this.soundFinishPoint = setTimeout(() => {
+                // if the streaming hasn't finished before the end of the audio
+                // we can assume we are having streaming issues
+                // publish event in case we are having issues
+                this._raftConnector.onConnEvent(RaftConnEvents_1.RaftConnEvent.CONN_STREAMING_ISSUE);
+                this.clearFinishPointTimeout();
+            }, this._audioDuration + 500);
+        }
+    }
+    // Send the start message
+    async _sendStreamStartMsg(streamName, targetEndpoint, streamTypeEnum, streamContents) {
+        // Stream start command message
+        const streamType = 'rtstream';
+        const cmdMsg = `{"cmdName":"ufStart","reqStr":"ufStart","fileType":"${streamType}","fileName":"${streamName}","endpoint":"${targetEndpoint}","fileLen":${streamContents.length}}`;
+        // Debug
+        RaftLog_1.default.debug(`sendStreamStartMsg ${cmdMsg}`);
+        // Send
+        let streamStartResp = null;
+        try {
+            streamStartResp = await this._msgHandler.sendRICREST(cmdMsg, RaftProtocolDefs_1.RICRESTElemCode.RICREST_ELEM_CODE_COMMAND_FRAME);
+        }
+        catch (err) {
+            RaftLog_1.default.error(`sendStreamStartMsg error ${err}`);
+            return false;
+        }
+        // Extract params
+        if (streamStartResp && (streamStartResp.rslt === 'ok')) {
+            this._streamID = streamStartResp.streamID;
+            this._maxBlockSize = streamStartResp.maxBlockSize || this.DEFAULT_MAX_BLOCK_SIZE;
+            this.streamingPerformanceChecker();
+            RaftLog_1.default.verbose(`sendStreamStartMsg streamID ${this._streamID} maxBlockSize ${this._maxBlockSize} streamType ${streamTypeEnum}`);
+        }
+        else {
+            RaftLog_1.default.warn(`sendStreamStartMsg failed ${streamStartResp ? streamStartResp.rslt : 'no response'}`);
+            return false;
+        }
+        return true;
+    }
+    get maxBlockSize() {
+        return this._maxBlockSize;
+    }
+    set maxBlockSize(maxBlockSize) {
+        this._maxBlockSize = maxBlockSize;
+        this.DEFAULT_MAX_BLOCK_SIZE = maxBlockSize;
+    }
+    async _sendStreamEndMsg(streamID) {
+        if (streamID === null) {
+            return false;
+        }
+        // Stram end command message
+        const cmdMsg = `{"cmdName":"ufEnd","reqStr":"ufEnd","streamID":${streamID}}`;
+        // Debug
+        RaftLog_1.default.debug(`sendStreamEndMsg ${cmdMsg}`);
+        // Send
+        let streamEndResp = null;
+        try {
+            streamEndResp = await this._msgHandler.sendRICREST(cmdMsg, RaftProtocolDefs_1.RICRESTElemCode.RICREST_ELEM_CODE_COMMAND_FRAME);
+        }
+        catch (err) {
+            RaftLog_1.default.error(`sendStreamEndMsg error ${err}`);
+            return false;
+        }
+        return streamEndResp.rslt === 'ok';
+    }
+    /*
+      private async _sendAudioStopMsg(): Promise<RaftOKFail> {
+        const cmdMsg = `{"cmdName":"audio/stop"}`;
+    
+        // Debug
+        RaftLog.debug(`sendAudioStopMsg ${cmdMsg}`);
+    
+        // Send
+        return this._msgHandler.sendRICREST<RaftOKFail>(
+          cmdMsg,
+          RICRESTElemCode.RICREST_ELEM_CODE_COMMAND_FRAME,
+        );
+      }
+    
+    
+      private async _sendStreamCancelMsg(): Promise<RaftOKFail> {
+        // File cancel command message
+        const cmdMsg = `{"cmdName":"ufCancel","reqStr":"ufCancel","streamID":${this._streamID}}`;
+    
+        // Debug
+        RaftLog.debug(`sendStreamCancelMsg ${cmdMsg}`);
+    
+        // Send
+        return this._msgHandler.sendRICREST<RaftOKFail>(
+          cmdMsg,
+          RICRESTElemCode.RICREST_ELEM_CODE_COMMAND_FRAME,
+        );
+      }
+    */
+    async _sendStreamBuffer() {
+        const streamStartTime = Date.now();
+        // Check streamID is valid
+        if (this._streamID === null) {
+            return false;
+        }
+        let blockNum = 0;
+        // Send stream blocks
+        while (this._soktoPos < this._streamBuffer.length || this._isPaused) {
+            if (this._isPaused) {
+                await new Promise((resolve) => setTimeout(resolve, 5));
+                continue;
+            }
+            // Check for new sokto
+            if (this._soktoReceived) {
+                if (this._legacySoktoMode)
+                    this._streamPos = this._soktoPos;
+                // apart from when in legacy mode, the sokto message is now informational only, 
+                // to allow the central to slow down sending of data if it is swamping the peripheral
+                RaftLog_1.default.verbose(`sendStreamContents ${Date.now() - streamStartTime}ms soktoReceived for ${this._streamPos}`);
+                this._soktoReceived = false;
+                // receiving an sokto message before the completion of the stream means that the streaming is not keeping up
+                this._raftConnector.onConnEvent(RaftConnEvents_1.RaftConnEvent.CONN_STREAMING_ISSUE);
+            }
+            // Send stream block
+            const blockSize = Math.min(this._streamBuffer.length - this._streamPos, this._maxBlockSize);
+            const block = this._streamBuffer.slice(this._streamPos, this._streamPos + blockSize);
+            if (block.length > 0) {
+                const sentOk = await this._msgHandler.sendStreamBlock(block, this._streamPos, this._streamID);
+                this._commsStats.recordStreamBytes(block.length);
+                RaftLog_1.default.verbose(`sendStreamContents ${sentOk ? "OK" : "FAILED"} ${Date.now() - streamStartTime}ms pos ${this._streamPos} ${blockSize} ${block.length} ${this._soktoPos}`);
+                if (!sentOk) {
+                    return false;
+                }
+                this._streamPos += blockSize;
+                blockNum += 1;
+                if (this._audioByteRate && blockNum > this._numBlocksWithoutPause) {
+                    const pauseTime = ((blockSize / this._audioByteRate) * 1000) - 10;
+                    RaftLog_1.default.verbose(`Pausing for ${pauseTime} ms between audio packets. Bit rate ${this._audioByteRate * 8}`);
+                    await new Promise((resolve) => setTimeout(resolve, pauseTime));
+                }
+            }
+            // Wait to ensure we don't hog the CPU
+            await new Promise((resolve) => setTimeout(resolve, 1));
+        }
+        this._isStreaming = false;
+        this.clearFinishPointTimeout();
+        await this._sendStreamEndMsg(this._streamID);
+        return true;
+    }
+    onSoktoMsg(soktoPos) {
+        // Get how far we've progressed in file
+        this._soktoPos = soktoPos;
+        this._soktoReceived = true;
+        RaftLog_1.default.debug(`onSoktoMsg received file up to ${this._soktoPos}`);
+    }
+}
+exports.default = RaftStreamHandler;
+//# sourceMappingURL=RaftStreamHandler.js.map

package/dist/RaftStreamHandler.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RaftStreamHandler.js","sourceRoot":"","sources":["../src/RaftStreamHandler.ts"],"names":[],"mappings":";AAAA,iHAAiH;AACjH,EAAE;AACF,mBAAmB;AACnB,iBAAiB;AACjB,EAAE;AACF,wCAAwC;AACxC,oCAAoC;AACpC,EAAE;AACF,iHAAiH;;;AAEjH,gEAA+B;AAG/B,2CAA8E;AAE9E,qDAAiD;AACjD,yDAAoD;AAEpD,MAAqB,iBAAiB;IA4CpC,YAAY,UAA0B,EAAE,UAA0B,EAAE,aAA4B;QA1ChG,iCAAiC;QACjC;;;;;UAKE;QAEF,eAAe;QACP,cAAS,GAAkB,IAAI,CAAC;QACxC,2BAAsB,GAAG,GAAG,CAAC;QACrB,kBAAa,GAAW,IAAI,CAAC,sBAAsB,CAAC;QAW5D,eAAe;QACP,mBAAc,GAAG,KAAK,CAAC;QACvB,cAAS,GAAG,CAAC,CAAC;QAEd,sBAAiB,GAAG,KAAK,CAAC;QAC1B,yBAAoB,GAAG,CAAC,CAAC;QAEzB,iBAAY,GAAG,KAAK,CAAC;QACrB,cAAS,GAAG,KAAK,CAAC;QAClB,kBAAa,GAAG,IAAI,UAAU,EAAE,CAAC;QACjC,mBAAc,GAAG,CAAC,CAAC;QACnB,mBAAc,GAAG,CAAC,CAAC;QACnB,eAAU,GAAG,CAAC,CAAC;QACf,2BAAsB,GAAG,EAAE,CAAC;QAC5B,qBAAgB,GAAG,KAAK,CAAC;QAGjC,yBAAyB;QACjB,qBAAgB,GAA0B,IAAI,CAAC;QAGrD,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,wBAAwB,CAAC,SAAiB;QACxC,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC;IAC1C,CAAC;IAED,kBAAkB,CAAC,UAAmB;QACpC,iBAAO,CAAC,KAAK,CAAC,gCAAgC,UAAU,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC;IACrC,CAAC;IAED,wBAAwB;IACxB,WAAW,CAAC,cAA0B,EAAE,aAAsB,EAAE,aAAqB;QACnF,IAAI,CAAC,aAAa;YAChB,iBAAO,CAAC,KAAK,CAAC,mDAAmD,CAAC,CAAC;QAErE,mDAAmD;QACnD,IAAI,IAAI,CAAC,iBAAiB,IAAI,IAAI,CAAC,oBAAoB,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,EAAE,CAAC;YAC7E,iBAAO,CAAC,KAAK,CAAC,oDAAoD,CAAC,CAAC;YACpE,OAAO;QACT,CAAC;QAED,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvC,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;QAC5B,IAAI,CAAC,SAAS,GAAG,CAAC,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,aAAa,GAAG,cAAc,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,aAAa,CAAC;QACpC,IAAI,CAAC,cAAc,GAAG,CAAC,cAAc,CAAC,MAAM,GAAG,aAAa,CAAC,GAAC,IAAI,CAAC;QAEnE,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAE/B,IAAI,CAAC,mBAAmB,CAAC,WAAW,EAAE,aAAa,EAAE,0BAAc,CAAC,gBAAgB,EAAE,cAAc,CAAC,CAAC,IAAI,CACxG,CAAC,MAAe,EAAE,EAAE;YAClB,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;YACvB,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAC;YAC/B,IAAI,CAAC,MAAM,EAAC,CAAC;gBACX,iBAAO,CAAC,KAAK,CAAC,qDAAqD,CAAC,CAAC;gBACrE,OAAO;YACT,CAAC;YACD,qCAAqC;YACrC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAC,CAAC;gBACtB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;gBACzB,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC3B,CAAC;QAEH,CAAC,CACF,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,IAAI,CAAC,aAAa,GAAG,IAAI,UAAU,EAAE,CAAC;QACtC,IAAI,CAAC,uBAAuB,EAAE,CAAC;IACjC,CAAC;IAEM,gBAAgB;QACrB,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAChC,CAAC;IAGD,uBAAuB;QACrB,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACpC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,2BAA2B;QACzB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC/B,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,GAAG,EAAE;gBACtC,+DAA+D;gBAC/D,+CAA+C;gBAE/C,6CAA6C;gBAC7C,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,8BAAa,CAAC,oBAAoB,CAAC,CAAC;gBAEpE,IAAI,CAAC,uBAAuB,EAAE,CAAC;YACjC,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC;QAChC,CAAC;IACH,CAAC;IAED,yBAAyB;IACjB,KAAK,CAAC,mBAAmB,CAC/B,UAAkB,EAClB,cAAsB,EACtB,cAA8B,EAC9B,cAA0B;QAE1B,+BAA+B;QAC/B,MAAM,UAAU,GAAG,UAAU,CAAC;QAC9B,MAAM,MAAM,GAAG,uDAAuD,UAAU,iBAAiB,UAAU,iBAAiB,cAAc,eAAe,cAAc,CAAC,MAAM,GAAG,CAAC;QAElL,QAAQ;QACR,iBAAO,CAAC,KAAK,CAAC,sBAAsB,MAAM,EAAE,CAAC,CAAC;QAE9C,OAAO;QACP,IAAI,eAAe,GAAG,IAAI,CAAC;QAC3B,IAAI,CAAC;YACH,eAAe,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAClD,MAAM,EACN,kCAAe,CAAC,+BAA+B,CAChD,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,iBAAO,CAAC,KAAK,CAAC,4BAA4B,GAAG,EAAE,CAAC,CAAC;YACjD,OAAO,KAAK,CAAC;QACf,CAAC;QAED,iBAAiB;QACjB,IAAI,eAAe,IAAI,CAAC,eAAe,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACvD,IAAI,CAAC,SAAS,GAAG,eAAe,CAAC,QAAQ,CAAC;YAC1C,IAAI,CAAC,aAAa,GAAG,eAAe,CAAC,YAAY,IAAI,IAAI,CAAC,sBAAsB,CAAC;YACjF,IAAI,CAAC,2BAA2B,EAAE,CAAC;YACnC,iBAAO,CAAC,OAAO,CACb,+BAA+B,IAAI,CAAC,SAAS,iBAAiB,IAAI,CAAC,aAAa,eAAe,cAAc,EAAE,CAChH,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,iBAAO,CAAC,IAAI,CAAC,6BAA6B,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC,CAAC;YACpG,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAI,YAAY,CAAE,YAAoB;QACpC,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;QAClC,IAAI,CAAC,sBAAsB,GAAG,YAAY,CAAC;IAC7C,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC7B,QAAuB;QAEvB,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC;QACf,CAAC;QACD,4BAA4B;QAC5B,MAAM,MAAM,GAAG,kDAAkD,QAAQ,GAAG,CAAC;QAE7E,QAAQ;QACR,iBAAO,CAAC,KAAK,CAAC,oBAAoB,MAAM,EAAE,CAAC,CAAC;QAE5C,OAAO;QACP,IAAI,aAAa,GAAG,IAAI,CAAC;QACzB,IAAI,CAAC;YACH,aAAa,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAChD,MAAM,EACN,kCAAe,CAAC,+BAA+B,CAChD,CAAC;QACJ,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,iBAAO,CAAC,KAAK,CAAC,0BAA0B,GAAG,EAAE,CAAC,CAAC;YAC/C,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,aAAa,CAAC,IAAI,KAAK,IAAI,CAAC;IACrC,CAAC;IAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA4BE;IAEM,KAAK,CAAC,iBAAiB;QAC3B,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEnC,0BAA0B;QAC1B,IAAI,IAAI,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;YAC5B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,QAAQ,GAAG,CAAC,CAAC;QACjB,qBAAqB;QACrB,OAAO,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpE,IAAI,IAAI,CAAC,SAAS,EAAC,CAAC;gBAClB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;gBACvD,SAAS;YACX,CAAC;YAED,sBAAsB;YACtB,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,gBAAgB;oBACvB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC;gBACnC,gFAAgF;gBAChF,qFAAqF;gBACrF,iBAAO,CAAC,OAAO,CAAC,sBAAsB,IAAI,CAAC,GAAG,EAAE,GAAG,eAAe,wBAAwB,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;gBAC7G,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;gBAE5B,4GAA4G;gBAC5G,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,8BAAa,CAAC,oBAAoB,CAAC,CAAC;YACtE,CAAC;YAED,oBAAoB;YACpB,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAC5F,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC;YACrF,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC9F,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBAEjD,iBAAO,CAAC,OAAO,CACb,sBAAsB,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,eAAe,UAAU,IAAI,CAAC,UAAU,IAAI,SAAS,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,SAAS,EAAE,CACzJ,CAAC;gBACF,IAAI,CAAC,MAAM,EAAE,CAAC;oBACZ,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,IAAI,CAAC,UAAU,IAAI,SAAS,CAAC;gBAC7B,QAAQ,IAAI,CAAC,CAAC;gBAEd,IAAI,IAAI,CAAC,cAAc,IAAI,QAAQ,GAAG,IAAI,CAAC,sBAAsB,EAAC,CAAC;oBACjE,MAAM,SAAS,GAAG,CAAC,CAAC,SAAS,GAAG,IAAI,CAAC,cAAc,CAAC,GAAC,IAAI,CAAC,GAAG,EAAE,CAAC;oBAChE,iBAAO,CAAC,OAAO,CAAC,eAAe,SAAS,uCAAuC,IAAI,CAAC,cAAc,GAAG,CAAC,EAAE,CAAC,CAAA;oBACzG,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC,CAAC;gBACjE,CAAC;YACH,CAAC;YAED,sCAAsC;YACtC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QACzD,CAAC;QAED,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC1B,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC/B,MAAM,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAE7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,UAAU,CAAC,QAAgB;QACzB,uCAAuC;QACvC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAC1B,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC3B,iBAAO,CAAC,KAAK,CAAC,kCAAkC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IACpE,CAAC;CACF;AArTD,oCAqTC"}

package/dist/RaftSystemType.d.ts

@@ -0,0 +1,21 @@
+import RaftSystemUtils from "./RaftSystemUtils";
+import { RaftEventFn } from "./RaftTypes";
+export type RaftSubscribeForUpdatesCBType = (systemUtils: RaftSystemUtils, enable: boolean) => Promise<void>;
+export type RaftStateIsInvalidCBType = () => void;
+export type RaftRxOtherMsgType = (payload: Uint8Array, _frameTimeMs: number) => void;
+export interface ConnectorOptions {
+    wsSuffix?: string;
+    connTimeoutMs?: number;
+}
+export interface RaftSystemType {
+    nameForDialogs: string;
+    defaultWiFiHostname: string;
+    firmwareDestName: string;
+    normalFileDestName: string;
+    connectorOptions: ConnectorOptions;
+    setup: (systemUtils: RaftSystemUtils, onEvent: RaftEventFn | null) => void;
+    subscribeForUpdates: RaftSubscribeForUpdatesCBType | null;
+    stateIsInvalid: RaftStateIsInvalidCBType | null;
+    rxOtherMsgType: RaftRxOtherMsgType | null;
+}
+export type RaftGetSystemTypeCBType = (systemUtils: RaftSystemUtils) => Promise<RaftSystemType | null>;

package/dist/RaftSystemType.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RaftSystemType.js.map

package/dist/RaftSystemType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RaftSystemType.js","sourceRoot":"","sources":["../src/RaftSystemType.ts"],"names":[],"mappings":""}

package/dist/RaftSystemUtils.d.ts

@@ -0,0 +1,136 @@
+import { RaftWifiConnStatus } from "./RaftWifiTypes";
+import RaftMsgHandler from "./RaftMsgHandler";
+import { RaftFileList, RaftFriendlyName, RaftOKFail, RaftSysModInfoBLEMan, RaftSystemInfo, RaftWifiScanResults } from "./RaftTypes";
+export default class RaftSystemUtils {
+    private _msgHandler;
+    private _systemInfo;
+    private _friendlyName;
+    private _wifiConnStatus;
+    private _defaultWiFiHostname;
+    private _maxSecsToWaitForWiFiConn;
+    /**
+     * constructor
+     * @param raftMsgHandler
+     */
+    constructor(raftMsgHandler: RaftMsgHandler);
+    /**
+     * getMsgHandler
+     * @returns RaftMsgHandler
+     */
+    getMsgHandler(): RaftMsgHandler;
+    /**
+     * setDefaultWiFiHostname
+     * @param defaultWiFiHostname
+     */
+    setDefaultWiFiHostname(defaultWiFiHostname: string): void;
+    /**
+     * getFriendlyName
+     *
+     * @returns friendly name
+     */
+    getFriendlyName(): RaftFriendlyName | null;
+    /**
+     * invalidate
+     */
+    invalidate(): void;
+    /**
+     * retrieveInfo - get system info
+     * @returns Promise<RaftSystemInfo>
+     *
+     */
+    retrieveInfo(): Promise<boolean>;
+    /**
+     *
+     * getSystemInfo
+     * @param forceGet - true to force a get from the raft app
+     * @returns Promise<RaftSystemInfo>
+     *
+     */
+    getSystemInfo(forceGet?: boolean): Promise<RaftSystemInfo>;
+    /**
+     *
+     * setRaftName
+     * @param newName name to refer to Raft - used for BLE advertising
+     * @returns Promise<boolean> true if successful
+     *
+     */
+    setRaftName(newName: string): Promise<boolean>;
+    /**
+     *
+     * getRaftName
+     * @param forceGet - true to force a get from the raft app
+     * @returns Promise<RaftNameResponse> (object containing rslt)
+     *
+     */
+    getRaftName(forceGet?: boolean): Promise<RaftFriendlyName>;
+    /**
+     *
+     * getFileList - get list of files on file system
+     * @returns Promise<RaftFileList>
+     *
+     */
+    getFileList(): Promise<RaftFileList>;
+    /**
+     *
+     * Get BLEMan sysmod info
+     *
+     * @returns RaftSysModInfoBLEMan
+     *
+     */
+    getSysModInfoBLEMan(): Promise<RaftSysModInfoBLEMan | null>;
+    /**
+     * Get hostname of connected WiFi
+     *
+     *  @return string - hostname of connected WiFi
+     *
+     */
+    _getHostnameFromFriendlyName(): string;
+    /**
+     * Get Wifi connection status
+     *
+     *  @return boolean - true if connected
+     *
+     */
+    getWiFiConnStatus(): Promise<boolean | null>;
+    /**
+     * pause Wifi connection
+     *
+     *  @param boolean - true to pause, false to resume
+     *  @return boolean - true if successful
+     *
+     */
+    pauseWifiConnection(pause: boolean): Promise<boolean>;
+    /**
+     * Connect to WiFi
+     *
+     *  @param string - WiFi SSID
+     *  @param string - WiFi password
+     *  @return boolean - true if successful
+     *
+     */
+    wifiConnect(ssid: string, password: string): Promise<boolean>;
+    /**
+     * Disconnect WiFi
+     *
+     *  @return boolean - true if successful
+     *
+     */
+    wifiDisconnect(): Promise<boolean>;
+    /**
+     *  WiFiScan start
+     *
+     *  @return boolean - true if successful
+     *
+     */
+    wifiScanStart(): Promise<boolean>;
+    /**
+     *  WiFiScan get results
+     *
+     *  @return boolean - false if unsuccessful, otherwise the results of the promise
+     *
+     */
+    wifiScanResults(): Promise<boolean | RaftOKFail | RaftWifiScanResults>;
+    getCachedSystemInfo(): RaftSystemInfo | null;
+    getCachedRaftName(): RaftFriendlyName | null;
+    getCachedWifiStatus(): RaftWifiConnStatus;
+}