illuminance
2.0.0.0
|
API for configuring and manipulating Illuminance Click driver. More...
Modules | |
Illuminance Registers List | |
List of registers of Illuminance Click driver. | |
Illuminance Registers Settings | |
Settings for registers of Illuminance Click driver. | |
Illuminance MikroBUS Map | |
MikroBUS pin mapping of Illuminance Click driver. | |
Functions | |
void | illuminance_cfg_setup (illuminance_cfg_t *cfg) |
Illuminance configuration object setup function. More... | |
err_t | illuminance_init (illuminance_t *ctx, illuminance_cfg_t *cfg) |
Illuminance initialization function. More... | |
err_t | illuminance_default_cfg (illuminance_t *ctx) |
Illuminance default configuration function. More... | |
err_t | illuminance_generic_write (illuminance_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len) |
Illuminance I2C writing function. More... | |
err_t | illuminance_generic_read (illuminance_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len) |
Illuminance I2C reading function. More... | |
err_t | illuminance_write_register (illuminance_t *ctx, uint8_t reg, uint8_t data_in) |
Illuminance write register function. More... | |
err_t | illuminance_read_register (illuminance_t *ctx, uint8_t reg, uint8_t *data_out) |
Illuminance read register function. More... | |
uint8_t | illuminance_get_int_pin (illuminance_t *ctx) |
Illuminance get int pin function. More... | |
err_t | illuminance_check_communication (illuminance_t *ctx) |
Illuminance check communication function. More... | |
err_t | illuminance_set_atime (illuminance_t *ctx, float atime_ms) |
Illuminance set atime function. More... | |
err_t | illuminance_set_gain (illuminance_t *ctx, uint8_t gain) |
Illuminance set gain function. More... | |
err_t | illuminance_read_raw_data (illuminance_t *ctx, uint16_t *ch_0, uint16_t *ch_1) |
Illuminance read raw data function. More... | |
API for configuring and manipulating Illuminance Click driver.
void illuminance_cfg_setup | ( | illuminance_cfg_t * | cfg | ) |
Illuminance configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See illuminance_cfg_t object definition for detailed explanation. |
err_t illuminance_check_communication | ( | illuminance_t * | ctx | ) |
Illuminance check communication function.
This function checks the communication by reading and verifying the chip ID values.
[in] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t illuminance_default_cfg | ( | illuminance_t * | ctx | ) |
Illuminance default configuration function.
This function executes a default configuration of Illuminance click board.
[in] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t illuminance_generic_read | ( | illuminance_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | rx_buf, | ||
uint8_t | rx_len | ||
) |
Illuminance I2C reading function.
This function reads a desired number of data bytes starting from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[out] | rx_buf | : Output read data. |
[in] | rx_len | : Number of bytes to be read. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t illuminance_generic_write | ( | illuminance_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | tx_buf, | ||
uint8_t | tx_len | ||
) |
Illuminance I2C writing function.
This function writes a desired number of data bytes starting from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[in] | tx_buf | : Data to be written. |
[in] | tx_len | : Number of bytes to be written. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. uint8_t illuminance_get_int_pin | ( | illuminance_t * | ctx | ) |
Illuminance get int pin function.
This function returns the INT pin logic state.
[in] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
err_t illuminance_init | ( | illuminance_t * | ctx, |
illuminance_cfg_t * | cfg | ||
) |
Illuminance initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See illuminance_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.err_t illuminance_read_raw_data | ( | illuminance_t * | ctx, |
uint16_t * | ch_0, | ||
uint16_t * | ch_1 | ||
) |
Illuminance read raw data function.
This function checks if the data is ready and then reads the raw ADC data from two channels.
[in] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
[out] | ch_0 | : Raw data from channel 0. |
[out] | ch_1 | : Raw data from channel 1. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t illuminance_read_register | ( | illuminance_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | data_out | ||
) |
Illuminance read register function.
This function reads a desired data from the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
[in] | reg | : Start register address. |
[out] | data_out | : Output read data. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t illuminance_set_atime | ( | illuminance_t * | ctx, |
float | atime_ms | ||
) |
Illuminance set atime function.
This function sets the timing register for the selected integration time.
[in] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
[in] | atime_ms | : Als integration time. Valid values from 2.7 to 688.5 milliseconds. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t illuminance_set_gain | ( | illuminance_t * | ctx, |
uint8_t | gain | ||
) |
Illuminance set gain function.
This function sets the gain level.
[in] | ctx | : Click context object. See illuminance_t object definition for detailed explanation. |
[in] | gain | : Gain level value [0-3]. |
0
- Success, -1
- Error. See #err_t definition for detailed explanation. err_t illuminance_write_register | ( | illuminance_t * | ctx, |
uint8_t | reg, | ||
uint8_t | data_in | ||
) |
Illuminance write register function.
This function writes a desired data to the selected register by using I2C serial interface.
[in] | ctx | : Click context object. See illuminance_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.