step_counter_command.h

Go to the documentation of this file.

/****************************************************************************
 * modules/include/sensing/logical_sensor/step_counter_command.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_STEP_COUNTER_COMMAND_H
#define __INCLUDE_SENSING_STEP_COUNTER_COMMAND_H
 
/****************************************************************************
 * Included Files
 ****************************************************************************/
 
#include <stdint.h>
#include <stddef.h>
 
#include "sensing/logical_sensor/sensor_command.h"
#include "sensing/logical_sensor/physical_command.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/****************************************************************************
 * Pre-processor Definitions
 ****************************************************************************/
 
#define STEP_COUNTER_SAMPLING_MAX         (32)
 
/****************************************************************************
 * Public Types
 ****************************************************************************/
 
typedef enum
{
  STEP_COUNTER_MODE_FIXED_LENGTH = 0, 
  STEP_COUNTER_MODE_NEW_TABLE,        
  STEP_COUNTER_MODE_STEP_TABLE        
} StepCounterStepMode;
 
/*--------------------------------------------------------------------------*/
struct step_counter_param_s
{
  int32_t              step_length; 
  StepCounterStepMode  step_mode;   
};
 
typedef struct step_counter_param_s StepCounterSetParam;
 
/*--------------------------------------------------------------------------*/
struct step_counter_setting_s
{
  StepCounterSetParam  walking;      
  StepCounterSetParam  running;      
};
 
typedef struct step_counter_setting_s StepCounterSetting;
 
/*--------------------------------------------------------------------------*/
typedef enum
{
  STEP_COUNTER_MOVEMENT_TYPE_OTHER = 0, 
  STEP_COUNTER_MOVEMENT_TYPE_STILL,     
  STEP_COUNTER_MOVEMENT_TYPE_WALK,      
  STEP_COUNTER_MOVEMENT_TYPE_RUN,       
} StepCounterMovementType;
 
/*--------------------------------------------------------------------------*/
typedef enum
{
  STEP_COUNTER_CMD_UPDATE_ACCELERATION = 0 , 
  STEP_COUNTER_CMD_UPDATE_GPS ,              
  STEP_COUNTER_CMD_STEP_SET                  
} StepCounterCmdType;
 
/*--------------------------------------------------------------------------*/
struct StepCounterDebugDumpInfo
{
  void    *addr;  
  size_t  size;   
};
 
/*--------------------------------------------------------------------------*/
typedef struct
{
  StepCounterSetting        setting; 
  StepCounterDebugDumpInfo  debug_dump_info; 
} SensorInitStepCounter;
 
/*--------------------------------------------------------------------------*/
typedef struct
{
  StepCounterCmdType cmd_type; 
  union
    {
      ThreeAxisSampleData update_acc;  
      GnssSampleData      update_gps;  
      StepCounterSetting  setting;     
    };
} SensorExecStepCounter;
 
/*--------------------------------------------------------------------------*/
typedef struct
{
 
} SensorFlushStepCounter;
 
/*--------------------------------------------------------------------------*/
typedef struct {
 
  float    tempo;     
  float    stride;    
  float    speed;     
  float    distance;  
  uint32_t step;      
  StepCounterMovementType  movement_type; 
  uint64_t          time_stamp;    
} StepCounterStepInfo;
 
/*--------------------------------------------------------------------------*/
typedef struct
{
  SensorExecResult exec_result; 
  union
    {
      StepCounterStepInfo steps;        
      SensorAssertionInfo assert_info;  
    };
} SensorResultStepCounter;
 
/*--------------------------------------------------------------------------*/
typedef struct
{
  SensorCmdHeader header;  
  union
    {
      SensorInitStepCounter  init_cmd;  
      SensorExecStepCounter  exec_cmd;  
      SensorFlushStepCounter flush_cmd; 
    };
 
  SensorResultStepCounter result; 
} SensorCmdStepCounter;
 
#ifdef __cplusplus
};
#endif
 
#endif /*  __INCLUDE_SENSING_STEP_COUNTER_COMMAND_H */