temphum14 2.0.0.0
|
API for configuring and manipulating Temp Hum 14 Click driver. More...
Modules | |
Temp Hum 14 Registers List | |
List of registers of Temp Hum 14 Click driver. | |
Temp Hum 14 MikroBUS Map | |
MikroBUS pin mapping of Temp Hum 14 Click driver. | |
Functions | |
void | temphum14_cfg_setup (temphum14_cfg_t *cfg) |
Temp Hum 14 configuration object setup function. More... | |
err_t | temphum14_init (temphum14_t *ctx, temphum14_cfg_t *cfg) |
Temp Hum 14 initialization function. More... | |
err_t | temphum14_generic_write (temphum14_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len) |
Temp Hum 14 I2C writing function. More... | |
err_t | temphum14_generic_read (temphum14_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len) |
Temp Hum 14 I2C reading function. More... | |
void | temphum14_hw_reset (temphum14_t *ctx) |
HW reset function. More... | |
void | temphum14_set_cmd (temphum14_t *ctx, uint8_t cmd) |
Send command function. More... | |
void | temphum14_set_conversion (temphum14_t *ctx, uint8_t hum_osr, uint8_t temp_osr) |
Set conversion function. More... | |
void | temphum14_read_t_and_rh (temphum14_t *ctx, uint8_t *p_rx_data) |
Read temperature and humidity data function. More... | |
void | temphum14_get_temp_and_hum (temphum14_t *ctx, float *temp, float *hum) |
Get temperature and humidity data function. More... | |
void | temphum14_read_rh (temphum14_t *ctx, uint8_t *p_rx_data) |
Read humidity data function. More... | |
float | temphum14_get_hum (temphum14_t *ctx) |
Get humidity data function. More... | |
void | temphum14_soft_reset (temphum14_t *ctx) |
Soft reset function. More... | |
void | temphum14_set_heater (temphum14_t *ctx, uint8_t en_heater) |
Enable heater function. More... | |
void | temphum14_get_diagnostic (temphum14_t *ctx, temphum14_diagn_t *diag_data) |
Get diagnostic status function. More... | |
uint32_t | temphum14_get_serial_number (temphum14_t *ctx) |
Get serial number function. More... | |
API for configuring and manipulating Temp Hum 14 Click driver.
void temphum14_cfg_setup | ( | temphum14_cfg_t * | cfg | ) |
Temp Hum 14 configuration object setup function.
This function initializes click configuration structure to initial values.
[out] | cfg | : Click configuration structure. See temphum14_cfg_t object definition for detailed explanation. |
err_t temphum14_generic_read | ( | temphum14_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | rx_buf, | ||
uint8_t | rx_len | ||
) |
Temp Hum 14 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 temphum14_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.err_t temphum14_generic_write | ( | temphum14_t * | ctx, |
uint8_t | reg, | ||
uint8_t * | tx_buf, | ||
uint8_t | tx_len | ||
) |
Temp Hum 14 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 temphum14_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.void temphum14_get_diagnostic | ( | temphum14_t * | ctx, |
temphum14_diagn_t * | diag_data | ||
) |
Get diagnostic status function.
The function get diagnostic status of the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
[out] | diag_data | : pointer to the memory location where structure where data be stored. |
float temphum14_get_hum | ( | temphum14_t * | ctx | ) |
Get humidity data function.
The function get humidity value of the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
uint32_t temphum14_get_serial_number | ( | temphum14_t * | ctx | ) |
Get serial number function.
The function get the serial number of the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
void temphum14_get_temp_and_hum | ( | temphum14_t * | ctx, |
float * | temp, | ||
float * | hum | ||
) |
Get temperature and humidity data function.
The function get temperature and humidity value of the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
[out] | temp | : Pointer to the memory location where temperature (degree Celsius) be stored. |
[out] | hum | : Pointer to the memory location where humidity (percentage) be stored. |
void temphum14_hw_reset | ( | temphum14_t * | ctx | ) |
HW reset function.
The function is performed by a hardware reset of the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
err_t temphum14_init | ( | temphum14_t * | ctx, |
temphum14_cfg_t * | cfg | ||
) |
Temp Hum 14 initialization function.
This function initializes all necessary pins and peripherals used for this click board.
[out] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
[in] | cfg | : Click configuration structure. See temphum14_cfg_t object definition for detailed explanation. |
0
- Success, -1
- Error.void temphum14_read_rh | ( | temphum14_t * | ctx, |
uint8_t * | p_rx_data | ||
) |
Read humidity data function.
The function read humidity data of the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
[out] | p_rx_data | : Pointer to the memory location where data be stored. |
void temphum14_read_t_and_rh | ( | temphum14_t * | ctx, |
uint8_t * | p_rx_data | ||
) |
Read temperature and humidity data function.
The function read temperature and humidity data of the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
[out] | p_rx_data | : Pointer to the memory location where data be stored. |
void temphum14_set_cmd | ( | temphum14_t * | ctx, |
uint8_t | cmd | ||
) |
Send command function.
The function send the desired command to the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
[in] | cmd | : 8-bit command. |
void temphum14_set_conversion | ( | temphum14_t * | ctx, |
uint8_t | hum_osr, | ||
uint8_t | temp_osr | ||
) |
Set conversion function.
The function set conversion a single temperature and humidity conversion and select data resolution to the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
[in] | hum_osr | : Humidity OSR See #temphum14_reg object definition for detailed explanation. |
[in] | temp_osr | : Temperature OSR See #temphum14_reg object definition for detailed explanation. |
void temphum14_set_heater | ( | temphum14_t * | ctx, |
uint8_t | en_heater | ||
) |
Enable heater function.
The function set heater status ( disable or enable ) of the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | en_heater | : Heater enable and disable. |
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |
void temphum14_soft_reset | ( | temphum14_t * | ctx | ) |
Soft reset function.
The function is performed by a software reset of the HTU31D RH/T SENSOR IC Digital Relative Humidity sensor with Temperature output on the Temp-Hum 14 click board.
[in] | ctx | : Click context object. See temphum14_t object definition for detailed explanation. |