|
uv4
2.0.0.0
|
Functions | |
| void | uv4_cfg_setup (uv4_cfg_t *cfg) |
| Config Object Initialization function. More... | |
| UV4_RETVAL | uv4_init (uv4_t *ctx, uv4_cfg_t *cfg) |
| Initialization function. More... | |
| void | uv4_default_cfg (uv4_t *ctx) |
| Click Default Configuration function. More... | |
| UV4_RETVAL | uv4_write_reg (uv4_t *ctx, const uint8_t reg_address, const uint8_t transfer_data) |
| Generic write function. More... | |
| UV4_RETVAL | uv4_read_reg (uv4_t *ctx, uint8_t reg_address, uint8_t *data_out, uint8_t n_bytes) |
| Generic read function. More... | |
| UV4_RETVAL | uv4_write_param_data (uv4_t *ctx, uint8_t param_address, uint8_t transfer_data) |
| Parameter Data Write Function. More... | |
| UV4_RETVAL | uv4_read_param_data (uv4_t *ctx, uint8_t param_address, uint8_t *param_out) |
| Parameter Data Read Function. More... | |
| void | uv4_read_measurements (uv4_t *ctx, uint32_t *measure_out) |
| Measurements Read Function. More... | |
| UV4_RETVAL | uv4_check_err_and_ctr (uv4_t *ctx, uint8_t *cnt_data) |
| Error And Counter Check function. More... | |
| UV4_RETVAL | uv4_check_interr (uv4_t *ctx) |
| Error And Counter Check function. More... | |
| void uv4_cfg_setup | ( | uv4_cfg_t * | cfg | ) |
Config Object Initialization function.
| cfg | Click configuration structure. |
@description This function initializes click configuration structure to init state.
| UV4_RETVAL uv4_check_err_and_ctr | ( | uv4_t * | ctx, |
| uint8_t * | cnt_data | ||
| ) |
Error And Counter Check function.
| uv4 | Click object. |
| cnt_data | Pointer where counter data is stored. |
@description This function checks if error occurred and if it didn't, reads counter data. Counter increments on every successful command.
| UV4_RETVAL uv4_check_interr | ( | uv4_t * | ctx | ) |
Error And Counter Check function.
| uv4 | Click object. |
@description This function checks state on INT pin, if interrupt occurred.
| void uv4_default_cfg | ( | uv4_t * | ctx | ) |
Click Default Configuration function.
| ctx | Click object. |
@description This function executes default configuration for UV4 Click.
| UV4_RETVAL uv4_init | ( | uv4_t * | ctx, |
| uv4_cfg_t * | cfg | ||
| ) |
Initialization function.
| ctx | Click object. |
| cfg | Click configuration structure. |
@description This function initializes all necessary pins and peripherals used for this click.
| void uv4_read_measurements | ( | uv4_t * | ctx, |
| uint32_t * | measure_out | ||
| ) |
Measurements Read Function.
| uv4 | Click object. |
| measure_out | Pointer to buffer where measured data is stored. |
@description This function reads measured determined data from selected channel/channels, when measurement is completed on selected channel. Measured data can be 16-bit unsigned data, or 24-bit signed data.
| UV4_RETVAL uv4_read_param_data | ( | uv4_t * | ctx, |
| uint8_t | param_address, | ||
| uint8_t * | param_out | ||
| ) |
Parameter Data Read Function.
| uv4 | Click object. |
| param_address | Address of parameter data. |
| param_out | Pointer to buffer where parameter is stored. |
@description This function reads one byte of data from parameter table.
| UV4_RETVAL uv4_read_reg | ( | uv4_t * | ctx, |
| uint8_t | reg_address, | ||
| uint8_t * | data_out, | ||
| uint8_t | n_bytes | ||
| ) |
Generic read function.
| uv4 | Click object. |
| reg_address | Address to read byte from. |
| data_out | Pointer to buffer where data is to be stored. |
| inc_en | 0x00 - Enable autoincrement pointer, 0x40 - Disable autoincrement pointer. |
@description This function reads determined number of bytes from given address.
| UV4_RETVAL uv4_write_param_data | ( | uv4_t * | ctx, |
| uint8_t | param_address, | ||
| uint8_t | transfer_data | ||
| ) |
Parameter Data Write Function.
| uv4 | Click object. |
| param_address | Address of parameter data. |
| transfer_data | Data to be written. |
@description This function writes one byte of data in parameter table.
| UV4_RETVAL uv4_write_reg | ( | uv4_t * | ctx, |
| const uint8_t | reg_address, | ||
| const uint8_t | transfer_data | ||
| ) |
Generic write function.
| uv4 | Click object. |
| reg_address | Address to write byte to. |
@description This function write one byte of data to given address.