temphum17.h File Reference

This file contains API for Temp&Hum 17 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures
struct	temphum17_t
	Temp&Hum 17 Click context object. More...
struct	temphum17_cfg_t
	Temp&Hum 17 Click configuration object. More...

Macros
#define	TEMPHUM17_REG_HUMIDITY_SENSOR_RESOLUTION_READ   0x06
	Temp&Hum 17 description register.
#define	TEMPHUM17_REG_HUMIDITY_SENSOR_RESOLUTION_WRITE   0x46
#define	TEMPHUM17_REG_TEMPERATURE_SENSOR_RESOLUTION_READ   0x11
#define	TEMPHUM17_REG_TEMPERATURE_SENSOR_RESOLUTION_WRITE   0x51
#define	TEMPHUM17_REG_SENSOR_ID_UPPER_READ   0x1E
#define	TEMPHUM17_REG_SENSOR_ID_LOWER_READ   0x1F
#define	TEMPHUM17_CMD_ENTER_PROGRAMMING_MODE   0xA0
	Temp&Hum 17 description command.
#define	TEMPHUM17_CMD_DUMMY   0x00
#define	TEMPHUM17_CMD_ENTER_MEASUREMENTS_MODE   0x80
#define	TEMPHUM17_STATUS_VALID_DATA   0x00
	Temp&Hum 17 description status bits.
#define	TEMPHUM17_STATUS_STALE_DATA   0x01
#define	TEMPHUM17_RESOLUTION_8_BITS   0x00
	Temp&Hum 17 description setting.
#define	TEMPHUM17_RESOLUTION_10_BITS   0x01
#define	TEMPHUM17_RESOLUTION_12_BITS   0x02
#define	TEMPHUM17_RESOLUTION_14_BITS   0x03
#define	TEMPHUM17_SET_DEV_ADDR   0x44
	Temp&Hum 17 device address setting.
#define	TEMPHUM17_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	temphum17_return_value_t { TEMPHUM17_OK = 0 , TEMPHUM17_ERROR = -1 }
	Temp&Hum 17 Click return value data. More...

Functions
void	temphum17_cfg_setup (temphum17_cfg_t *cfg)
	Temp&Hum 17 configuration object setup function.
err_t	temphum17_init (temphum17_t *ctx, temphum17_cfg_t *cfg)
	Temp&Hum 17 initialization function.
err_t	temphum17_default_cfg (temphum17_t *ctx)
	Temp&Hum 17 default configuration function.
err_t	temphum17_generic_write (temphum17_t *ctx, uint8_t reg, uint8_t *tx_buf, uint8_t tx_len)
	Temp&Hum 17 I2C writing function.
err_t	temphum17_generic_read (temphum17_t *ctx, uint8_t reg, uint8_t *rx_buf, uint8_t rx_len)
	Temp&Hum 17 I2C reading function.
err_t	temphum17_wake_up (temphum17_t *ctx)
	Temp&Hum 17 wake up function.
err_t	temphum17_get_raw_data (temphum17_t *ctx, uint8_t resolution, int16_t *temp, uint16_t *hum, uint8_t *status)
	Temp&Hum 17 get raw data function.
err_t	temphum17_get_temp_hum (temphum17_t *ctx, uint8_t resolution, float *temperature, float *humidity)
	Temp&Hum 17 get temperature and humidity function.
err_t	temphum17_enter_programming_mode (temphum17_t *ctx)
	Temp&Hum 17 enter programming mode function.
err_t	temphum17_enter_measurements_mode (temphum17_t *ctx)
	Temp&Hum 17 enter measurements mode function.
err_t	temphum17_set_relative_humidity_resolution (temphum17_t *ctx, uint8_t resolution)
	Temp&Hum 17 set relative humidity resolution function.
err_t	temphum17_set_temperature_resolution (temphum17_t *ctx, uint8_t resolution)
	Temp&Hum 17 set temperature resolution function.

Detailed Description

This file contains API for Temp&Hum 17 Click Driver.

Enumeration Type Documentation

temphum17_return_value_t

enum temphum17_return_value_t

Temp&Hum 17 Click return value data.

Predefined enum values for driver return values.

Enumerator
TEMPHUM17_OK
TEMPHUM17_ERROR