User Manual

www.veear.eu
User Manual (1.0.14) EasyVR 3 45
EasyVR Arduino Library
The EasyVR library implements the serial communication protocol to manage the EasyVR module and the
EasyVR Shield from Arduino boards and controllers and it enables easy access to all the EasyVR features.
Installation
To install the EasyVR library on your Arduino IDE use the menu Sketch > Import Library ... > Add Library
and open the released zip archive.
Examples
You can easily open the example sketches included with the EasyVR library from inside the Arduino IDE,
using the menu File > Examples > EasyVR and choosing one of the available sketches.
EasyVR library settings
Macros
 #define EASYVR_RX_TIMEOUT
 #define EASYVR_STORAGE_TIMEOUT
 #define EASYVR_WAKE_TIMEOUT
 #define EASYVR_PLAY_TIMEOUT
 #define EASYVR_TOKEN_TIMEOUT
Detailed Description
By defining these symbols before the library include directive, you can alter 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 maximum time that is spent waiting for a reply after
a command that involves write access to the EasyVR internal storage.
#define EASYVR_WAKE_TIMEOUT
Wakeup maximum delay (in ms). The maximum time that the EasyVR module can spend for waking up
from idle states.
#define EASYVR_PLAY_TIMEOUT
Playback maximum duration (in ms). The maximum time that is spent waiting for a synchronous
playback operation to complete. Asynchronous playback is not affected.
#define EASYVR_TOKEN_TIMEOUT
Token maximum duration (in ms). The maximum time that is spent by the EasyVR module for sending
a SonicNet token and reply.