@robdobsn/raftjs 1.1.1

package/src/main.ts

@@ -0,0 +1,28 @@
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// RaftJS
+// Commms library for the Raft ESP32 application framework supporting BLE, WebSockets and Serial
+//
+// Rob Dobson & Chris Greening 2020-2024
+// (C) 2020-2024 All rights reserved
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export { default as RaftCommsStats } from './RaftCommsStats';
+export { default as RaftConnector } from './RaftConnector';
+export { default as RaftChannel } from './RaftChannel';
+export { default as RaftChannelWebBLE } from './RaftChannelWebBLE';
+export { default as RaftChannelWebSocket } from './RaftChannelWebSocket';
+export { default as RaftFileHandler } from './RaftFileHandler';
+export { default as RaftLog } from './RaftLog';
+export { default as RaftMiniHDLC } from './RaftMiniHDLC';
+export { default as RaftMsgHandler } from './RaftMsgHandler'
+export { default as RaftStreamHandler } from './RaftStreamHandler';
+export { default as RaftSystemUtils } from './RaftSystemUtils';
+export { default as RaftUtils } from './RaftUtils';
+export * from './RaftTypes';
+export * from './RaftSystemType';
+export * from './RaftWifiTypes';
+export * from './RaftConnEvents';
+export * from './RaftUpdateEvents';
+export * from "./RaftProtocolDefs";

package/testdata/TestDeviceTypeRecs.json

@@ -0,0 +1,492 @@
+{
+    "devTypes": {
+        "VCNL4040": {
+            "addresses": "0x60",
+            "deviceType": "VCNL4040",
+            "detectionValues": "0x0c=0b100001100000XXXX",
+            "initValues": "0x041007=&0x030e08=&0x000000=",
+            "pollInfo": {
+                "c": "0x08=r2&0x09=r2&0x0a=r2",
+                "i": 200,
+                "s": 10
+            },
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "VCNL4040",
+                "desc": "Prox&ALS",
+                "manu": "Vishay",
+                "type": "VCNL4040",
+                "resp": {
+                    "b": 6,
+                    "a": [
+                        {
+                            "n": "prox",
+                            "t": "<H",
+                            "u": "",
+                            "r": [0,65535],
+                            "d": 0,
+                            "f": "5d",
+                            "o": "uint16"
+                        },
+                        {
+                            "n": "als",
+                            "t": "<H",
+                            "u": "lux",
+                            "r": [0,65535],
+                            "d": 10,
+                            "f": "5.2f",
+                            "o": "float"
+                        },
+                        {
+                            "n": "white",
+                            "t": "<H",
+                            "u": "lux",
+                            "r": [0,65535],
+                            "d": 10,
+                            "f": "5.2f",
+                            "o": "float"
+                        }
+                    ]
+                }
+            }
+        },
+        "VL6180": {
+            "_notes": "Interleaved mode ALS & Range (0x2a3=>0x01)\nRange settings defined in https://www.st.com/resource/en/application_note/an4545-vl6180x-basic-ranging-application-note-stmicroelectronics.pdf\nALS integration period 100ms (0x0040=>0x0063)\nALS gain 20 (0x003f=>0x40)\n",
+            "addresses": "0x29",
+            "deviceType": "VL6180",
+            "detectionValues": "0x0000=0b10110100",
+            "initValues": "0x020701&0x020801&0x009600&0x0097fd&0x00e301&0x00e403&0x00e502&0x00e601&0x00e703&0x00f502&0x00d905&0x00dbce&0x00dc03&0x00ddf8&0x009f00&0x00a33c&0x00b700&0x00bb3c&0x00b209&0x00ca09&0x019801&0x01b017&0x01ad00&0x00ff05&0x010005&0x019905&0x01a61b&0x01ac3e&0x01a71f&0x003000&0x001110&0x010a30&0x003f42&0x0031ff&0x004000&0x004163&0x002e01&0x001b09&0x003e31&0x001424&0x003801",
+            "pollInfo": {
+                "c": "0x004f=r1&0x0062=r1&0x001507&0x001801",
+                "i": 200,
+                "s": 10
+            },
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "VL6180",
+                "desc": "ToF",
+                "manu": "ST",
+                "type": "VL6180",
+                "resp": {
+                    "b": 2,
+                    "a": [
+                        {
+                            "n": "valid",
+                            "t": "B",
+                            "u": "",
+                            "r": [0,1],
+                            "m": "0x04",
+                            "s": 2,
+                            "f": "b",
+                            "o": "bool",
+                            "vs": false
+                        },
+                        {
+                            "n": "dist",
+                            "t": "B",
+                            "u": "mm",
+                            "r": [0,255],
+                            "f": "3d",
+                            "o": "float",
+                            "vft": "valid"
+                        }
+                    ]
+                }
+            }
+        },
+        "MAX30101": {
+            "_notes": "init: 0x0940 (reset), 0x00=r1 (clear INT), 0x0903 (SpO2mode Red+IR), 0x085f (4 sample avg, FIFO rollover, FIFO Int 17), 0x0A27 (100 samples/s, 18bit), 0x0c40&0x0d40 (LEDs 12.6mA), 0x1121 (Slot interleaved)",
+            "addresses": "0x57",
+            "deviceType": "MAX30101",
+            "detectionValues": "0xff=0x15",
+            "initValues": "0x0940&0x00=r1&0x085f&0x0903&0x0a27&0x0c4040&0x11=0x21",
+            "pollInfo": {
+                "c": "0x04=r51",
+                "i": 200,
+                "s": 5
+            },
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "MAX30101",
+                "desc": "Prox&ALS",
+                "manu": "Vishay",
+                "type": "MAX30101",
+                "resp": {
+                    "b": 51,
+                    "a": [
+                        {
+                            "n": "Red",
+                            "t": ">I",
+                            "u": "",
+                            "r": [0, 16777215],
+                            "f": "6d",
+                            "o": "uint32"
+                        },
+                        {
+                            "n": "IR",
+                            "t": ">I",
+                            "u": "",
+                            "r": [0, 16777215],
+                            "f": "6d",
+                            "o": "uint32"
+                        }
+                    ],
+                    "c": {
+                        "n": "max30101_fifo",
+                        "c": "int N=(buf[0]+32-buf[2])%32;int k=3;int i=0;while(i<N){out.Red=(buf[k]<<16)|(buf[k+1]<<8)|buf[k+2];out.IR=(buf[k+3]<<16)|(buf[k+4]<<8)|buf[k+5];k+=6;i++;next;}"
+                    },
+                    "us": 40000
+                }
+            }
+        },        
+        "ADXL313": {
+            "addresses": "0x1d,0x53",
+            "deviceType": "ADXL313",
+            "detectionValues": "0x00=0b1010110100011101",
+            "initValues": "0x2d0c=;0x310a=",
+            "pollInfo": {
+                "c": "0x32=r6",
+                "i": 100,
+                "s": 10
+            },
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "ADXL313",
+                "desc": "3-Axis Accel",
+                "manu": "Analog Devices",
+                "type": "ADXL313",
+                "resp": {
+                    "b": 6,
+                    "a": [
+                        {
+                            "n": "x",
+                            "t": "<h",
+                            "u": "g",
+                            "r": [-4.0, 4.0],
+                            "d": 1024,
+                            "f": ".2f",
+                            "o": "float"
+                        },
+                        {
+                            "n": "y",
+                            "t": "<h",
+                            "u": "g",
+                            "r": [-4.0,4.0],
+                            "d": 1024,
+                            "f": ".2f",
+                            "o": "float"
+                        },
+                        {
+                            "n": "z",
+                            "t": "<h",
+                            "u": "g",
+                            "r": [-4.0,4.0],
+                            "d": 1024,
+                            "f": ".2f",
+                            "o": "float"
+                        }
+                    ]
+                }
+            }
+        },
+        "AHT20": {
+            "addresses": "0x38",
+            "deviceType": "AHT20",
+            "detectionValues": "",
+            "initValues": "0xbe0800=",
+            "pollInfo": {
+                "c": "=r6&0xac3300=",
+                "i": 5000,
+                "s": 2
+            },
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "AHT20",
+                "desc": "Temp&Humid",
+                "manu": "Asair",
+                "type": "AHT20",
+                "resp": {
+                    "b": 6,
+                    "a": [
+                        {
+                            "n": "status",
+                            "t": "B",
+                            "u": "",
+                            "f": "02x",
+                            "o": "uint8",
+                            "vs": false
+                        },
+                        {
+                            "n": "humidity",
+                            "t": ">I",
+                            "u": "%",
+                            "r": [0, 100],
+                            "m": "0xfffff000",
+                            "s": 12,
+                            "d": 10485.76,
+                            "f": "3.1f",
+                            "o": "float"
+                        },
+                        {
+                            "n": "temperature",
+                            "at": 2,
+                            "t": ">I",
+                            "u": "&deg;C",
+                            "r": [-40,80],
+                            "m": "0x000fffff",
+                            "d": 5242.88,
+                            "a": -50,
+                            "f": "3.2f",
+                            "o": "float"
+                        }
+                    ]
+                }
+            }
+        },
+        "MCP9808": {
+            "addresses": "0x18-0x1f",
+            "deviceType": "MCP9808",
+            "detectionValues": "0x06=0b0000000001010100&0x07=0b00000100XXXXXXXX",
+            "initValues": "0x010000",
+            "pollInfo": {
+                "c": "0x05=r2",
+                "i": 5000,
+                "s": 2
+            },
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "MCP9808",
+                "desc": "Temp",
+                "manu": "Microchip",
+                "type": "MCP9808",
+                "resp": {
+                    "b": 2,
+                    "a": [
+                        {
+                            "n": "temperature",
+                            "t": ">H",
+                            "u": "&deg;C",
+                            "r": [-40,125],
+                            "m": "0x1fff",
+                            "d": 16,
+                            "sb": 12,
+                            "ss": 4096,
+                            "f": "3.2f",
+                            "o": "float"
+                        }
+                    ]
+                }
+            }
+        },
+        "LPS25": {
+            "addresses": "0x5D",
+            "deviceType": "LPS25",
+            "detectionValues": "0x0f=0b10111101",
+            "initValues": "0x2104=&0x20C0=",
+            "pollInfo": {
+                "c": "0xA7=r6",
+                "i": 1000,
+                "s": 2
+            },
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "LPS25",
+                "desc": "Pressure",
+                "manu": "ST",
+                "type": "LPS25",
+                "resp": {
+                    "b": 6,
+                    "a": [
+                        {
+                            "n": "status",
+                            "t": "B",
+                            "r": [0,255],
+                            "m": "0xff",
+                            "f": "02x",
+                            "o": "uint8",
+                            "vs": false
+                        },
+                        {
+                            "n": "pressure",
+                            "at": 0,
+                            "t": "<I",
+                            "u": "hPa",
+                            "r": [260,1260],
+                            "s": 8,
+                            "d": 4096,
+                            "f": "4.2f",
+                            "o": "float"
+                        },
+                        {
+                            "n": "temperature",
+                            "at": 4,
+                            "t": "<h",
+                            "u": "&deg;C",
+                            "r": [-30,105],
+                            "d": 480,
+                            "a": 42.5,
+                            "f": "3.2f",
+                            "o": "float"
+                        }
+                    ]
+                }
+            }
+        },
+        "CAP1203": {
+            "addresses": "0x28",
+            "deviceType": "CAP1203",
+            "detectionValues": "0xfd=0b01101101",
+            "initValues": "0x0000&0x1f06",
+            "pollInfo": {
+                "c": "0x02=r2&0x0000",
+                "i": 100,
+                "s": 10
+            },
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "CAP1203",
+                "desc": "Capacitive Touch x 3",
+                "manu": "Sparkfun",
+                "type": "CAP1203",
+                "resp": {
+                    "b": 2,
+                    "a": [
+                        {
+                            "n": "A",
+                            "at": 1,
+                            "t": "B",
+                            "r": [0, 1],
+                            "m": "0x01",
+                            "s": 0,
+                            "f": "b",
+                            "o": "bool"
+                        },
+                        {
+                            "n": "B",
+                            "at": 1,
+                            "t": "B",
+                            "r": [0, 1],
+                            "m": "0x02",
+                            "s": 1,
+                            "f": "b",
+                            "o": "bool"
+                        },
+                        {
+                            "n": "C",
+                            "at": 1,
+                            "t": "B",
+                            "r": [0, 1],
+                            "m": "0x04",
+                            "s": 2,
+                            "f": "b",
+                            "o": "bool"
+                        },
+                        {
+                            "n": "status",
+                            "t": ">H",
+                            "vs": false,
+                            "f": "04x",
+                            "o": "uint16"
+                        }
+                    ]
+                }
+            }
+        },
+        "QwiicButton": {
+            "addresses": "0x6f",
+            "deviceType": "QwiicButton",
+            "detectionValues": "0x00=0b01011101",
+            "initValues": "",
+            "pollInfo": {
+                "c": "0x03=r1",
+                "i": 100,
+                "s": 10
+            },
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "Qwiic Button",
+                "desc": "Button",
+                "manu": "Sparkfun",
+                "type": "QwiicButton",
+                "resp": {
+                    "b": 1,
+                    "a": [
+                        {
+                            "n": "press",
+                            "t": "B",
+                            "u": "",
+                            "r": [0, 1],
+                            "m": "0x04",
+                            "s": 2,
+                            "f": "b",
+                            "o": "bool"
+                        }
+                    ]
+                },
+                "actions": [
+                    {
+                        "n": "brightness",
+                        "t": "B",
+                        "w": "19",
+                        "r": [0,255]
+                    },
+                    {
+                        "n": "granularity",
+                        "t": "B",
+                        "w": "1a",
+                        "r": [1,255]
+                    },
+                    {
+                        "n": "cycle time",
+                        "t": "<H",
+                        "w": "1b",
+                        "r": [0,65535]
+                    },
+                    {
+                        "n": "off time",
+                        "t": "<H",
+                        "w": "1d",
+                        "r": [0,65535]
+                    }
+                ]
+            }
+        },
+        "QwiicLEDStick": {
+            "addresses": "0x23",
+            "deviceType": "QwiicLEDStick",
+            "detectionValues": "",
+            "initValues": "",
+            "pollInfo": {},
+            "scanPriority": "high",
+            "devInfoJson": {
+                "name": "Qwiic LED Stick",
+                "desc": "LEDs",
+                "manu": "Sparkfun",
+                "type": "QwiicLEDStick",
+                "actions": [
+                    {
+                        "n": "pixels",
+                        "t": "BBBB",
+                        "w": "71",
+                        "f": "LEDPIX",
+                        "NX": 10,
+                        "NY": 1,
+                        "concat": false,
+                        "r": [0,255]
+                    },
+                    {
+                        "n": "brightness",
+                        "t": "B",
+                        "w": "76",
+                        "r": [0,255],
+                        "d": 50
+                    },
+                    {
+                        "n": "off",
+                        "w": "78"
+                    }
+                ]
+            }
+        }
+    }
+}

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+"compilerOptions": {
+    "target": "es2017",
+    "module": "commonjs",
+    "lib": ["dom", "es2017"],
+    "outDir": "./dist/",
+    "rootDir": "./src",
+    "strict": true,
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "sourceMap": true,
+    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
+    "strictNullChecks": true /* Enable strict null checks. */,
+    "strictFunctionTypes": true /* Enable strict checking of function types. */,
+    "noUnusedLocals": true /* Report errors on unused locals. */,
+    "noUnusedParameters": true /* Report errors on unused parameters. */,
+    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
+    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
+    "importHelpers": true,
+    "resolveJsonModule": true,
+},
+"include": ["src","__tests__"],
+"exclude": ["node_modules","dist","**/*.test.ts"]
+}