Windows Virtual Shields for Arduino
Public Member Functions | Public Attributes | List of all members
Recognition Class Reference

#include <Recognition.h>

Inherits Sensor.

Public Member Functions

 Recognition (const VirtualShield &shield)
 Initializes a new instance of the Speech class. More...
 
int listen (char *openTextBuffer, int *length, bool useUI=true, long timeout=0)
 Recognizes open text / not constricted without a UI. More...
 
int listenFor (String constraint, bool useUI=true, int expectedConfidence=Confidence_Medium, long timeout=0)
 Recognizes the specified constricted recognition text without a UI. More...
 
int listenFor (const char *constraint, bool useUI=true, int expectedConfidence=Confidence_Medium, long timeout=0)
 Recognizes the specified constricted recognition text without a UI. More...
 
int listenFor (EPtr constraint, bool useUI=true, int expectedConfidence=Confidence_Medium, long timeout=0)
 Recognizes the specified constricted recognition text without a UI. More...
 
int stop () override
 Stops this sensor. More...
 
bool heard (String text)
 Verifies if the recognized spoken text matches the text parameter. More...
 
bool heard (int spokenNumber)
 Verifies if the recognized spoken number matches the number parameter. More...
 
void onJsonReceived (JsonObject &root, ShieldEvent *shieldEvent) override
 Event called when a valid json message was received. Consumes the proper values for this sensor. More...
 
- Public Member Functions inherited from Sensor
 Sensor (const VirtualShield &shield, const char sensorType)
 Initializes a new instance of the Sensor class. More...
 
int start (double delta=0, long interval=0)
 Starts the sensor, triggered when longer than the interval and larger than the delta. More...
 
int get ()
 Gets a single, current sensor reading. More...
 
int getOnChange (double delta=0)
 Requests a single reading when more than the delta beyond the current reading. More...
 
bool isUpdated ()
 Determines whether this sensor has an updated value. Resets to false after this call. More...
 
int writeAll (const char *serviceName, EPtr values[], int count, Attr extraAttributes[]=0, int extraAttributeCount=0)
 Writes all EPtr values to the communication channel. More...
 
int sensorAction (SensorAction sensorAction, double delta=0, long interval=0) const
 Sends the specific action to start/stop/get/onChange the sensor using a delta and interval. More...
 
virtual bool isEvent (const char *tag, const char *action, ShieldEvent *shieldEvent)
 Determines whether the specified shieldEvent matches the tag and action. More...
 
virtual bool isEvent (int id, const char *action, ShieldEvent *shieldEvent)
 Determines whether the specified shieldEvent matches the id and action. More...
 
void setOnEvent (void(*onEvent)(ShieldEvent *shieldEvent))
 
int sendStop (const char *serviceName)
 

Public Attributes

int recognizedIndex = 0
 
int confidence
 
- Public Attributes inherited from Sensor
void(* onEvent )(ShieldEvent *shieldEvent)
 
VirtualShieldshield
 
ShieldEvent recentEvent
 
const char sensorType
 
bool isRunning = false
 

Additional Inherited Members

- Protected Attributes inherited from Sensor
bool _isUpdated = false
 

Constructor & Destructor Documentation

Recognition::Recognition ( const VirtualShield shield)

Initializes a new instance of the Speech class.

Parameters
shieldThe shield.

Member Function Documentation

bool Recognition::heard ( String  text)

Verifies if the recognized spoken text matches the text parameter.

Parameters
textThe text to verify.
Returns
true if the text matches.
bool Recognition::heard ( int  spokenNumber)

Verifies if the recognized spoken number matches the number parameter.

Parameters
textThe text to verify.
Returns
true if the text matches.
int Recognition::listen ( char *  openTextBuffer,
int *  length,
bool  useUI = true,
long  timeout = 0 
)

Recognizes open text / not constricted without a UI.

Returns
The id of the message. Negative if an error.
int Recognition::listenFor ( String  recognitionText,
bool  useUI = true,
int  expectedConfidence = Confidence_Medium,
long  timeout = 0 
)

Recognizes the specified constricted recognition text without a UI.

Parameters
recognitionTextThe recognition text (words or groups).
Returns
The id of the message. Negative if an error.
int Recognition::listenFor ( const char *  recognitionText,
bool  useUI = true,
int  expectedConfidence = Confidence_Medium,
long  timeout = 0 
)

Recognizes the specified constricted recognition text without a UI.

Parameters
recognitionTextThe recognition text (words or groups).
Returns
The id of the message. Negative if an error.
int Recognition::listenFor ( EPtr  constraint,
bool  useUI = true,
int  expectedConfidence = Confidence_Medium,
long  timeout = 0 
)

Recognizes the specified constricted recognition text without a UI.

Parameters
recognitionTextThe recognition text (words or groups).
Returns
The id of the message. Negative if an error.
void Recognition::onJsonReceived ( JsonObject &  root,
ShieldEvent shieldEvent 
)
overridevirtual

Event called when a valid json message was received. Consumes the proper values for this sensor.

Parameters
rootThe root json object.
shieldEventThe shield event.

Reimplemented from Sensor.

int Recognition::stop ( )
overridevirtual

Stops this sensor.

Reimplemented from Sensor.

Member Data Documentation

int Recognition::confidence
int Recognition::recognizedIndex = 0

The documentation for this class was generated from the following files: