proximity14
2.0.0.0
|
API for configuring and manipulating Proximity 14 Click driver. More...
Modules | |
Proximity 14 Registers List | |
List of registers of Proximity 14 Click driver. | |
Proximity 14 Registers Settings | |
Settings for registers of Proximity 14 Click driver. | |
Proximity 14 MikroBUS Map | |
MikroBUS pin mapping of Proximity 14 Click driver. | |
Functions | |
void | proximity14_cfg_setup (proximity14_cfg_t *cfg) |
Proximity 14 configuration object setup function. More... | |
err_t | proximity14_init (proximity14_t *ctx, proximity14_cfg_t *cfg) |
Proximity 14 initialization function. More... | |
err_t | proximity14_default_cfg (proximity14_t *ctx) |
Proximity 14 default configuration function. More... | |
err_t | proximity14_generic_write (proximity14_t *ctx, uint8_t reg, uint16_t tx_data) |
Writing function. More... | |
err_t | proximity14_generic_read (proximity14_t *ctx, uint8_t reg, uint16_t *rx_data) |
Reading function. More... | |
uint8_t | proximity14_get_int (proximity14_t *ctx) |
Get INT pin state. More... | |
API for configuring and manipulating Proximity 14 Click driver.
void proximity14_cfg_setup | ( | proximity14_cfg_t * | cfg | ) |
Proximity 14 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See proximity14_cfg_t object definition for detailed explanation. |
err_t proximity14_default_cfg | ( | proximity14_t * | ctx | ) |
Proximity 14 default configuration function.
This function executes a default configuration of Proximity 14 click board.
[in] | ctx | : Click context object. See proximity14_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t proximity14_generic_read | ( | proximity14_t * | ctx, |
uint8_t | reg, | ||
uint16_t * | rx_data | ||
) |
Reading function.
This function reads a data to the selected register.
[in] | ctx | : Click context object. See proximity14_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[out] | rx_data | : Output read data. |
0
- Success, -1
- Error.err_t proximity14_generic_write | ( | proximity14_t * | ctx, |
uint8_t | reg, | ||
uint16_t | tx_data | ||
) |
Writing function.
This function writes a data to the selected register.
[in] | ctx | : Click context object. See proximity14_t object definition for detailed explanation. |
[in] | reg | : Register address. |
[in] | tx_data | : Data to be written. |
0
- Success, -1
- Error.uint8_t proximity14_get_int | ( | proximity14_t * | ctx | ) |
Get INT pin state.
This function reads logic state of interrupt pin.
[in] | ctx | : Click context object. See proximity14_t object definition for detailed explanation. |
err_t proximity14_init | ( | proximity14_t * | ctx, |
proximity14_cfg_t * | cfg | ||
) |
Proximity 14 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See proximity14_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See proximity14_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.