inclinometer4
2.1.0.0
|
API for configuring and manipulating Inclinometer 4 Click driver. More...
Modules | |
Inclinometer 4 Registers List | |
List of registers of Inclinometer 4 Click driver. | |
Inclinometer 4 Registers Settings | |
Settings for registers of Inclinometer 4 Click driver. | |
Inclinometer 4 MikroBUS Map | |
MikroBUS pin mapping of Inclinometer 4 Click driver. | |
Functions | |
void | inclinometer4_cfg_setup (inclinometer4_cfg_t *cfg) |
Inclinometer 4 configuration object setup function. More... | |
void | inclinometer4_drv_interface_sel (inclinometer4_cfg_t *cfg, inclinometer4_drv_t drv_sel) |
Inclinometer 4 driver interface setup function. More... | |
err_t | inclinometer4_init (inclinometer4_t *ctx, inclinometer4_cfg_t *cfg) |
Inclinometer 4 initialization function. More... | |
err_t | inclinometer4_default_cfg (inclinometer4_t *ctx) |
Inclinometer 4 default configuration function. More... | |
err_t | inclinometer4_write_regs (inclinometer4_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len) |
Inclinometer 4 write regs function. More... | |
err_t | inclinometer4_read_regs (inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len) |
Inclinometer 4 read regs function. More... | |
err_t | inclinometer4_write_reg (inclinometer4_t *ctx, uint8_t reg, uint8_t data_in) |
Inclinometer 4 write reg function. More... | |
err_t | inclinometer4_read_reg (inclinometer4_t *ctx, uint8_t reg, uint8_t *data_out) |
Inclinometer 4 read reg function. More... | |
uint8_t | inclinometer4_get_int1_pin (inclinometer4_t *ctx) |
Inclinometer 4 get int1 pin function. More... | |
uint8_t | inclinometer4_get_int2_pin (inclinometer4_t *ctx) |
Inclinometer 4 get int2 pin function. More... | |
err_t | inclinometer4_check_comm (inclinometer4_t *ctx) |
Inclinometer 4 check comm function. More... | |
err_t | inclinometer4_get_status (inclinometer4_t *ctx, uint8_t *status) |
Inclinometer 4 get status function. More... | |
err_t | inclinometer4_sw_reset (inclinometer4_t *ctx) |
Inclinometer 4 sw reset function. More... | |
err_t | inclinometer4_set_mode (inclinometer4_t *ctx, uint8_t mode) |
Inclinometer 4 set mode function. More... | |
err_t | inclinometer4_set_fsr (inclinometer4_t *ctx, uint8_t fsr) |
Inclinometer 4 set fsr function. More... | |
err_t | inclinometer4_set_odr (inclinometer4_t *ctx, uint8_t odr) |
Inclinometer 4 set odr function. More... | |
err_t | inclinometer4_get_data (inclinometer4_t *ctx, inclinometer4_data_t *data_out) |
Inclinometer 4 get data function. More... | |
API for configuring and manipulating Inclinometer 4 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void inclinometer4_cfg_setup | ( | inclinometer4_cfg_t * | cfg | ) |
Inclinometer 4 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See inclinometer4_cfg_t object definition for detailed explanation. |
err_t inclinometer4_check_comm | ( | inclinometer4_t * | ctx | ) |
Inclinometer 4 check comm function.
This function checks the communication by reading and verifying the device ID.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_default_cfg | ( | inclinometer4_t * | ctx | ) |
Inclinometer 4 default configuration function.
This function executes a default configuration of Inclinometer 4 click board.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void inclinometer4_drv_interface_sel | ( | inclinometer4_cfg_t * | cfg, |
inclinometer4_drv_t | drv_sel | ||
) |
Inclinometer 4 driver interface setup function.
This function sets a serial driver interface which will be used further in the click driver.
[out] | cfg | : Click configuration structure. See inclinometer4_cfg_t object definition for detailed explanation. |
[in] | drv_sel | : Driver interface selection. See inclinometer4_drv_t object definition for detailed explanation. |
err_t inclinometer4_get_data | ( | inclinometer4_t * | ctx, |
inclinometer4_data_t * | data_out | ||
) |
Inclinometer 4 get data function.
This function reads accel X, Y, and Z axis data in g and temperature in degrees Celsius.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
[out] | data_out | : X, Y, and Z axis data in g, and temperature in degrees Celsius. See inclinometer4_data_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t inclinometer4_get_int1_pin | ( | inclinometer4_t * | ctx | ) |
Inclinometer 4 get int1 pin function.
This function returns the interrupt 1 (INT1) pin logic state.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
uint8_t inclinometer4_get_int2_pin | ( | inclinometer4_t * | ctx | ) |
Inclinometer 4 get int2 pin function.
This function returns the interrupt 2 (INT2) pin logic state.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
err_t inclinometer4_get_status | ( | inclinometer4_t * | ctx, |
uint8_t * | status | ||
) |
Inclinometer 4 get status function.
This function reads the interrupt status register.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
[out] | status | : Interrupt status read. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_init | ( | inclinometer4_t * | ctx, |
inclinometer4_cfg_t * | cfg | ||
) |
Inclinometer 4 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See inclinometer4_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_read_reg | ( | inclinometer4_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
Inclinometer 4 read reg function.
This function reads a data byte from the selected register.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | data_out | : Output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_read_regs | ( | inclinometer4_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out, | ||
uint8_t | len | ||
) |
Inclinometer 4 read regs function.
This function reads a desired number of data bytes starting from the selected register.
[in] | ctx | : Click context object. See inclinometer4_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. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_set_fsr | ( | inclinometer4_t * | ctx, |
uint8_t | fsr | ||
) |
Inclinometer 4 set fsr function.
This function sets the accel measurement full scale range.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
[in] | fsr | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_set_mode | ( | inclinometer4_t * | ctx, |
uint8_t | mode | ||
) |
Inclinometer 4 set mode function.
This function sets the device operating mode to standby or active.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
[in] | mode | : Operating mode:
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_set_odr | ( | inclinometer4_t * | ctx, |
uint8_t | odr | ||
) |
Inclinometer 4 set odr function.
This function sets the measurement output data rate.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
[in] | odr | :
|
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_sw_reset | ( | inclinometer4_t * | ctx | ) |
Inclinometer 4 sw reset function.
This function performs the device software reset.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_write_reg | ( | inclinometer4_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
Inclinometer 4 write reg function.
This function write a data byte to the selected register.
[in] | ctx | : Click context object. See inclinometer4_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | data_in | : Data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t inclinometer4_write_regs | ( | inclinometer4_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_in, | ||
uint8_t | len | ||
) |
Inclinometer 4 write regs function.
This function writes a desired number of data bytes starting from the selected register.
[in] | ctx | : Click context object. See inclinometer4_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. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.