| invn.algo.orientation-bundle.asf - InvnAlgoASFLib documentation 1.1.1 Documentation on Algo ASF Library.

- Main Page
- Modules
- Data Structures

Data Structures | Functions
InvnAlgoSample

Pedometer algorithm that estimates user's step count. More...

## Data Structures
struct | InvnAlgoPedometerInput
| InvnAlgoSample input structure (raw data) More...
struct | InvnAlgoPedometerOutput
| InvnAlgoSample output structure. More...
struct | InvnAlgoPedometerConfig
| InvnAlgoSample configuration structure (algo and data related settings) More...

## Functions
int8_t | invn_algo_sample_init (const InvnAlgoSampleConfig *config)
| Initializes algorithms with config parameters and reset algorithm states. More...
int8_t | invn_algo_sample_process (const InvnAlgoSampleInput *input, InvnAlgoSampleOutput *output)
| Performs algorithm computation. More...

## Detailed Description

Pedometer algorithm that estimates user's step count.

Algorithm input is raw Accelerometer data

Warning
  - Supported input acceleration data frequency [25Hz, 50Hz, 100Hz]. The input data frequency should be defined in InvnAlgoPedometerConfig::acc_odr
  - Supported accelerometer FSR [2g, 4g, 8g, 16 g]. The accelerometer FSR should be defined in InvnAlgoPedometerConfig::acc_fsr
  - Supported algorithm frequecny [25Hz, 50Hz]. The desired algorithm frequency should be set in InvnAlgoPedometerConfig::ped_odr

## Function Documentation

int8_t invn_algo_sample_init | ( | const InvnAlgoSampleConfig * | config | ) |

Initializes algorithms with config parameters and reset algorithm states.

[in] algo init parameters structure.

Returns
  initialization success indicator.

Return values

  0 | Success
  1 | Fail

int8_t invn_algo_sample_process | ( | const InvnAlgoSampleInput * | input,
|  | InvnAlgoSampleOutput * | output
| ) |  |

Performs algorithm computation.

Parameters

  [in] | input | algorithm input structure
  [out] | output | algorithm output structure