tempalarm  2.1.0.0
Main Page

Temp Alarm Click

Temp Alarm Click is a compact add-on board that adds temperature alarm functionalities to your project. This board features the PTMP4718, a high-accuracy remote and local temperature sensor from Texas Instruments. This temperature sensor has pin-programmable alert thresholds, with a fault queue for debounce.

Click Product page


Click library

  • Author : Stefan Ilic
  • Date : Aug 2023.
  • Type : I2C type

Software Support

We provide a library for the Temp Alarm Click as well as a demo application (example), developed using MikroElektronika compilers. The demo can run on all the main MikroElektronika development boards.

Package can be downloaded/installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Library Description

This library contains API for Temp Alarm Click driver.

Standard key functions :

Example key functions :

  • tempalarm_write_reg Temp Alarm register writing function.
    err_t tempalarm_write_reg ( tempalarm_t *ctx, uint8_t reg, uint8_t data_in );
  • tempalarm_read_remote_temperature Temp Alarm remote sensor read temperature function.
    err_t tempalarm_read_remote_temperature ( tempalarm_t *ctx, float *temperature );
  • tempalarm_set_alarm_high_limit Temp Alarm remote sensor set limit high temperature function.
    err_t tempalarm_set_alarm_high_limit ( tempalarm_t *ctx, float max_temperature );

Example Description

This example demonstrates the use of Temp Alarm Click board by reading and displaying

the temperature measurements and monitoring it.

The demo application is composed of two sections :

Application Init

Initializes the driver and sets the Local sensor critical temperature at 30 degC with hysteresis of 1 degC,

and Remote sensor alarm temperature at 30 degC.

void application_init ( void )
{
log_cfg_t log_cfg;
tempalarm_cfg_t tempalarm_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
tempalarm_cfg_setup( &tempalarm_cfg );
TEMPALARM_MAP_MIKROBUS( tempalarm_cfg, MIKROBUS_1 );
if ( I2C_MASTER_ERROR == tempalarm_init( &tempalarm, &tempalarm_cfg ) )
{
log_error( &logger, " Communication init." );
for ( ; ; );
}
if ( TEMPALARM_ERROR == tempalarm_default_cfg ( &tempalarm ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Reads the temperature measurement in degrees Celsius and displays the results on the USB UART

approximately once per second. Monitoring alarm and critical state.

void application_task ( void )
{
uint8_t flag_data = 0;
int8_t local_temp = 0;
float remote_temp = 0;
tempalarm_get_alarms( &tempalarm, &flag_data );
{
tempalarm_read_temperature( &tempalarm, &local_temp );
tempalarm_read_remote_temp( &tempalarm, &remote_temp );
log_printf( &logger, " Local temperature : %d degC \r\n" , ( int16_t ) local_temp );
log_printf( &logger, " Remote temperature : %.3f degC \r\n" , remote_temp );
log_printf( &logger, " -------------------------------- \r\n" );
}
{
log_printf( &logger, " Alarm is on, remote temperature \r\n" );
log_printf( &logger, " is higher then 30 degC \r\n" );
log_printf( &logger, " -------------------------------- \r\n" );
}
{
log_printf( &logger, " Alarm is on, local temperature \r\n" );
log_printf( &logger, " is higher then 30 degC \r\n" );
log_printf( &logger, " -------------------------------- \r\n" );
}
Delay_ms ( 1000 );
}

The full application code, and ready to use projects can be installed directly from NECTO Studio Package Manager(recommended way), downloaded from our LibStock™ or found on Mikroe github account.

Other Mikroe Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.TempAlarm

Additional notes and informations

Depending on the development board you are using, you may need USB UART Click, USB UART 2 Click or RS232 Click to connect to your PC, for development systems with no UART to USB interface available on the board. UART terminal is available in all MikroElektronika compilers.


tempalarm_write_reg
err_t tempalarm_write_reg(tempalarm_t *ctx, uint8_t reg, uint8_t data_in)
Temp Alarm register writing function.
TEMPALARM_MAP_MIKROBUS
#define TEMPALARM_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: tempalarm.h:219
tempalarm_cfg_t
Temp Alarm Click configuration object.
Definition: tempalarm.h:251
tempalarm_init
err_t tempalarm_init(tempalarm_t *ctx, tempalarm_cfg_t *cfg)
Temp Alarm initialization function.
TEMPALARM_PIN_STATE_LOW
#define TEMPALARM_PIN_STATE_LOW
Definition: tempalarm.h:181
tempalarm_read_temperature
err_t tempalarm_read_temperature(tempalarm_t *ctx, int8_t *temperature)
Temp Alarm local sensor read temperature function.
tempalarm_set_alarm_high_limit
err_t tempalarm_set_alarm_high_limit(tempalarm_t *ctx, float max_temperature)
Temp Alarm remote sensor set limit high temperature function.
application_task
void application_task(void)
Definition: main.c:66
tempalarm_get_tcr_pin
uint8_t tempalarm_get_tcr_pin(tempalarm_t *ctx)
Temp Alarm get critical temperature alert pin state function.
tempalarm_default_cfg
err_t tempalarm_default_cfg(tempalarm_t *ctx)
Temp Alarm default configuration function.
tempalarm_t
Temp Alarm Click context object.
Definition: tempalarm.h:233
TEMPALARM_ERROR
@ TEMPALARM_ERROR
Definition: tempalarm.h:270
tempalarm_read_remote_temp
err_t tempalarm_read_remote_temp(tempalarm_t *ctx, float *temperature)
Temp Alarm remote sensor read temperature function.
application_init
void application_init(void)
Definition: main.c:30
tempalarm_get_alarms
err_t tempalarm_get_alarms(tempalarm_t *ctx, uint8_t *alarms)
Temp Alarm read alarms state function.
tempalarm_cfg_setup
void tempalarm_cfg_setup(tempalarm_cfg_t *cfg)
Temp Alarm configuration object setup function.
tempalarm_get_alr_pin
uint8_t tempalarm_get_alr_pin(tempalarm_t *ctx)
Temp Alarm get alarm pin state function.
TEMPALARM_ADC_BUSY_MASK
#define TEMPALARM_ADC_BUSY_MASK
Temp Alarm flags setting.
Definition: tempalarm.h:130