TactigonDoc  1.3 - 2018-28-12
Documentation of Tactigon libraries exposed in Arduino IDE
Public Types | Public Member Functions | Public Attributes | List of all members
T_BGDM Class Reference

#include <tactigon_BGDM.h>

Public Types

enum  BGDM_gestures {
  ROLL_ROT, PITCH_ROT, YAW_ROT, GENMOV_X,
  GENMOV_Y, GENMOV_Z, GENROT_X, GENROT_Y,
  GENROT_Z, ALL, HALT
}
 

Public Member Functions

 T_BGDM (void)
 
void enable (BGDM_gestures gestureToEnable)
 
void engineRun (void)
 
int configGest (BGDM_gestures gestureID, Gesture_params *pPar)
 
int installEventCB (BGDM_gestures gestureID, BGDM_evt_cb pCBFuncPointer)
 

Public Attributes

BGDM_evt_cb haltCB
 

Detailed Description

Virtual Gesture Class

Base Gesture Detection Module class

Member Enumeration Documentation

◆ BGDM_gestures

Available gestures

Enumerator
ROLL_ROT 

Roll rotation gesture

PITCH_ROT 

Pitch rotation gesture

YAW_ROT 

Yaw rotation gesture

GENMOV_X 

Acc x movement

GENMOV_Y 

Acc y movement

GENMOV_Z 

Acc z movement

GENROT_X 

Gyro x movement

GENROT_Y 

Gyro y movement

GENROT_Z 

Gyro z movement

Constructor & Destructor Documentation

◆ T_BGDM()

T_BGDM::T_BGDM ( void  )

class constructor: all general class initialization will be done here

Member Function Documentation

◆ configGest()

int T_BGDM::configGest ( BGDM_gestures  gestureID,
Gesture_params *  pPar 
)

configure Gesture params

◆ enable()

void T_BGDM::enable ( BGDM_gestures  gestureToEnable)

enable the detection of selected gesture.

◆ engineRun()

void T_BGDM::engineRun ( void  )

engine of gesture detection: user must call this method in Arduino loop() function

◆ installEventCB()

int T_BGDM::installEventCB ( BGDM_gestures  gestureID,
BGDM_evt_cb  pCBFuncPointer 
)

install a callback event for selected gesture callback Must be of type: void calBackName(uint8_t *pointer_to_data, uint8_t byte_data_size)


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