irgrid3 2.0.0.0
|
API for configuring and manipulating IR Grid 3 Click driver. More...
Topics | |
IR Grid 3 Registers List | |
List of registers of IR Grid 3 Click driver. | |
IR Grid 3 Registers Settings | |
Settings for registers of IR Grid 3 Click driver. | |
IR Grid 3 MikroBUS Map | |
MikroBUS pin mapping of IR Grid 3 Click driver. | |
Functions | |
void | irgrid3_cfg_setup (irgrid3_cfg_t *cfg) |
IR Grid 3 configuration object setup function. | |
err_t | irgrid3_init (irgrid3_t *ctx, irgrid3_cfg_t *cfg) |
IR Grid 3 initialization function. | |
void | irgrid3_default_cfg (irgrid3_t *ctx) |
IR Grid 3 default configuration function. | |
void | irgrid3_generic_write (irgrid3_t *ctx, uint16_t reg, uint8_t *data_buf, uint16_t len) |
IR Grid 3 I2C writing function. | |
void | irgrid3_generic_read (irgrid3_t *ctx, uint16_t reg, uint8_t *rx_buf, uint16_t rx_len) |
IR Grid 3 I2C reading function. | |
void | irgrid3_read_eeprom (irgrid3_t *ctx, uint16_t *eeprom_data) |
Function for reading EEPROM. | |
uint8_t | irgrid3_extract_parameters (irgrid3_t *ctx, uint16_t *eeprom_data) |
Parameters storage function. | |
void | irgrid3_set_refresh_rate (irgrid3_t *ctx, uint8_t refresh_rate) |
Function for setting refresh rate. | |
uint16_t | irgrid3_get_frame_data (irgrid3_t *ctx, uint16_t *frame_data) |
Function for getting frame data. | |
void | irgrid3_set_resolution (irgrid3_t *ctx, uint8_t resolution) |
Function for setting resolution. | |
uint16_t | irgrid3_get_current_res (irgrid3_t *ctx) |
Function for getting current resolution. | |
uint16_t | irgrid3_get_refresh_rate (irgrid3_t *ctx) |
Function for getting current refresh Rate. | |
void | irgrid3_set_interleaved_mode (irgrid3_t *ctx) |
Function for setting interleaved mode. | |
void | irgrid3_set_chess_mode (irgrid3_t *ctx) |
Function for setting chess mode. | |
uint16_t | irgrid3_get_current_mode (irgrid3_t *ctx) |
Function for getting current mode. | |
void | irgrid3_get_pixel_temperature (irgrid3_t *ctx, float *temp_ambient, float *pixel_temp) |
Function for getting pixels temperature. | |
float | irgrid3_get_temp_ambient (irgrid3_t *ctx, uint16_t *frame_data) |
Function for getting Ambient temperature. | |
uint16_t | irgrid3_get_subpage_number (uint16_t *frame_data) |
Function for getting sub page number. | |
float | irgrid3_get_vdd (irgrid3_t *ctx, uint16_t *frame_data) |
Function for getting Vdd. | |
void | irgrid3_calculate_temp_obj (irgrid3_t *ctx, uint16_t *frame_data, float tr_data, float *px_matrix) |
Function for calculating temperature objects. | |
void | irgrid3_get_image (irgrid3_t *ctx, uint16_t *frame_data, float *px_matrix) |
Function for getting Image. | |
API for configuring and manipulating IR Grid 3 Click driver.
Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.
void irgrid3_calculate_temp_obj | ( | irgrid3_t * | ctx, |
uint16_t * | frame_data, | ||
float | tr_data, | ||
float * | px_matrix ) |
Function for calculating temperature objects.
This function is used for calculating temperature objects.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[in] | frame_data | : Frame Data |
[in] | tr_data | : Real temperature |
[out] | px_matrix | : Buffer in which the result of the calculation will be stored |
void irgrid3_cfg_setup | ( | irgrid3_cfg_t * | cfg | ) |
IR Grid 3 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See irgrid3_cfg_t object definition for detailed explanation. |
void irgrid3_default_cfg | ( | irgrid3_t * | ctx | ) |
IR Grid 3 default configuration function.
This function executes a default configuration of IR Grid 2 click board.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
See #err_t definition for detailed explanation.
uint8_t irgrid3_extract_parameters | ( | irgrid3_t * | ctx, |
uint16_t * | eeprom_data ) |
Parameters storage function.
This function stpores data from the EEPROM.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[out] | eeprom_data | : EEPROM buffer. |
void irgrid3_generic_read | ( | irgrid3_t * | ctx, |
uint16_t | reg, | ||
uint8_t * | rx_buf, | ||
uint16_t | rx_len ) |
IR Grid 3 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 irgrid3_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. |
See #err_t definition for detailed explanation.
void irgrid3_generic_write | ( | irgrid3_t * | ctx, |
uint16_t | reg, | ||
uint8_t * | data_buf, | ||
uint16_t | len ) |
IR Grid 3 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 irgrid3_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. |
See #err_t definition for detailed explanation.
uint16_t irgrid3_get_current_mode | ( | irgrid3_t * | ctx | ) |
Function for getting current mode.
This function is used for getting current mode.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
uint16_t irgrid3_get_current_res | ( | irgrid3_t * | ctx | ) |
Function for getting current resolution.
This function is used for getting current resolution.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
uint16_t irgrid3_get_frame_data | ( | irgrid3_t * | ctx, |
uint16_t * | frame_data ) |
Function for getting frame data.
This function is used for getting frame data.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[out] | frame_data | : Buffer in which the data will be stored |
void irgrid3_get_image | ( | irgrid3_t * | ctx, |
uint16_t * | frame_data, | ||
float * | px_matrix ) |
Function for getting Image.
This function is used for getting Image.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[in] | frame_data | : Frame Data |
[out] | px_matrix | : Buffer in which the result of the calculation will be stored |
void irgrid3_get_pixel_temperature | ( | irgrid3_t * | ctx, |
float * | temp_ambient, | ||
float * | pixel_temp ) |
Function for getting pixels temperature.
This function is used for getting pixels temperature.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[in] | temp_ambient | : Ambient temperature data. |
[out] | pixel_temp | : Output matrix pixels. |
uint16_t irgrid3_get_refresh_rate | ( | irgrid3_t * | ctx | ) |
Function for getting current refresh Rate.
This function is used for getting current refresh Rate.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
uint16_t irgrid3_get_subpage_number | ( | uint16_t * | frame_data | ) |
Function for getting sub page number.
This function is used for getting sub page number.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[in] | frame_data | : Frame Data. |
float irgrid3_get_temp_ambient | ( | irgrid3_t * | ctx, |
uint16_t * | frame_data ) |
Function for getting Ambient temperature.
This function is used for getting ambient temperature.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[in] | frame_data | : Frame Data |
float irgrid3_get_vdd | ( | irgrid3_t * | ctx, |
uint16_t * | frame_data ) |
Function for getting Vdd.
This function is used for getting Vdd.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[in] | frame_data | : Frame Data |
err_t irgrid3_init | ( | irgrid3_t * | ctx, |
irgrid3_cfg_t * | cfg ) |
IR Grid 3 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See irgrid3_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void irgrid3_read_eeprom | ( | irgrid3_t * | ctx, |
uint16_t * | eeprom_data ) |
Function for reading EEPROM.
This function reads data from the EEPROM.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[out] | eeprom_data | : Buffer in which the data will be stored. |
void irgrid3_set_chess_mode | ( | irgrid3_t * | ctx | ) |
Function for setting chess mode.
This function is used for setting chess mode.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
void irgrid3_set_interleaved_mode | ( | irgrid3_t * | ctx | ) |
Function for setting interleaved mode.
This function is used for interleaved mode.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
void irgrid3_set_refresh_rate | ( | irgrid3_t * | ctx, |
uint8_t | refresh_rate ) |
Function for setting refresh rate.
This function sets settings for refresh rate.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[in] | refresh_rate | : the refresh Rate data that will be set. |
void irgrid3_set_resolution | ( | irgrid3_t * | ctx, |
uint8_t | resolution ) |
Function for setting resolution.
This function is used for setting resolution.
[in] | ctx | : Click context object. See irgrid3_t object definition for detailed explanation. |
[in] | resolution | : The resolution that will be set. |