VeeaR EasyVR 3 User Manual Download Page 47

Page: 47 / 70

www.veear.eu

User Manual (1.0.11)

EasyVR 3

Enumerator

ERR_DATACOL_TOO_LONG

too long (memory overflow)

ERR_DATACOL_TOO_NOISY

too noisy

ERR_DATACOL_TOO_SOFT

spoke too soft

ERR_DATACOL_TOO_LOUD

spoke too loud

ERR_DATACOL_TOO_SOON

spoke too soon

ERR_DATACOL_TOO_CHOPPY

too many segments/too complex

ERR_DATACOL_BAD_WEIGHTS

invalid SI weights

ERR_DATACOL_BAD_SETUP

invalid setup

ERR_RECOG_FAIL

recognition failed

ERR_RECOG_LOW_CONF

recognition result doubtful

ERR_RECOG_MID_CONF

recognition result maybe

ERR_RECOG_BAD_TEMPLATE

invalid SD/SV template

ERR_RECOG_BAD_WEIGHTS

invalid SI weights

ERR_RECOG_DURATION

incompatible pattern durations

ERR_T2SI_EXCESS_STATES

state structure is too big

ERR_T2SI_BAD_VERSION

RSC code version/Grammar ROM dont match

ERR_T2SI_OUT_OF_RAM

reached limit of available RAM

ERR_T2SI_UNEXPECTED

an unexpected error occurred

ERR_T2SI_OVERFLOW

ran out of time to process

ERR_T2SI_PARAMETER

bad macro or grammar parameter

ERR_T2SI_NN_TOO_BIG

layer size out of limits

ERR_T2SI_NN_BAD_VERSION

net structure incompatibility

ERR_T2SI_NN_NOT_READY

initialization not complete

ERR_T2SI_NN_BAD_LAYERS

not correct number of layers

ERR_T2SI_TRIG_OOV

trigger recognized Out Of Vocabulary

ERR_T2SI_TOO_SHORT

utterance was too short

ERR_SYNTH_BAD_VERSION

bad release number in speech file

ERR_SYNTH_ID_NOT_SET

(obsolete) bad sentence structure

ERR_SYNTH_TOO_MANY_TABLES

(obsolete) too many talk tables

ERR_SYNTH_BAD_SEN

(obsolete) bad sentence number

ERR_SYNTH_BAD_MSG

bad message data or SX technology files missing

ERR_CUSTOM_NOTA

none of the above (out of grammar)

ERR_SW_STACK_OVERFLOW

no room left in software stack

ERR_INTERNAL_T2SI_BAD_SETUP

T2SI test mode error

enum

BridgeMode

Type of Bridge mode requested

Enumerator

BRIDGE_NONE

Bridge mode has not been requested

BRIDGE_NORMAL

Normal bridge mode (

EasyVR

baudrate 9600)

BRIDGE_BOOT

Bridge mode for

EasyVR

bootloader (baudrate 115200)

Constructor & Destructor Documentation

EasyVR

(Stream &

)

Creates an

EasyVR

object, using a communication object implementing the #Stream interface (such as

#HardwareSerial, or the modified #SoftwareSerial and #NewSoftSerial).

Parameters:

the Stream object to use for communication with the

EasyVR

module

Summary of Contents for EasyVR 3

Page 1: ...EasyVR 3 User Manual Release 1 0 11 www veear eu ...

Page 2: ...eld 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 R...

Page 3: ...ctor 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 SonicNet TM 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 T...

Page 4: ...3 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...

Page 5: ...and vocabularies 1 Supported Languages o US English o British English o French o German o Italian o Japanese o Korean o Mandarin o Spanish 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 o English US o Italian o German...

Page 6: ... 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...

Page 7: ... 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 dri...

Page 8: ... 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 10...

Page 9: ...acteristics 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...

Page 10: ... 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 8 Data bits No parity 1 Stop bit The receiver input data line is RX while the transmitter output data line is TX No ...

Page 11: ... Microphone Rx Optional Microphone circuit Modifying gain resistance You can calculate the overall microphone gain resistance using the formula below Rs is the optimal microphone gain resistance I is the impedance rating of the microphone G is the desired overall system gain defined as follows 1 If the module is configured for HEADSET microphone distance typically a few centimeters from the user s...

Page 12: ...ounting the microphone in the final device keep in mind the following guidelines 1 Flush Mounting The microphone element should be positioned as close to the mounting surface as possible and should be fully seated in the plastic housing There must be no airspace between the microphone element and the housing Having such airspace can lead to acoustic resonance which can reduce recognition accuracy ...

Page 13: ...voice volume see appendix Error codes Audio Output The EasyVR 3 audio output interface is capable of directly driving an 8Ω speaker It can also be connected to an external audio amplifier to drive lower impedance loudspeakers Note Connecting speakers with lower impedance directly to the module may permanently damage the EasyVR audio output or the whole module It is possible to connect higher imped...

Page 14: ... 12V RELAY Z Switched Load AC MAINS Voltage I O pin directly driving a low current LED I O pin connected to high impedance 5V circuit such as MCU input pin I O pin switching a load on a high voltage line using a 12V relay The exact components values in these circuits may vary You need to calculate required values for your application and choice of components For example resistor value for the LED ...

Page 15: ...istors values or other passive components Flash Update The EasyVR module includes a boot loader that allows to update the firmware and to download new sound tables or custom grammars to the on board memory The boot mode is activated by keeping the XM signal to a high logical level at power on or reset This can be easily done with a jumper or switch taking the signal to a suitable pull up resistor ...

Page 16: ...h the serial handshake lines so you don t need to set any jumper How to get started 1 Connect the microphone to the 2 way socket MIC J6 2 Connect an 8Ω speaker to the 3 way socket SPEAKER J5 3 Connect a QuickUSB cable to the 3x2 pins socket J7 4 Plug the USB end of the adapter cable to your PC The first time it may take some time to install the required drivers see Software Setup 5 If your install...

Page 17: ...RX_P I Adapter should have TTL LVTTL compatible inputs VIH 2 0V 2 RTS_P O Adapter outputs can have 3 3V or 5V levels RTS handshake is required for automatic reset and boot mode control 3 GND Ground 4 5V_P O Adapter should provide a 5V DC power output for the module see Recommended Operating Conditions and Power Supply Requirements 5 TX_P O Adapter outputs can have 3 3V or 5V levels 6 CTS_P I CTS i...

Page 18: ...no stackable headers for the Shield interface The EasyVR 3 module is also provided separately Note The EasyVR 3 module and all stackable headers must be soldered before use EasyVR Shield 3 Features Compatible with Arduino boards that have the 1 0 Shield interface UNO R3 and legacy boards including but not limited to o Arduino Duemilanove o Arduino Uno o Arduino Mega o Arduino Leonardo o Arduino Du...

Page 19: ...EASYVR GPIO IO1 IO2 IO3 IO4 IO5 IO6 ARDUINO POWER IOREF RESET 3V3 5V GND GND VIN ARDUINO ANALOG A0 A1 A2 A3 A4 A5 SDA ARDUINO DIGITAL SCL AREF GND 13 12 11 10 9 8 7 ARDUINO DIGITAL 6 5 4 3 2 1 0 3 5mm JACK MIC SPEAKER LINE OUT EASYVR AUDIO Top View SW SERIAL PINS SW SERIAL PINS TX D13 D9 TX RX D12 D8 RX Detail Bottom View ...

Page 20: ...irectly to these pins Mode Jumper settings This jumper selects the operating mode of the EasyVR Shield and it can be placed in one of four positions o SW Software Serial mode Use it for controlling the EasyVR module from your Arduino sketch through a software serial port using pins 12 13 You can also connect the EasyVR Commander in this mode provided that the running sketch implements bridge mode ...

Page 21: ...l pin 12 as serial receiver default D8 Use digital pin 8 as serial receiver o TX Software Serial Transmitter pin D13 Use digital pin 13 as serial transmitter default D9 Use digital pin 9 as serial transmitter The choice of pins 12 13 is maintained for backward compatibility with the previous hardware revisions of the EasyVR Shield However those pins may also be used for the SPI interface so anothe...

Page 22: ...e example sketch TestEasyVR from your IDE menu File Examples EasyVR 3 Upload the sketch and open the Serial Monitor window 4 Send a question mark without quotes 5 After a few seconds you should receive an EasyVR detected message Test the Shield with the EasyVR Commander 1 Make sure the Mode jumper J7 is in the HW position 2 Open and upload the example sketch TestEasyVR or EasyVRBridge see menu Fil...

Page 23: ...r J7 is in the PC position 2 Open the EasyVR Commander and connect to the same serial port used by Arduino Download a new sound table or firmware update 1 Make sure the Mode jumper J7 is in the UP position 2 Open the EasyVR Commander and select the Arduino serial port 3 While disconnected choose Update Custom Data from the File menu or Update Firmware from the Help menu When the EasyVR Commander i...

Page 24: ...s 0 9 ms 10 90 ms and 100 ms 1 s That accounts for slower or faster host systems and therefore suitable also for software based serial communication bit banging Since the EasyVR serial interface also is software based a very short delay might be needed before transmitting a character to the module especially if the host is very fast to allow the EasyVR to get back listening to a new character The ...

Page 25: ... ARG_MAX 60h Maximum argument value 31 ARG_ZERO A 41h Zero argument value 0 ARG_ACK 20h Read more status arguments Having those constants defined in your code can simplify the validity checks and the encoding decoding process For example in pseudo code encode value 5 FIVE 5 ARG_ZERO decode value 5 FIVE ARG_ZERO 5 validity check IF ARG ARG_MIN OR ARG ARG_MAX THEN ERROR Just to make things clearer h...

Page 26: ... or received character 2 wake on loud sound or received character 3 5 wake on double clap with varying sensitivity or received character 6 8 wake on triple clap with varying sensitivity or received character Expected replies STS_SUCCESS STS_AWAKEN CMD_LEVEL v 76h Set SD level 1 Strictness control setting 1 5 1 easy 2 default 5 hard A higher setting will result in more recognition errors Expected r...

Page 27: ...TRAIN_SD t 74h Train specified SD SV command 1 Group index 0 trigger 1 15 generic 16 password 2 Command position 0 31 Expected replies STS_SUCCESS STS_RESULT STS_SIMILAR STS_TIMEOUT STS_ERROR CMD_GROUP_SD g 67h Insert new SD SV command 1 Group index 0 trigger 1 15 generic 16 password 2 Position 0 31 Expected replies STS_SUCCESS STS_OUT_OF_MEM CMD_UNGROUP_SD u 75h Remove SD SV command 1 Group index...

Page 28: ... SV commands in the specified group 1 Group index 0 trigger 1 15 generic 16 password Expected replies STS_COUNT CMD_DUMP_SD p 70h Read SD SV command data label and training 1 Group index 0 trigger 1 15 generic 16 password 2 Command position 0 31 Expected replies STS_DATA CMD_MASK_SD m 6Dh Request bit mask of non empty groups Expected replies STS_MASK CMD_RESETALL r 72h Reset all commands and group...

Page 29: ...e values that form a 10 bit index to the sound table index 1 32 2 0 built in beep 1 1023 sound index 3 Playback volume 0 31 0 min volume 15 full scale 31 double gain Expected replies STS_SUCCESS STS_ERROR CMD_PLAY_DTMF w 77h Play a DTMF key tone or dial tone 1 Fixed to 1 2 Index of phone tone to play 0 9 for digits 10 for key 11 for key and 12 15 for extra keys A to D 1 for the dial tone 3 Tone du...

Page 30: ... 10 bit delay for token output since the next sound playback delay 4 32 5 0 send immediately 1 1023 delay in units of 27 46ms Expected replies STS_SUCCESS CMD_RECV_SN h 68h Receive a SonicNet TM token 1 Length of token 4 or 8 in bits 2 Rejection level 0 2 higher values mean fewer results 1 default 3 4 Two positive values that form a 10 bit timeout for token detection timeout 3 32 4 0 wait forever ...

Page 31: ...data 1 Training information 1 empty 1 6 training count 8 SD SV conflict 16 SI conflict Known issues In firmware ID 0 command creation deletion might cause other empty commands training count to change to 7 Treat count values of 1 0 or 7 as empty training markers Never train commands more than 2 or 3 times 2 Conflicting command position 0 31 only meaningful when trained 3 Length of label 0 31 4 n T...

Page 32: ..._SD CMD_TRAIN_SD STS_SIMILAR s 73h Recognized SI word or Training similar to SI word 1 Word index 0 31 In reply to CMD_RECOG_SI CMD_RECOG_SD CMD_TRAIN_SD STS_OUT_OF_MEM m 6Dh Memory error no more room for commands or sound table not present In reply to CMD_GROUP_SD CMD_DUMP_SX STS_ID x 78h Provide firmware identification 1 Version identifier 0 In reply to CMD_ID STS_PIN p 70h Provide pin input sta...

Page 33: ...nds in this grammar 0 31 3 Length of first command label 0 31 4 n Text of first command label ASCII characters from A to Repeat last two fields for all the commands in this grammar In reply to CMD_DUMP_SI STS_TOKEN f 66h Detected a SonicNet TM token 1 2 Two positive values that form the index of a received token index 1 32 2 0 15 for 4 bit tokens or 0 255 for 8 bits tokens In reply to CMD_RECV_SN ...

Page 34: ...ts for the command and status characters as well as for mapping numeric arguments that would be used throughout the program to minimize the chance of repetition errors and clarify the meaning of the code See the Protocol header file for sample definitions that can be used in a C language environment Here below all the characters sent and received are written explicitly in order to clarify the comm...

Page 35: ...rd spoken ELSE IF result e THEN error code ack and read which one SEND error RECEIVE A 16 SEND error error RECEIVE A perform actions according to error ELSE invalid request or reply ERROR END IF Adding a new SD command insert command 0 in group 3 SEND g SEND D SEND A IF RECEIVE o THEN OK ELSE ERROR set command label to ARDUINO_2009 SEND g SEND D SEND A SEND Q name length 16 characters digits count...

Page 36: ...ay skip reading SEND command RECEIVE A may notify user and erase training or keep it ELSE IF result t THEN timed out no word spoken or heard ELSE IF result e THEN error code ack and read which one SEND error RECEIVE A 16 SEND error error RECEIVE A perform actions according to error ELSE invalid request or reply ERROR END IF Recognition of an SD command start recognition in group 1 SEND d SEND B wa...

Page 37: ...ROR ack and read count SEND count RECEIVE A IF count 1 THEN count 32 Read a user defined command group dump command 0 in group 3 SEND p SEND D SEND A IF NOT RECEIVE d THEN ERROR read command data SEND training RECEIVE A extract training count 2 for a completely trained command tr_count training AND 7 extract flags for conflicts SD or SI tr_flags training AND 24 read index of conflicting command sa...

Page 38: ... state is optional SEND q SEND D SEND C IF NOT RECEIVE p THEN ERROR Use custom sound playback play a beep at full volume works with any or no table SEND w SEND A SEND A SEND P IF RECEIVE o THEN OK ELSE ERROR play entry 13 at half volume SEND w SEND A SEND N SEND H IF RECEIVE o THEN OK ELSE ERROR play entry 123 3 32 26 at max volume SEND w SEND A 3 SEND A 26 SEND A 31 IF RECEIVE o THEN OK ELSE ERRO...

Page 39: ...5 attack attacca 攻撃 kougeki attacke ataca attaque 6 stop fermo 止まれ tomare halt para arrête 7 hello ciao こんにちは konnichiwa hallo hola salut 2 0 left a sinistra 左 hidari nach links a la izquierda à gauche 1 right a destra 右 migi nach rechts a la derecha à droite 2 up in alto 上 ue hinauf arriba vers le haut 3 down in basso 下 shita hinunter abajo vers le bas 4 forward avanti 前 mae vorwärts adelante en ...

Page 40: ...e way of speaking to the EasyVR or disturbances in the acquired audio signal that may depend on the surrounding environment The second group 11h 13h indicates an insufficient score of the recognized word from lowest to highest Acceptance of lower score results may be allowed by lowering the knob or level settings respectively for built in and custom commands see CMD_KNOB and CMD_LEVEL A third grou...

Page 41: ...PLAY_DTMF w play 1 1 dial tone 2 for duration 3 define CMD_DUMP_SX h dump wave table entries define CMD_DUMP_SI z dump si settings for ws 1 or total ws count if 1 define CMD_SEND_SN j send sonicnet token with bits 1 index 2 3 at time 4 5 define CMD_RECV_SN f receive sonicnet token with bits 1 rejection 2 timeout 3 4 define STS_MASK k mask of active groups 1 8 define STS_COUNT c count of commands 1...

Page 42: ...the default settings used by the library implementation These settings are available for completeness The default settings should be appropriate for normal use cases Macro Definition Documentation define EASYVR_RX_TIMEOUT Receive timeout in ms The maximum time that is spent waiting for a reply from the EasyVR module define EASYVR_STORAGE_TIMEOUT Reply timeout for storage operations in ms The maxim...

Page 43: ...BAD_VERSION ERR_T2SI_OUT_OF_RAM ERR_T2SI_UNEXPECTED ERR_T2SI_OVERFLOW ERR_T2SI_PARAMETER ERR_T2SI_NN_TOO_BIG ERR_T2SI_NN_BAD_VERSION ERR_T2SI_NN_NOT_READY ERR_T2SI_NN_BAD_LAYERS ERR_T2SI_TRIG_OOV ERR_T2SI_TOO_SHORT ERR_SYNTH_BAD_VERSION ERR_SYNTH_ID_NOT_SET ERR_SYNTH_TOO_MANY_TABLES ERR_SYNTH_BAD_SEN ERR_SYNTH_BAD_MSG ERR_CUSTOM_NOTA ERR_SW_STACK_OVERFLOW ERR_INTERNAL_T2SI_BAD_SETUP enum BridgeMod...

Page 44: ...n implementation of the EasyVR communication protocol Member Enumeration Documentation enum ModuleId Module identification number firmware version Enumerator VRBOT Identifies a VRbot module EASYVR Identifies an EasyVR module EASYVR2 Identifies an EasyVR module version 2 EASYVR2_3 Identifies an EasyVR module version 2 firmware revision 3 EASYVR3 Identifies an EasyVR module version 3 firmware revisi...

Page 45: ... Level Strictness values for the level settings used for recognition of custom commands not used for the mixed trigger group Enumerator EASY Lowest value most results reported NORMAL Typical value default HARD Slightly higher value fewer results reported HARDER Higher value fewer results reported HARDEST Highest value fewest results reported enum Baudrate Constants to use for baudrate settings Enu...

Page 46: ...ntifier of pin IO6 only EasyVR3 enum SoundVolume Some quick volume settings for the sound playback functions any value in the range 0 31 can be used Enumerator VOL_MIN Lowest volume almost mute VOL_HALF Half scale volume softer VOL_FULL Full scale volume normal VOL_DOUBLE Double gain volume louder enum SoundIndex Special sound index values always available even when no soundtable is present Enumer...

Page 47: ..._T2SI_NN_BAD_VERSION net structure incompatibility ERR_T2SI_NN_NOT_READY initialization not complete ERR_T2SI_NN_BAD_LAYERS not correct number of layers ERR_T2SI_TRIG_OOV trigger recognized Out Of Vocabulary ERR_T2SI_TOO_SHORT utterance was too short ERR_SYNTH_BAD_VERSION bad release number in speech file ERR_SYNTH_ID_NOT_SET obsolete bad sentence structure ERR_SYNTH_TOO_MANY_TABLES obsolete too m...

Page 48: ...etLanguage int8_t lang Sets the language to use for recognition of built in words Parameters lang 0 5 is one of values in Language Return values true if the operation is successful bool setTimeout int8_t seconds Sets the timeout to use for any recognition task Parameters seconds 0 31 is the maximum time the module keep listening for a word or a command Return values true if the operation is succes...

Page 49: ... 1000 is the delay duration in milliseconds rounded to 10 units in range 10 100 and to 100 units in range 100 1000 Return values true if the operation is successful bool changeBaudrate int8_t baud Sets the new communication speed You need to modify the baudrate of the underlying Stream object accordingly after the function returns successfully Parameters baud is one of values in Baudrate Return va...

Page 50: ... the target group or one of the values in Groups index 0 31 is the index of the command within the selected group name is a string containing the label to be assigned to the specified command Return values true if the operation is successful bool eraseCommand int8_t group int8_t index Erases the training data of a custom command Parameters group 0 16 is the target group or one of the values in Gro...

Page 51: ...cessful int8_t getGrammarsCount void Gets the total number of grammars available including built in and custom Return values integer is the count of grammars negative in case of errors bool dumpGrammar int8_t grammar uint8_t flags uint8_t count Retrieves the contents of a built in or a custom grammar Command labels contained in the grammar can be obtained by calling getNextWordLabel Parameters gra...

Page 52: ...gnition with stop void recognizeWord int8_t wordset Starts recognition of a built in word Results are available after hasFinished returns true Parameters wordset 0 3 is the target word set or one of the values in Wordset 4 31 is the target custom grammar if present Note The module is busy until recognition completes and it cannot accept other commands You can interrupt recognition with stop bool h...

Page 53: ...shed has been called Return values true if the module has been awakened from sleep mode bool isConflict Retrieves the conflict indicator Return values true is a conflict occurred during training To know what caused the conflict use getCommand and getWord only valid for triggers bool isMemoryFull Retrieves the memory full indicator only valid after addCommand returned false Return values true if a ...

Page 54: ...letes and it cannot accept other commands You can interrupt listening with stop void sendTokenAsync int8_t bits uint8_t token Starts immediate playback of a SonicNet token Manually check for completion with hasFinished Parameters bits 4 or 8 specifies the length of trasmitted token token is the index of the SonicNet token to play 0 255 for 8 bit tokens or 0 15 for 4 bit tokens Note The module is b...

Page 55: ...l playback completes and it cannot accept other commands You can interrupt playback with stop bool playSound int16_t index int8_t volume Plays a sound from the sound table and waits for completion Parameters index is the index of the target sound in the sound table volume 0 31 may be one of the values in SoundVolume Return values true if the operation is successful Note To alter the maximum time f...

Page 56: ...hole process to complete and it cannot be interrupted During this time the module cannot accept any other command The sound table and custom grammars data is not affected int bridgeRequested Stream port Tests if bridge mode has been requested on the specified port Parameters port is the target serial port usually the PC serial port Return values non zero if bridge mode should be started Note The E...

Page 57: ... then check that all devices are properly turned on and start the EasyVR Commander Select the serial port to use from the toolbar or the File menu and then go with the Connect command Figure 1 Main application window There are five kinds of commands in the software see Figure 1 and Figure 4 Trigger is a special group where you have the built in SI trigger word Robot and you may add one user define...

Page 58: ...icons or the Edit menu A command should be given a label and then it should be trained twice with the user s voice the user will be guided throughout this process see Figure 2 when the Train Command action is invoked Note Only Latin characters and digits can be used for labels as well as the underscore character Figure 2 Guided training dialog After clicking on Phase 1 or Phase 2 buttons remember ...

Page 59: ...at reflects the real command that you are going to train Figure 4 Conflicting commands The current status is displayed in the EasyVR Commander list view where groups that already contain commands are highlighted in bold The selected group of commands can also be tested by using the icon on the toolbar or the Tools menu to make sure the trained commands can be recognized successfully Note If you wa...

Page 60: ... results to be reported as correct The drawback is that even words that were correctly refused before now might also be accepted The vice versa is also true you can increase the threshold to avoid some incorrect words to be reported as good but then you may also lose a few correct results So in the end you need to find the best compromise The last parameter affect the internal microphone pre ampli...

Page 61: ... duration of 3 seconds its duration can be modified when programming the EasyVR Testing SonicNetTM Another feature available from the Tools menu is the SonicNet a wireless communication protocol based on transmission and detection of special sequences of tones called tokens Two kinds of tokens can be selected a short version with up to 16 different tokens and a long version that provides up to 256...

Page 62: ...meter can be used to indicate that the token will be mixed with the next sound played from the Soundtable after the specified amount of time since the playback begins In this case the SonicNet dialog will close to let you choose a sound to play back Note If you want to mix tokens with a compressed audio sample you must use a compression scheme with a sample rate of 9 3kHz when building the Soundta...

Page 63: ... a new project specifying RSC4 family Add your WAV files and specify one of the supported compression scheme see table below Optionally add sentences by combining basic WAV sounds That allows you to save memory when you have speech audio files if they share some pieces like You said One You said Two and so on Build the project with QuickSynthesis TM and use default settings Build linkable module L...

Page 64: ... with a list of words or short phrases also called commands and an optional trigger word phrase The so called trigger is a special set that contains only one word or phrase with an improved recognition performance that is used as an entry point for any vocal interaction with a device that is continuously listening to the user s voice If you need to use a trigger word it is important to carefully c...

Page 65: ... required to list all the QuickSynthesis TM and QuickT2SI TM projects you want to use A new file containing the specified custom data will be generated and the contents will be displayed so that you can verify them before updating the module Note The projects must have been built already with the QuickSynthesis TM or the QuickT2SI TM tool before the custom data generation can be completed successf...

Page 66: ...letes a new connection can be established with the EasyVR module in normal mode and the new sounds will be displayed by the EasyVR Commander in the special group SoundTable the last one in the list with a yellow icon They can be played back and tested using the Play Sound command on the toolbar or in the Tools menu See also how to do that in your application in the code example Use custom sound pl...

Page 67: ... required to start it in boot mode see the section Flash Update The specified file will be verified as an official firmware release and basic version information will be displayed If the firmware passes the verification step then the Download button will be enabled Figure 13 Interface for updating EasyVR firmware Note After a new firmware is downloaded to the module the custom data already present...

Page 68: ...d interface Full UART RX TX and RTS CTS at 3 3V Data transfer rates from 300 bps to 3 Mbps Extended operating temperature range 40 C to 85 C Cable Length 1 8 m Technical Specifications Drawings and Schematics A SIDE B SIDE USB Type A Plug male connector Hirose DF11 6DS 2C female connector Pin Description Pin Type Name Description 1 I RXD Asynchronous Data Receive line 2 O RTS Request To Send flow ...

Page 69: ...PC and leave the other end unconnected 2 If you have a recent OS version please allow the system to search for updated drivers a If the setup was successful unplug the cable the procedure is complete b If the setup failed unplug the cable and continue to the next step 3 Download the latest official drivers for your OS version from the FTDI VCP Drivers page 4 Run the driver setup package or follow ...

Page 70: ...bsite at http www veear eu support The more detail you provide the better support we can give VeeaR RoboTech srl all rights reserved All VeeaR branded boards and software are manufactured by RoboTech srl RoboTech srl assumes no responsibility for any errors which may appear in this manual Furthermore RoboTech srl reserves the right to alter the hardware software and or specifications detailed here...

Search results

Summary of Contents for EasyVR 3

Reviews:

VeeaR EasyVR 3, User Manual, Page: 47 / 70

Search results

Summary of Contents for EasyVR 3

Reviews: