pedometer3  2.0.0.0
Main Page

Pedometer 3 click

Pedometer 3 click is a three-axis acceleration sensing Click board which utilizes the KX126-1063. An advanced tri-axis acceleration sensor, KX126-1063 includes the pedometer algorithm support.

click Product page


Click library

  • Author : Katarina Perendic
  • Date : okt 2019.
  • Type : I2C/SPI type

Software Support

We provide a library for the Pedometer3 Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Pedometer3 Click driver.

Standard key functions :

  • Config Object Initialization function.

    void pedometer3_cfg_setup ( pedometer3_cfg_t *cfg );

  • Initialization function.

    PEDOMETER3_RETVAL pedometer3_init ( pedometer3_t *ctx, pedometer3_cfg_t *cfg );

  • Click Default Configuration function.

    void pedometer3_default_cfg ( pedometer3_t *ctx );

Example key functions :

  • High Pass Accel axis data

    void pedometer3_get_highpass_accel_axis ( pedometer3_t *ctx, pedometer3_axis_t *axis );

  • Accel axis data

    void pedometer3_get_accel_axis ( pedometer3_t *ctx, pedometer3_axis_t *axis );

  • Pedometer step counter

    uint16_t pedometer3_get_step_counter ( pedometer3_t *ctx );

  • Tilt current and previous position

    void pedometer3_get_tilt_position ( pedometer3_t *ctx, pedometer3_tilt_position_t *tilt );

Examples Description

The demo application displays measuring 2 accelerometers (normal accel and high pass accel), counting steps and displaying tilt positions. The sensor includes additional feature and setups that you can look up in the library.

The demo application is composed of two sections :

Application Init

Configuring clicks and log objects. Settings the click in the default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
PEDOMETER3_MAP_MIKROBUS( cfg, MIKROBUS_1 );
pedometer3_init( &pedometer3, &cfg );
// Default click configurations
pedometer3_default_cfg( &pedometer3 );
}

Application Task

Reads Accel and High Pass Accel X/Y/Z axis and detect Tilt Position. All data logs on the USBUART every 500 ms.

void application_task ( void )
{
static uint16_t ped_step = 0;
pedometer3_axis_t accel_axis;
pedometer3_axis_t highpass_axis;
// Task implementation.
pedometer3_get_accel_axis( &pedometer3, &accel_axis );
pedometer3_get_highpass_accel_axis( &pedometer3, &highpass_axis );
ped_step += pedometer3_get_step_counter( &pedometer3 );
log_printf( &logger, "___________ Pedometer 3 click _____________\r\n");
log_printf( &logger, "-- Accel : [ X ]: %d / [ Y ]: %d / [ Z ]: %d \r\n", accel_axis.x, accel_axis.y, accel_axis.z);
log_printf( &logger, "-- HP Accel : [ X ]: %d / [ Y ]: %d / [ Z ]: %d \r\n", highpass_axis.x, highpass_axis.y, highpass_axis.z);
log_printf( &logger, "-- Step counter : [ STEP ]: %d \r\n", ped_step);
pedometer3_get_tilt_position( &pedometer3, &tilt);
switch ( tilt.current_pos )
{
{
log_printf( &logger, "-- Current Tilt Position: [ LEFT ] \r\n" );
break;
}
{
log_printf( &logger, "-- Current Tilt Position: [ RIGHT ] \r\n" );
break;
}
{
log_printf( &logger, "-- Current Tilt Position: [ DOWN ] \r\n" );
break;
}
{
log_printf( &logger, "-- Current Tilt Position: [ UP ] \r\n" );
break;
}
{
log_printf( &logger, "-- Current Tilt Position: [ FACE DOWN ] \r\n" );
break;
}
{
log_printf( &logger, "-- Current Tilt Position: [ FACE UP ] \r\n" );
break;
}
}
Delay_ms( 400 );
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Pedometer3

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


PEDOMETER3_TILT_POSITION_UP
#define PEDOMETER3_TILT_POSITION_UP
Definition: pedometer3.h:586
pedometer3_axis_t
Axis structure.
Definition: pedometer3.h:686
PEDOMETER3_TILT_POSITION_RIGHT
#define PEDOMETER3_TILT_POSITION_RIGHT
Definition: pedometer3.h:584
PEDOMETER3_CNTL1_TAP_ENABLE
#define PEDOMETER3_CNTL1_TAP_ENABLE
Definition: pedometer3.h:246
pedometer3_tilt_position_t
Tilt position structure.
Definition: pedometer3.h:697
PEDOMETER3_CNTL1_RES_MODE_LOWER_NOISE
#define PEDOMETER3_CNTL1_RES_MODE_LOWER_NOISE
Definition: pedometer3.h:239
PEDOMETER3_MAP_MIKROBUS
#define PEDOMETER3_MAP_MIKROBUS(cfg, mikrobus)
Definition: pedometer3.h:52
application_task
void application_task(void)
Definition: main.c:78
pedometer3_get_highpass_accel_axis
void pedometer3_get_highpass_accel_axis(pedometer3_t *ctx, pedometer3_axis_t *axis)
Functions for read High Pass Accel axis data.
pedometer3_cfg_t
Click configuration structure definition.
Definition: pedometer3.h:653
pedometer3_tilt_position_t::current_pos
uint8_t current_pos
Definition: pedometer3.h:699
pedometer3_axis_t::y
int16_t y
Definition: pedometer3.h:689
PEDOMETER3_CNTL1_MODE_LOW_POWER
#define PEDOMETER3_CNTL1_MODE_LOW_POWER
Definition: pedometer3.h:237
PEDOMETER3_TILT_POSITION_LEFT
#define PEDOMETER3_TILT_POSITION_LEFT
Definition: pedometer3.h:583
PEDOMETER3_TILT_POSITION_DOWN
#define PEDOMETER3_TILT_POSITION_DOWN
Definition: pedometer3.h:585
PEDOMETER3_TILT_POSITION_FACE_DOWN
#define PEDOMETER3_TILT_POSITION_FACE_DOWN
Definition: pedometer3.h:587
PEDOMETER3_CNTL1_TILT_ENABLE
#define PEDOMETER3_CNTL1_TILT_ENABLE
Definition: pedometer3.h:250
PEDOMETER3_CNTL1_DATA_READY_DISABLE
#define PEDOMETER3_CNTL1_DATA_READY_DISABLE
Definition: pedometer3.h:240
PEDOMETER3_CNTL1_G_RANGE_2g
#define PEDOMETER3_CNTL1_G_RANGE_2g
Definition: pedometer3.h:242
pedometer3_get_tilt_position
void pedometer3_get_tilt_position(pedometer3_t *ctx, pedometer3_tilt_position_t *tilt)
Functions for get Tilt current and previous position.
PEDOMETER3_REG_CONTROL_1
#define PEDOMETER3_REG_CONTROL_1
Definition: pedometer3.h:112
pedometer3_default_cfg
void pedometer3_default_cfg(pedometer3_t *ctx)
Click Default Configuration function.
PEDOMETER3_CNTL1_PEDOMETER_ENABLE
#define PEDOMETER3_CNTL1_PEDOMETER_ENABLE
Definition: pedometer3.h:248
application_init
void application_init(void)
Definition: main.c:41
pedometer3_get_accel_axis
void pedometer3_get_accel_axis(pedometer3_t *ctx, pedometer3_axis_t *axis)
Functions for read Accel axis data.
pedometer3_generic_write
void pedometer3_generic_write(pedometer3_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
pedometer3_axis_t::z
int16_t z
Definition: pedometer3.h:690
pedometer3_get_step_counter
uint16_t pedometer3_get_step_counter(pedometer3_t *ctx)
Functions for get pedometer step counter.
PEDOMETER3_TILT_POSITION_FACE_UP
#define PEDOMETER3_TILT_POSITION_FACE_UP
Definition: pedometer3.h:588
pedometer3_axis_t::x
int16_t x
Definition: pedometer3.h:688
pedometer3_init
PEDOMETER3_RETVAL pedometer3_init(pedometer3_t *ctx, pedometer3_cfg_t *cfg)
Initialization function.
pedometer3_cfg_setup
void pedometer3_cfg_setup(pedometer3_cfg_t *cfg)
Config Object Initialization function.