shtan  2.0.0.0
Functions
Public function

Functions

void shtan_cfg_setup (shtan_cfg_t *cfg)
 Config Object Initialization function. More...
 
SHTAN_RETVAL shtan_init (shtan_t *ctx, shtan_cfg_t *cfg)
 Initialization function. More...
 
void shtan_default_cfg (shtan_t *ctx)
 Click Default Configuration function. More...
 
shtan_data_t shtan_generic_read (shtan_t *ctx)
 Generic read function. More...
 
void shtan_set_mode (shtan_t *ctx, uint8_t adc_mode)
 Set ADC mode function. More...
 
void shtan_reset (shtan_t *ctx)
 Hardware reset function. More...
 

Detailed Description

Function Documentation

◆ shtan_cfg_setup()

void shtan_cfg_setup ( shtan_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ shtan_default_cfg()

void shtan_default_cfg ( shtan_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

This function executes default configuration for SHT AN click.

◆ shtan_generic_read()

shtan_data_t shtan_generic_read ( shtan_t ctx)

Generic read function.

Parameters
ctxClick object.
Returns
ADC data

This function read ADC data.

◆ shtan_init()

SHTAN_RETVAL shtan_init ( shtan_t ctx,
shtan_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

This function initializes all necessary pins and peripherals used for this click.

◆ shtan_reset()

void shtan_reset ( shtan_t ctx)

Hardware reset function.

Parameters
ctxClick object.

Function hardware reset the SHT3x-ARP Humidity and Temperature Sensor IC on SHT AN click by cleared to '0' state of the RST pin, wait the 100 ms, sets to '1' state of the RST pin.

Note
Delay is 100 ms.

◆ shtan_set_mode()

void shtan_set_mode ( shtan_t ctx,
uint8_t  adc_mode 
)

Set ADC mode function.

Parameters
ctxClick object.
adc_mode8-bit ADC mode
  • 0 ( SHTAN_SET_ADC_MODE_TEMP ) - Set signal output, ADC mode temperature.
  • 1 ( SHTAN_SET_ADC_MODE_HUM ) - Set signal output, ADC mode humidity.

Function sets signal output ADC mode of the SHT3x-ARP Humidity and Temperature Sensor IC on SHT AN Click.