L-1014e.Ax phyBOARD-Mira Voice Control Kit with Beamforming Quickstart Head
This Quickstart guide describes the tools and provides the know-how to install and begin working with the vicCONTROL Industrial Voice Control System from voice INTER connect GmbH for use with Voice Recognition Adapter and the phyBOARD-Mira. This guide includes installing the appropriate tools and sources, booting the board, and starting the two demo programs (Washing Machine and Industrial Paper Cutting Machine) in order to begin working with the hardware and software.
QS Guide: A short guide on how to set up and boot a phyCORE board along with brief information on building a BSP, the device tree, and accessing peripherals.
Hardware Manual: A detailed description of the System on Module and accompanying carrier board.
Yocto Guide: A comprehensive guide for the Yocto version the phyCORE uses. This guide contains an overview of Yocto; introducing, installing, and customizing the PHYTEC BSP; how to work with programs like Poky and Bitbake; and much more.
BSP Manual: A manual specific to the BSP version of the phyCORE. Information such as how to build the BSP, booting, updating software, device tree, and accessing peripherals can be found here.
Development Environment Guide: This guide shows how to work with the Virtual Machine (VM) Host PHYTEC has developed and prepared to run various Development Environments. There are detailed step-by-step instructions for Eclipse and Qt Creator, which are included in the VM. There are instructions for running demo projects for these programs on a phyCORE product as well. Information on how to build a Linux host PC yourself is also a part of this guide.
Pin Muxing Table: phyCORE SOMs have an accompanying pin table (in Excel format). This table will show the complete default signal path, from the processor to the carrier board. The default device tree muxing option will also be included. This gives a developer all the information needed in one location to make muxing changes and design options when developing a specialized carrier board or adapting a PHYTEC phyCORE SOM to an application.
On top of these standard manuals and guides, PHYTEC will also provide Product Change Notifications, Application Notes, and Technical Notes. These will be done on a case-by-case basis. Most of the documentation can be found on the applicable download page of our products.
The input is done by means of the Microphone Array which has 7 microphones mounted over it.
The output is only supported via the USB port. The audio jack of the Voice Recognition Adapter (PEB-AV-07) is not supported for an output device.
For more information on setting the Audio input and output, please read vicCONTROL industrial version 5.0.0 User guide Phytec Voice Control Kits (phyBOARD®-Mira) Section4.9. The link can be found in the section Further Documentation.
Setting USB Input and Output
Manual setting of USB input and output is not necessary. The USB output device is automatically detected and set as default upon plugging in. This restarts the recognition system.
Jumpers are set out of the box to use the microphone array as default.
For more information on setting the Audio input and output, please read vicCONTROL industrial version 5.0.0 User guide Phytec Voice Control Kits (phyBOARD®-Mira) Sections 4.9. The link can be found in the section Further Documentation.
USB Mouse (optional)
A USB mouse can be connected to the phyBOARD-Mira. This is optional but will make using the interface and demo easier.
Either a mouse or touch screen is required to change the language of the Washing Machine demo.
Initial Boot Up
To obtain the SD card image used in this kit, please contact our support: email@example.com
Once the SD card has been inserted and a speaker and display attached to the board, connecting a power supply will boot up the phyBOARD-Mira. A pre-loaded demo, vicCONTROL Industrial Demo - Industrial Paper Cutting Machine, will then begin automatically.
vicCONTROL Industrial Usage
Starting the Demo Program
The Boot Sequence
Before you can start working with the demo applications, you will need to make sure the phyBOARD-Mira is set to the correct boot sequence.
The boot switch on the phyBOARD-Mira has only one label: ON. To avoid confusion when selecting the boot sequence, the side not labeled is considered to be OFF.
On the bottom of the phyBOARD-Mira is a switch controlling the boot sequence (either internal memory or SD card). The default setting (the boot switch set to ON) begins booting from the SD card. To change the boot sequence, power off the phyBOARD-Mira, and move the switch from ON to OFF:
phyBOARD-Mira Boot Switch (S2)
Booting from the SD card (boot switch set to ON) will start the preloaded vicCONTROL Industrial Demo - Industrial Paper Cutting Machine.
Booting from internal memory (boot switch set to OFF) will start the preloaded demo Washing Machine.
Then power the board back on. The system will boot using the chosen boot sequence.
Boot Switch set to ON - Industrial Paper Cutting Machine Demo
By default, the boot switch on the phyBOARD-Mira is set to ON before connecting the power supply. After the board has been powered on, the vicCONTROL Industrial Welcome Screen will be presented. This screen also shows the system ID:
An example of a vicCONTROL Industrial Welcome Screen showing the system ID
If a display is not available, logging in via SSH aslp prints the hardware ID as part of the welcome message.
With the given hardware ID, a license can be obtained from vicSDC (vicsdc.voiceinterconnect.de). The generated license file, named lic, should be deployed to:
and then speech applications need to be reloaded:
systemctl restart speech.target
After a license is successfully deployed, the vicCONTROL Industrial - Industrial Paper Cutting Machine Demo will be shown:
Industrial Paper Cutting Machine Demo
Similar to the Washing Machine demo, simply say the wake-up phrase followed by a command, for example:
Hey machine, turn on.
Hey machine, set the paper size to A5, 500 pieces.
Audio input and output can be tricky and has many components involved (microphone, amplifier, casing, the room's acoustic you are in, the noise inside the room, speaker distance, etc.).
The demo is meant to be used in relatively quiet office environments.
Command-Line Example App
After logging in, you can run the command line (CLI) demo with the following command:
The application will print the recognition results for the running speech application (the Paper Cutting Machine demo by default). The user can also input the name of an audio prompt that is included in the application and the prompt will be played. The application can also serve as a sample Python implementation for communication between a user application and the rest of the recognition system. The code for the application can be found in:
Boot Switch set to OFF - Washing Machine Demo
For the Washing Machine Demo, the jumpers have to be changed to use the built-in microphones. The complete setup and behavior are covered in the "FAQ for the target platform Phytec Voice Control Kits", FAQ 13: How to use the washing machine demo with the Voice Control Kit 2. The link can be found in the section Further Documentation.
The "Washing Machine" application is for demonstration only. It cannot be used as a starting point for your own applications.
The German version is the default setting for the "Washing Machine" demo. You can return to the main menu with the button in the upper left corner and select another recognition language from there. This can only be done if there is a mouse or touch screen attached to the pyhBOARD-Mira.
Washing Machine Demo in different languages - left: German; right - Mandarin
Say the wake-up phrase. This will allow you to control the setting on the screen.
The wake-up phrase is different for each language but is shown on the screen. For example, in the German version, you might say:
"Hallo Waschmaschine, Kockwäsche 90°C, 1200 Umdrehungen, extra Spülen, fertig in 5 Stunden!"
"Hallo Waschmachine, wie lange dauert das Programm noch?"
You do not have to follow this format exactly when talking to the application. The system should be able to understand natural speech.
Inside the "Washing Machine" screen, you can say the wake-up phrase, for example: "Hallo Waschmachine", and then a command phrase.
After the wake-up phrase and before issuing a command, you should wait for the system to respond with a short tune and highlighting of the wake-up phrase on the screen. This is, however, optional. You can also say the wake-up and command phrase at once, without a pause in between.
In general, the system supports two tasks (or intents):
Selection of a program or changing its parameters by voice: The system provides natural language input and will try to follow any reasonable command that you provide by voice. You can set a program or any of the parameters here or even many at once.
Get the remaining time of the "currently running" program: Just ask how long the current program will last.
The following provides just a few short examples of sentences. Get creative! Try long or short sentences! Try synonyms for words...and have fun!!
English (Great Britain) - Washing Machine "Hello washing machine, wash my coloured cloths at 60 degrees!" "Hello washing machine, how long does the program last?"
English (USA) - Washer "Hey washer, wash my white clothes, hot!" "Hey washer, how long?"
French (France) - Lave-linge "Allô lave-linge, couleur 60 degrés Celsius!" "Allô lave-linge, quand le programme est-il terminé?"
After exploring the two demo programs, you will want to see how to create and modify your own speech application. vicSDC is a web tool where speech applications are defined and generated. These applications can be downloaded from here, ready for deployment on the phyBOARD-Mira.
The vicSDC registration code can be found on your Packing Slip. DO NOT lose, throw away, or destroy your Bill of Delivery as you will not be able to register your account!
Go to the following webpage and click Register from the main menu:
Enter a username and password, along with the Registration Code found on your Bill of Delivery to register. With this account, you are now able to create and maintain all speech applications for the vicCONTROL Industrial.
Only one user account can be created per the Registration Code.
After registering, you can now log in and see the included example application or create new speech applications. Under Links and Documentation, you will find a downloadable user guide to help work through the many options you have when designing an application.
Congratulations! You have now completed the demo programs that come with this product.
Modifying the PHYTEC BSP
Now that you have completed the demo program, you may want to design your own carrier board, change the user functionality of either your hardware or software and create your own application with Voice Recognition support.
For any of these situations, you will probably need to modify the PHYTEC BSP that comes with this product. The following section shows you how this can be done.
Add this layer (meta-speech) to the folder "Sources", unpacked. Then register this layer in the file build/conf/bblayers.conf, by adding the following line at the bottom of the existing list of layers in the BBLAYERS variable:
Accept the vicCONTROL Industrial license by adding the following lines in the file build/conf/local.conf: