6dofimu24 2.2.1
Loading...
Searching...
No Matches
6DOF IMU 24 Click Driver

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

Topics

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

Functions

void c6dofimu24_cfg_setup (c6dofimu24_cfg_t *cfg)
 6DOF IMU 24 configuration object setup function.
void c6dofimu24_drv_interface_sel (c6dofimu24_cfg_t *cfg, c6dofimu24_drv_t drv_sel)
 6DOF IMU 24 driver interface setup function.
err_t c6dofimu24_init (c6dofimu24_t *ctx, c6dofimu24_cfg_t *cfg)
 6DOF IMU 24 initialization function.
err_t c6dofimu24_default_cfg (c6dofimu24_t *ctx)
 6DOF IMU 24 default configuration function.
err_t c6dofimu24_write_regs (c6dofimu24_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
 6DOF IMU 24 write registers function.
err_t c6dofimu24_read_regs (c6dofimu24_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
 6DOF IMU 24 read registers function.
err_t c6dofimu24_write_reg (c6dofimu24_t *ctx, uint8_t reg, uint8_t data_in)
 6DOF IMU 24 write register function.
err_t c6dofimu24_read_reg (c6dofimu24_t *ctx, uint8_t reg, uint8_t *data_out)
 6DOF IMU 24 read register function.
err_t c6dofimu24_select_reg_bank (c6dofimu24_t *ctx, uint8_t bank_num)
 6DOF IMU 24 select reg bank function.
uint8_t c6dofimu24_get_int1_pin (c6dofimu24_t *ctx)
 6DOF IMU 24 get int1 pin function.
uint8_t c6dofimu24_get_int2_pin (c6dofimu24_t *ctx)
 6DOF IMU 24 get int2 pin function.
err_t c6dofimu24_reset_device (c6dofimu24_t *ctx)
 6DOF IMU 24 reset device function.
err_t c6dofimu24_check_communication (c6dofimu24_t *ctx)
 6DOF IMU 24 check communication function.
err_t c6dofimu24_clear_data_ready (c6dofimu24_t *ctx)
 6DOF IMU 24 clear data ready function.
err_t c6dofimu24_set_gyro_fs_odr (c6dofimu24_t *ctx, uint8_t fs_sel, uint8_t odr)
 6DOF IMU 24 set gyro fs odr function.
err_t c6dofimu24_set_accel_fs_odr (c6dofimu24_t *ctx, uint8_t fs_sel, uint8_t odr)
 6DOF IMU 24 set accel fs odr function.
err_t c6dofimu24_read_gyro (c6dofimu24_t *ctx, c6dofimu24_axes_t *gyro)
 6DOF IMU 24 read gyro function.
err_t c6dofimu24_read_accel (c6dofimu24_t *ctx, c6dofimu24_axes_t *accel)
 6DOF IMU 24 read accel function.
err_t c6dofimu24_read_temperature (c6dofimu24_t *ctx, float *temperature)
 6DOF IMU 24 read temperature function.
err_t c6dofimu24_read_data (c6dofimu24_t *ctx, c6dofimu24_data_t *data_out)
 6DOF IMU 24 read data function.

Detailed Description

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

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

◆ c6dofimu24_cfg_setup()

void c6dofimu24_cfg_setup ( c6dofimu24_cfg_t * cfg)

6DOF IMU 24 configuration object setup function.

This function initializes Click configuration structure to initial values.

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

◆ c6dofimu24_check_communication()

err_t c6dofimu24_check_communication ( c6dofimu24_t * ctx)

6DOF IMU 24 check communication function.

This function checks the communication by reading and verifying the device ID.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_clear_data_ready()

err_t c6dofimu24_clear_data_ready ( c6dofimu24_t * ctx)

6DOF IMU 24 clear data ready function.

This function clears the data ready interrupt by reading the INT_STATUS register.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_default_cfg()

err_t c6dofimu24_default_cfg ( c6dofimu24_t * ctx)

6DOF IMU 24 default configuration function.

This function executes a default configuration of 6DOF IMU 24 Click board.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
This function can consist any necessary configuration or setting to put device into operating mode.

◆ c6dofimu24_drv_interface_sel()

void c6dofimu24_drv_interface_sel ( c6dofimu24_cfg_t * cfg,
c6dofimu24_drv_t drv_sel )

6DOF IMU 24 driver interface setup function.

This function sets a serial driver interface which will be used further in the Click driver.

Parameters
[out]cfg: Click configuration structure. See c6dofimu24_cfg_t object definition for detailed explanation.
[in]drv_sel: Driver interface selection. See c6dofimu24_drv_t object definition for detailed explanation.
Returns
Nothing.
Note
This driver selection should be called before init function to configure the driver to work with the serial interface which is consistent with the real state of the hardware. If this function is not called, the default driver interface will be set.

◆ c6dofimu24_get_int1_pin()

uint8_t c6dofimu24_get_int1_pin ( c6dofimu24_t * ctx)

6DOF IMU 24 get int1 pin function.

This function returns the INT1 pin logic state.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ c6dofimu24_get_int2_pin()

uint8_t c6dofimu24_get_int2_pin ( c6dofimu24_t * ctx)

6DOF IMU 24 get int2 pin function.

This function returns the INT2 pin logic state.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
Returns
Pin logic state.
Note
None.

◆ c6dofimu24_init()

err_t c6dofimu24_init ( c6dofimu24_t * ctx,
c6dofimu24_cfg_t * cfg )

6DOF IMU 24 initialization function.

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

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

◆ c6dofimu24_read_accel()

err_t c6dofimu24_read_accel ( c6dofimu24_t * ctx,
c6dofimu24_axes_t * accel )

6DOF IMU 24 read accel function.

This function reads the accelerometer of X, Y, and Z axis relative to standard gravity (g).

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[out]accel: Output accelerometer data. See c6dofimu24_axes_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_read_data()

err_t c6dofimu24_read_data ( c6dofimu24_t * ctx,
c6dofimu24_data_t * data_out )

6DOF IMU 24 read data function.

This function reads the accelerometer, gyroscope, and temperature measurement data.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[out]data_out: Output data structure read. See c6dofimu24_data_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_read_gyro()

err_t c6dofimu24_read_gyro ( c6dofimu24_t * ctx,
c6dofimu24_axes_t * gyro )

6DOF IMU 24 read gyro function.

This function reads the angular rate of X, Y, and Z axis in degrees per second (dps).

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[out]gyro: Output gyro data. See c6dofimu24_axes_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_read_reg()

err_t c6dofimu24_read_reg ( c6dofimu24_t * ctx,
uint8_t reg,
uint8_t * data_out )

6DOF IMU 24 read register function.

This function reads data from the selected bank 0 register.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[in]reg: Register address.
[out]data_out: Output read data.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_read_regs()

err_t c6dofimu24_read_regs ( c6dofimu24_t * ctx,
uint8_t reg,
uint8_t * data_out,
uint8_t len )

6DOF IMU 24 read registers function.

This function reads a desired number of data bytes starting from the selected register.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[in]reg: Start register address.
[out]data_out: Output read data.
[in]len: Number of bytes to be read.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_read_temperature()

err_t c6dofimu24_read_temperature ( c6dofimu24_t * ctx,
float * temperature )

6DOF IMU 24 read temperature function.

This function reads the temperature measurement in degrees Celsius.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[out]temperature: Temperature in degrees Celsius.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_reset_device()

err_t c6dofimu24_reset_device ( c6dofimu24_t * ctx)

6DOF IMU 24 reset device function.

This function performs the device software reset.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_select_reg_bank()

err_t c6dofimu24_select_reg_bank ( c6dofimu24_t * ctx,
uint8_t bank_num )

6DOF IMU 24 select reg bank function.

This function selects the user bank registers.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[in]bank_num: User bank number.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_set_accel_fs_odr()

err_t c6dofimu24_set_accel_fs_odr ( c6dofimu24_t * ctx,
uint8_t fs_sel,
uint8_t odr )

6DOF IMU 24 set accel fs odr function.

This function sets the accel full scale resolution and output data rate.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[in]fs_sel: Full scale selection, see C6DOFIMU24_ACCEL_FS_SEL_x definition.
[in]odr: Output data rate, see C6DOFIMU24_ACCEL_ODR_x definition.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_set_gyro_fs_odr()

err_t c6dofimu24_set_gyro_fs_odr ( c6dofimu24_t * ctx,
uint8_t fs_sel,
uint8_t odr )

6DOF IMU 24 set gyro fs odr function.

This function sets the gyro full scale resolution and output data rate.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[in]fs_sel: Full scale selection, see C6DOFIMU24_GYRO_FS_SEL_x definition.
[in]odr: Output data rate, see C6DOFIMU24_GYRO_ODR_x definition.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_write_reg()

err_t c6dofimu24_write_reg ( c6dofimu24_t * ctx,
uint8_t reg,
uint8_t data_in )

6DOF IMU 24 write register function.

This function writes a data byte to the selected bank 0 register.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[in]reg: Register address.
[in]data_in: Data to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.

◆ c6dofimu24_write_regs()

err_t c6dofimu24_write_regs ( c6dofimu24_t * ctx,
uint8_t reg,
uint8_t * data_in,
uint8_t len )

6DOF IMU 24 write registers function.

This function writes a desired number of data bytes starting from the selected register.

Parameters
[in]ctx: Click context object. See c6dofimu24_t object definition for detailed explanation.
[in]reg: Start register address.
[in]data_in: Data to be written.
[in]len: Number of bytes to be written.
Returns
  • 0 - Success,
  • -1 - Error. See #err_t definition for detailed explanation.
Note
None.