tirecheck-device-sdk 0.2.70 → 0.2.72

package/dist/index.d.ts

@@ -1,3 +1,44 @@
+interface UnitechListenerHandle {
+    remove: () => Promise<void>;
+}
+interface ReaderStateEvent {
+    state: string;
+}
+interface ActionStateEvent {
+    state: string;
+}
+interface TriggerEvent {
+    pressed: boolean;
+}
+interface TagReadEvent {
+    epc: string;
+    rssi: number;
+    [key: string]: unknown;
+}
+interface BatteryEvent {
+    percent: number;
+}
+interface TemperatureEvent {
+    celsius: number;
+}
+interface UnitechRfidImplementation {
+    removeAllListeners: () => Promise<void>;
+    addListener: ((eventName: 'readerState', listener: (event: ReaderStateEvent) => void | Promise<void>) => Promise<UnitechListenerHandle>) & ((eventName: 'actionState', listener: (event: ActionStateEvent) => void | Promise<void>) => Promise<UnitechListenerHandle>) & ((eventName: 'trigger', listener: (event: TriggerEvent) => void | Promise<void>) => Promise<UnitechListenerHandle>) & ((eventName: 'tagRead', listener: (event: TagReadEvent) => void | Promise<void>) => Promise<UnitechListenerHandle>) & ((eventName: 'battery', listener: (event: BatteryEvent) => void | Promise<void>) => Promise<UnitechListenerHandle>) & ((eventName: 'temperature', listener: (event: TemperatureEvent) => void | Promise<void>) => Promise<UnitechListenerHandle>);
+    startDetect: (options: {
+        deviceName: string;
+    }) => Promise<void>;
+    stopDetect: () => Promise<void>;
+    connect: (options: {
+        bluetoothAddress?: string;
+    }) => Promise<{
+        connected: boolean;
+    }>;
+    disconnect: () => Promise<void>;
+    initDeviceSettings: () => Promise<void>;
+    startInventory: () => Promise<void>;
+    stopInventory: () => Promise<void>;
+}
+
 interface BleImplementation {
     startScanWithOptions: (services: string[], options: StartScanOptions, success: (data: PeripheralData) => any, failure?: (error: string) => any) => void;
     stopScan: () => Promise<void>;
@@ -118,6 +159,11 @@ declare const _default$1: {
         };
         getDeviceInfoFromAdvertising: (device: PeripheralData) => BleTorqueWrench;
     };
+    unitechRfid: {
+        nameRegex: RegExp;
+        transport: "serial";
+        getDeviceInfoFromAdvertising: (device: PeripheralData) => BleUnitechRfid;
+    };
 };
 
 declare const _default: {
@@ -927,6 +973,109 @@ declare const _default: {
             };
         };
     };
+    bridgeConfiguration: {
+        id: number[];
+        name: string;
+        structure: {
+            configVersion: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            bleTxPower: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            bleTxChannels: {
+                size: number;
+                description: string;
+            };
+            bleConnectableAdvPeriod: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            configurationFlags: {
+                size: number;
+                description: string;
+            };
+            wrongPinsUntilLockout: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            maxLockoutPeriodIncreases: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            wrongPinInitialLockoutTime: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            securityConfiguration: {
+                size: number;
+                description: string;
+            };
+            canEnabled: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            bleEnabled: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            canBitrate: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            movementDetectionLimit: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            sensorInactivityTimeout: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            manufacturerCode: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            identityNumber: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+            manufacturerName: {
+                size: number;
+                description: string;
+                display: "ascii";
+            };
+            ecuPartNumber: {
+                size: number;
+                description: string;
+                display: "ascii";
+            };
+            softwareVersion: {
+                size: number;
+                description: string;
+                display: "ascii";
+            };
+            reservedConfiguration: {
+                size: number;
+                description: string;
+                display: "decimal";
+            };
+        };
+    };
 };
 
 type DeepPartial<T> = T extends object ? {
@@ -1018,15 +1167,14 @@ interface BridgeConfiguration {
     eolStatus?: BridgeCommandStructurized<typeof _default.eolStatus.structure>;
     /** only available after 0.9.8 fw */
     autolearnSettings?: BridgeCommandStructurized<typeof _default.autolearnSettings.structure>;
-    vehicleLayout?: BridgeCommandStructurized<typeof _default.vehicleLayout.structure>;
-    /** Per-axle wheel sensor IDs, indexed by axle (0-14). Each entry holds the 15 wheel slots of one axle. */
-    axleInfo?: BridgeCommandStructurized<typeof _default.idsPerWheel.structure>[];
     /** Parsed 0x90 SW Version DID (BT stack, config data version, BLE chip compilation date, BT chip FW version). */
     firmwareVersion?: BridgeCommandStructurized<typeof _default.firmwareVersion.structure>;
     /** only available after 0.9.7 fw */
     autolearnIdStatus?: BridgeCommandStructurized<typeof _default.autolearnIdStatus.structure>;
     /** only available after 0.9.7 fw */
     autolearnUnknownSensors?: BridgeCommandStructurized<typeof _default.autolearnUnknownSensors.structure>;
+    /** R10/R141 software identification numbers, computed app-side from config records. */
+    rxswin?: RxSwinResult;
 }
 interface BridgeReading {
     date: number;
@@ -1095,7 +1243,7 @@ type BridgeCommandStructurized<T extends BridgeCommandStructureProperties> = {
 };
 type BleDeviceType = keyof typeof _default$1;
 /** distinguish by type, e.g. `if (device.type === 'bridge')`, to access furhter fields */
-type BleDevice = BleBridge | BleBridgeOta | BleFlexiGaugeTpms | BlePressureStick | BleFlexiGauge | BleTorqueWrench;
+type BleDevice = BleBridge | BleBridgeOta | BleFlexiGaugeTpms | BlePressureStick | BleFlexiGauge | BleTorqueWrench | BleUnitechRfid;
 type BleDeviceSimulated = BleBridgeSimulated | BleFlexiGaugeTpmsSimulated;
 type BleDeviceStatus = 'connected' | 'connecting' | 'disconnecting' | undefined;
 interface BleDeviceBase {
@@ -1125,6 +1273,9 @@ interface BleFlexiGauge extends BleDeviceBase {
 interface BleTorqueWrench extends BleDeviceBase {
     type: 'torqueWrench';
 }
+interface BleUnitechRfid extends BleDeviceBase {
+    type: 'unitechRfid';
+}
 interface BleBridgeOta extends BleDeviceBase {
     advertisingData: {
         bridgeId: string;
@@ -1200,12 +1351,25 @@ type Wrapper<T extends Record<string, (...args: any) => any>> = {
 type ReportStatusFn = (status: string, completionPercentage: number) => void;
 type DeviceState = 'connected' | 'connecting' | 'disconnecting' | 'paired' | undefined;
 type StateReason = 'lostConnection' | 'manualDisconnection' | 'failedConnection' | 'failedDisconnection' | 'firmwareUpdate' | string;
+/** A unique RFID tag aggregated across many tagRead events, keeping the strongest signal seen. */
+interface RfidTag {
+    epc: string;
+    rssi: number;
+}
 interface EventHandlers {
     'fg:treadDepth'?: (deviceId: string, value: number) => void;
     'fg:button'?: (deviceId: string, value: string) => void;
     'fg:tpms'?: (deviceId: string, value: FgSensorReading | undefined) => void;
     'ps:pressure'?: (deviceId: string, value: number) => void;
     'tw:reading'?: (deviceId: string, value: TorqueWrenchReading) => void;
+    'unitech:readerState'?: (deviceId: string, event: ReaderStateEvent) => void;
+    'unitech:readerStateConnect'?: (deviceId: string, event: ReaderStateEvent) => void;
+    'unitech:actionState'?: (deviceId: string, event: ActionStateEvent) => void;
+    'unitech:trigger'?: (deviceId: string, event: TriggerEvent) => void;
+    'unitech:tag'?: (deviceId: string, event: TagReadEvent) => void;
+    'unitech:tagReadMultiple'?: (deviceId: string, tags: RfidTag[]) => void;
+    'unitech:battery'?: (deviceId: string, event: BatteryEvent) => void;
+    'unitech:temperature'?: (deviceId: string, event: TemperatureEvent) => void;
     'bridgeOta:status'?: (deviceId: string, status: string) => void;
     'bridgeOta:success'?: (deviceId: string) => void;
     'bridgeOta:error'?: (deviceId: string, error: string) => void;
@@ -1234,18 +1398,55 @@ interface TorqueWrenchReading {
     angle: number;
     duration: number;
 }
+interface RxSwinBridgeConfiguration {
+    bleTxPower?: number;
+    bleTxChannels?: string;
+    canEnabled?: number;
+    movementDetectionLimit?: number;
+    sensorInactivityTimeout?: number;
+}
+interface RxSwinResult {
+    R10SWIN: string;
+    R141SWIN: string;
+}
 type EventName = keyof EventHandlers;
 
+interface BluetoothClassicSerialDevice {
+    /** Device identifier.
+     * Android: device's MAC address (same value as `address`).
+     * iOS: device UUID. */
+    id: string;
+    /** Device's MAC address (Android only). */
+    address?: string;
+    name: string;
+    /** Bluetooth device class (Android only). */
+    class?: number;
+    rssi?: number;
+}
+interface BluetoothClassicSerialImplementation {
+    /** Lists already paired/bonded serial devices. */
+    list: () => Promise<BluetoothClassicSerialDevice[]>;
+    /** Discovers nearby unpaired serial devices. Resolves with all devices found once discovery finishes.
+     * For incremental results during discovery, also register `setDeviceDiscoveredListener`. */
+    discoverUnpaired: () => Promise<BluetoothClassicSerialDevice[]>;
+    /** Registers a listener fired for each device discovered during `discoverUnpaired`. */
+    setDeviceDiscoveredListener?: (notify: (device: BluetoothClassicSerialDevice) => void) => void;
+    /** Removes the listener registered via `setDeviceDiscoveredListener`. */
+    clearDeviceDiscoveredListener?: () => void;
+}
+
 /** Creates instance of SDK.
  * For real usage, `bleImplementation` argument must be provided - it's an object that follows method definitions from `cordova-plugin-bluetooth-central`.
  * If `bleImplementation` is not provided, SDK will work only with the simulator. */
-declare function createTirecheckDeviceSdk(platform: DevicePlatform, bleImplementation?: BleImplementation, securityKeys?: BleSecurityKeys): {
+declare function createTirecheckDeviceSdk(platform: DevicePlatform, bleImplementation?: BleImplementation, securityKeys?: BleSecurityKeys, unitechRfidImplementation?: UnitechRfidImplementation, bluetoothClassicSerialImplementation?: BluetoothClassicSerialImplementation): {
     /** Generic methods common for all devices */
     bluetooth: {
         onDeviceAdvertising(callback: (device: BleDevice) => void): void;
         onDeviceUnreachable(callback: (deviceId: string) => void): void;
         onDeviceStateChange(callback: (deviceId: string, state?: DeviceState, reason?: StateReason) => void): void;
         scanDevices: (services?: string[], duration?: number) => Promise<void>;
+        scanSerialDevicesPaired: () => Promise<void>;
+        scanSerialDevicesUnpaired: () => Promise<void>;
         stopScan(): void;
         connect: (deviceId: string, disconnectCallback: (deviceId: string) => void) => Promise<void | PeripheralDataExtended>;
         disconnect: (deviceId: string) => Promise<void>;
@@ -1258,8 +1459,9 @@ declare function createTirecheckDeviceSdk(platform: DevicePlatform, bleImplement
         connect: (deviceId: string, accessLevel: BridgeAccessLevel) => Promise<void>;
         getVehicle: (deviceId: string) => Promise<BridgeTcVehicle>;
         setVehicle: (deviceId: string, tcVehicle: BridgeTcVehicle) => Promise<void>;
-        getConfiguration: (deviceId: string, includeVehicleData?: boolean) => Promise<BridgeConfiguration>;
+        getConfiguration: (deviceId: string) => Promise<BridgeConfiguration>;
         setConfiguration: (deviceId: string, bridgeConfiguration: BridgeConfiguration) => Promise<void>;
+        getRxSWIN: (deviceId: string, configuration?: Partial<BridgeConfiguration>) => Promise<RxSwinResult>;
         getSensorReading: (deviceId: string, positionId: number) => Promise<BridgeReading>;
         getVehicleReadings: (deviceId: string, tcVehicle: BridgeTcVehicle) => Promise<BridgeReading[]>;
         getAutolearnStatuses: (deviceId: string, tcVehicle: BridgeTcVehicle) => Promise<BridgeAutolearnStatus[]>;
@@ -1333,6 +1535,19 @@ declare function createTirecheckDeviceSdk(platform: DevicePlatform, bleImplement
         getTime: (deviceId: string) => Promise<Date>;
         onReading: (callback: (deviceId: string, value: TorqueWrenchReading) => void) => void;
     };
+    /** Methods for working with Unitech RFID reader */
+    unitechRfid: {
+        connect(deviceId: string): Promise<void>;
+        disconnect(deviceId: string, reason?: StateReason): Promise<void>;
+        startReading(): Promise<void>;
+        stopReading(): Promise<void>;
+        onReaderState: (callback: (deviceId: string, event: ReaderStateEvent) => void) => void;
+        onActionState: (callback: (deviceId: string, event: ActionStateEvent) => void) => void;
+        onTrigger: (callback: (deviceId: string, event: TriggerEvent) => void) => void;
+        onTagRead: (callback: (deviceId: string, event: TagReadEvent) => void) => void;
+        onBattery: (callback: (deviceId: string, event: BatteryEvent) => void) => void;
+        onTemperature: (callback: (deviceId: string, event: TemperatureEvent) => void) => void;
+    };
     utils: {
         bridge: {
             convertBarToKpaByte: (deviceId: string, value?: number) => number;
@@ -1342,4 +1557,4 @@ declare function createTirecheckDeviceSdk(platform: DevicePlatform, bleImplement
     };
 };
 
-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 };
+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 BleUnitechRfid, 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 RfidTag, type RxSwinBridgeConfiguration, type RxSwinResult, type Simulator, type StateReason, type TorqueWrenchProperties, type TorqueWrenchReading, type TorqueWrenchStartJobParams, type Wrapper, createTirecheckDeviceSdk };