feat: firmware version is now checked for compatibility

package.json

@@ -83,6 +83,7 @@
     "@types/jest": "^28.1.6",
     "@types/node": "^12.20.11",
     "@types/node-fetch": "^2.6.2",
+    "@types/semver": "^7.3.13",
     "@types/w3c-web-serial": "^1.0.2",
     "@typescript-eslint/eslint-plugin": "^4.22.0",
     "@typescript-eslint/parser": "^4.22.0",
@@ -101,6 +102,7 @@
     "rollup-plugin-polyfill-node": "^0.10.1",
     "rollup-plugin-visualizer": "^5.7.1",
     "semantic-release": "^19.0.2",
+    "semver": "^7.3.8",
     "typescript": "^4.2.4",
     "wds": "^0.12.0"
   },

src/PirateMidiDevice.ts

@@ -1,3 +1,4 @@
+import semver from 'semver';
 import { BankSettings, Command, DeviceInfo, GlobalSettings } from './types';
 import { BaseDevice } from './BaseDevice';
 import { deviceDescriptors } from './data/deviceDescriptors';
@@ -7,6 +8,8 @@ import { WebSerialPort } from './serial/WebSerialPort';
 import { EventEmitter } from 'events';
 import { DevicePortMock } from './mock/DevicePortMock';
 
+export const MINIMUM_FIRMWARE_VERSION = '1.1.3';
+
 export class PirateMidiDevice extends EventEmitter {
   deviceInfo?: DeviceInfo;
   baseDevice: BaseDevice;
@@ -30,6 +33,14 @@ export class PirateMidiDevice extends EventEmitter {
     return deviceDescriptors[this.deviceInfo.deviceModel];
   }
 
+  getIsSupported(): boolean {
+    if (!this.deviceInfo) throw new Error('No device info available');
+    return semver.gte(
+      this.deviceInfo.firmwareVersion,
+      MINIMUM_FIRMWARE_VERSION
+    );
+  }
+
   validateBankNumber(bank: number): void {
     const { numberBanks } = this.getDeviceDescription();
     if (typeof bank !== 'number')

src/index.browser.ts

@@ -1,4 +1,4 @@
-import { PirateMidiDevice } from './PirateMidiDevice';
+import { MINIMUM_FIRMWARE_VERSION, PirateMidiDevice } from './PirateMidiDevice';
 import { WebSerialPort } from './serial/WebSerialPort';
 import { GetDevices } from './types';
 
@@ -25,5 +25,10 @@ export const getDevices: GetDevices = async () => {
   // Populate deviceInfo immediately to reduce friction
   await device.updateDeviceInfo();
 
+  if (!device.getIsSupported())
+    throw new Error(
+      `Minimum firmware version ${MINIMUM_FIRMWARE_VERSION} is required`
+    );
+
   return [device];
 };

src/index.ts

@@ -1,4 +1,4 @@
-import { PirateMidiDevice } from './PirateMidiDevice';
+import { MINIMUM_FIRMWARE_VERSION, PirateMidiDevice } from './PirateMidiDevice';
 import { NodeSerialPort } from './serial/NodeSerialPort';
 import { GetDevices } from './types';
 
@@ -24,6 +24,11 @@ export const getDevices: GetDevices = async () => {
       // Populate deviceInfo immediately to reduce friction
       await device.updateDeviceInfo();
 
+      if (!device.getIsSupported())
+        throw new Error(
+          `Minimum firmware version ${MINIMUM_FIRMWARE_VERSION} is required`
+        );
+
       return device;
     })
   );