c6dofimu23  2.1.0.0
Modules | Functions
6DOF IMU 23 Click Driver

API for configuring and manipulating 6DOF IMU 23 Click driver. More...

Modules

 6DOF IMU 23 Registers List
 List of registers of 6DOF IMU 23 Click driver.
 
 6DOF IMU 23 Registers Settings
 Settings for registers of 6DOF IMU 23 Click driver.
 
 6DOF IMU 23 MikroBUS Map
 MikroBUS pin mapping of 6DOF IMU 23 Click driver.
 

Functions

void c6dofimu23_cfg_setup (c6dofimu23_cfg_t *cfg)
 6DOF IMU 23 configuration object setup function. More...
 
err_t c6dofimu23_init (c6dofimu23_t *ctx, c6dofimu23_cfg_t *cfg)
 6DOF IMU 23 initialization function. More...
 
void c6dofimu23_device_enable (c6dofimu23_t *ctx)
 6DOF IMU 23 device enable function. More...
 
uint8_t c6dofimu23_get_odr (c6dofimu23_t *ctx)
 6DOF IMU 23 device enable function. More...
 
err_t c6dofimu23_generic_write (c6dofimu23_t *ctx, uint8_t offset, uint8_t *data_in, uint8_t len)
 6DOF IMU 23 data writing function. More...
 
err_t c6dofimu23_generic_read (c6dofimu23_t *ctx, uint8_t offset, uint8_t *data_out, uint8_t len)
 6DOF IMU 23 data reading function. More...
 
err_t c6dofimu23_write_prtcl (c6dofimu23_t *ctx, uint8_t *data_in)
 6DOF IMU 23 data writing protocol function. More...
 
err_t c6dofimu23_read_prtcl (c6dofimu23_t *ctx, uint8_t *data_in, uint16_t *data_out)
 6DOF IMU 23 data reading protocol function. More...
 
err_t c6dofimu23_cmd_write (c6dofimu23_t *ctx, uint32_t cmd)
 6DOF IMU 23 command writing function. More...
 
err_t c6dofimu23_cmd_read (c6dofimu23_t *ctx, uint32_t cmd, uint16_t *data_out)
 6DOF IMU 23 command reading function. More...
 
err_t c6dofimu23_get_accel_data (c6dofimu23_t *ctx, c6dofimu23_axis_t *acc_axis)
 6DOF IMU 23 get the accel sensor axes function. More...
 
err_t c6dofimu23_get_gyro_data (c6dofimu23_t *ctx, c6dofimu23_axis_t *gyro_axis)
 6DOF IMU 23 get the gyro sensor axes function. More...
 

Detailed Description

API for configuring and manipulating 6DOF IMU 23 Click driver.

Function Documentation

◆ c6dofimu23_cfg_setup()

void c6dofimu23_cfg_setup ( c6dofimu23_cfg_t cfg)

6DOF IMU 23 configuration object setup function.

This function initializes click configuration structure to initial values.

Parameters
[out]cfg: Click configuration structure. See c6dofimu23_cfg_t object definition for detailed explanation.
Returns
Nothing.
Note
The all used pins will be set to unconnected state.

◆ c6dofimu23_cmd_read()

err_t c6dofimu23_cmd_read ( c6dofimu23_t ctx,
uint32_t  cmd,
uint16_t *  data_out 
)

6DOF IMU 23 command reading function.

This function reads a desired 16-bit data by using desired command of the IIM-20670, SmartIndustrial? 6-axis MotionTracking® MEMS on the 6DOF IMU 23 click board.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
[in]cmd: 32-bit command data (offset, data and CRC).
[out]data_out: Output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu23_cmd_write()

err_t c6dofimu23_cmd_write ( c6dofimu23_t ctx,
uint32_t  cmd 
)

6DOF IMU 23 command writing function.

This function writes a 16-bit data bytes by using desired command of the IIM-20670, SmartIndustrial? 6-axis MotionTracking® MEMS on the 6DOF IMU 23 click board.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
[in]cmd: 32-bit command data (offset, data and CRC).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu23_device_enable()

void c6dofimu23_device_enable ( c6dofimu23_t ctx)

6DOF IMU 23 device enable function.

This function enabled the device by using SPI serial interface.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
Returns
Nothing.
Note
None.

◆ c6dofimu23_generic_read()

err_t c6dofimu23_generic_read ( c6dofimu23_t ctx,
uint8_t  offset,
uint8_t *  data_out,
uint8_t  len 
)

6DOF IMU 23 data reading function.

This function reads a desired data bytes starting from the currently selected offset by using SPI serial interface.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
[in]offset: Offset with respect to the bank that is currently selected.
[out]data_out: Output read data (data and CRC).
[in]len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu23_generic_write()

err_t c6dofimu23_generic_write ( c6dofimu23_t ctx,
uint8_t  offset,
uint8_t *  data_in,
uint8_t  len 
)

6DOF IMU 23 data writing function.

This function writes a desired data bytes starting to the currently selected offset by using SPI serial interface.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
[in]offset: Offset with respect to the bank that is currently selected.
[in]data_in: Data to be written (data and CRC).
[in]len: Number of bytes to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu23_get_accel_data()

err_t c6dofimu23_get_accel_data ( c6dofimu23_t ctx,
c6dofimu23_axis_t acc_axis 
)

6DOF IMU 23 get the accel sensor axes function.

This function reads the accelerometer sensor axes measurement data of the IIM-20670, SmartIndustrial? 6-axis MotionTracking® MEMS on the 6DOF IMU 23 click board.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
[out]acc_axis: Linear acceleration output data object (mg).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu23_get_gyro_data()

err_t c6dofimu23_get_gyro_data ( c6dofimu23_t ctx,
c6dofimu23_axis_t gyro_axis 
)

6DOF IMU 23 get the gyro sensor axes function.

This function reads the gyroscope sensor axes measurement data of the IIM-20670, SmartIndustrial? 6-axis MotionTracking® MEMS on the 6DOF IMU 23 click board.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
[out]gyro_axis: Angular rate output data object (dps).
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu23_get_odr()

uint8_t c6dofimu23_get_odr ( c6dofimu23_t ctx)

6DOF IMU 23 device enable function.

This function gets states of the output data-ready ( ODR-INT ) pin of the IIM-20670, SmartIndustrial? 6-axis MotionTracking® MEMS on the 6DOF IMU 23 click board.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
Returns
  • 0 - Low pin state,
  • 1 - High pin state.
Note
None.

◆ c6dofimu23_init()

err_t c6dofimu23_init ( c6dofimu23_t ctx,
c6dofimu23_cfg_t cfg 
)

6DOF IMU 23 initialization function.

This function initializes all necessary pins and peripherals used for this click board.

Parameters
[out]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
[in]cfg: Click configuration structure. See c6dofimu23_cfg_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu23_read_prtcl()

err_t c6dofimu23_read_prtcl ( c6dofimu23_t ctx,
uint8_t *  data_in,
uint16_t *  data_out 
)

6DOF IMU 23 data reading protocol function.

This function reads a desired 16-bit data by using 32-bit communication protocol of the IIM-20670, SmartIndustrial? 6-axis MotionTracking® MEMS on the 6DOF IMU 23 click board.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
[in]data_in: 32-bit communication protocol data.
[out]data_out: Output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu23_write_prtcl()

err_t c6dofimu23_write_prtcl ( c6dofimu23_t ctx,
uint8_t *  data_in 
)

6DOF IMU 23 data writing protocol function.

This function writes a desired data bytes by using 32-bit communication protocol of the IIM-20670, SmartIndustrial? 6-axis MotionTracking® MEMS on the 6DOF IMU 23 click board.

Parameters
[in]ctx: Click context object. See c6dofimu23_t object definition for detailed explanation.
[in]data_in: 32-bit communication protocol data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.