c6dofimu23
2.1.0.0
|
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... | |
err_t | c6dofimu23_default_cfg (c6dofimu23_t *ctx) |
6DOF IMU 23 default configuration function. More... | |
err_t | c6dofimu23_reg_write (c6dofimu23_t *ctx, uint8_t address, uint16_t data_in) |
6DOF IMU 23 reg write function. More... | |
err_t | c6dofimu23_reg_read (c6dofimu23_t *ctx, uint8_t address, uint16_t *data_out) |
6DOF IMU 23 reg read function. More... | |
err_t | c6dofimu23_check_communication (c6dofimu23_t *ctx) |
6DOF IMU 23 check communication function. More... | |
void | c6dofimu23_device_enable (c6dofimu23_t *ctx) |
6DOF IMU 23 device enable function. More... | |
void | c6dofimu23_device_disable (c6dofimu23_t *ctx) |
6DOF IMU 23 device disable function. More... | |
uint8_t | c6dofimu23_get_odr (c6dofimu23_t *ctx) |
6DOF IMU 23 get odr 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... | |
err_t | c6dofimu23_get_temperature (c6dofimu23_t *ctx, float *temperature) |
6DOF IMU 23 get the internal temperature function. More... | |
API for configuring and manipulating 6DOF IMU 23 Click driver.
void c6dofimu23_cfg_setup | ( | c6dofimu23_cfg_t * | cfg | ) |
6DOF IMU 23 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See c6dofimu23_cfg_t object definition for detailed explanation. |
err_t c6dofimu23_check_communication | ( | c6dofimu23_t * | ctx | ) |
6DOF IMU 23 check communication function.
This function checks the communication by reading and verifying the fixed value register from bank 0.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t c6dofimu23_default_cfg | ( | c6dofimu23_t * | ctx | ) |
6DOF IMU 23 default configuration function.
This function executes a default configuration of 6DOF IMU 23 click board.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void c6dofimu23_device_disable | ( | c6dofimu23_t * | ctx | ) |
6DOF IMU 23 device disable function.
This function disables the device by setting the RST pin to low logic state.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
void c6dofimu23_device_enable | ( | c6dofimu23_t * | ctx | ) |
6DOF IMU 23 device enable function.
This function enables the device by setting the RST pin to high logic state.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
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.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
[out] | acc_axis | : Linear acceleration output data object (mg). |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
[out] | gyro_axis | : Angular rate output data object (dps). |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t c6dofimu23_get_odr | ( | c6dofimu23_t * | ctx | ) |
6DOF IMU 23 get odr 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.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
0
- Low pin state, 1
- High pin state. err_t c6dofimu23_get_temperature | ( | c6dofimu23_t * | ctx, |
float * | temperature | ||
) |
6DOF IMU 23 get the internal temperature function.
This function reads the internal temperature sensor measurement in degrees Celsius of the IIM-20670, SmartIndustrial 6-axis MotionTracking MEMS on the 6DOF IMU 23 click board.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
[out] | temperature | : Internal temperature (degrees Celsius). |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. 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.
[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. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t c6dofimu23_reg_read | ( | c6dofimu23_t * | ctx, |
uint8_t | address, | ||
uint16_t * | data_out | ||
) |
6DOF IMU 23 reg read function.
This function reads a data word from the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
[in] | address | : Register offset with respect to the bank that is currently selected. |
[out] | data_out | : 16-bit output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t c6dofimu23_reg_write | ( | c6dofimu23_t * | ctx, |
uint8_t | address, | ||
uint16_t | data_in | ||
) |
6DOF IMU 23 reg write function.
This function writes a data word to the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See c6dofimu23_t object definition for detailed explanation. |
[in] | address | : Register offset with respect to the bank that is currently selected. |
[in] | data_in | : 16-bit data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.