new 'Cmdl.set.wakeword' + improved state broadcasting (cmdl);

Author: fquirin

www/scripts/sepiaFW.inputControls.cmdl.js

@@ -95,10 +95,17 @@ function sepiaFW_build_input_controls_cmdl() {
         }
     }
     function wakeWordBroadcaster(ev){
-        if (Cmdl.broadcasters.wakeWord && ev.detail && ev.detail.keyword){
-            broadcastEvent("sepia-wake-word", {
-                word: ev.detail.keyword
-            });
+        if (Cmdl.broadcasters.wakeWord && ev.detail && ev.detail.state){
+            var d = {
+                state: ev.detail.state
+            }
+            if (ev.detail.keyword){
+                d.word = ev.detail.keyword;
+            }
+            if (ev.detail.msg){
+                d.msg = ev.detail.msg;
+            }
+            broadcastEvent("sepia-wake-word", d);
         }
     }
 
@@ -162,6 +169,23 @@ function sepiaFW_build_input_controls_cmdl() {
 
     Cmdl.set = {};
 
+    Cmdl.set.wakeword = function(ev){
+        if (ev.state){
+            if (ev.state == "on" || ev.state == "active" || ev.state == "activate"){
+                SepiaFW.wakeTriggers.useWakeWord = true;
+                if (!SepiaFW.wakeTriggers.engineLoaded){
+                    SepiaFW.wakeTriggers.setupWakeWords();      //will auto-start after setup
+                }else if (!SepiaFW.wakeTriggers.isListening()){
+                    SepiaFW.wakeTriggers.listenToWakeWords();
+                }
+            }else if (ev.state == "off" || ev.state == "inactive" || ev.state == "deactivate"){
+                if (SepiaFW.wakeTriggers.engineLoaded && SepiaFW.wakeTriggers.isListening()){
+                    SepiaFW.wakeTriggers.stopListeningToWakeWords();
+                }
+            }
+        }
+    }
+
     //---------- GET ------------
 
     Cmdl.get = {};

www/scripts/sepiaFW.ui.animate.js

@@ -195,9 +195,19 @@ function sepiaFW_build_animate(){
 
 	Animate.wakeWord.active = function(){
 		$('#sepiaFW-nav-label-online-status').addClass("wake-word-active");
+		//dispatch event
+		var event = new CustomEvent('sepia_wake_word', { detail: {
+			state: "active"
+		}});
+		document.dispatchEvent(event);
 	}
 	Animate.wakeWord.inactive = function(){
 		$('#sepiaFW-nav-label-online-status').removeClass("wake-word-active");
+		//dispatch event
+		var event = new CustomEvent('sepia_wake_word', { detail: {
+			state: "inactive"
+		}});
+		document.dispatchEvent(event);
 	}
 
 	//channel animations for missed off-channel messages:

www/scripts/sepiaFW.wakeTriggers.js

@@ -18,7 +18,8 @@ function sepiaFW_build_wake_triggers() {
 
 		//dispatch event
 		var event = new CustomEvent('sepia_wake_word', { detail: {
-			keyword: keyword
+			keyword: keyword,
+			state: "triggered"
 		}});
 		document.dispatchEvent(event);
 
@@ -33,6 +34,15 @@ function sepiaFW_build_wake_triggers() {
 			});
 		}
 	}
+	function broadcastWakeWordError(error){
+		//dispatch event
+		var event = new CustomEvent('sepia_wake_word', { detail: {
+			msg: error,
+			state: "error"
+		}});
+		document.dispatchEvent(event);
+	}
+	//NOTE: active, inactive: see ui.animate.wakeWord...
 
 	//Interface 
 
@@ -399,6 +409,7 @@ function sepiaFW_build_wake_triggers() {
 		}
 		SepiaFW.debug.error("Porcupine: " + errMsg);
 		SepiaFW.ui.showPopup("Porcupine error: " + errMsg);
+		broadcastWakeWordError(errMsg);
     };
 
 	//-------------------------------------------------