|
temphum13 2.2.0
|
Functions | |
| void | temphum13_cfg_setup (temphum13_cfg_t *cfg) |
| Config Object Initialization function. | |
| TEMPHUM13_RETVAL | temphum13_init (temphum13_t *ctx, temphum13_cfg_t *cfg) |
| Initialization function. | |
| void | temphum13_default_cfg (temphum13_t *ctx) |
| Click Default Configuration function. | |
| void | temphum13_generic_write (temphum13_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len) |
| Generic write function. | |
| void | temphum13_generic_read (temphum13_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len) |
| Generic read function. | |
| float | temphum13_get_temperature (temphum13_t *ctx) |
| Get temperature value. | |
| float | temphum13_get_humidity (temphum13_t *ctx) |
| Get humidity value. | |
| uint8_t | temphum13_get_user_register (temphum13_t *ctx) |
| Get user register value. | |
| void | temphum13_set_user_register (temphum13_t *ctx, uint8_t register_content) |
| Set user register. | |
| void | temphum13_soft_reset (temphum13_t *ctx) |
| Software reset. | |
| uint8_t | temphum13_enable_heater (temphum13_t *ctx, uint8_t enable_heater) |
| Enable heater. | |
| uint8_t | temphum13_change_resolution (temphum13_t *ctx, uint8_t meas_res) |
| Change measurement resolution. | |
| uint8_t | temphum13_disable_otp_reload (temphum13_t *ctx, uint8_t disable_otp_rel) |
| Disable OTP. | |
| void temphum13_cfg_setup | ( | temphum13_cfg_t * | cfg | ) |
Config Object Initialization function.
| cfg | Click configuration structure. |
@description This function initializes Click configuration structure to init state.
| uint8_t temphum13_change_resolution | ( | temphum13_t * | ctx, |
| uint8_t | meas_res ) |
Change measurement resolution.
| ctx | Click object. |
| meas_res | Resolution to be set. |
@description This function sets Click measurement resolution.
meas_res = 0x00 => resolution is 12-bit, 0x01 => resolution is 8-bit
0x80 => resolution is 10-bit, 0x81 => resolution is 11-bit
| void temphum13_default_cfg | ( | temphum13_t * | ctx | ) |
Click Default Configuration function.
| ctx | Click object. |
@description This function executes default configuration ( delay 0,5 secs - soft reset - delay 0,5 secs ) for TempHum13 Click.
| uint8_t temphum13_disable_otp_reload | ( | temphum13_t * | ctx, |
| uint8_t | disable_otp_rel ) |
Disable OTP.
| ctx | Click object. |
| disable_otp_rel | OTP reload boolean. |
@description This function disables or enables OTP.
If disable_otp_rel = 1 => OTP disabled, 0 => OTP enabled.
| uint8_t temphum13_enable_heater | ( | temphum13_t * | ctx, |
| uint8_t | enable_heater ) |
Enable heater.
| ctx | Click object. |
| enable_heater | Heater enable/disable switch. |
@description This function enables or disables heater.
enable_heater = 0 means disable heater; enable_heater = 1 means enable heater.
| void temphum13_generic_read | ( | temphum13_t * | ctx, |
| uint8_t | reg, | ||
| uint8_t * | data_buf, | ||
| uint8_t | len ) |
Generic read function.
| ctx | Click object. |
| reg | Register address. |
| data_buf | Output data buf |
| len | Number of the bytes to be read |
@description This function reads data from the desired register.
| void temphum13_generic_write | ( | temphum13_t * | ctx, |
| uint8_t | reg, | ||
| uint8_t * | data_buf, | ||
| uint8_t | len ) |
Generic write function.
| ctx | Click object. |
| reg | Register address. |
| data_buf | Data buf to be written. |
| len | Number of the bytes in data buf. |
@description This function writes data to the desired register.
| float temphum13_get_humidity | ( | temphum13_t * | ctx | ) |
Get humidity value.
| ctx | Click object. |
@description This function calculates humidity.
| float temphum13_get_temperature | ( | temphum13_t * | ctx | ) |
Get temperature value.
| ctx | Click object. |
@description This function calculates current temperature.
| uint8_t temphum13_get_user_register | ( | temphum13_t * | ctx | ) |
Get user register value.
| ctx | Click object. |
@description This function gets user register value
| TEMPHUM13_RETVAL temphum13_init | ( | temphum13_t * | ctx, |
| temphum13_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 temphum13_set_user_register | ( | temphum13_t * | ctx, |
| uint8_t | register_content ) |
Set user register.
| ctx | Click object |
| register_content | Desired register content to be set |
@description This function sets user register to desired value.
| void temphum13_soft_reset | ( | temphum13_t * | ctx | ) |
Software reset.
| ctx | Click object. |
@description This function performs Click soft reset.