Skip to content

Latest commit

 

History

History
155 lines (102 loc) · 4.62 KB

DETAILS.md

File metadata and controls

155 lines (102 loc) · 4.62 KB
Raw

Accel 7 Click

The Accel 7 Click is a tri-axis acceleration sensing Click board™ powered by the KXTJ3-1057 14-bit tri-axis digital accelerometer from Kionix. This sensor was developed using proprietary Kionix micromachining technology, resulting in high accuracy and excellent noise immunity.

Click Product page

Click library

  • Author : MikroE Team
  • Date : Dec 2019.
  • Type : I2C type

Software Support

We provide a library for the Accel7 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 Accel7 Click driver.

Standard key functions :

  • Config Object Initialization function.

void accel7_cfg_setup ( accel7_cfg_t *cfg );

  • Initialization function.

ACCEL7_RETVAL accel7_init ( accel7_t *ctx, accel7_cfg_t *cfg );

  • Click Default Configuration function.

void accel7_default_cfg ( accel7_t *ctx, uint8_t resolution, uint8_t range );

Example key functions :

  • This function reads two bytes of data from the desired axis register.

int16_t accel7_get_axis ( accel7_t *ctx, uint8_t axis );

  • This function calculates the resolution and range values which are used in the default_cfg() function.

void accel7_res_range_cfg ( accel7_t *ctx, uint8_t *resolution, uint8_t *range );

  • This function reads the state of the interrupt pin.

uint8_t accel7_get_interrupt_state ( accel7_t *ctx );

Examples Description

This example shows how data from all three axes is collected, processed and later displayed in the logger module.

The demo application is composed of two sections :

Application Init

Initializes and configures the Click and logger modules.

void application_init (  )
{
    log_cfg_t log_cfg;
    accel7_cfg_t cfg;

    uint8_t resolution = ACCEL7_DATA_RESP_14bit;
    uint8_t range = ACCEL7_RANGE_8g;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----\r\n" );

    //  Click initialization.

    accel7_cfg_setup( &cfg );
    ACCEL7_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    accel7_init( &accel7, &cfg );

    accel7_res_range_cfg( &accel7, &resolution, &range );
    accel7_default_cfg( &accel7, resolution, range );

    delay_ms( 100 );
}

Application Task

Reads and displays data from all three axes every second.

void application_task (  )
{
    int16_t x_axis;
    int16_t y_axis;
    int16_t z_axis;

    x_axis = accel7_get_axis( &accel7, ACCEL7_AXIS_X );
    y_axis = accel7_get_axis( &accel7, ACCEL7_AXIS_Y );
    z_axis = accel7_get_axis( &accel7, ACCEL7_AXIS_Z );

    log_printf( &logger, "X axis: %d\r\n", x_axis );
    log_printf( &logger, "Y axis: %d\r\n", y_axis );
    log_printf( &logger, "Z axis: %d\r\n", z_axis );   
    
    log_printf( &logger, "------------------\r\n" );

    delay_ms( 1000 );
}

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.Accel7

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.