react-native-wakeword 1.0.30 → 1.0.32

package/README.md

@@ -3,11 +3,7 @@ DaVoice.io Voice commands / Wake words / Voice to Intent / keyword detection npm
 
 Contact us at info@DaVoice.io
 
-## What's in this package
-
-### This package includes 
-1. "Wake Word" (also known as: "keyword detection" and "phrase spotting") api to enable ios and android applications.
-2. "Speech to Intent" (also known as: "voice commands" and "phrase spotting") very similar to "Wake Word" however mainly used to use speech command to control the application rather than waking up the application.
+# IOS and Android Package
 
 ## Installation
 npm install react-native-wakeword

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "react-native-wakeword",
-    "version": "1.0.30",
+    "version": "1.0.32",
     "description": "Voice/Wake-word detection library for React Native",
     "main": "wakewords/index.js",
     "types": "wakewords/index.d.ts",
@@ -31,10 +31,15 @@
         "react-native",
         "voice commands",
         "wake word",
+        "wakeword",
+        "wake words",
         "keyword detection",
         "keyword spotting",
         "speech to intent",
-        "phrase spotting"
+        "voice to intent",
+        "phrase spotting",
+        "react native wake word",
+        "rn wake word"
     ],
     "author": "Davoice.io",
     "license": "MIT"

package/wakewords/KeyWordRNBridge.d.ts

@@ -4,13 +4,13 @@ export class KeyWordRNBridgeInstance {
     listeners: any[];
     isFirstInstance: boolean;
     isSticky: any;
-    createInstance(modelName: any, threshold: any, bufferCnt: any): any;
-    setKeywordDetectionLicense(license: any): any;
-    replaceKeywordDetectionModel(modelName: any, threshold: any, bufferCnt: any): any;
-    setKeywordLicense(license: any): any;
-    startKeywordDetection(threshold: any): any;
-    stopKeywordDetection(): any;
-    destroyInstance(): any;
+    createInstance(modelName: any, threshold: any, bufferCnt: any): Promise<any>;
+    setKeywordDetectionLicense(license: any): Promise<any>;
+    replaceKeywordDetectionModel(modelName: any, threshold: any, bufferCnt: any): Promise<any>;
+    setKeywordLicense(license: any): Promise<any>;
+    startKeywordDetection(threshold: any): Promise<any>;
+    stopKeywordDetection(): Promise<any>;
+    destroyInstance(): Promise<any>;
     onKeywordDetectionEvent(callback: any): void;
     removeListeners(): void;
 }

package/wakewords/KeyWordRNBridge.js

@@ -20,30 +20,25 @@ export class KeyWordRNBridgeInstance {
       this.isSticky = isSticky;
     }
   
-    createInstance(
-      modelName,
-      threshold,
-      bufferCnt) 
-      {
-      instance = KeyWordRNBridge.createInstance(
+    async createInstance(modelName, threshold, bufferCnt) {
+      instance = await KeyWordRNBridge.createInstance(
         this.instanceId,
         modelName,
         threshold,
-        bufferCnt
-      );
+        bufferCnt);
       if (instance && this.isFirstInstance)
       {
         this.isFirstInstance = false;
-        KeyWordRNBridge.startForegroundService(this.instanceId); 
+        await KeyWordRNBridge.startForegroundService(this.instanceId); 
       }
       return instance;
     }
 
-    setKeywordDetectionLicense(license) {
+    async setKeywordDetectionLicense(license) {
         return KeyWordRNBridge.setKeywordDetectionLicense(this.instanceId, license);
     }
 
-    replaceKeywordDetectionModel(modelName, threshold, bufferCnt) {
+    async replaceKeywordDetectionModel(modelName, threshold, bufferCnt) {
         return KeyWordRNBridge.replaceKeywordDetectionModel(this.instanceId, modelName, threshold, bufferCnt);
     }
     /*startForegroundService() {
@@ -53,19 +48,19 @@ export class KeyWordRNBridgeInstance {
     stopForegroundService() {
         return KeyWordRNBridge.stopForegroundService(this.instanceId);
     }*/
-    setKeywordLicense(license) {
+    async setKeywordLicense(license) {
         return KeyWordRNBridge.setKeywordLicense(this.instanceId, license);
     }
 
-    startKeywordDetection(threshold) {
+    async startKeywordDetection(threshold) {
         return KeyWordRNBridge.startKeywordDetection(this.instanceId, threshold);
     }
 
-    stopKeywordDetection() {
+    async stopKeywordDetection() {
         return KeyWordRNBridge.stopKeywordDetection(this.instanceId);
     }
 
-    destroyInstance() {
+    async destroyInstance() {
         return KeyWordRNBridge.destroyInstance(this.instanceId);
     }
 

package/wakewords/useModel.d.ts

@@ -1,3 +1,10 @@
+interface instanceConfig {
+    id: string;
+    modelName: string;
+    threshold: number;
+    bufferCnt: number;
+    sticky: boolean;
+}
 /**
  * Custom hook for handling keyword detection using KeyWordRNBridge
  * @returns An object with functions and state for keyword detection
@@ -5,7 +12,7 @@
 export declare const useModel: () => {
     isListening: boolean;
     startListening: () => Promise<void>;
-    loadModel: (models: [string], callback: (phrase: string) => void) => Promise<void>;
+    loadModel: (useConfigs: instanceConfig[], callback: (phrase: string) => void) => Promise<void>;
     setKeywordDetectionLicense: (licenseKey: string) => Promise<void>;
     stopListening: () => Promise<void>;
 };

package/wakewords/useModel.tsx

@@ -31,6 +31,14 @@ var instanceConfigs:instanceConfig[] = [
     { id: 'need_help_now', modelName: 'need_help_now.onnx', threshold: 0.9999, bufferCnt: 3 , sticky: false },
 ];
 
+// Helper function to format the ONNX file name
+const formatWakeWord = (fileName) => {
+    return fileName
+      .replace(/_/g, ' ')  // Use global flag to replace all underscores
+      .replace('.onnx', '')
+      .replace(/\b\w/g, (char) => char.toUpperCase()); // Capitalize each word
+};
+  
 // Function to add a new instance dynamically
 //async function addInstance(
 //    conf: instanceConfig) 
@@ -43,7 +51,7 @@ async function addInstance(
     if (instanceConf != null) {
         console.log("Found Instance: ", id, "starting to listen");
         const instance = instanceConf.instance;
-        instance.startKeywordDetection(conf.threshold);
+        await instance.startKeywordDetection(conf.threshold);
         return instance;
     }
     const instance = await createKeyWordRNBridgeInstance(id, conf.sticky);
@@ -63,12 +71,13 @@ async function addInstance(
     keyWordRNBridgeInstances.push({ id, instance });
       // Set up event listener
     instance.onKeywordDetectionEvent((phrase: string) => {
+      phrase = formatWakeWord(id);
       console.log(`Instance ${id} detected: ${id} with phrase`, phrase);
       // callback(phrase); Does not work on IOS
-      callback(id);
+      callback(phrase);
     });
     console.log(`Instance ${id} calling startKeywordDetection()`);
-    instance.startKeywordDetection(conf.threshold);
+    await instance.startKeywordDetection(conf.threshold);
     console.log(`Instance ${id} started Keyword Detection`);
     return instance;
   }
@@ -140,9 +149,9 @@ export const useModel = () => {
         let element:any = null;
         console.log("loadModel() - instanceConfigs == ", instanceConfigs)
         try {
-            instanceConfigs.forEach(element => {
-            console.log('Adding element:', element);
-            const id = addInstance(element, callback);
+            instanceConfigs.forEach(async element => {
+                console.log('Adding element:', element);
+                const id = await addInstance(element, callback);
             });
         } catch (error) {
             console.error("[useModel] Error loading model:", error);
@@ -154,11 +163,11 @@ export const useModel = () => {
      */
     const startListening = useCallback(async () => {
         try {
-            keyWordRNBridgeInstances.forEach(element => {
+            keyWordRNBridgeInstances.forEach(async element => {
                 const instance = element.instance;
                 const conf = instanceConfigs.find(element => element.id === instance.instanceId);
                 if (conf) {
-                    instance.startKeywordDetection(conf.threshold);
+                    await instance.startKeywordDetection(conf.threshold);
                 } else {
                     console.error(`No configuration found for instance ID: ${instance.instanceId}`);
                 }
@@ -179,9 +188,9 @@ export const useModel = () => {
      */
     const stopListening = useCallback(async () => {
         try {
-            keyWordRNBridgeInstances.forEach(element => {
+            keyWordRNBridgeInstances.forEach(async element => {
                 const instance = element.instance;
-                instance.stopKeywordDetection();
+                await instance.stopKeywordDetection();
                 /*if (instance.isSticky == false) {
                     instance.stopKeywordDetection();
                 } else if (Platform.OS != 'ios') {