sht_click.h File Reference

mikrosdk interface More...

#include <stdint.h>

Include dependency graph for sht_click.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	SHT_USE_INTERRUPT   0
#define	SHT3X_MAXDLEN   6
#define	SHT3X_ADDLEN   3
#define	MIKROSDK_SHT_ON   1
#define	MIKROSDK_SHT_OFF   0
#define	SHT_CMD_WR_LO_SET   0x6100 /* write low limits set */
#define	SHT_CMD_WR_LO_CLR   0x610B /* write low limits clear */
#define	SHT_CMD_WR_HI_SET   0x611D /* write high limits set */
#define	SHT_CMD_WR_HI_CLR   0x6116 /* write high limits clear */
#define	SHT_CMD_RD_LO_SET   0xE102 /* write low limits set */
#define	SHT_CMD_RD_LO_CLR   0xE109 /* write low limits clear */
#define	SHT_CMD_RD_HI_SET   0xE11F /* write high limits set */
#define	SHT_CMD_RD_HI_CLR   0xE114 /* write high limits clear */
#define	SHT_T_COMMS   2 /* 2 ms between communication exchange */
#define	SHT_LIMIT_H_HI   5500 /* humidity high */
#define	SHT_LIMIT_H_LO   2000 /* humidity low */
#define	SHT_LIMIT_T_HI   6000 /* temperature high */
#define	SHT_LIMIT_T_LO   -1000 /* temperature low */
#define	SHT_LIMIT_H_HYS   200 /* humidity hysteresis for clearing alarms */
#define	SHT_LIMIT_T_HYS   200 /* temperature hysteresis for clearing alarms */

Enumerations
enum	sht_alarm_state { SHT_ALARM_TRIGGERED = 2 , SHT_ALARM_CLEARED = 1 , SHT_ALARM_NOALARM = 0 }
enum	sht_status { SHT_ST_OK = 0 , SHT_ST_ALARM_CLEARED = 1 , SHT_ST_ALARM_TRIGGERED = 2 , SHT_ST_FAIL = 3 }

Functions
uint8_t	MIKROSDK_SHT_start_pm (void)
uint8_t	MIKROSDK_SHT_stop_pm (void)
uint8_t	MIKROSDK_SHT_get_temp_hum_pm (int16_t *humidity, int16_t *temperature)
uint8_t	MIKROSDK_SHT_get_temp_hum_ss (int16_t *humidity, int16_t *temperature)
uint8_t	MIKROSDK_SHT_heater_control (uint8_t state)
uint8_t	MIKROSDK_SHT_read_status (uint16_t *statusregister)
uint8_t	MIKROSDK_SHT_clear_status (void)
void	MIKROSDK_SHT_hard_reset (void)
uint8_t	MIKROSDK_SHT_soft_reset (void)
uint8_t	MIKROSDK_SHT_set_hi_alert_limits (int16_t h_set, int16_t h_clr, int16_t t_set, int16_t t_clr)
uint8_t	MIKROSDK_SHT_set_lo_alert_limits (int16_t h_set, int16_t h_clr, int16_t t_set, int16_t t_clr)
uint8_t	MIKROSDK_SHT_get_hi_alert_limits (int16_t *h_set, int16_t *h_clr, int16_t *t_set, int16_t *t_clr)
uint8_t	MIKROSDK_SHT_get_lo_alert_limits (int16_t *h_set, int16_t *h_clr, int16_t *t_set, int16_t *t_clr)
void	MIKROSDK_SHT_config (void)
void	MIKROSDK_SHT_pin_mapping (uint8_t reset, uint8_t alarm)
uint8_t	MIKROSDK_SHT_get_alarm (void)
uint8_t	MIKROSDK_SHT_alarm_triggered (void)
uint8_t	MIKROSDK_SHT_Initialise (void)
uint8_t	MIKROSDK_SHT_Reinitialise (void)
uint8_t	MIKROSDK_SHT_Acquire (int16_t *humidity, int16_t *temperature)

Detailed Description

mikrosdk interface

Macro Definition Documentation

MIKROSDK_SHT_OFF

#define MIKROSDK_SHT_OFF   0

MIKROSDK_SHT_ON

#define MIKROSDK_SHT_ON   1

SHT3X_ADDLEN

#define SHT3X_ADDLEN   3

SHT3X_MAXDLEN

#define SHT3X_MAXDLEN   6

SHT_CMD_RD_HI_CLR

#define SHT_CMD_RD_HI_CLR   0xE114 /* write high limits clear */

SHT_CMD_RD_HI_SET

#define SHT_CMD_RD_HI_SET   0xE11F /* write high limits set */

SHT_CMD_RD_LO_CLR

#define SHT_CMD_RD_LO_CLR   0xE109 /* write low limits clear */

SHT_CMD_RD_LO_SET

#define SHT_CMD_RD_LO_SET   0xE102 /* write low limits set */

SHT_CMD_WR_HI_CLR

#define SHT_CMD_WR_HI_CLR   0x6116 /* write high limits clear */

SHT_CMD_WR_HI_SET

#define SHT_CMD_WR_HI_SET   0x611D /* write high limits set */

SHT_CMD_WR_LO_CLR

#define SHT_CMD_WR_LO_CLR   0x610B /* write low limits clear */

SHT_CMD_WR_LO_SET

#define SHT_CMD_WR_LO_SET   0x6100 /* write low limits set */

SHT_LIMIT_H_HI

#define SHT_LIMIT_H_HI   5500 /* humidity high */

SHT_LIMIT_H_HYS

#define SHT_LIMIT_H_HYS   200 /* humidity hysteresis for clearing alarms */

SHT_LIMIT_H_LO

#define SHT_LIMIT_H_LO   2000 /* humidity low */

SHT_LIMIT_T_HI

#define SHT_LIMIT_T_HI   6000 /* temperature high */

SHT_LIMIT_T_HYS

#define SHT_LIMIT_T_HYS   200 /* temperature hysteresis for clearing alarms */

SHT_LIMIT_T_LO

#define SHT_LIMIT_T_LO   -1000 /* temperature low */

SHT_T_COMMS

#define SHT_T_COMMS   2 /* 2 ms between communication exchange */

SHT_USE_INTERRUPT

#define SHT_USE_INTERRUPT   0

Enumeration Type Documentation

sht_alarm_state

enum sht_alarm_state

Enumerator
SHT_ALARM_TRIGGERED
SHT_ALARM_CLEARED
SHT_ALARM_NOALARM

sht_status

enum sht_status

Enumerator
SHT_ST_OK
SHT_ST_ALARM_CLEARED
SHT_ST_ALARM_TRIGGERED
SHT_ST_FAIL

Function Documentation

MIKROSDK_SHT_Acquire()

uint8_t MIKROSDK_SHT_Acquire	(	int16_t *	humidity,
		int16_t *	temperature
	)

MIKROSDK_SHT_alarm_triggered()

uint8_t MIKROSDK_SHT_alarm_triggered

(

void

)

MIKROSDK_SHT_clear_status()

uint8_t MIKROSDK_SHT_clear_status

(

void

)

MIKROSDK_SHT_config()

void MIKROSDK_SHT_config

(

void

)

MIKROSDK_SHT_get_alarm()

uint8_t MIKROSDK_SHT_get_alarm

(

void

)

MIKROSDK_SHT_get_hi_alert_limits()

uint8_t MIKROSDK_SHT_get_hi_alert_limits	(	int16_t *	h_set,
		int16_t *	h_clr,
		int16_t *	t_set,
		int16_t *	t_clr
	)

MIKROSDK_SHT_get_lo_alert_limits()

uint8_t MIKROSDK_SHT_get_lo_alert_limits	(	int16_t *	h_set,
		int16_t *	h_clr,
		int16_t *	t_set,
		int16_t *	t_clr
	)

MIKROSDK_SHT_get_temp_hum_pm()

uint8_t MIKROSDK_SHT_get_temp_hum_pm	(	int16_t *	humidity,
		int16_t *	temperature
	)

MIKROSDK_SHT_get_temp_hum_ss()

uint8_t MIKROSDK_SHT_get_temp_hum_ss	(	int16_t *	humidity,
		int16_t *	temperature
	)

MIKROSDK_SHT_hard_reset()

void MIKROSDK_SHT_hard_reset

(

void

)

MIKROSDK_SHT_heater_control()

uint8_t MIKROSDK_SHT_heater_control

(

uint8_t

state

)

MIKROSDK_SHT_Initialise()

uint8_t MIKROSDK_SHT_Initialise

(

void

)

MIKROSDK_SHT_pin_mapping()

void MIKROSDK_SHT_pin_mapping	(	uint8_t	reset,
		uint8_t	alarm
	)

MIKROSDK_SHT_read_status()

uint8_t MIKROSDK_SHT_read_status

(

uint16_t *

statusregister

)

MIKROSDK_SHT_Reinitialise()

uint8_t MIKROSDK_SHT_Reinitialise

(

void

)

MIKROSDK_SHT_set_hi_alert_limits()

uint8_t MIKROSDK_SHT_set_hi_alert_limits	(	int16_t	h_set,
		int16_t	h_clr,
		int16_t	t_set,
		int16_t	t_clr
	)

MIKROSDK_SHT_set_lo_alert_limits()

uint8_t MIKROSDK_SHT_set_lo_alert_limits	(	int16_t	h_set,
		int16_t	h_clr,
		int16_t	t_set,
		int16_t	t_clr
	)

MIKROSDK_SHT_soft_reset()

uint8_t MIKROSDK_SHT_soft_reset

(

void

)

MIKROSDK_SHT_start_pm()

uint8_t MIKROSDK_SHT_start_pm

(

void

)

MIKROSDK_SHT_stop_pm()

uint8_t MIKROSDK_SHT_stop_pm

(

void

)