thermo3_click.h File Reference

mikrosdk interface More...

#include <stdint.h>

Include dependency graph for thermo3_click.h:

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

Go to the source code of this file.

Macros
#define	THERMO3_USE_INTERRUPT   0
#define	TMP102_REGLEN   2
#define	TMP102_ADDLEN   2
#define	TMP102_I2C_ADDR   0x48
#define	MIKROSDK_THERMO3_REGADD_TEMP   0x00
#define	MIKROSDK_THERMO3_REGADD_CONFIG   0x01
#define	MIKROSDK_THERMO3_REGADD_TLOW   0x02
#define	MIKROSDK_THERMO3_REGADD_THIGH   0x03
#define	MIKROSDK_THERMO3_CONFIG_SHUTDOWN   0x01
#define	MIKROSDK_THERMO3_CONFIG_TMMODE   0x02
#define	MIKROSDK_THERMO3_CONFIG_ONESHOT   0x80
#define	MIKROSDK_THERMO3_DEFAULT_CONFIG_0   0x60
#define	MIKROSDK_THERMO3_DEFAULT_CONFIG_1   0xA0
#define	MIKROSDK_THERMO3_CONFIG
#define	MIKROSDK_THERMO3_TEMP_LIMIT_LOW   0x01B0 /* +27.0000 'C */
#define	MIKROSDK_THERMO3_TEMP_LIMIT_HIGH   0x01C8 /* +28.5000 'C */
#define	THERMO3_T_POWERUP   35 /* tmp102 35 ms power-up (conversion time max) */

Enumerations
enum	thermo3_alarm_state { THERMO3_ALARM_TRIGGERED = 0 , THERMO3_ALARM_CLEARED = 1 }
enum	thermo3_status { THERMO3_ST_OK = 0 , THERMO3_ST_ALARM_CLEARED = 1 , THERMO3_ST_ALARM_TRIGGERED = 2 , THERMO3_ST_FAIL = 3 }

Functions
uint8_t	MIKROSDK_THERMO3_get_config (uint16_t *configuration)
uint8_t	MIKROSDK_THERMO3_set_config (uint16_t config)
uint8_t	MIKROSDK_THERMO3_get_temperature_limits (uint16_t *temp_limit_low, uint16_t *temp_limit_high)
uint8_t	MIKROSDK_THERMO3_set_temperature_limits (uint16_t temp_limit_low, uint16_t temp_limit_high)
uint8_t	MIKROSDK_THERMO3_get_alarm (void)
uint8_t	MIKROSDK_THERMO3_alarm_triggered (void)
uint8_t	MIKROSDK_THERMO3_get_temperature (uint16_t *temperature)
void	MIKROSDK_THERMO3_pin_mapping (uint8_t alarm)
uint8_t	MIKROSDK_THERMO3_Initialise (void)
uint8_t	MIKROSDK_THERMO3_Reinitialise (void)
uint8_t	MIKROSDK_THERMO3_Acquire (uint16_t *temperature)

Detailed Description

mikrosdk interface

Macro Definition Documentation

MIKROSDK_THERMO3_CONFIG

#define MIKROSDK_THERMO3_CONFIG

Value:

    ((MIKROSDK_THERMO3_DEFAULT_CONFIG_1 << 8) + (MIKROSDK_THERMO3_DEFAULT_CONFIG_0 | MIKROSDK_THERMO3_CONFIG_ONESHOT | \
                                                 MIKROSDK_THERMO3_CONFIG_TMMODE | MIKROSDK_THERMO3_CONFIG_SHUTDOWN))

MIKROSDK_THERMO3_CONFIG_ONESHOT

#define MIKROSDK_THERMO3_CONFIG_ONESHOT   0x80

MIKROSDK_THERMO3_CONFIG_SHUTDOWN

#define MIKROSDK_THERMO3_CONFIG_SHUTDOWN   0x01

MIKROSDK_THERMO3_CONFIG_TMMODE

#define MIKROSDK_THERMO3_CONFIG_TMMODE   0x02

MIKROSDK_THERMO3_DEFAULT_CONFIG_0

#define MIKROSDK_THERMO3_DEFAULT_CONFIG_0   0x60

MIKROSDK_THERMO3_DEFAULT_CONFIG_1

#define MIKROSDK_THERMO3_DEFAULT_CONFIG_1   0xA0

MIKROSDK_THERMO3_REGADD_CONFIG

#define MIKROSDK_THERMO3_REGADD_CONFIG   0x01

MIKROSDK_THERMO3_REGADD_TEMP

#define MIKROSDK_THERMO3_REGADD_TEMP   0x00

MIKROSDK_THERMO3_REGADD_THIGH

#define MIKROSDK_THERMO3_REGADD_THIGH   0x03

MIKROSDK_THERMO3_REGADD_TLOW

#define MIKROSDK_THERMO3_REGADD_TLOW   0x02

MIKROSDK_THERMO3_TEMP_LIMIT_HIGH

#define MIKROSDK_THERMO3_TEMP_LIMIT_HIGH   0x01C8 /* +28.5000 'C */

MIKROSDK_THERMO3_TEMP_LIMIT_LOW

#define MIKROSDK_THERMO3_TEMP_LIMIT_LOW   0x01B0 /* +27.0000 'C */

THERMO3_T_POWERUP

#define THERMO3_T_POWERUP   35 /* tmp102 35 ms power-up (conversion time max) */

THERMO3_USE_INTERRUPT

#define THERMO3_USE_INTERRUPT   0

TMP102_ADDLEN

#define TMP102_ADDLEN   2

TMP102_I2C_ADDR

#define TMP102_I2C_ADDR   0x48

TMP102_REGLEN

#define TMP102_REGLEN   2

Enumeration Type Documentation

thermo3_alarm_state

enum thermo3_alarm_state

Enumerator
THERMO3_ALARM_TRIGGERED
THERMO3_ALARM_CLEARED

thermo3_status

enum thermo3_status

Enumerator
THERMO3_ST_OK
THERMO3_ST_ALARM_CLEARED
THERMO3_ST_ALARM_TRIGGERED
THERMO3_ST_FAIL

Function Documentation

MIKROSDK_THERMO3_Acquire()

uint8_t MIKROSDK_THERMO3_Acquire

(

uint16_t *

temperature

)

MIKROSDK_THERMO3_alarm_triggered()

uint8_t MIKROSDK_THERMO3_alarm_triggered

(

void

)

MIKROSDK_THERMO3_get_alarm()

uint8_t MIKROSDK_THERMO3_get_alarm

(

void

)

MIKROSDK_THERMO3_get_config()

uint8_t MIKROSDK_THERMO3_get_config

(

uint16_t *

configuration

)

MIKROSDK_THERMO3_get_temperature()

uint8_t MIKROSDK_THERMO3_get_temperature

(

uint16_t *

temperature

)

MIKROSDK_THERMO3_get_temperature_limits()

uint8_t MIKROSDK_THERMO3_get_temperature_limits	(	uint16_t *	temp_limit_low,
		uint16_t *	temp_limit_high
	)

MIKROSDK_THERMO3_Initialise()

uint8_t MIKROSDK_THERMO3_Initialise

(

void

)

MIKROSDK_THERMO3_pin_mapping()

void MIKROSDK_THERMO3_pin_mapping

(

uint8_t

alarm

)

MIKROSDK_THERMO3_Reinitialise()

uint8_t MIKROSDK_THERMO3_Reinitialise

(

void

)

MIKROSDK_THERMO3_set_config()

uint8_t MIKROSDK_THERMO3_set_config

(

uint16_t

config

)

MIKROSDK_THERMO3_set_temperature_limits()

uint8_t MIKROSDK_THERMO3_set_temperature_limits	(	uint16_t	temp_limit_low,
		uint16_t	temp_limit_high
	)