Managing States in SUSI MagicMirror Module
SUSI MagicMirror Module is a module for MagicMirror project by which you can use SUSI directly on MagicMirror. While developing the module, a problem I faced was that we need to manage the flow between the various stages of processing of voice input by the user and displaying SUSI output to the user. This was solved by making state management flow between various states of SUSI MagicMirror Module namely,
- Idle State: When SUSI MagicMirror Module is actively listening for a hotword.
- Listening State: In this state, the user’s speech input from the microphone is recorded to a file.
- Busy State: The user has finished speaking or timed out. Now, we need to transcribe the audio spoken by the user, send the response to SUSI server and speak out the SUSI response.
The flow between these states can be explained by the following diagram:
As clear from the above diagram, transitions are not possible from a state to all other states. Only some transitions are allowed. Thus, we need a mechanism to guarantee only allowed transitions and ensure it triggers on the right time.
For achieving this, we first implement an abstract class State with common properties of a state. We store the information whether a state can transition into some other state in a map allowedTransitions which maps state names “idle”, “listening” and “busy” to their corresponding states. The transition method to transition from one state to another is implemented in the following way.
protected transition(state: State): void { if (!this.canTransition(state)) { console.error(`Invalid transition to state: ${state}`); return; } this.onExit(); state.onEnter(); } private canTransition(state: State): boolean { return this.allowedStateTransitions.has(state.name); }
Here we first check if a transition is valid. Then we exit one state and enter into the supplied state. We also define a state machine that initializes the default state of the Mirror and define valid transitions for each state. Here is the constructor for state machine.
constructor(components: IStateMachineComponents) {
this.idleState = new IdleState(components);
this.listeningState = new ListeningState(components);
this.busyState = new BusyState(components);
this.idleState.AllowedStateTransitions = new Map<StateName, State>([["listening", this.listeningState]]);
this.listeningState.AllowedStateTransitions = new Map<StateName, State>([["busy", this.busyState], ["idle", this.idleState]]);
this.busyState.AllowedStateTransitions = new Map<StateName, State>([["idle", this.idleState]]);
this.currentState = this.idleState;
this.currentState.onEnter();
}
Now, the question arises that how do we detect when we need to transition from one state to another. For that we subscribe on the Snowboy Detector Observable. We are using Snowboy library for Hotword Detection. Snowboy detects whether an audio stream is silent, has some sound or whether hotword was spoken. We bind all this information to an observable using the ReactiveX Observable pattern. This gives us a stream of events to which we can subscribe and get the results. It can be understood in the following code snippet.
detector.on("silence", () => { this.subject.next(DETECTOR.Silence); }); detector.on("sound", () => {}); detector.on("error", (error) => { console.error(error); }); detector.on("hotword", (index, hotword) => { this.subject.next(DETECTOR.Hotword); });
public get Observable(): Observable<DETECTOR> { return this.subject.asObservable(); }
Now, in the idle state, we subscribe to the values emitted by the observable of the detector to know when a hotword is detected to transition to the listening state. Here is the code snippet for the same.
this.detectorSubscription = this.components.detector.Observable.subscribe( (value) => { switch (value) { case DETECTOR.Hotword: this.transition(this.allowedStateTransitions.get("listening")); break; } });
In the listening state, we subscribe to the states emitted by the detector observable to find when silence is detected so that we can stop recording the audio stream for processing and move to busy state.
this.detectorSubscription = this.components.detector.Observable.subscribe( (value) => { switch (value) { case DETECTOR.Silence: record.stop(); this.transition(this.allowedStateTransitions.get("busy")); break; } });
The task of speaking the audio and displaying results on the screen is done by a renderer. The communication to renderer is done via a RendererCommunicator object using a notification system. We also bind its events to an observable so that we know when SUSI has finished speaking the result. To transition from busy state to idle state, we subscribe to renderer observable in the following manner.
this.rendererSubscription = this.components.rendererCommunicator.Observable.subscribe((type) => { if (type === "finishedSpeaking") { this.transition(this.allowedStateTransitions.get("idle")); } });
In this way, we transition between various states of MagicMirror Module for SUSI in an efficient manner.
Resources
- MagicMirror Project Website: https://magicmirror.builders
- RxJS Observable Usage tutorial: http://xgrommx.github.io/rx-book/content/observable/
- State Pattern for Software Development: https://en.wikipedia.org/wiki/State_pattern
- State Machine pattern in NodeJS: http://www.robert-drummond.com/2015/04/21/event-driven-programming-finite-state-machines-and-nodejs/
You must be logged in to post a comment.