tempiso  2.1.0.0
Data Structures | Macros | Enumerations | Functions
tempiso.h File Reference

This file contains API for Temp ISO Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_analog_in.h"

Go to the source code of this file.

Data Structures

struct  tempiso_t
 Temp ISO Click context object. More...
 
struct  tempiso_cfg_t
 Temp ISO Click configuration object. More...
 

Macros

#define TEMPISO_NUM_CONVERSIONS   100
 Temp ISO default ADC samples number for averaging. More...
 
#define TEMPISO_VREF_3V3   3.3
 Temp ISO ADC setting. More...
 
#define TEMPISO_VREF_5V   5.0
 
#define TEMPISO_TIMEOUT_MS   2000
 Temp ISO timeout setting. More...
 
#define TEMPISO_TEMP_SENS_V_PER_C   0.01f
 Temp ISO temperature calculation setting. More...
 
#define TEMPISO_TEMP_ZERO_OFFSET_V   0.5f
 
#define TEMPISO_MAP_MIKROBUS(cfg, mikrobus)    cfg.an = MIKROBUS( mikrobus, MIKROBUS_AN );
 MikroBUS pin mapping. More...
 

Enumerations

enum  tempiso_return_value_t { TEMPISO_OK = 0, TEMPISO_ERROR = -1 }
 Temp ISO Click return value data. More...
 

Functions

void tempiso_cfg_setup (tempiso_cfg_t *cfg)
 Temp ISO configuration object setup function. More...
 
err_t tempiso_init (tempiso_t *ctx, tempiso_cfg_t *cfg)
 Temp ISO initialization function. More...
 
err_t tempiso_read_raw_adc (tempiso_t *ctx, uint16_t *raw_adc)
 Temp ISO read raw ADC value function. More...
 
err_t tempiso_read_voltage (tempiso_t *ctx, float *voltage)
 Temp ISO read voltage level function. More...
 
err_t tempiso_read_voltage_avg (tempiso_t *ctx, uint16_t num_conv, float *voltage_avg)
 Temp ISO read average voltage level function. More...
 
err_t tempiso_set_vref (tempiso_t *ctx, float vref)
 Temp ISO set vref function. More...
 
err_t tempiso_read_temperature (tempiso_t *ctx, float *data_out)
 Temp ISO read temperature function. More...
 

Detailed Description

This file contains API for Temp ISO Click Driver.

Enumeration Type Documentation

◆ tempiso_return_value_t

Temp ISO Click return value data.

Predefined enum values for driver return values.

Enumerator
TEMPISO_OK 
TEMPISO_ERROR