tap.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/sensing/tap.h
 *
 *   Copyright 2018 Sony Semiconductor Solutions Corporation
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name of Sony Semiconductor Solutions Corporation nor
 *    the names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/
#ifndef __INCLUDE_SENSING_TAP_H
#define __INCLUDE_SENSING_TAP_H
 
/* --------------------------------------------------------------------------
  Included Files
   -------------------------------------------------------------------------- */
 
#include <sys/time.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* --------------------------------------------------------------------------
  Pre-Processor Definitions
   -------------------------------------------------------------------------- */
#define TAP_BUF_LEN                   16
 
#define D_SA_STATUS_OK                0
 
#define D_SA_STATUS_E_INVALID_ARGS    -1
 
#define D_SA_STATUS_E_UNEXPECTED      -8
 
#define SEC_PER_US                    1000000
 
#define NS_PER_US                     1000
 
/* --------------------------------------------------------------------------
  Enumerations
   -------------------------------------------------------------------------- */
typedef enum {
  E_TAP_STATE_IDLE = 0,     
  E_TAP_STATE_TAP           
} E_TAP_STATE;
 
/* --------------------------------------------------------------------------
  Command Structures
   -------------------------------------------------------------------------- */
 
typedef struct
{
  float tap_period;  
  float peak_thres;  
  float long_thres;  
  int stab_frame;    
} ST_TAP_OPEN;
 
typedef struct
{
  float accel_x;    
  float accel_y;    
  float accel_z;    
} ST_TAP_ACCEL;
 
/*--------------------------------------------------------------------
    Tap Class
  --------------------------------------------------------------------*/
class TapClass {
 
public:
 
  /* public methods */
 
  int open(ST_TAP_OPEN*);
  int close(void);
  int write(ST_TAP_ACCEL*);
  int write(ST_TAP_ACCEL*, uint64_t);
 
  TapClass();
  ~TapClass(){};
 
private:
 
  /* private members */
 
  uint64_t    mTapPeriod;  
  float       mPeakThres;  /* (G) The minimum value of vibration tapping
                       *   shall be deemed. range 0.0 - 4.0
                       */
  float       mLongThres;  /* (G) The maximum vibration indicates that 
                       *   vibration of the tap. range 0.0 - 4.0
                       */
  int         mStabFrame;  /* (64Hz frame num) time of PEAK_THRES -> LONG_THRES. 
                       *   range 0 - 32
                       */
 
  int          mTapCnt;          
  E_TAP_STATE  mState;           
  float        mR[TAP_BUF_LEN];  
  float        mX[TAP_BUF_LEN];  
  float        mY[TAP_BUF_LEN];  
  float        mZ[TAP_BUF_LEN];  
  int          mIndex;           
  int          mDetectionCount;  
  int          mStab;            /* When it becomes larger than mStabFrame,
                                    * tap detection 
                                  */
 
  uint64_t     mStartTime;        
  /* private methods */
  float calcR(int i0, int j0);
  bool detect(float x, float y, float z);
  float getIndex(int idx);
 
};
 
/*--------------------------------------------------------------------
    External Interface
  --------------------------------------------------------------------*/
 
TapClass* TapCreate(void);
 
int TapOpen(FAR TapClass *ins, FAR ST_TAP_OPEN *OpenParam);
 
int TapClose(FAR TapClass *ins);
 
int TapWrite(FAR TapClass *ins, FAR ST_TAP_ACCEL *accelData);
 
int TapWrite_timestamp(FAR TapClass *ins, FAR ST_TAP_ACCEL *accelData, 
                       uint64_t time_stamp);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __INCLUDE_SENSING_TAP_H */