@neurodevs/ndx-native 1.1.0 → 2.0.1

package/src/impl/LibndxAdapter.ts

@@ -1,9 +1,8 @@
-import { DataType, define, open } from 'ffi-rs'
+import koffi from 'koffi'
 
 export default class LibndxAdapter implements Libndx {
     public static Class?: LibndxConstructor
-    public static ffiRsOpen = open
-    public static ffiRsDefine = define
+    public static koffiLoad: typeof koffi.load = koffi.load.bind(koffi)
 
     private static instance?: Libndx
 
@@ -35,75 +34,60 @@ export default class LibndxAdapter implements Libndx {
 
     private tryToLoadBindings() {
         try {
-            this.openLibndx()
             this.defineBindings()
         } catch (err: unknown) {
             this.throwFailedToLoadLibndx(err as Error)
         }
     }
 
-    private openLibndx() {
-        this.ffiRsOpen({
-            library: 'ndx',
-            path: this.libndxPath,
-        })
-    }
-
     private defineBindings() {
-        this.bindings = this.ffiRsDefine({
-            create_ble_backend: {
-                library: 'ndx',
-                retType: DataType.String,
-                paramsType: [DataType.String],
-            },
-            start_ble_backend: {
-                library: 'ndx',
-                retType: DataType.String,
-                paramsType: [DataType.String],
-            },
-            stop_ble_backend: {
-                library: 'ndx',
-                retType: DataType.String,
-                paramsType: [DataType.String],
-            },
-            get_rssi_ble_backend: {
-                library: 'ndx',
-                retType: DataType.String,
-                paramsType: [DataType.String],
-            },
-            destroy_ble_backend: {
-                library: 'ndx',
-                retType: DataType.String,
-                paramsType: [DataType.String],
-            },
-            create_ftdi_backend: {
-                library: 'ndx',
-                retType: DataType.String,
-                paramsType: [DataType.String],
-            },
-            start_ftdi_backend: {
-                library: 'ndx',
-                retType: DataType.String,
-                paramsType: [DataType.String],
-            },
-            stop_ftdi_backend: {
-                library: 'ndx',
-                retType: DataType.String,
-                paramsType: [DataType.String],
-            },
-            destroy_ftdi_backend: {
-                library: 'ndx',
-                retType: DataType.String,
-                paramsType: [DataType.String],
-            },
-        }) as LibndxBindings
+        const lib = LibndxAdapter.koffiLoad(this.libndxPath)
+
+        const wrap1 = (f: (a: string) => string) => (args: [string]) =>
+            f(args[0])
+
+        const wrap3 =
+            (f: (a: string, b: string, c: string) => string) =>
+            (args: [string, string, string]) =>
+                f(args[0], args[1], args[2])
+
+        this.bindings = {
+            create_ble_backend: wrap1(
+                lib.func('str create_ble_backend(str config)')
+            ),
+            start_ble_backend: wrap1(
+                lib.func('str start_ble_backend(str uuid)')
+            ),
+            write_ble_characteristic: wrap3(
+                lib.func(
+                    'str write_ble_characteristic(str uuid, str charUuid, str value)'
+                )
+            ),
+            read_ble_rssi: wrap1(lib.func('str read_ble_rssi(str uuid)')),
+            stop_ble_backend: wrap1(lib.func('str stop_ble_backend(str uuid)')),
+            destroy_ble_backend: wrap1(
+                lib.func('str destroy_ble_backend(str uuid)')
+            ),
+            create_ftdi_backend: wrap1(
+                lib.func('str create_ftdi_backend(str config)')
+            ),
+            start_ftdi_backend: wrap1(
+                lib.func('str start_ftdi_backend(str serial)')
+            ),
+            stop_ftdi_backend: wrap1(
+                lib.func('str stop_ftdi_backend(str serial)')
+            ),
+            destroy_ftdi_backend: wrap1(
+                lib.func('str destroy_ftdi_backend(str serial)')
+            ),
+        }
     }
 
     private throwFailedToLoadLibndx(err: Error) {
         throw new Error(
             `
             \n -----------------------------------
-            \n Failed to load libndx! Tried to load from: 
+            \n Failed to load libndx! Tried to load from:
             \n     ${this.libndxPath}
             \n Instructions to save your day (on MacOS):
             \n     1. git clone https://github.com/neurodevs/libndx.git
@@ -111,7 +95,7 @@ export default class LibndxAdapter implements Libndx {
             \n     3. sudo cp build/libndx.dylib /opt/local/lib/
             \n     4. Try whatever you were doing again!
             \n Modify step 3 for your OS if you are not on MacOS.
-            \n If you're still unsure, ask an LLM with this error and your OS. 
+            \n If you're still unsure, ask an LLM with this error and your OS.
             \n You could also post an issue on the repo:
             \n     https://github.com/neurodevs/ndx-native/issues
             \n Good luck!
@@ -134,6 +118,20 @@ export default class LibndxAdapter implements Libndx {
         return this.bindings.start_ble_backend([deviceUuid])
     }
 
+    public writeBleCharacteristic(options: BleWriteOptions) {
+        const { deviceUuid, characteristicUuid, value } = options
+        return this.bindings.write_ble_characteristic([
+            deviceUuid,
+            characteristicUuid,
+            value,
+        ])
+    }
+
+    public readBleRssi(options: BleBackendOptions) {
+        const { deviceUuid } = options
+        return this.bindings.read_ble_rssi([deviceUuid])
+    }
+
     public stopBleBackend(options: BleBackendOptions) {
         const { deviceUuid } = options
         return this.bindings.stop_ble_backend([deviceUuid])
@@ -144,11 +142,6 @@ export default class LibndxAdapter implements Libndx {
         return this.bindings.destroy_ble_backend([deviceUuid])
     }
 
-    public getRssiBleBackend(options: BleBackendOptions) {
-        const { deviceUuid } = options
-        return this.bindings.get_rssi_ble_backend([deviceUuid])
-    }
-
     public createFtdiBackend(options: FtdiBackendOptions) {
         const { serialNumber } = options
         const configJson = JSON.stringify({ serialNumber })
@@ -169,22 +162,15 @@ export default class LibndxAdapter implements Libndx {
         const { serialNumber } = options
         return this.bindings.destroy_ftdi_backend([serialNumber])
     }
-
-    private get ffiRsOpen() {
-        return LibndxAdapter.ffiRsOpen
-    }
-
-    private get ffiRsDefine() {
-        return LibndxAdapter.ffiRsDefine
-    }
 }
 
 export interface Libndx {
     createBleBackend(options: BleBackendOptions): string
     startBleBackend(options: BleBackendOptions): string
+    writeBleCharacteristic(options: BleWriteOptions): string
+    readBleRssi(options: BleBackendOptions): string
     stopBleBackend(options: BleBackendOptions): string
     destroyBleBackend(options: BleBackendOptions): string
-    getRssiBleBackend(options: BleBackendOptions): string
     createFtdiBackend(options: FtdiBackendOptions): string
     startFtdiBackend(options: FtdiBackendOptions): string
     stopFtdiBackend(options: FtdiBackendOptions): string
@@ -201,6 +187,12 @@ export interface BleBackendOptions {
     deviceUuid: string
 }
 
+export interface BleWriteOptions {
+    deviceUuid: string
+    characteristicUuid: string
+    value: string
+}
+
 export interface FtdiBackendOptions {
     serialNumber: string
 }
@@ -208,9 +200,10 @@ export interface FtdiBackendOptions {
 export interface LibndxBindings {
     create_ble_backend(args: [string]): string
     start_ble_backend(args: [string]): string
+    write_ble_characteristic(args: [string, string, string]): string
+    read_ble_rssi(args: [string]): string
     stop_ble_backend(args: [string]): string
     destroy_ble_backend(args: [string]): string
-    get_rssi_ble_backend(args: [string]): string
     create_ftdi_backend(args: [string]): string
     start_ftdi_backend(args: [string]): string
     stop_ftdi_backend(args: [string]): string

package/src/testDoubles/Libndx/FakeLibndx.ts

@@ -1,5 +1,6 @@
 import {
     BleBackendOptions,
+    BleWriteOptions,
     FtdiBackendOptions,
     Libndx,
     LibndxAdapterOptions,
@@ -9,6 +10,7 @@ export default class FakeLibndx implements Libndx {
     public static callsToConstructor: (LibndxAdapterOptions | undefined)[] = []
     public static callsToCreateBleBackend: BleBackendOptions[] = []
     public static callsToStartBleBackend: BleBackendOptions[] = []
+    public static callsToWriteBle: BleWriteOptions[] = []
     public static callsToStopBleBacked: BleBackendOptions[] = []
     public static callsToDestroyBleBackend: BleBackendOptions[] = []
     public static callsToGetRssiBleBackend: BleBackendOptions[] = []
@@ -17,59 +19,67 @@ export default class FakeLibndx implements Libndx {
     public static callsToStopFtdiBackend: FtdiBackendOptions[] = []
     public static callsToDestroyFtdiBackend: FtdiBackendOptions[] = []
 
+    public static fakeResult = ''
+
     public constructor(options?: LibndxAdapterOptions) {
         FakeLibndx.callsToConstructor.push(options)
     }
 
     public createBleBackend(options: BleBackendOptions) {
         FakeLibndx.callsToCreateBleBackend.push(options)
-        return ''
+        return FakeLibndx.fakeResult
     }
 
     public startBleBackend(options: BleBackendOptions) {
         FakeLibndx.callsToStartBleBackend.push(options)
-        return ''
+        return FakeLibndx.fakeResult
+    }
+
+    public writeBleCharacteristic(options: BleWriteOptions) {
+        FakeLibndx.callsToWriteBle.push(options)
+        return FakeLibndx.fakeResult
+    }
+
+    public readBleRssi(options: BleBackendOptions) {
+        FakeLibndx.callsToGetRssiBleBackend.push(options)
+        return FakeLibndx.fakeResult
     }
 
     public stopBleBackend(options: BleBackendOptions) {
         FakeLibndx.callsToStopBleBacked.push(options)
-        return ''
+        return FakeLibndx.fakeResult
     }
 
     public destroyBleBackend(options: BleBackendOptions) {
         FakeLibndx.callsToDestroyBleBackend.push(options)
-        return ''
-    }
-
-    public getRssiBleBackend(options: BleBackendOptions) {
-        FakeLibndx.callsToGetRssiBleBackend.push(options)
-        return ''
+        return FakeLibndx.fakeResult
     }
 
     public createFtdiBackend(options: FtdiBackendOptions) {
         FakeLibndx.callsToCreateFtdiBackend.push(options)
-        return ''
+        return FakeLibndx.fakeResult
     }
 
     public startFtdiBackend(options: FtdiBackendOptions) {
         FakeLibndx.callsToStartFtdiBackend.push(options)
-        return ''
+        return FakeLibndx.fakeResult
     }
 
     public stopFtdiBackend(options: FtdiBackendOptions) {
         FakeLibndx.callsToStopFtdiBackend.push(options)
-        return ''
+        return FakeLibndx.fakeResult
     }
 
     public destroyFtdiBackend(options: FtdiBackendOptions) {
         FakeLibndx.callsToDestroyFtdiBackend.push(options)
-        return ''
+        return FakeLibndx.fakeResult
     }
 
     public static resetTestDouble() {
         FakeLibndx.callsToConstructor = []
         FakeLibndx.callsToCreateBleBackend = []
         FakeLibndx.callsToStartBleBackend = []
+        FakeLibndx.callsToWriteBle = []
         FakeLibndx.callsToStopBleBacked = []
         FakeLibndx.callsToGetRssiBleBackend = []
         FakeLibndx.callsToDestroyBleBackend = []

package/tsconfig.json

@@ -20,5 +20,5 @@
     "resolveJsonModule": true,
     "experimentalDecorators": true
   },
-  "include": ["src/*.ts", "src/**/*.ts", "./src/*.ts", "./src/**/*.ts"]
+  "include": ["./src/*.ts", "./src/**/*.ts", "src/*.ts", "src/**/*.ts"]
 }

package/.regressionproof.json

@@ -1,7 +0,0 @@
-{
-  "version": "0.9.4",
-  "projectName": "ndx-native",
-  "remote": {
-    "url": "https://git.regressionproof.ai/liquidg3/ndx-native.git"
-  }
-}

package/build/.spruce/settings.json

@@ -1,11 +0,0 @@
-{
-  "scriptUpdater": {
-    "skipped": []
-  },
-  "skipped": ["skill"],
-  "installed": ["test"],
-  "regressionproof": {
-    "enabled": true,
-    "projectName": "ndx-native"
-  }
-}

package/src/.spruce/settings.json

@@ -1,11 +0,0 @@
-{
-  "scriptUpdater": {
-    "skipped": []
-  },
-  "skipped": ["skill"],
-  "installed": ["test"],
-  "regressionproof": {
-    "enabled": true,
-    "projectName": "ndx-native"
-  }
-}