tirecheck-device-sdk 0.1.0 → 0.1.2

package/README.md

@@ -62,12 +62,49 @@ implementation so that test passes.
 Focus on one small improvement at a time - one failing test, then make it pass, then another failing test, etc. Mentally
 this approach is much easier because you don't need to think about system as a whole
 
+### Local testing in app
+
+To test the library in your application, without publishing them to npm, please, run following commands:
+
+```
+// From /Work/tirecheck-device-sdk
+pnpm build
+
+// From /Work/my-app
+pnpm link ../tirecheck-device-sdk
+```
+
+This will temporarily ensure that package is taken from your local directory and not from package.json.
+
 ### Conventions
 
 - use `deviceMeta` for storing generic device info and methods for processing advertisement for all supported devices
   - this is to avoid importing full device services before we're connected to them
 - use `devices/*` for exposed logic related to devices after they're connected. That includes methods `connect` and
   `disconnect`.
+- For more complicated devices, such as `bridge`, it is useful to create `bridgeCommands` file, that contain _commands_.
+  Command = method that accepts human-readable arguments and converts them to _single_ low-level call of `ble` (i.e. it
+  just converts human-readable data to binary data and sends them to `ble`).
+
+```
+// bridge.ts - methods from this file are exposed to library users
+import bridgeCommands from './bridgeCommands'
+
+export default {
+  // You can expose command directly...
+  getMeasurement: bridgeCommands.getMeasurement,
+
+  // Or expose method that calls sequence of commands
+  async getVehicleSchema() {
+    const axles = await bridgeCommands.getVehicleAxles()
+    for(let i = 0; i < axles.length; i++) {
+      const tyres = await bridgeCommands.getVehicleTyres(i)
+    }
+    return { axles, tyres }
+  }
+}
+```
+
 - use `services/*` for logic shared between devices. Those files won't be exposed in the build.
 - expose only top-level functions. So, expose `bridge.writeConfiguration` or `bridge.writeAxleSetup` instead of generic
   `bridge.writeMessage`
@@ -96,6 +133,14 @@ export default {
 function foo() {}
 ```
 
+### Simulator
+
+For each supported device, you must provide a simulator. It is important for testing final apps. **Simulator replaces
+high-level calls** - i.e. it works with human-readable data and doesn't need to convert data to binary
+
+- For complex devices with `commands` layer, such as bridge example above, we advice to simulate only `commands` layer,
+  and leave top-level as is
+
 ### Submitting changes
 
 If you wish to include a new change, process is as follows:
@@ -117,6 +162,10 @@ You can contact tirecheck if you need support - admin@tirecheck.com
 
 [x] Initial structure
 
+[x] Simulators
+
+[x] Ability to test against real devices
+
 [] Full CAN bridge support
 
 [] CAN Bridge Firmware Update support

package/dist/index.cjs

@@ -309,19 +309,19 @@ const deviceMeta = {
 
 const checkUnreachableDevicesTimeouts = {};
 const checkConnectedStateIntervals = {};
-const deviceAdvertisingCallbacks = [];
-const deviceUpdateCallbacks = [];
-const deviceUnreachableCallbacks = [];
+let deviceAdvertisingCallback;
+let deviceUpdateCallback;
+let deviceUnreachableCallback;
 const bluetooth = {
   /** Triggered when "scanDevices" detects device supported by SDK */
-  onDeviceAdvertising(deviceAdvertisingCallback) {
-    deviceAdvertisingCallbacks.push(deviceAdvertisingCallback);
+  onDeviceAdvertising(callback) {
+    deviceAdvertisingCallback = callback;
   },
-  onDeviceUpdate(deviceUpdateCallback) {
-    deviceUpdateCallbacks.push(deviceUpdateCallback);
+  onDeviceUpdate(callback) {
+    deviceUpdateCallback = callback;
   },
-  onDeviceUnreachable(deviceUnreachableCallback) {
-    deviceUnreachableCallbacks.push(deviceUnreachableCallback);
+  onDeviceUnreachable(callback) {
+    deviceUnreachableCallback = callback;
   },
   async scanDevices(services = []) {
     await ble.stopScan();
@@ -339,9 +339,7 @@ const bluetooth = {
         const processedDevice = processDevice(device);
         if (!processedDevice)
           return;
-        for (const c of deviceAdvertisingCallbacks) {
-          c(processedDevice);
-        }
+        deviceAdvertisingCallback?.(processedDevice);
       },
       (e) => console.error("ble.startScanWithOptions error:", e)
     );
@@ -392,9 +390,7 @@ function monitorConnectedState(deviceId) {
     } catch {
       isConnected = false;
     }
-    for (const c of deviceUpdateCallbacks) {
-      c({ deviceId, isConnected });
-    }
+    deviceUpdateCallback?.({ deviceId, isConnected });
   }, 1e3);
 }
 function refreshUnreachableTimeouts(deviceId) {
@@ -402,9 +398,7 @@ function refreshUnreachableTimeouts(deviceId) {
     clearTimeout(checkUnreachableDevicesTimeouts[deviceId]);
   }
   checkUnreachableDevicesTimeouts[deviceId] = setTimeout(() => {
-    for (const c of deviceUnreachableCallbacks) {
-      c(deviceId);
-    }
+    deviceUnreachableCallback?.(deviceId);
     if (checkConnectedStateIntervals[deviceId]) {
       clearInterval(checkConnectedStateIntervals[deviceId]);
       delete checkConnectedStateIntervals[deviceId];

package/dist/index.d.cts

@@ -28,6 +28,89 @@ interface PeripheralData {
 }
 type PeripheralState = 'disconnected' | 'disconnecting' | 'connecting' | 'connected';
 
+declare const _default: {
+    bridge: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        capabilities: never[];
+        manufacturerId: number;
+        mtu: number;
+        getDeviceInfoFromAdvertising: (device: PeripheralData) => BleBridge | undefined;
+    };
+    bridgeOta: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        capabilities: never[];
+        getDeviceInfoFromAdvertising: () => void;
+    };
+    flexiGaugeTpms: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        getDeviceInfoFromAdvertising: () => void;
+        capabilities: {
+            id: string;
+            regex: RegExp;
+        }[];
+        reconnect: boolean;
+    };
+    pressureStick: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        getDeviceInfoFromAdvertising: () => void;
+        capabilities: {
+            id: string;
+            regex: RegExp;
+        }[];
+    };
+};
+
+interface BluetoothDeviceCharacteristic {
+    serviceId: string;
+    characteristicId: string;
+}
+interface BluetoothDeviceCapability {
+    id: string;
+    processFn: Function;
+    regex: RegExp;
+}
+interface BluetoothDeviceHandler {
+    /** Characteristic on which device sends messages, will be subscribed by connect function  */
+    characteristic: BluetoothDeviceCharacteristic;
+    capabilities: BluetoothDeviceCapability[];
+    name: string;
+    /** Icon to display in bluetooth device list, e.g. "mdi-bluetooth" or "icon-flexigauge" */
+    icon: string;
+    regex: RegExp;
+    /** Used for messages and responses from device */
+    processMessage: Function;
+    tpmsScan?: Function;
+    getPinFn?: Function;
+    /** Used to increase/decrease byte count recieved, when library splits messages */
+    mtu?: number;
+    /** If true application will remember this device and will try to reconnect to it on app launch */
+    reconnect?: boolean;
+    /** Will be run repeatedly if defined, should return keep alive command, interval, characteristic */
+    keepAliveFn?: Function;
+    /** Used to get information from device advertising */
+    processAdvertising?: Function;
+    /** Will be run after successfull connection is established as a part of connect() promise */
+    onConnected?: Function;
+    /** Will be run after successfull disconnection as a part of disconnect() promise */
+    onDisconnected?: Function;
+}
+type BleDeviceType = keyof typeof _default;
 type BleDevice = BleBridge;
 interface BleBridge {
     id: string;
@@ -55,14 +138,14 @@ interface BleBridgeAdvertisingData {
 
 declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation): {
     bluetooth: {
-        onDeviceAdvertising(deviceAdvertisingCallback: (device: BleDevice) => void): void;
-        onDeviceUpdate(deviceUpdateCallback: (update: {
+        onDeviceAdvertising(callback: (device: BleDevice) => void): void;
+        onDeviceUpdate(callback: (update: {
             deviceId: string;
             isConnected: boolean;
         }) => void): void;
-        onDeviceUnreachable(deviceUnreachableCallback: (deviceId: string) => void): void;
+        onDeviceUnreachable(callback: (deviceId: string) => void): void;
         scanDevices(services?: string[]): Promise<void>;
     };
 };
 
-export { createTirecheckDeviceSdk };
+export { type BleBridge, type BleBridgeAdvertisingData, type BleDevice, type BleDeviceType, type BluetoothDeviceCapability, type BluetoothDeviceCharacteristic, type BluetoothDeviceHandler, createTirecheckDeviceSdk };

package/dist/index.d.mts

@@ -28,6 +28,89 @@ interface PeripheralData {
 }
 type PeripheralState = 'disconnected' | 'disconnecting' | 'connecting' | 'connected';
 
+declare const _default: {
+    bridge: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        capabilities: never[];
+        manufacturerId: number;
+        mtu: number;
+        getDeviceInfoFromAdvertising: (device: PeripheralData) => BleBridge | undefined;
+    };
+    bridgeOta: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        capabilities: never[];
+        getDeviceInfoFromAdvertising: () => void;
+    };
+    flexiGaugeTpms: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        getDeviceInfoFromAdvertising: () => void;
+        capabilities: {
+            id: string;
+            regex: RegExp;
+        }[];
+        reconnect: boolean;
+    };
+    pressureStick: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        getDeviceInfoFromAdvertising: () => void;
+        capabilities: {
+            id: string;
+            regex: RegExp;
+        }[];
+    };
+};
+
+interface BluetoothDeviceCharacteristic {
+    serviceId: string;
+    characteristicId: string;
+}
+interface BluetoothDeviceCapability {
+    id: string;
+    processFn: Function;
+    regex: RegExp;
+}
+interface BluetoothDeviceHandler {
+    /** Characteristic on which device sends messages, will be subscribed by connect function  */
+    characteristic: BluetoothDeviceCharacteristic;
+    capabilities: BluetoothDeviceCapability[];
+    name: string;
+    /** Icon to display in bluetooth device list, e.g. "mdi-bluetooth" or "icon-flexigauge" */
+    icon: string;
+    regex: RegExp;
+    /** Used for messages and responses from device */
+    processMessage: Function;
+    tpmsScan?: Function;
+    getPinFn?: Function;
+    /** Used to increase/decrease byte count recieved, when library splits messages */
+    mtu?: number;
+    /** If true application will remember this device and will try to reconnect to it on app launch */
+    reconnect?: boolean;
+    /** Will be run repeatedly if defined, should return keep alive command, interval, characteristic */
+    keepAliveFn?: Function;
+    /** Used to get information from device advertising */
+    processAdvertising?: Function;
+    /** Will be run after successfull connection is established as a part of connect() promise */
+    onConnected?: Function;
+    /** Will be run after successfull disconnection as a part of disconnect() promise */
+    onDisconnected?: Function;
+}
+type BleDeviceType = keyof typeof _default;
 type BleDevice = BleBridge;
 interface BleBridge {
     id: string;
@@ -55,14 +138,14 @@ interface BleBridgeAdvertisingData {
 
 declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation): {
     bluetooth: {
-        onDeviceAdvertising(deviceAdvertisingCallback: (device: BleDevice) => void): void;
-        onDeviceUpdate(deviceUpdateCallback: (update: {
+        onDeviceAdvertising(callback: (device: BleDevice) => void): void;
+        onDeviceUpdate(callback: (update: {
             deviceId: string;
             isConnected: boolean;
         }) => void): void;
-        onDeviceUnreachable(deviceUnreachableCallback: (deviceId: string) => void): void;
+        onDeviceUnreachable(callback: (deviceId: string) => void): void;
         scanDevices(services?: string[]): Promise<void>;
     };
 };
 
-export { createTirecheckDeviceSdk };
+export { type BleBridge, type BleBridgeAdvertisingData, type BleDevice, type BleDeviceType, type BluetoothDeviceCapability, type BluetoothDeviceCharacteristic, type BluetoothDeviceHandler, createTirecheckDeviceSdk };

package/dist/index.d.ts

@@ -28,6 +28,89 @@ interface PeripheralData {
 }
 type PeripheralState = 'disconnected' | 'disconnecting' | 'connecting' | 'connected';
 
+declare const _default: {
+    bridge: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        capabilities: never[];
+        manufacturerId: number;
+        mtu: number;
+        getDeviceInfoFromAdvertising: (device: PeripheralData) => BleBridge | undefined;
+    };
+    bridgeOta: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        capabilities: never[];
+        getDeviceInfoFromAdvertising: () => void;
+    };
+    flexiGaugeTpms: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        getDeviceInfoFromAdvertising: () => void;
+        capabilities: {
+            id: string;
+            regex: RegExp;
+        }[];
+        reconnect: boolean;
+    };
+    pressureStick: {
+        nameRegex: RegExp;
+        characteristic: {
+            serviceId: string;
+            characteristicId: string;
+        };
+        getDeviceInfoFromAdvertising: () => void;
+        capabilities: {
+            id: string;
+            regex: RegExp;
+        }[];
+    };
+};
+
+interface BluetoothDeviceCharacteristic {
+    serviceId: string;
+    characteristicId: string;
+}
+interface BluetoothDeviceCapability {
+    id: string;
+    processFn: Function;
+    regex: RegExp;
+}
+interface BluetoothDeviceHandler {
+    /** Characteristic on which device sends messages, will be subscribed by connect function  */
+    characteristic: BluetoothDeviceCharacteristic;
+    capabilities: BluetoothDeviceCapability[];
+    name: string;
+    /** Icon to display in bluetooth device list, e.g. "mdi-bluetooth" or "icon-flexigauge" */
+    icon: string;
+    regex: RegExp;
+    /** Used for messages and responses from device */
+    processMessage: Function;
+    tpmsScan?: Function;
+    getPinFn?: Function;
+    /** Used to increase/decrease byte count recieved, when library splits messages */
+    mtu?: number;
+    /** If true application will remember this device and will try to reconnect to it on app launch */
+    reconnect?: boolean;
+    /** Will be run repeatedly if defined, should return keep alive command, interval, characteristic */
+    keepAliveFn?: Function;
+    /** Used to get information from device advertising */
+    processAdvertising?: Function;
+    /** Will be run after successfull connection is established as a part of connect() promise */
+    onConnected?: Function;
+    /** Will be run after successfull disconnection as a part of disconnect() promise */
+    onDisconnected?: Function;
+}
+type BleDeviceType = keyof typeof _default;
 type BleDevice = BleBridge;
 interface BleBridge {
     id: string;
@@ -55,14 +138,14 @@ interface BleBridgeAdvertisingData {
 
 declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation): {
     bluetooth: {
-        onDeviceAdvertising(deviceAdvertisingCallback: (device: BleDevice) => void): void;
-        onDeviceUpdate(deviceUpdateCallback: (update: {
+        onDeviceAdvertising(callback: (device: BleDevice) => void): void;
+        onDeviceUpdate(callback: (update: {
             deviceId: string;
             isConnected: boolean;
         }) => void): void;
-        onDeviceUnreachable(deviceUnreachableCallback: (deviceId: string) => void): void;
+        onDeviceUnreachable(callback: (deviceId: string) => void): void;
         scanDevices(services?: string[]): Promise<void>;
     };
 };
 
-export { createTirecheckDeviceSdk };
+export { type BleBridge, type BleBridgeAdvertisingData, type BleDevice, type BleDeviceType, type BluetoothDeviceCapability, type BluetoothDeviceCharacteristic, type BluetoothDeviceHandler, createTirecheckDeviceSdk };

package/dist/index.mjs

@@ -303,19 +303,19 @@ const deviceMeta = {
 
 const checkUnreachableDevicesTimeouts = {};
 const checkConnectedStateIntervals = {};
-const deviceAdvertisingCallbacks = [];
-const deviceUpdateCallbacks = [];
-const deviceUnreachableCallbacks = [];
+let deviceAdvertisingCallback;
+let deviceUpdateCallback;
+let deviceUnreachableCallback;
 const bluetooth = {
   /** Triggered when "scanDevices" detects device supported by SDK */
-  onDeviceAdvertising(deviceAdvertisingCallback) {
-    deviceAdvertisingCallbacks.push(deviceAdvertisingCallback);
+  onDeviceAdvertising(callback) {
+    deviceAdvertisingCallback = callback;
   },
-  onDeviceUpdate(deviceUpdateCallback) {
-    deviceUpdateCallbacks.push(deviceUpdateCallback);
+  onDeviceUpdate(callback) {
+    deviceUpdateCallback = callback;
   },
-  onDeviceUnreachable(deviceUnreachableCallback) {
-    deviceUnreachableCallbacks.push(deviceUnreachableCallback);
+  onDeviceUnreachable(callback) {
+    deviceUnreachableCallback = callback;
   },
   async scanDevices(services = []) {
     await ble.stopScan();
@@ -333,9 +333,7 @@ const bluetooth = {
         const processedDevice = processDevice(device);
         if (!processedDevice)
           return;
-        for (const c of deviceAdvertisingCallbacks) {
-          c(processedDevice);
-        }
+        deviceAdvertisingCallback?.(processedDevice);
       },
       (e) => console.error("ble.startScanWithOptions error:", e)
     );
@@ -386,9 +384,7 @@ function monitorConnectedState(deviceId) {
     } catch {
       isConnected = false;
     }
-    for (const c of deviceUpdateCallbacks) {
-      c({ deviceId, isConnected });
-    }
+    deviceUpdateCallback?.({ deviceId, isConnected });
   }, 1e3);
 }
 function refreshUnreachableTimeouts(deviceId) {
@@ -396,9 +392,7 @@ function refreshUnreachableTimeouts(deviceId) {
     clearTimeout(checkUnreachableDevicesTimeouts[deviceId]);
   }
   checkUnreachableDevicesTimeouts[deviceId] = setTimeout(() => {
-    for (const c of deviceUnreachableCallbacks) {
-      c(deviceId);
-    }
+    deviceUnreachableCallback?.(deviceId);
     if (checkConnectedStateIntervals[deviceId]) {
       clearInterval(checkConnectedStateIntervals[deviceId]);
       delete checkConnectedStateIntervals[deviceId];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tirecheck-device-sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "SDK for working with various devices produced by Tirecheck via Bluetooth (CAN Bridge, Routers, Sensors, FlexiGauge, PressureStick, etc)",
   "author": "Leonid Buneev <leonid.buneev@tirecheck.com>",
   "license": "ISC",
@@ -11,22 +11,42 @@
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": ">=18"
+  },
   "dependencies": {
-    "lodash": "^4.17.21"
+    "crypto-js": "^4.2.0",
+    "lodash": "^4.17.21",
+    "uuid": "^10.0.0"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^2.25.1",
+    "@types/express": "^4.17.21",
     "@types/lodash": "^4.17.7",
+    "@types/websocket": "^1.0.10",
     "@vitest/ui": "^2.0.5",
+    "chalk": "^5.3.0",
     "eslint": "^9.9.0",
     "eslint-plugin-format": "^0.1.2",
     "eslint-plugin-tyrecheck": "^2.64.0",
+    "express": "^4.19.2",
+    "express-ws": "^5.0.2",
+    "h3": "^1.12.0",
+    "ngrok": "5.0.0-beta.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.6.2",
     "unbuild": "^2.0.0",
-    "vitest": "^2.0.5"
+    "uqr": "^0.1.2",
+    "vitest": "^2.0.5",
+    "websocket": "^1.0.35"
   },
   "scripts": {
     "test": "vitest --ui",
+    "typecheck": "pnpm tsc --noEmit",
     "dev": "pnpm install && vitest --ui",
+    "dev-server-old": "ts-node ./devServer/devServer.ts",
+    "dev-server": "npx --yes listhen -w --ws --open ./devServer/devServer.ts",
+    "dev-ngrok": "node --loader ts-node/esm ./devServer/ngrok.mts",
     "build": "unbuild"
   }
 }