tirecheck-device-sdk 0.2.57 → 0.2.59

package/dist/index.cjs

@@ -245,9 +245,17 @@ const bridgeTools = {
     }, []).join(".");
   },
   barToKpaByte(value) {
+    console.warn("barToKpaByte is deprecated, please use convertBarToKpaByte instead");
     if (!value) return 0;
     return ___default.round((value + 1) * 100 / 5.0625);
   },
+  convertBarToKpaByte(deviceId, value) {
+    if (!value) return 0;
+    const deviceData = this.getBridgeFromStore(deviceId);
+    if (!deviceData) throw new Error(`Cannot convert bar to kpa byte, no device data found: ${deviceId}`);
+    const bitValue = deviceData.name.includes("030717") ? 6.7 : 5.0625;
+    return ___default.round((value + 1) * 100 / bitValue);
+  },
   convertSensorIdForBridge(sensorId) {
     let bridgeSensorId = sensorId;
     if (/\d{10}/.test(sensorId)) {
@@ -257,12 +265,23 @@ const bridgeTools = {
     return bridgeSensorId;
   },
   kpaByteToBar(value, decrementValue = 1) {
+    console.warn("kpaByteToBar is deprecated, please use convertKpaByteToBar instead");
     if (!___default.isNumber(value)) {
       throw new TypeError("Value has to be a number");
     }
     const rawBar = value * 5.0625 / 100;
     return ___default.round(Math.max(rawBar - decrementValue, 0), 1);
   },
+  convertKpaByteToBar(deviceId, value, decrementValue = 1) {
+    if (!___default.isNumber(value)) {
+      throw new TypeError("Value has to be a number");
+    }
+    const deviceData = this.getBridgeFromStore(deviceId);
+    if (!deviceData) throw new Error(`Cannot convert kpa byte to bar, no device data found: ${deviceId}`);
+    const bitValue = deviceData.name.includes("030717") ? 6.7 : 5.0625;
+    const rawBar = value * bitValue / 100;
+    return ___default.round(Math.max(rawBar - decrementValue, 0), 1);
+  },
   isVersionGreaterThan(deviceId, version) {
     if (version.length !== 5) {
       throw new Error("Invalid version format");
@@ -2386,12 +2405,12 @@ async function setAxlesPressure(deviceId, axles) {
   let bridgeAxlesPressureData;
   for (let index = 0; index < 15; index++) {
     let { targetPressure, maxTargetPressure, minTargetPressure, isSpare } = axles[index] || {};
-    maxTargetPressure = bridgeTools.barToKpaByte(maxTargetPressure);
-    minTargetPressure = bridgeTools.barToKpaByte(minTargetPressure);
+    maxTargetPressure = bridgeTools.convertBarToKpaByte(deviceId, maxTargetPressure);
+    minTargetPressure = bridgeTools.convertBarToKpaByte(deviceId, minTargetPressure);
     if (isSpare && axles[0]) {
-      targetPressure = bridgeTools.barToKpaByte(axles[0].targetPressure);
+      targetPressure = bridgeTools.convertBarToKpaByte(deviceId, axles[0].targetPressure);
     } else {
-      targetPressure = bridgeTools.barToKpaByte(targetPressure);
+      targetPressure = bridgeTools.convertBarToKpaByte(deviceId, targetPressure);
     }
     if (!maxTargetPressure) {
       if (!bridgeAxlesPressureData) {
@@ -2456,15 +2475,23 @@ async function setVehicle(deviceId, tcVehicle) {
 }
 async function getSensorReading(deviceId, positionId) {
   const value = await bridgeCommands.getSensorMeasurement(deviceId, positionId);
+  const messageLength = value[2];
+  const payloadStartIndex = 9;
+  const payloadLength = messageLength - 6;
+  const payload = value.slice(payloadStartIndex, payloadStartIndex + payloadLength);
+  if (payload.length < 6) {
+    throw new Error(`Invalid sensor measurement payload length: ${payload.length}`);
+  }
   const sensorId = value.slice(5, 9).reverse().map((s) => decimalToHex(s).toUpperCase()).join("");
   const correctedSensorId = bridgeTools.convertSensorIdFromBridge(sensorId);
   return {
-    date: Date.now() - value[14] * 2e3,
+    date: Date.now() - payload[5] * 2e3,
     sensorId: correctedSensorId,
-    sensorStatus: value[12],
-    eceStatus: value[13],
-    pressureIssue: getPressureIssue$1(deviceId, value[13]),
-    ...getPressureAndTemperatureReadingObjects(value[9], value[10]),
+    sensorType: payload[6],
+    sensorStatus: payload[3],
+    eceStatus: payload[4],
+    pressureIssue: getPressureIssue$1(deviceId, payload[4]),
+    ...getPressureAndTemperatureReadingObjects(payload[0], payload[1]),
     byteReading: value
   };
 }
@@ -2743,14 +2770,20 @@ async function assignTyres(deviceId, tcVehicle) {
 async function assignAxlePressureLimits(deviceId, tcVehicle, tcVehicleAxle, axleIndex, bridgeAxlesPressureData) {
   const axlesPressureData = bridgeAxlesPressureData ?? (await bridgeCommands.getAxlesPressure(deviceId)).data;
   if (axlesPressureData[axleIndex * 3]) {
-    tcVehicleAxle.maxTargetPressure = ___default.floor(bridgeTools.kpaByteToBar(axlesPressureData[axleIndex * 3]), 1);
+    tcVehicleAxle.maxTargetPressure = ___default.floor(
+      bridgeTools.convertKpaByteToBar(deviceId, axlesPressureData[axleIndex * 3]),
+      1
+    );
   }
   if (axlesPressureData[axleIndex * 3 + 1]) {
-    tcVehicleAxle.minTargetPressure = ___default.ceil(bridgeTools.kpaByteToBar(axlesPressureData[axleIndex * 3 + 1]), 1);
+    tcVehicleAxle.minTargetPressure = ___default.ceil(
+      bridgeTools.convertKpaByteToBar(deviceId, axlesPressureData[axleIndex * 3 + 1]),
+      1
+    );
   }
   if (axlesPressureData[axleIndex * 3 + 2]) {
     tcVehicleAxle.targetPressure = ___default.round(
-      bridgeTools.kpaByteToBar(axlesPressureData[axleIndex * 3 + 2], void 0),
+      bridgeTools.convertKpaByteToBar(deviceId, axlesPressureData[axleIndex * 3 + 2], void 0),
       1
     );
   }
@@ -4502,7 +4535,13 @@ function createTirecheckDeviceSdk(platform, bleImplementation, securityKeys) {
     /** Allows simulating devices without actually using bluetooth */
     simulator,
     /** Methods for working with Tirecheck Torque Wrench */
-    torqueWrench
+    torqueWrench,
+    utils: {
+      bridge: {
+        convertBarToKpaByte: bridgeTools.convertBarToKpaByte,
+        convertKpaByteToBar: bridgeTools.convertKpaByteToBar
+      }
+    }
   };
 }
 

package/dist/index.d.cts

@@ -736,6 +736,7 @@ interface BridgeConfiguration {
 interface BridgeReading {
     date: number;
     sensorId: string;
+    sensorType?: number;
     sensorStatus: number;
     eceStatus: number;
     pressureIssue?: BridgeTcIssue;
@@ -1037,6 +1038,12 @@ declare function createTirecheckDeviceSdk(platform: DevicePlatform, bleImplement
         getTime: (deviceId: string) => Promise<Date>;
         onReading: (callback: (deviceId: string, value: TorqueWrenchReading) => void) => void;
     };
+    utils: {
+        bridge: {
+            convertBarToKpaByte: (deviceId: string, value?: number) => number;
+            convertKpaByteToBar: (deviceId: string, value?: number, decrementValue?: number) => number;
+        };
+    };
 };
 
 export { type BleBridge, type BleBridgeAdvertisingData, type BleBridgeOta, type BleBridgeSimulated, type BleDevice, type BleDeviceBase, type BleDeviceSimulated, type BleDeviceStatus, type BleDeviceType, type BleFlexiGauge, type BleFlexiGaugeTpms, type BleFlexiGaugeTpmsSimulated, type BlePressureStick, type BleSecurityKeys, type BleTorqueWrench, type BridgeAccessLevel, type BridgeAutolearnStatus, type BridgeCommandStructure, type BridgeCommandStructureProperties, type BridgeCommandStructurized, type BridgeConfiguration, type BridgeReading, type BridgeTcIssue, type BridgeTcTyre, type BridgeTcVehicle, BridgeTcVehicleAxle, type DeepPartial, type DevicePlatform, type DeviceState, type EventHandlers, type EventName, type FgConfig, type FgConfigNeedleLength, type FgConfigPressureDisplay, type FgConfigPressureUnit, type FgConfigRegion, type FgConfigTdUnit, type FgConfigTemperatureUnit, type FgSensorReading, type FgTpmsConfig, type FgTpmsConfigProtocol, type FgTpmsConfigProtocolSetting, type PositionInfo, type ReportStatusFn, type Simulator, type StateReason, type TorqueWrenchProperties, type TorqueWrenchReading, type TorqueWrenchStartJobParams, type Wrapper, createTirecheckDeviceSdk };

package/dist/index.d.mts

@@ -736,6 +736,7 @@ interface BridgeConfiguration {
 interface BridgeReading {
     date: number;
     sensorId: string;
+    sensorType?: number;
     sensorStatus: number;
     eceStatus: number;
     pressureIssue?: BridgeTcIssue;
@@ -1037,6 +1038,12 @@ declare function createTirecheckDeviceSdk(platform: DevicePlatform, bleImplement
         getTime: (deviceId: string) => Promise<Date>;
         onReading: (callback: (deviceId: string, value: TorqueWrenchReading) => void) => void;
     };
+    utils: {
+        bridge: {
+            convertBarToKpaByte: (deviceId: string, value?: number) => number;
+            convertKpaByteToBar: (deviceId: string, value?: number, decrementValue?: number) => number;
+        };
+    };
 };
 
 export { type BleBridge, type BleBridgeAdvertisingData, type BleBridgeOta, type BleBridgeSimulated, type BleDevice, type BleDeviceBase, type BleDeviceSimulated, type BleDeviceStatus, type BleDeviceType, type BleFlexiGauge, type BleFlexiGaugeTpms, type BleFlexiGaugeTpmsSimulated, type BlePressureStick, type BleSecurityKeys, type BleTorqueWrench, type BridgeAccessLevel, type BridgeAutolearnStatus, type BridgeCommandStructure, type BridgeCommandStructureProperties, type BridgeCommandStructurized, type BridgeConfiguration, type BridgeReading, type BridgeTcIssue, type BridgeTcTyre, type BridgeTcVehicle, BridgeTcVehicleAxle, type DeepPartial, type DevicePlatform, type DeviceState, type EventHandlers, type EventName, type FgConfig, type FgConfigNeedleLength, type FgConfigPressureDisplay, type FgConfigPressureUnit, type FgConfigRegion, type FgConfigTdUnit, type FgConfigTemperatureUnit, type FgSensorReading, type FgTpmsConfig, type FgTpmsConfigProtocol, type FgTpmsConfigProtocolSetting, type PositionInfo, type ReportStatusFn, type Simulator, type StateReason, type TorqueWrenchProperties, type TorqueWrenchReading, type TorqueWrenchStartJobParams, type Wrapper, createTirecheckDeviceSdk };

package/dist/index.d.ts

@@ -736,6 +736,7 @@ interface BridgeConfiguration {
 interface BridgeReading {
     date: number;
     sensorId: string;
+    sensorType?: number;
     sensorStatus: number;
     eceStatus: number;
     pressureIssue?: BridgeTcIssue;
@@ -1037,6 +1038,12 @@ declare function createTirecheckDeviceSdk(platform: DevicePlatform, bleImplement
         getTime: (deviceId: string) => Promise<Date>;
         onReading: (callback: (deviceId: string, value: TorqueWrenchReading) => void) => void;
     };
+    utils: {
+        bridge: {
+            convertBarToKpaByte: (deviceId: string, value?: number) => number;
+            convertKpaByteToBar: (deviceId: string, value?: number, decrementValue?: number) => number;
+        };
+    };
 };
 
 export { type BleBridge, type BleBridgeAdvertisingData, type BleBridgeOta, type BleBridgeSimulated, type BleDevice, type BleDeviceBase, type BleDeviceSimulated, type BleDeviceStatus, type BleDeviceType, type BleFlexiGauge, type BleFlexiGaugeTpms, type BleFlexiGaugeTpmsSimulated, type BlePressureStick, type BleSecurityKeys, type BleTorqueWrench, type BridgeAccessLevel, type BridgeAutolearnStatus, type BridgeCommandStructure, type BridgeCommandStructureProperties, type BridgeCommandStructurized, type BridgeConfiguration, type BridgeReading, type BridgeTcIssue, type BridgeTcTyre, type BridgeTcVehicle, BridgeTcVehicleAxle, type DeepPartial, type DevicePlatform, type DeviceState, type EventHandlers, type EventName, type FgConfig, type FgConfigNeedleLength, type FgConfigPressureDisplay, type FgConfigPressureUnit, type FgConfigRegion, type FgConfigTdUnit, type FgConfigTemperatureUnit, type FgSensorReading, type FgTpmsConfig, type FgTpmsConfigProtocol, type FgTpmsConfigProtocolSetting, type PositionInfo, type ReportStatusFn, type Simulator, type StateReason, type TorqueWrenchProperties, type TorqueWrenchReading, type TorqueWrenchStartJobParams, type Wrapper, createTirecheckDeviceSdk };

package/dist/index.mjs

@@ -238,9 +238,17 @@ const bridgeTools = {
     }, []).join(".");
   },
   barToKpaByte(value) {
+    console.warn("barToKpaByte is deprecated, please use convertBarToKpaByte instead");
     if (!value) return 0;
     return _.round((value + 1) * 100 / 5.0625);
   },
+  convertBarToKpaByte(deviceId, value) {
+    if (!value) return 0;
+    const deviceData = this.getBridgeFromStore(deviceId);
+    if (!deviceData) throw new Error(`Cannot convert bar to kpa byte, no device data found: ${deviceId}`);
+    const bitValue = deviceData.name.includes("030717") ? 6.7 : 5.0625;
+    return _.round((value + 1) * 100 / bitValue);
+  },
   convertSensorIdForBridge(sensorId) {
     let bridgeSensorId = sensorId;
     if (/\d{10}/.test(sensorId)) {
@@ -250,12 +258,23 @@ const bridgeTools = {
     return bridgeSensorId;
   },
   kpaByteToBar(value, decrementValue = 1) {
+    console.warn("kpaByteToBar is deprecated, please use convertKpaByteToBar instead");
     if (!_.isNumber(value)) {
       throw new TypeError("Value has to be a number");
     }
     const rawBar = value * 5.0625 / 100;
     return _.round(Math.max(rawBar - decrementValue, 0), 1);
   },
+  convertKpaByteToBar(deviceId, value, decrementValue = 1) {
+    if (!_.isNumber(value)) {
+      throw new TypeError("Value has to be a number");
+    }
+    const deviceData = this.getBridgeFromStore(deviceId);
+    if (!deviceData) throw new Error(`Cannot convert kpa byte to bar, no device data found: ${deviceId}`);
+    const bitValue = deviceData.name.includes("030717") ? 6.7 : 5.0625;
+    const rawBar = value * bitValue / 100;
+    return _.round(Math.max(rawBar - decrementValue, 0), 1);
+  },
   isVersionGreaterThan(deviceId, version) {
     if (version.length !== 5) {
       throw new Error("Invalid version format");
@@ -2379,12 +2398,12 @@ async function setAxlesPressure(deviceId, axles) {
   let bridgeAxlesPressureData;
   for (let index = 0; index < 15; index++) {
     let { targetPressure, maxTargetPressure, minTargetPressure, isSpare } = axles[index] || {};
-    maxTargetPressure = bridgeTools.barToKpaByte(maxTargetPressure);
-    minTargetPressure = bridgeTools.barToKpaByte(minTargetPressure);
+    maxTargetPressure = bridgeTools.convertBarToKpaByte(deviceId, maxTargetPressure);
+    minTargetPressure = bridgeTools.convertBarToKpaByte(deviceId, minTargetPressure);
     if (isSpare && axles[0]) {
-      targetPressure = bridgeTools.barToKpaByte(axles[0].targetPressure);
+      targetPressure = bridgeTools.convertBarToKpaByte(deviceId, axles[0].targetPressure);
     } else {
-      targetPressure = bridgeTools.barToKpaByte(targetPressure);
+      targetPressure = bridgeTools.convertBarToKpaByte(deviceId, targetPressure);
     }
     if (!maxTargetPressure) {
       if (!bridgeAxlesPressureData) {
@@ -2449,15 +2468,23 @@ async function setVehicle(deviceId, tcVehicle) {
 }
 async function getSensorReading(deviceId, positionId) {
   const value = await bridgeCommands.getSensorMeasurement(deviceId, positionId);
+  const messageLength = value[2];
+  const payloadStartIndex = 9;
+  const payloadLength = messageLength - 6;
+  const payload = value.slice(payloadStartIndex, payloadStartIndex + payloadLength);
+  if (payload.length < 6) {
+    throw new Error(`Invalid sensor measurement payload length: ${payload.length}`);
+  }
   const sensorId = value.slice(5, 9).reverse().map((s) => decimalToHex(s).toUpperCase()).join("");
   const correctedSensorId = bridgeTools.convertSensorIdFromBridge(sensorId);
   return {
-    date: Date.now() - value[14] * 2e3,
+    date: Date.now() - payload[5] * 2e3,
     sensorId: correctedSensorId,
-    sensorStatus: value[12],
-    eceStatus: value[13],
-    pressureIssue: getPressureIssue$1(deviceId, value[13]),
-    ...getPressureAndTemperatureReadingObjects(value[9], value[10]),
+    sensorType: payload[6],
+    sensorStatus: payload[3],
+    eceStatus: payload[4],
+    pressureIssue: getPressureIssue$1(deviceId, payload[4]),
+    ...getPressureAndTemperatureReadingObjects(payload[0], payload[1]),
     byteReading: value
   };
 }
@@ -2736,14 +2763,20 @@ async function assignTyres(deviceId, tcVehicle) {
 async function assignAxlePressureLimits(deviceId, tcVehicle, tcVehicleAxle, axleIndex, bridgeAxlesPressureData) {
   const axlesPressureData = bridgeAxlesPressureData ?? (await bridgeCommands.getAxlesPressure(deviceId)).data;
   if (axlesPressureData[axleIndex * 3]) {
-    tcVehicleAxle.maxTargetPressure = _.floor(bridgeTools.kpaByteToBar(axlesPressureData[axleIndex * 3]), 1);
+    tcVehicleAxle.maxTargetPressure = _.floor(
+      bridgeTools.convertKpaByteToBar(deviceId, axlesPressureData[axleIndex * 3]),
+      1
+    );
   }
   if (axlesPressureData[axleIndex * 3 + 1]) {
-    tcVehicleAxle.minTargetPressure = _.ceil(bridgeTools.kpaByteToBar(axlesPressureData[axleIndex * 3 + 1]), 1);
+    tcVehicleAxle.minTargetPressure = _.ceil(
+      bridgeTools.convertKpaByteToBar(deviceId, axlesPressureData[axleIndex * 3 + 1]),
+      1
+    );
   }
   if (axlesPressureData[axleIndex * 3 + 2]) {
     tcVehicleAxle.targetPressure = _.round(
-      bridgeTools.kpaByteToBar(axlesPressureData[axleIndex * 3 + 2], void 0),
+      bridgeTools.convertKpaByteToBar(deviceId, axlesPressureData[axleIndex * 3 + 2], void 0),
       1
     );
   }
@@ -4495,7 +4528,13 @@ function createTirecheckDeviceSdk(platform, bleImplementation, securityKeys) {
     /** Allows simulating devices without actually using bluetooth */
     simulator,
     /** Methods for working with Tirecheck Torque Wrench */
-    torqueWrench
+    torqueWrench,
+    utils: {
+      bridge: {
+        convertBarToKpaByte: bridgeTools.convertBarToKpaByte,
+        convertKpaByteToBar: bridgeTools.convertKpaByteToBar
+      }
+    }
   };
 }
 

package/package.json

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