piezoaccel250g
2.1.0.0
|
API for configuring and manipulating Piezo Accel 2 50g Click driver. More...
Modules | |
Piezo Accel 2 50g Fast Commands List | |
List of fast commands of Piezo Accel 2 50g Click driver. | |
Piezo Accel 2 50g Registers List | |
List of registers of Piezo Accel 2 50g Click driver. | |
Piezo Accel 2 50g Registers Settings | |
Settings for registers of Piezo Accel 2 50g Click driver. | |
Piezo Accel 2 50g MikroBUS Map | |
MikroBUS pin mapping of Piezo Accel 2 50g Click driver. | |
Functions | |
void | piezoaccel250g_cfg_setup (piezoaccel250g_cfg_t *cfg) |
Piezo Accel 2 50g configuration object setup function. More... | |
err_t | piezoaccel250g_init (piezoaccel250g_t *ctx, piezoaccel250g_cfg_t *cfg) |
Piezo Accel 2 50g initialization function. More... | |
err_t | piezoaccel250g_default_cfg (piezoaccel250g_t *ctx) |
Piezo Accel 2 50g default configuration function. More... | |
err_t | piezoaccel250g_fast_cmd_write (piezoaccel250g_t *ctx, uint8_t fast_cmd) |
Piezo Accel 2 50g fast cmd write function. More... | |
err_t | piezoaccel250g_reg_write_multi (piezoaccel250g_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len) |
Piezo Accel 2 50g reg write multi function. More... | |
err_t | piezoaccel250g_reg_write_8 (piezoaccel250g_t *ctx, uint8_t reg, uint8_t data_in) |
Piezo Accel 2 50g reg write 8 function. More... | |
err_t | piezoaccel250g_reg_write_24 (piezoaccel250g_t *ctx, uint8_t reg, uint32_t data_in) |
Piezo Accel 2 50g reg write 24 function. More... | |
err_t | piezoaccel250g_reg_read_multi (piezoaccel250g_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len) |
Piezo Accel 2 50g reg read multi function. More... | |
err_t | piezoaccel250g_reg_read_8 (piezoaccel250g_t *ctx, uint8_t reg, uint8_t *data_out) |
Piezo Accel 2 50g reg read 8 function. More... | |
err_t | piezoaccel250g_reg_read_24 (piezoaccel250g_t *ctx, uint8_t reg, uint32_t *data_out) |
Piezo Accel 2 50g reg read 24 function. More... | |
err_t | piezoaccel250g_reg_read_32 (piezoaccel250g_t *ctx, uint8_t reg, uint32_t *data_out) |
Piezo Accel 2 50g reg read 32 function. More... | |
err_t | piezoaccel250g_unlock_reg_write (piezoaccel250g_t *ctx) |
Piezo Accel 2 50g unlock reg write function. More... | |
err_t | piezoaccel250g_lock_reg_write (piezoaccel250g_t *ctx) |
Piezo Accel 2 50g lock reg write function. More... | |
uint8_t | piezoaccel250g_get_clk_pin (piezoaccel250g_t *ctx) |
Piezo Accel 2 50g get clk pin function. More... | |
uint8_t | piezoaccel250g_get_irq_pin (piezoaccel250g_t *ctx) |
Piezo Accel 2 50g get irq pin function. More... | |
err_t | piezoaccel250g_wait_data_ready (piezoaccel250g_t *ctx, uint16_t timeout_ms) |
Piezo Accel 2 50g wait data ready function. More... | |
err_t | piezoaccel250g_read_adc_data (piezoaccel250g_t *ctx, piezoaccel250g_adc_data_t *data_out) |
Piezo Accel 2 50g read adc data function. More... | |
API for configuring and manipulating Piezo Accel 2 50g Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void piezoaccel250g_cfg_setup | ( | piezoaccel250g_cfg_t * | cfg | ) |
Piezo Accel 2 50g configuration object setup function.
This function initializes Click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See piezoaccel250g_cfg_t object definition for detailed explanation. |
err_t piezoaccel250g_default_cfg | ( | piezoaccel250g_t * | ctx | ) |
Piezo Accel 2 50g default configuration function.
This function executes a default configuration of Piezo Accel 2 50g Click board.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_fast_cmd_write | ( | piezoaccel250g_t * | ctx, |
uint8_t | fast_cmd | ||
) |
Piezo Accel 2 50g fast cmd write function.
This function writes the selected fast command by using SPI serial interface.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
[in] | fast_cmd | : Fast command to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t piezoaccel250g_get_clk_pin | ( | piezoaccel250g_t * | ctx | ) |
Piezo Accel 2 50g get clk pin function.
This function returns the CLK pin logic state.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
uint8_t piezoaccel250g_get_irq_pin | ( | piezoaccel250g_t * | ctx | ) |
Piezo Accel 2 50g get irq pin function.
This function returns the IRQ pin logic state.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
err_t piezoaccel250g_init | ( | piezoaccel250g_t * | ctx, |
piezoaccel250g_cfg_t * | cfg | ||
) |
Piezo Accel 2 50g initialization function.
This function initializes all necessary pins and peripherals used for this Click board.
[out] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See piezoaccel250g_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_lock_reg_write | ( | piezoaccel250g_t * | ctx | ) |
Piezo Accel 2 50g lock reg write function.
This function locks writing to registers.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_read_adc_data | ( | piezoaccel250g_t * | ctx, |
piezoaccel250g_adc_data_t * | data_out | ||
) |
Piezo Accel 2 50g read adc data function.
This function reads raw ADC values of X, Y, and Z axis, and the internal temperature sensor measurements.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
[in] | data_out | : RAW ADC data read. See piezoaccel250g_adc_data_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_reg_read_24 | ( | piezoaccel250g_t * | ctx, |
uint8_t | reg, | ||
uint32_t * | data_out | ||
) |
Piezo Accel 2 50g reg read 24 function.
This function reads 24-bit data from the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | data_out | : 24-bit output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_reg_read_32 | ( | piezoaccel250g_t * | ctx, |
uint8_t | reg, | ||
uint32_t * | data_out | ||
) |
Piezo Accel 2 50g reg read 32 function.
This function reads 32-bit data from the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | data_out | : 32-bit output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_reg_read_8 | ( | piezoaccel250g_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
Piezo Accel 2 50g reg read 8 function.
This function reads 8-bit data from the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | data_out | : 8-bit output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_reg_read_multi | ( | piezoaccel250g_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out, | ||
uint8_t | len | ||
) |
Piezo Accel 2 50g reg read multi function.
This function reads a desired number of data bytes starting from the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See piezoaccel250g_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 piezoaccel250g_reg_write_24 | ( | piezoaccel250g_t * | ctx, |
uint8_t | reg, | ||
uint32_t | data_in | ||
) |
Piezo Accel 2 50g reg write 24 function.
This function writes 24-bit data to the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | data_in | : 24-bit data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_reg_write_8 | ( | piezoaccel250g_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
Piezo Accel 2 50g reg write 8 function.
This function writes 8-bit data to the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | data_in | : 8-bit data to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_reg_write_multi | ( | piezoaccel250g_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_in, | ||
uint8_t | len | ||
) |
Piezo Accel 2 50g reg write multi function.
This function writes a desired number of data bytes starting from the selected register by using SPI serial interface.
[in] | ctx | : Click context object. See piezoaccel250g_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 piezoaccel250g_unlock_reg_write | ( | piezoaccel250g_t * | ctx | ) |
Piezo Accel 2 50g unlock reg write function.
This function unlocks writing to registers.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t piezoaccel250g_wait_data_ready | ( | piezoaccel250g_t * | ctx, |
uint16_t | timeout_ms | ||
) |
Piezo Accel 2 50g wait data ready function.
This function waits a desired period for a data ready indication.
[in] | ctx | : Click context object. See piezoaccel250g_t object definition for detailed explanation. |
[in] | timeout_ms | : Waiting timeout in milliseconds. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation.