accel28 2.1.0.0
|
API for configuring and manipulating Accel 28 Click driver. More...
Modules | |
Accel 28 Registers List | |
List of registers of Accel 28 Click driver. | |
Accel 28 Registers Settings | |
Settings for registers of Accel 28 Click driver. | |
Accel 28 MikroBUS Map | |
MikroBUS pin mapping of Accel 28 Click driver. | |
Functions | |
void | accel28_cfg_setup (accel28_cfg_t *cfg) |
Accel 28 configuration object setup function. More... | |
void | accel28_drv_interface_selection (accel28_cfg_t *cfg, accel28_drv_t drv_sel) |
Accel 28 driver interface setup function. More... | |
err_t | accel28_init (accel28_t *ctx, accel28_cfg_t *cfg) |
Accel 28 initialization function. More... | |
err_t | accel28_default_cfg (accel28_t *ctx) |
Accel 28 default configuration function. More... | |
err_t | accel28_generic_write (accel28_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len) |
Accel 28 data writing function. More... | |
err_t | accel28_generic_read (accel28_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len) |
Accel 28 data reading function. More... | |
uint8_t | accel28_get_int_state (accel28_t *ctx) |
Accel 28 interrupt reading function. More... | |
err_t | accel28_get_raw_data (accel28_t *ctx, accel28_data_t *data_out) |
Accel 28 raw data reading function. More... | |
err_t | accel28_get_data (accel28_t *ctx, accel28_data_t *data_out) |
Accel 28 data reading function. More... | |
err_t | accel28_write_reg (accel28_t *ctx, uint8_t reg, uint8_t data_in) |
Accel 28 register data writing function. More... | |
err_t | accel28_read_reg (accel28_t *ctx, uint8_t reg, uint8_t *data_out) |
Accel 28 register data reading function. More... | |
err_t | accel28_sw_reset (accel28_t *ctx) |
Accel 28 SW reset function. More... | |
API for configuring and manipulating Accel 28 Click driver.
void accel28_cfg_setup | ( | accel28_cfg_t * | cfg | ) |
Accel 28 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See accel28_cfg_t object definition for detailed explanation. |
err_t accel28_default_cfg | ( | accel28_t * | ctx | ) |
Accel 28 default configuration function.
This function executes a default configuration of Accel 28 click board.
[in] | ctx | : Click context object. See accel28_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. void accel28_drv_interface_selection | ( | accel28_cfg_t * | cfg, |
accel28_drv_t | drv_sel | ||
) |
Accel 28 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 accel28_cfg_t object definition for detailed explanation. |
[in] | drv_sel | : Driver interface selection. See accel28_drv_t object definition for detailed explanation. |
err_t accel28_generic_read | ( | accel28_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out, | ||
uint8_t | len | ||
) |
Accel 28 data reading function.
This function reads a desired number of data bytes starting from the selected register.
[in] | ctx | : Click context object. See accel28_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 accel28_generic_write | ( | accel28_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_in, | ||
uint8_t | len | ||
) |
Accel 28 data writing function.
This function writes a desired number of data bytes starting from the selected register.
[in] | ctx | : Click context object. See accel28_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. err_t accel28_get_data | ( | accel28_t * | ctx, |
accel28_data_t * | data_out | ||
) |
Accel 28 data reading function.
This function reads the accel data.
[in] | ctx | : Click context object. See accel28_t object definition for detailed explanation. |
[out] | data_out | : Accel data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t accel28_get_int_state | ( | accel28_t * | ctx | ) |
Accel 28 interrupt reading function.
This function reads the interrupt state data.
[in] | ctx | : Click context object. See accel28_t object definition for detailed explanation. |
err_t accel28_get_raw_data | ( | accel28_t * | ctx, |
accel28_data_t * | data_out | ||
) |
Accel 28 raw data reading function.
This function reads the raw accel data.
[in] | ctx | : Click context object. See accel28_t object definition for detailed explanation. |
[out] | data_out | : Accel data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t accel28_init | ( | accel28_t * | ctx, |
accel28_cfg_t * | cfg | ||
) |
Accel 28 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See accel28_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See accel28_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t accel28_read_reg | ( | accel28_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
Accel 28 register data reading function.
This function reads a byte of data from the selected register.
[in] | ctx | : Click context object. See accel28_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 accel28_sw_reset | ( | accel28_t * | ctx | ) |
Accel 28 SW reset function.
This function performes software reset.
[in] | ctx | : Click context object. See accel28_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t accel28_write_reg | ( | accel28_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
Accel 28 register data writing function.
This function writes a byte of data into the selected register.
[in] | ctx | : Click context object. See accel28_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.