tirecheck-device-sdk 0.1.5 → 0.1.6

package/dist/index.cjs

@@ -14,13 +14,17 @@ function setBleImplementation(bleImplementation) {
 }
 
 const store = {
-  platform: "web",
+  platform: "android",
+  /** Defines access level for each connection, should be 'driver' as default, Supported roles: ['manufacturer', 'driver'] , Example: F4B4553322: 'manufacturer' */
+  deviceAccessLevel: {},
   devices: {},
   simulatedDevices: {},
   /** undefined - no information but since we get advertisings it is most likely disconnected, connecting - trying to connect via bluetooth, connected - connected via bluetooth (can send write and read), paired - all additional connection steps completed (setMtu, sendPin, etc) */
   deviceState: {},
   // undefined => connecting => connected => paired => disconnecting => disconnected
   bridgesReboot: {},
+  //** Ios uses generated device Id, bridges send mac address in advertising so internaly we always use mac address but when real device id is needed we check mapping table for it */
+  deviceIdMapingTable: {},
   setState(deviceId, state) {
     this.deviceState[deviceId] = state;
     deviceStateChangeCallback?.(deviceId, state);
@@ -306,9 +310,14 @@ const bridgeAdvertisingParser = {
     const adversitingType = getAdvertisingType(device);
     if (adversitingType !== "connectable") return void 0;
     const advertisingData = getAdvertisingData({ advertising: device.advertising, deviceName: device.name });
-    const bridgeId = advertisingData?.macAddress?.map((n) => bridgeTools.decimalToHex(n)).reverse().join("").toUpperCase() || "";
+    const macArray = advertisingData?.macAddress?.map((n) => bridgeTools.decimalToHex(n).toUpperCase()).reverse() || [];
+    const bridgeId = macArray.join("");
     const vin = String.fromCharCode(...advertisingData?.vinNum || []).split("\0").join("");
-    return { id: device.id, name: device.name, bridgeId, vin, advertisingData, type: "bridge", rssi: device.rssi };
+    const macString = macArray.join(":");
+    if (store.platform === "ios") {
+      store.deviceIdMapingTable[macString] = device.id;
+    }
+    return { id: macString, name: device.name, bridgeId, vin, advertisingData, type: "bridge", rssi: device.rssi };
   }
 };
 function getAdvertisingType(device) {
@@ -528,7 +537,8 @@ async function connect(deviceId, disconnectCallback) {
       if (attempt === 3) throw new Error("Connection unsuccessful");
     }
   }
-  const isConnected = await ble.isConnected(deviceId);
+  const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+  const isConnected = await ble.isConnected(_deviceId);
   if (!isConnected) {
     store.setState(deviceId, void 0);
     throw new Error("Connect Error");
@@ -537,8 +547,9 @@ async function connect(deviceId, disconnectCallback) {
   return connectedDevice;
 }
 function connectInner(deviceId, disconnectCallback) {
+  const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
   return new Promise(
-    (resolve, reject) => ble.connect(deviceId, resolve, (err) => {
+    (resolve, reject) => ble.connect(_deviceId, resolve, (err) => {
       if (toolsSvc.canCommunicateWith(deviceId)) {
         deviceLostConnectionCallback?.(deviceId);
         disconnectCallback(deviceId);
@@ -549,8 +560,9 @@ function connectInner(deviceId, disconnectCallback) {
 }
 async function disconnect(deviceId) {
   for (let attempts = 0; attempts < 3; attempts++) {
-    await withTimeout(ble.disconnect(deviceId), 1e3, "Disconnect timed out");
-    const isConnected = await ble.isConnected(deviceId);
+    const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+    await withTimeout(ble.disconnect(_deviceId), 1e3, "Disconnect timed out");
+    const isConnected = await ble.isConnected(_deviceId);
     if (!isConnected) return;
   }
   store.setState(deviceId, void 0);
@@ -559,7 +571,8 @@ async function disconnect(deviceId) {
 async function write(deviceId, serviceUuid, characteristicUuid, value) {
   if (!toolsSvc.canCommunicateWith(deviceId)) throw new Error("Write Error: Not connected to device");
   try {
-    await ble.writeWithoutResponse(deviceId, serviceUuid, characteristicUuid, value);
+    const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+    await ble.writeWithoutResponse(_deviceId, serviceUuid, characteristicUuid, value);
   } catch (e) {
     throw new Error(`Write Error: ${e}`);
   }
@@ -567,7 +580,8 @@ async function write(deviceId, serviceUuid, characteristicUuid, value) {
 async function read(deviceId, serviceUuid, characteristicUuid) {
   if (!toolsSvc.canCommunicateWith(deviceId)) throw new Error("Read Error: Not connected to device");
   try {
-    const value = await ble.read(deviceId, serviceUuid, characteristicUuid);
+    const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+    const value = await ble.read(_deviceId, serviceUuid, characteristicUuid);
     return Array.from(new Uint8Array(value));
   } catch (e) {
     throw new Error(`Read Error: ${e}`);
@@ -1780,6 +1794,7 @@ const bridgeCommands = {
     );
     return { ...structurized, isFactory: result.isFactory };
   },
+  // Zdenek - add structure
   async getAxleInfo(deviceId, axleIndex) {
     const deviceData = bridgeTools.getBridgeFromStore(deviceId);
     if (!___default.inRange(axleIndex, 0, 16)) throw new Error("Error getting an axle");
@@ -2614,18 +2629,22 @@ function createNewTyre(positionId) {
 }
 
 const bridge = {
-  async connect(deviceId) {
+  async connect(deviceId, accessLevel) {
     await promiseQueue$1.clearQueue("Previous pending commands aborted");
     const bridgeMeta = deviceMeta.bridge;
     await bluetooth.connect(deviceId, this.disconnect);
-    await ble.requestMtu(deviceId, deviceMeta.bridge.mtu);
+    const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+    if (store.platform !== "ios") {
+      await ble.requestMtu(_deviceId, deviceMeta.bridge.mtu);
+    }
     await ble.startNotification(
-      deviceId,
+      _deviceId,
       bridgeMeta.communication.serviceId,
       bridgeMeta.communication.characteristicId,
       (notification) => promiseQueue$1.processMessage(deviceId, notification),
       (error) => console.error("startNotification Error", error)
     );
+    store.deviceAccessLevel[deviceId] = accessLevel ?? "driver";
     await bridgeCommands.sendPinCommand(deviceId);
     store.setState(deviceId, "paired");
   },
@@ -3053,7 +3072,8 @@ class BridgeTcVehicleAxle {
   minTargetPressure;
 }
 
-function createTirecheckDeviceSdk(bleImplementation) {
+function createTirecheckDeviceSdk(bleImplementation, platform) {
+  store.platform = platform;
   setBleImplementation(bleImplementation);
   return {
     /** Generic methods common for all devices */

package/dist/index.d.cts

@@ -705,6 +705,8 @@ interface BridgeTcVehicle {
         id: string;
     };
 }
+type DevicePlatform = 'ios' | 'android' | 'web';
+type BridgeAccessLevel = 'tirecheck' | 'vehicleManufacturer' | 'vehicleDealership' | 'workshop' | 'driver';
 interface BridgeTcTyre {
     mountedOn?: TcTyreMountedOn;
     serialNumber?: string;
@@ -866,7 +868,7 @@ type Wrapper<T extends Record<string, (...args: any) => any>> = {
 };
 type ReportStatusFn = (status: string, completionPercentage: number) => void;
 
-declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation): {
+declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation, platform: DevicePlatform): {
     /** Generic methods common for all devices */
     bluetooth: {
         onDeviceAdvertising(callback: (device: BleDevice) => void): void;
@@ -882,7 +884,7 @@ declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation):
     };
     /** Methods for working with Tirecheck CAN Bridge */
     bridge: {
-        connect(deviceId: string): Promise<void>;
+        connect(deviceId: string, accessLevel: BridgeAccessLevel): Promise<void>;
         disconnect(deviceId: string): Promise<void>;
         getVehicle: (deviceId: string) => Promise<BridgeTcVehicle>;
         setVehicle: (deviceId: string, tcVehicle: BridgeTcVehicle) => Promise<void>;
@@ -918,4 +920,4 @@ declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation):
     };
 };
 
-export { type BleBridge, type BleBridgeAdvertisingData, type BleBridgeOta, type BleBridgeSimulated, type BleDevice, type BleDeviceBase, type BleDeviceSimulated, type BleDeviceStatus, type BleDeviceType, type BleFlexiGaugeTpms, type BridgeAutolearnStatus, type BridgeCommandStructure, type BridgeCommandStructureProperties, type BridgeCommandStructurized, type BridgeConfiguration, type BridgeReading, type BridgeTcIssue, type BridgeTcTyre, type BridgeTcVehicle, BridgeTcVehicleAxle, type FgSensorReading, type PositionInfo, type ReportStatusFn, type Wrapper, createTirecheckDeviceSdk };
+export { type BleBridge, type BleBridgeAdvertisingData, type BleBridgeOta, type BleBridgeSimulated, type BleDevice, type BleDeviceBase, type BleDeviceSimulated, type BleDeviceStatus, type BleDeviceType, type BleFlexiGaugeTpms, type BridgeAccessLevel, type BridgeAutolearnStatus, type BridgeCommandStructure, type BridgeCommandStructureProperties, type BridgeCommandStructurized, type BridgeConfiguration, type BridgeReading, type BridgeTcIssue, type BridgeTcTyre, type BridgeTcVehicle, BridgeTcVehicleAxle, type DevicePlatform, type FgSensorReading, type PositionInfo, type ReportStatusFn, type Wrapper, createTirecheckDeviceSdk };

package/dist/index.d.mts

@@ -705,6 +705,8 @@ interface BridgeTcVehicle {
         id: string;
     };
 }
+type DevicePlatform = 'ios' | 'android' | 'web';
+type BridgeAccessLevel = 'tirecheck' | 'vehicleManufacturer' | 'vehicleDealership' | 'workshop' | 'driver';
 interface BridgeTcTyre {
     mountedOn?: TcTyreMountedOn;
     serialNumber?: string;
@@ -866,7 +868,7 @@ type Wrapper<T extends Record<string, (...args: any) => any>> = {
 };
 type ReportStatusFn = (status: string, completionPercentage: number) => void;
 
-declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation): {
+declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation, platform: DevicePlatform): {
     /** Generic methods common for all devices */
     bluetooth: {
         onDeviceAdvertising(callback: (device: BleDevice) => void): void;
@@ -882,7 +884,7 @@ declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation):
     };
     /** Methods for working with Tirecheck CAN Bridge */
     bridge: {
-        connect(deviceId: string): Promise<void>;
+        connect(deviceId: string, accessLevel: BridgeAccessLevel): Promise<void>;
         disconnect(deviceId: string): Promise<void>;
         getVehicle: (deviceId: string) => Promise<BridgeTcVehicle>;
         setVehicle: (deviceId: string, tcVehicle: BridgeTcVehicle) => Promise<void>;
@@ -918,4 +920,4 @@ declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation):
     };
 };
 
-export { type BleBridge, type BleBridgeAdvertisingData, type BleBridgeOta, type BleBridgeSimulated, type BleDevice, type BleDeviceBase, type BleDeviceSimulated, type BleDeviceStatus, type BleDeviceType, type BleFlexiGaugeTpms, type BridgeAutolearnStatus, type BridgeCommandStructure, type BridgeCommandStructureProperties, type BridgeCommandStructurized, type BridgeConfiguration, type BridgeReading, type BridgeTcIssue, type BridgeTcTyre, type BridgeTcVehicle, BridgeTcVehicleAxle, type FgSensorReading, type PositionInfo, type ReportStatusFn, type Wrapper, createTirecheckDeviceSdk };
+export { type BleBridge, type BleBridgeAdvertisingData, type BleBridgeOta, type BleBridgeSimulated, type BleDevice, type BleDeviceBase, type BleDeviceSimulated, type BleDeviceStatus, type BleDeviceType, type BleFlexiGaugeTpms, type BridgeAccessLevel, type BridgeAutolearnStatus, type BridgeCommandStructure, type BridgeCommandStructureProperties, type BridgeCommandStructurized, type BridgeConfiguration, type BridgeReading, type BridgeTcIssue, type BridgeTcTyre, type BridgeTcVehicle, BridgeTcVehicleAxle, type DevicePlatform, type FgSensorReading, type PositionInfo, type ReportStatusFn, type Wrapper, createTirecheckDeviceSdk };

package/dist/index.d.ts

@@ -705,6 +705,8 @@ interface BridgeTcVehicle {
         id: string;
     };
 }
+type DevicePlatform = 'ios' | 'android' | 'web';
+type BridgeAccessLevel = 'tirecheck' | 'vehicleManufacturer' | 'vehicleDealership' | 'workshop' | 'driver';
 interface BridgeTcTyre {
     mountedOn?: TcTyreMountedOn;
     serialNumber?: string;
@@ -866,7 +868,7 @@ type Wrapper<T extends Record<string, (...args: any) => any>> = {
 };
 type ReportStatusFn = (status: string, completionPercentage: number) => void;
 
-declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation): {
+declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation, platform: DevicePlatform): {
     /** Generic methods common for all devices */
     bluetooth: {
         onDeviceAdvertising(callback: (device: BleDevice) => void): void;
@@ -882,7 +884,7 @@ declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation):
     };
     /** Methods for working with Tirecheck CAN Bridge */
     bridge: {
-        connect(deviceId: string): Promise<void>;
+        connect(deviceId: string, accessLevel: BridgeAccessLevel): Promise<void>;
         disconnect(deviceId: string): Promise<void>;
         getVehicle: (deviceId: string) => Promise<BridgeTcVehicle>;
         setVehicle: (deviceId: string, tcVehicle: BridgeTcVehicle) => Promise<void>;
@@ -918,4 +920,4 @@ declare function createTirecheckDeviceSdk(bleImplementation: BleImplementation):
     };
 };
 
-export { type BleBridge, type BleBridgeAdvertisingData, type BleBridgeOta, type BleBridgeSimulated, type BleDevice, type BleDeviceBase, type BleDeviceSimulated, type BleDeviceStatus, type BleDeviceType, type BleFlexiGaugeTpms, type BridgeAutolearnStatus, type BridgeCommandStructure, type BridgeCommandStructureProperties, type BridgeCommandStructurized, type BridgeConfiguration, type BridgeReading, type BridgeTcIssue, type BridgeTcTyre, type BridgeTcVehicle, BridgeTcVehicleAxle, type FgSensorReading, type PositionInfo, type ReportStatusFn, type Wrapper, createTirecheckDeviceSdk };
+export { type BleBridge, type BleBridgeAdvertisingData, type BleBridgeOta, type BleBridgeSimulated, type BleDevice, type BleDeviceBase, type BleDeviceSimulated, type BleDeviceStatus, type BleDeviceType, type BleFlexiGaugeTpms, type BridgeAccessLevel, type BridgeAutolearnStatus, type BridgeCommandStructure, type BridgeCommandStructureProperties, type BridgeCommandStructurized, type BridgeConfiguration, type BridgeReading, type BridgeTcIssue, type BridgeTcTyre, type BridgeTcVehicle, BridgeTcVehicleAxle, type DevicePlatform, type FgSensorReading, type PositionInfo, type ReportStatusFn, type Wrapper, createTirecheckDeviceSdk };

package/dist/index.mjs

@@ -7,13 +7,17 @@ function setBleImplementation(bleImplementation) {
 }
 
 const store = {
-  platform: "web",
+  platform: "android",
+  /** Defines access level for each connection, should be 'driver' as default, Supported roles: ['manufacturer', 'driver'] , Example: F4B4553322: 'manufacturer' */
+  deviceAccessLevel: {},
   devices: {},
   simulatedDevices: {},
   /** undefined - no information but since we get advertisings it is most likely disconnected, connecting - trying to connect via bluetooth, connected - connected via bluetooth (can send write and read), paired - all additional connection steps completed (setMtu, sendPin, etc) */
   deviceState: {},
   // undefined => connecting => connected => paired => disconnecting => disconnected
   bridgesReboot: {},
+  //** Ios uses generated device Id, bridges send mac address in advertising so internaly we always use mac address but when real device id is needed we check mapping table for it */
+  deviceIdMapingTable: {},
   setState(deviceId, state) {
     this.deviceState[deviceId] = state;
     deviceStateChangeCallback?.(deviceId, state);
@@ -299,9 +303,14 @@ const bridgeAdvertisingParser = {
     const adversitingType = getAdvertisingType(device);
     if (adversitingType !== "connectable") return void 0;
     const advertisingData = getAdvertisingData({ advertising: device.advertising, deviceName: device.name });
-    const bridgeId = advertisingData?.macAddress?.map((n) => bridgeTools.decimalToHex(n)).reverse().join("").toUpperCase() || "";
+    const macArray = advertisingData?.macAddress?.map((n) => bridgeTools.decimalToHex(n).toUpperCase()).reverse() || [];
+    const bridgeId = macArray.join("");
     const vin = String.fromCharCode(...advertisingData?.vinNum || []).split("\0").join("");
-    return { id: device.id, name: device.name, bridgeId, vin, advertisingData, type: "bridge", rssi: device.rssi };
+    const macString = macArray.join(":");
+    if (store.platform === "ios") {
+      store.deviceIdMapingTable[macString] = device.id;
+    }
+    return { id: macString, name: device.name, bridgeId, vin, advertisingData, type: "bridge", rssi: device.rssi };
   }
 };
 function getAdvertisingType(device) {
@@ -521,7 +530,8 @@ async function connect(deviceId, disconnectCallback) {
       if (attempt === 3) throw new Error("Connection unsuccessful");
     }
   }
-  const isConnected = await ble.isConnected(deviceId);
+  const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+  const isConnected = await ble.isConnected(_deviceId);
   if (!isConnected) {
     store.setState(deviceId, void 0);
     throw new Error("Connect Error");
@@ -530,8 +540,9 @@ async function connect(deviceId, disconnectCallback) {
   return connectedDevice;
 }
 function connectInner(deviceId, disconnectCallback) {
+  const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
   return new Promise(
-    (resolve, reject) => ble.connect(deviceId, resolve, (err) => {
+    (resolve, reject) => ble.connect(_deviceId, resolve, (err) => {
       if (toolsSvc.canCommunicateWith(deviceId)) {
         deviceLostConnectionCallback?.(deviceId);
         disconnectCallback(deviceId);
@@ -542,8 +553,9 @@ function connectInner(deviceId, disconnectCallback) {
 }
 async function disconnect(deviceId) {
   for (let attempts = 0; attempts < 3; attempts++) {
-    await withTimeout(ble.disconnect(deviceId), 1e3, "Disconnect timed out");
-    const isConnected = await ble.isConnected(deviceId);
+    const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+    await withTimeout(ble.disconnect(_deviceId), 1e3, "Disconnect timed out");
+    const isConnected = await ble.isConnected(_deviceId);
     if (!isConnected) return;
   }
   store.setState(deviceId, void 0);
@@ -552,7 +564,8 @@ async function disconnect(deviceId) {
 async function write(deviceId, serviceUuid, characteristicUuid, value) {
   if (!toolsSvc.canCommunicateWith(deviceId)) throw new Error("Write Error: Not connected to device");
   try {
-    await ble.writeWithoutResponse(deviceId, serviceUuid, characteristicUuid, value);
+    const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+    await ble.writeWithoutResponse(_deviceId, serviceUuid, characteristicUuid, value);
   } catch (e) {
     throw new Error(`Write Error: ${e}`);
   }
@@ -560,7 +573,8 @@ async function write(deviceId, serviceUuid, characteristicUuid, value) {
 async function read(deviceId, serviceUuid, characteristicUuid) {
   if (!toolsSvc.canCommunicateWith(deviceId)) throw new Error("Read Error: Not connected to device");
   try {
-    const value = await ble.read(deviceId, serviceUuid, characteristicUuid);
+    const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+    const value = await ble.read(_deviceId, serviceUuid, characteristicUuid);
     return Array.from(new Uint8Array(value));
   } catch (e) {
     throw new Error(`Read Error: ${e}`);
@@ -1773,6 +1787,7 @@ const bridgeCommands = {
     );
     return { ...structurized, isFactory: result.isFactory };
   },
+  // Zdenek - add structure
   async getAxleInfo(deviceId, axleIndex) {
     const deviceData = bridgeTools.getBridgeFromStore(deviceId);
     if (!_.inRange(axleIndex, 0, 16)) throw new Error("Error getting an axle");
@@ -2607,18 +2622,22 @@ function createNewTyre(positionId) {
 }
 
 const bridge = {
-  async connect(deviceId) {
+  async connect(deviceId, accessLevel) {
     await promiseQueue$1.clearQueue("Previous pending commands aborted");
     const bridgeMeta = deviceMeta.bridge;
     await bluetooth.connect(deviceId, this.disconnect);
-    await ble.requestMtu(deviceId, deviceMeta.bridge.mtu);
+    const _deviceId = store.deviceIdMapingTable[deviceId] ?? deviceId;
+    if (store.platform !== "ios") {
+      await ble.requestMtu(_deviceId, deviceMeta.bridge.mtu);
+    }
     await ble.startNotification(
-      deviceId,
+      _deviceId,
       bridgeMeta.communication.serviceId,
       bridgeMeta.communication.characteristicId,
       (notification) => promiseQueue$1.processMessage(deviceId, notification),
       (error) => console.error("startNotification Error", error)
     );
+    store.deviceAccessLevel[deviceId] = accessLevel ?? "driver";
     await bridgeCommands.sendPinCommand(deviceId);
     store.setState(deviceId, "paired");
   },
@@ -3046,7 +3065,8 @@ class BridgeTcVehicleAxle {
   minTargetPressure;
 }
 
-function createTirecheckDeviceSdk(bleImplementation) {
+function createTirecheckDeviceSdk(bleImplementation, platform) {
+  store.platform = platform;
   setBleImplementation(bleImplementation);
   return {
     /** Generic methods common for all devices */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tirecheck-device-sdk",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "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",