temphum27 2.2.0
Loading...
Searching...
No Matches
temphum27.h File Reference

This file contains API for TempHum 27 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  temphum27_t
 TempHum 27 Click context object. More...
struct  temphum27_cfg_t
 TempHum 27 Click configuration object. More...

Macros

#define TEMPHUM27_CMD_HOLD_TEMP_MEAS   0xE3
 TempHum 27 commands list.
#define TEMPHUM27_CMD_NO_HOLD_TEMP_MEAS   0xF3
#define TEMPHUM27_CMD_HOLD_TEMP_HUM_MEAS   0xE5
#define TEMPHUM27_CMD_NO_HOLD_TEMP_HUM_MEAS   0xF5
#define TEMPHUM27_CMD_READ_REG   0xA7
#define TEMPHUM27_CMD_WRITE_REG   0xA6
#define TEMPHUM27_CMD_STOP_PERIODIC_MEAS   0x30
#define TEMPHUM27_CMD_READ_SENSOR_ID   0xD7
#define TEMPHUM27_REG_MEAS_RESOLUTION   0x00
 TempHum 27 registers list.
#define TEMPHUM27_REG_PERIODIC_CONFIG   0x02
#define TEMPHUM27_REG_ALERT_ENABLE   0x03
#define TEMPHUM27_REG_RST_THOLD_TEMP_H_LSB   0x05
#define TEMPHUM27_REG_RST_THOLD_TEMP_H_MSB   0x06
#define TEMPHUM27_REG_TRG_THOLD_TEMP_H_LSB   0x07
#define TEMPHUM27_REG_TRG_THOLD_TEMP_H_MSB   0x08
#define TEMPHUM27_REG_TRG_THOLD_TEMP_L_LSB   0x09
#define TEMPHUM27_REG_TRG_THOLD_TEMP_L_MSB   0x0A
#define TEMPHUM27_REG_RST_THOLD_TEMP_L_LSB   0x0B
#define TEMPHUM27_REG_RST_THOLD_TEMP_L_MSB   0x0C
#define TEMPHUM27_REG_RST_THOLD_HUM_H_LSB   0x0D
#define TEMPHUM27_REG_RST_THOLD_HUM_H_MSB   0x0E
#define TEMPHUM27_REG_TRG_THOLD_HUM_H_LSB   0x0F
#define TEMPHUM27_REG_TRG_THOLD_HUM_H_MSB   0x10
#define TEMPHUM27_REG_TRG_THOLD_HUM_L_LSB   0x11
#define TEMPHUM27_REG_TRG_THOLD_HUM_L_MSB   0x12
#define TEMPHUM27_REG_RST_THOLD_HUM_L_LSB   0x13
#define TEMPHUM27_REG_RST_THOLD_HUM_L_MSB   0x14
#define TEMPHUM27_PERIODIC_CONFIG_ACTIVATE   0x80
 TempHum 27 periodic config register setting.
#define TEMPHUM27_PERIODIC_CONFIG_FREQ_0_5S   0x00
#define TEMPHUM27_PERIODIC_CONFIG_FREQ_1S   0x10
#define TEMPHUM27_PERIODIC_CONFIG_FREQ_2_5S   0x20
#define TEMPHUM27_PERIODIC_CONFIG_FREQ_MASK   0x30
#define TEMPHUM27_PERIODIC_CONFIG_ALR_POL_LOW   0x00
#define TEMPHUM27_PERIODIC_CONFIG_ALR_POL_HIGH   0x01
#define TEMPHUM27_PERIODIC_CONFIG_ALR_POL_MASK   0x01
#define TEMPHUM27_PERIODIC_FREQ_0_5S   0
 TempHum 27 periodic measurement frequency setting.
#define TEMPHUM27_PERIODIC_FREQ_1S   1
#define TEMPHUM27_PERIODIC_FREQ_2_5S   2
#define TEMPHUM27_DATA_RESOLUTION   0x3FFF
 TempHum 27 measurements conversion setting.
#define TEMPHUM27_TEMP_DATA_RES   165
#define TEMPHUM27_TEMP_DATA_OFFSET   40
#define TEMPHUM27_HUM_DATA_RES   100
#define TEMPHUM27_DEVICE_ADDRESS   0x54
 TempHum 27 device address setting.
#define TEMPHUM27_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.

Enumerations

enum  temphum27_return_value_t { TEMPHUM27_OK = 0 , TEMPHUM27_ERROR = -1 }
 TempHum 27 Click return value data. More...

Functions

void temphum27_cfg_setup (temphum27_cfg_t *cfg)
 TempHum 27 configuration object setup function.
err_t temphum27_init (temphum27_t *ctx, temphum27_cfg_t *cfg)
 TempHum 27 initialization function.
err_t temphum27_write_reg (temphum27_t *ctx, uint8_t reg, uint8_t data_in)
 TempHum 27 write register function.
err_t temphum27_read_reg (temphum27_t *ctx, uint8_t reg, uint8_t *data_out)
 TempHum 27 read register function.
err_t temphum27_read_data_hold (temphum27_t *ctx, float *temp, float *hum)
 TempHum 27 read data (hold mode) function.
err_t temphum27_read_data_no_hold (temphum27_t *ctx, float *temp, float *hum)
 TempHum 27 read data (no hold mode) function.
err_t temphum27_start_periodic_meas (temphum27_t *ctx, uint8_t freq)
 TempHum 27 start periodic measurement function.
err_t temphum27_stop_periodic_meas (temphum27_t *ctx)
 TempHum 27 stop periodic measurement function.
err_t temphum27_read_data_periodic (temphum27_t *ctx, float *temp, float *hum)
 TempHum 27 read data in periodic mode function.
err_t temphum27_read_data_periodic_al (temphum27_t *ctx, float *temp, float *hum, uint8_t *alert)
 TempHum 27 read data and alert in periodic mode function.
err_t temphum27_read_sensor_id (temphum27_t *ctx, uint32_t *sensor_id)
 TempHum 27 read sensor ID function.
void temphum27_enable_device (temphum27_t *ctx)
 TempHum 27 enable device function.
void temphum27_disable_device (temphum27_t *ctx)
 TempHum 27 disable device function.
void temphum27_reset_device (temphum27_t *ctx)
 TempHum 27 reset device function.
uint8_t temphum27_get_alert_pin (temphum27_t *ctx)
 TempHum 27 get alert pin function.

Detailed Description

This file contains API for TempHum 27 Click Driver.

Enumeration Type Documentation

◆ temphum27_return_value_t

TempHum 27 Click return value data.

Predefined enum values for driver return values.

Enumerator
TEMPHUM27_OK 
TEMPHUM27_ERROR