VeeaR EasyVR 3 User manual

EasyVR 3
User Manual
Release
1.0.11
www.veear.eu

www.veear.eu
2EasyVR 3 User Manual (1.0.11)
Table of Contents
EasyVR 3 Module............................................................................................................................................. 5
Product Description........................................................................................................................................ 5
EasyVR 3 Features.................................................................................................................................... 5
Technical specifications................................................................................................................................. 6
Pin assignment .......................................................................................................................................... 7
Settings and indicators .............................................................................................................................. 8
Physical dimensions .................................................................................................................................. 8
Recommended Operating Conditions ....................................................................................................... 9
Power Supply Requirements..................................................................................................................... 9
Electrical Characteristics ........................................................................................................................... 9
Serial Interface......................................................................................................................................... 10
Microphone.............................................................................................................................................. 11
Audio Output............................................................................................................................................ 13
General Purpose I/O................................................................................................................................ 14
Flash Update ........................................................................................................................................... 15
Quick start for using the module .................................................................................................................. 16
EasyVR 3 as a Development Board........................................................................................................ 16
EasyVR Shield 3 for Arduino........................................................................................................................ 18
Product description ...................................................................................................................................... 18
EasyVR Shield 3 Features....................................................................................................................... 18
Technical specifications............................................................................................................................... 19
Board overview........................................................................................................................................ 19
Pin assignment ........................................................................................................................................ 20
Mode Jumper settings ............................................................................................................................. 20
Software Serial Pins settings................................................................................................................... 21
Quick start guide for using the Shield .......................................................................................................... 22
With Arduino Leonardo –Due (Native USB)........................................................................................... 22
With Arduino 2009 –Uno –Mega ........................................................................................................... 23
EasyVR Programming................................................................................................................................... 24
Communication Protocol.............................................................................................................................. 24
Introduction.............................................................................................................................................. 24
Arguments Mapping................................................................................................................................. 25
Command Details .................................................................................................................................... 26
Status Details........................................................................................................................................... 31
Communication Examples ........................................................................................................................... 34
Recommended wake up procedure......................................................................................................... 34
Recommended setup procedure ............................................................................................................. 34
Recognition of a built-in or custom SI command..................................................................................... 35
Adding a new SD command.................................................................................................................... 35
Training an SD command........................................................................................................................ 36
Recognition of an SD command.............................................................................................................. 36
Read used command groups................................................................................................................... 37
Read how many commands in a group................................................................................................... 37
Read a user defined command group..................................................................................................... 37
Use general purpose I/O pins.................................................................................................................. 38

www.veear.eu
User Manual (1.0.11) EasyVR 3 3
Use custom sound playback.................................................................................................................... 38
Read sound table..................................................................................................................................... 38
Built-in Command Sets ................................................................................................................................ 39
Error codes................................................................................................................................................... 40
Protocol header file...................................................................................................................................... 41
EasyVR Arduino Library ............................................................................................................................... 42
EasyVR library settings................................................................................................................................ 42
Macros..................................................................................................................................................... 42
Detailed Description................................................................................................................................. 42
Macro Definition Documentation ............................................................................................................. 42
EasyVR Class Reference............................................................................................................................. 42
Public Types ............................................................................................................................................ 42
Public Member Functions........................................................................................................................ 43
Detailed Description................................................................................................................................. 44
Member Enumeration Documentation..................................................................................................... 44
Constructor & Destructor Documentation................................................................................................ 47
Member Function Documentation ........................................................................................................... 48
EasyVR Commander ..................................................................................................................................... 57
Getting Started............................................................................................................................................. 57
Speech Recognition..................................................................................................................................... 58
Recognition Settings.................................................................................................................................... 60
Phone Tones Generation (DTMF) ............................................................................................................... 61
Testing SonicNetTM ...................................................................................................................................... 61
Using Custom Data...................................................................................................................................... 63
Sound Table ............................................................................................................................................ 63
Speaker Independent Custom Vocabularies........................................................................................... 64
Updating Custom Data ............................................................................................................................ 65
Updating Firmware....................................................................................................................................... 67
QuickUSB Adapter Cable.............................................................................................................................. 68
Product Description...................................................................................................................................... 68
QuickUSB Features................................................................................................................................. 68
Technical Specifications............................................................................................................................... 68
Drawings and Schematics....................................................................................................................... 68
Pin Description......................................................................................................................................... 68
Operating Conditions............................................................................................................................... 69
Electrical Characteristics ......................................................................................................................... 69
QuickStart Instructions................................................................................................................................. 69
Software Setup ........................................................................................................................................ 69
Using the Adapter.................................................................................................................................... 69
How to get support........................................................................................................................................ 70

www.veear.eu
4EasyVR 3 User Manual (1.0.11)
Document History Information
Revision
Date
Description
1.0
2015/01/27
Initial draft
1.0.3
2015/02/09
New drawings and updated descriptions
1.0.4
2015/03/19
Added new pictures and minor updates
1.0.5
2015/03/25
Update pictures and quickstart sections
1.0.6
2015/03/30
Added programming and library chapters
Added PC software description
Updated pictures and layout
1.0.7
2015/03/31
Minor corrections
1.0.8
2015/04/01
Updated custom data screenshots and description
1.0.9
2015/04/02
Added chapter for QuickUSB adapter
1.0.10
2015/04/22
Updated mechanical drawing of module
1.0.11
2015/06/05
Added note about soldering headers
Removed old logo from drawings

www.veear.eu
User Manual (1.0.11) EasyVR 3 5
EasyVR 3 Module
Product Description
EasyVR 3 is a multi-purpose speech recognition module designed to
easily add versatile, robust and cost effective speech recognition
capabilities to almost any application.
The EasyVR 3 module can be used with any host with an UART
interface powered at 3.3V –5V, such as PIC and Arduino boards.
Some application examples include home automation, such as voice
controlled light switches, locks, curtains or kitchen appliances, or
adding “hearing” to the most popular robots on the market.
It can be easily plugged into a solder-less breadboard or standard
prototyping board, and it is compatible with the mikroBUS™
specifications (see www.mikroe.com/mikrobus).
Separate male headers are provided inside the package, along with a microphone cable assembly and
speaker wires (loudspeaker not included).
EasyVR 3 Features
Up to 28 custom Speaker Independent (SI) command vocabularies
1
.
Supported Languages:
oUS English
oBritish English
oFrench
oGerman
oItalian
oJapanese
oKorean
oMandarin
oSpanish
Up to 32 user-defined Speaker Dependent (SD) or Speaker Verification (SV) commands, that can be
trained in ANY language.
A selection of built-in Speaker Independent (SI) commands for ready-to-run basic controls, in the
following languages:
oEnglish (US)
oItalian
oGerman
oFrench
oSpanish
oJapanese
SonicNet technology for wireless communications between modules or any other sound source
(Audio CD, DVD, MP3 Player).
Up to 22 minutes of pre-recorded sounds or speech
2
.
DTMF tone generation.
Differential audio output that directly supports 8Ω speakers.
Easy-to-use Graphical User Interface to program Voice Commands and audio.
Standard UART interface (powered at 3.3V - 5V).
Simple and robust documented serial protocol to access and program through the host board.
6 General purpose I/O lines that can be controlled via UART commands.
1
A QuickT2SI™ Lite license (sold separately) is required to enable creation of Speaker Independent
vocabularies (maximum 12 commands per set).
2
At maximum compression rate.

www.veear.eu
6EasyVR 3 User Manual (1.0.11)
Technical specifications
CABLES
MISC
SPEAKER
MIC
R4
D2
GPIO
IO1
SP+
AUDIO
IO2
SP-
IO3
VM
IO4
MIC
IO5
RET
IO6
VDD
MIKROBUS
XM
MIKROBUS
RST
DE
TX
RX
3V3
5V
GND
GND
PWR SEL
QUICK USB
D1
MISC
ADAPTER
MISC
The outer headers J1 and J2 are the mikroBUS™ interface connectors, providing selectable 3.3V/5V power
input to the module and voltage translated digital I/O lines, including: UART receive/transmit lines and control
pins.
The header J3 provides configurable I/O expansion lines (inputs with weak internal pull-up by default),
powered at the internal logic voltage VDD.
The header J4 contains the main analog signals, such as microphone signals and amplified DAC outputs,
which are also available on the internal right angle connectors J5 and J6.
The module can also be operated through the programming connector J7 alone, by using the QuickUSB
adapter/cable.

www.veear.eu
User Manual (1.0.11) EasyVR 3 7
Pin assignment
Group
Name
Number
Pin
Type
Description
●
MIKROBUS
J1
1
-
-
(Not connected)
2
RST
I
Active low asynchronous reset (internal pull-up)
3-6
-
-
(Not connected)
7
3V3
I
3.3V DC power input
8
GND
-
Ground
J2
1
XM
I
Boot select (internal pull-down)
2
DE
O
(Reserved)
3
TX
O
Serial Data Transmit
4
RX
I
Serial Data Receive
5-6
-
-
(Not connected)
7
5V
I
5.0V DC power input
8
GND
-
Ground
●
GPIO
J3
1
IO1
I/O
General purpose I/O (VDD logic levels)
2
IO2
I/O
General purpose I/O (VDD logic levels)
3
IO3
I/O
General purpose I/O (VDD logic levels)
4
IO4
I/O
General purpose I/O (VDD logic levels)
5
IO5
I/O
General purpose I/O (VDD logic levels)
6
IO6
I/O
General purpose I/O (VDD logic levels)
●
AUDIO
J4
1
SP+
O
Differential audio output (can directly drive 8Ω
speaker)
2
SP-
O
3
VM
O
Microphone power (to support custom
microphones)
4
MIC
I
Microphone audio input
5
RET
-
Microphone return (analog ground)
6
VDD
O
Internal logic voltage (for reference only)
●
CABLES
J5
1
SP-
O
Differential audio output (can directly drive 8Ω
speaker)
3
SP+
O
2
-
-
(Not connected)
J6
1
MIC
I
Microphone audio input
2
RET
-
Microphone return (analog ground)
●
ADAPTER
J7
1
RX_P
O
Programming cable serial data receive
2
RTS_P
I
Programming cable request to send (reset/boot
control)
3
GND
-
Programming cable ground
4
5V_P
I
Programming cable 5V DC power output
5
TX_P
I
Programming cable serial data transmit
6
CTS_P
O
Programming cable clear to send (tied to ground)

www.veear.eu
8EasyVR 3 User Manual (1.0.11)
Note: The General Purpose I/O lines (J3.1-6) are at nominal 3.0VDC level. Do not connect
higher voltages directly to these pins!
Settings and indicators
Group
Name
Type
Description
●
MISC
PWR SEL
3-Way Jumper
(SMD 0603)
Select power input and voltage level between +3.3V
and +5V with a zero Ohm resistor or solder bridge
D1
LED
Red light indicator, normally ON when the board is
powered, briefly blinking on serial data received
D2
LED
Green light indicator, turns ON when the module is
listening to its audio input
R4
Resistor
(SMD 0603)
Microphone gain resistor, default is 1.2kΩ
Physical dimensions
Symbol
Parameter
Units (mm / Inches)
W
Width
25.4
1.000
L
Length
56.4
2.220
H1
Height (without outer strips J1-J4)
9.5
0.375
H2
Height (with outer strips J1-J4)
17.0
0.670
E1
Connector pitch and pin spacing (of outer strips J1-J4)
2.54
0.100
E2
Connector pitch (of inner connectors J5-J7)
2.00
0.079
A
Headers horizontal spacing
22.86
0.900
B
Headers vertical spacing
20.32
0.800
C
Header vertical offset
3.81
0.150
D
Header horizontal offset
1.27
0.050
L
W
E2
E2
E1
E2
E2
E1 E1
E1
A
C
B
DD
H1
H2
W
L

www.veear.eu
User Manual (1.0.11) EasyVR 3 9
Recommended Operating Conditions
Symbol
Parameter
Min
Typ
Max
Unit
5V
DC Power Input (Host) = VSEL
3.15
5.0
5.5
V
3V3
3.15
3.3
5.5
V
5V_P
DC Power Input (Programming cable)
4.0
5.0
5.5
V
Ta
Ambient Operating Temperature Range
0
25
70
°C
Power Supply Requirements
Symbol
Parameter
Min
Typ
Max
Unit
ISLEEP
Sleep current (VSEL = 5.0V)
6
mA
IOPER
Operating current (VSEL = 5.0V)
25
35
mA
IAUDIO
Audio playback current (with 8Ωspeaker)
175
250
mA (RMS)
ITOT
Total current consumption (excluding I/O)
25
285
mA (RMS)
IPEAK
Peak supply current (excluding I/O)
400
mA
Electrical Characteristics
These are applicable to pins RX, TX_P.
Symbol
Parameter
Min
Typ
Max
Unit
VIH
Input High Voltage
2.1
5.5
V
VIL
Input Low Voltage
0.0
0.9
V
IIL
Input Leakage Current (0 < VI< 5.5V)
-65
µA
These are applicable to pins TX, DE.
Symbol
Parameter
Min
Typ
Max
Unit
VOH
Output High Voltage (IOH = -0.3 mA, VSEL = 3.3V)
2.6
3.3
V
Output High Voltage (IOH = -0.3 mA, VSEL = 5.0V)
4.3
5.0
V
VOL
Output Low Voltage (IOL = 5 mA)
0.0
0.2
V
These are applicable to pin XM.
Symbol
Parameter
Min
Typ
Max
Unit
VIH
Input High Voltage
1.4
(0.8)
5.5
V
VIL
Input Low Voltage
0.0
(0.7)
0.5
V
IIN
Input Current (0 < VI< 3.3V)
0
0.2
0.4
mA
Input Current (0 < VI< 5.5V)
0
0.5
0.7
mA
These are applicable to pin RST.
Symbol
Parameter
Min
Typ
Max
Unit
VIH
Input High Voltage
2.1
5.5
V
VIL
Input Low Voltage
0.0
0.6
V
IIL
Input Leakage Current (0 < VI< 5.5V)
-85
µA

www.veear.eu
10 EasyVR 3 User Manual (1.0.11)
These are applicable to pin RX_P.
Symbol
Parameter
Min
Typ
Max
Unit
VOH
Output High Voltage (IOH = -5 mA)
2.4
3.0
V
VOL
Output Low Voltage (IOL = 8 mA)
0.0
0.6
V
These are applicable to pins IO1 –IO6.
Symbol
Parameter
Min
Typ
Max
Unit
VIH
Input High Voltage
2.4
3.0
3.3
V
VIL
Input Low Voltage
-0.1
0.0
0.75
V
IIL
Input Leakage Current (0 < VI< 3V, Hi-Z Input)
<1
10
µA
RPU
Pull-up Resistance
Strong
10
kΩ
Weak
200
kΩ
VOH
Output High Voltage (IOH = -5 mA)
2.4
3.0
V
VOL
Output Low Voltage (IOL = 8 mA)
0.0
0.6
V
Serial Interface
The EasyVR 3 communicates via an asynchronous serial interface (commonly known as UART interface),
with the following features:
Baud Rate: 9600 (default), 19200, 38700, 57600, 115200
Frame: 8Data bits, No parity, 1Stop bit
The receiver input data line is RX, while the transmitter output data line is TX. No handshake lines are used.
Example of a serial data frame representing character “A” (decimal 65 or hexadecimal 41):
VCC
Idle
Start
1
0
0
0
0
0
1
0
Stop
Idle
0V
See also chapter Communication Protocol later on this manual for communication details.