presence  2.0.0.0
Main Page

Presence click

Presence click is an infrared sensing Click boardâ„¢ which can be used for presence sensing, motion detection, and a remote overtemperature protection.

click Product page


Click library

  • Author : MikroE Team
  • Date : Jan 2020.
  • Type : I2C type

Software Support

We provide a library for the Presence 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 form compilers IDE(recommended way), or downloaded from our LibStock, or found on mikroE github account.

Library Description

This library contains API for Presence Click driver.

Standard key functions :

Example key functions :

Examples Description

This application enables usage of sensor for motion and presence sensing and measuring of object's and ambient temperature.

The demo application is composed of two sections :

Application Init

Initializes driver and performs the click default configuration.

void application_init ( void )
{
log_cfg_t log_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, "---- Application Init ----" );
// Click initialization.
PRESENCE_MAP_MIKROBUS( cfg, MIKROBUS_1 );
presence_init( &presence, &cfg );
if ( PRESENCE_ERROR == presence_default_cfg ( &presence ) )
{
log_error( &logger, " Default configuration." );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}

Application Task

Checks whether a new event (motion, presence or over-temperature) is detected.

If there's no event detected it reads the ambient and object temperature and displays the results on the USB UART.

void application_task ( void )
{
uint8_t int_status = 0;
uint8_t tp_presence = 0;
uint8_t tp_motion = 0;
float t_amb = 0;
float t_obj = 0;
if ( PRESENCE_OK == presence_generic_read( &presence, PRESENCE_REG_INTERRUPT_STATUS, &int_status, 1 ) )
{
if ( int_status & PRESENCE_INT_MASK1_PRESENCE )
{
if ( PRESENCE_OK == presence_generic_read( &presence, PRESENCE_REG_TP_PRESENCE, &tp_presence, 1 ) )
{
log_info( &logger, "Presence detected! Level: %u", ( uint16_t ) tp_presence );
}
}
else if ( int_status & PRESENCE_INT_MASK1_MOTION )
{
if ( PRESENCE_OK == presence_generic_read( &presence, PRESENCE_REG_TP_MOTION, &tp_motion, 1 ) )
{
log_info( &logger, "Motion detected! Level: %u", ( uint16_t ) tp_motion );
}
}
else if ( int_status & PRESENCE_INT_MASK1_TP_OT )
{
log_info( &logger, "Temp threshold exceeded!" );
}
else
{
if ( PRESENCE_OK == presence_ambient_temperature( &presence, &t_amb ) )
{
log_printf( &logger, "Ambient temperature: %.2f degC\r\n", t_amb );
}
if ( PRESENCE_OK == presence_object_temperature( &presence, &t_obj ) )
{
log_printf( &logger, "Object temperature: %.2f degC\r\n\n", t_obj );
}
}
}
Delay_ms( 1000 );
}

The full application code, and ready to use projects can be installed directly form compilers IDE(recommneded) or found on LibStock page or mikroE GitHub accaunt.

Other mikroE Libraries used in the example:

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Presence

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. The terminal available in all Mikroelektronika compilers, or any other terminal application of your choice, can be used to read the message.


PRESENCE_ERROR
#define PRESENCE_ERROR
Definition: presence.h:63
PRESENCE_MAP_MIKROBUS
#define PRESENCE_MAP_MIKROBUS(cfg, mikrobus)
Definition: presence.h:52
PRESENCE_INT_MASK1_MOTION
#define PRESENCE_INT_MASK1_MOTION
Definition: presence.h:156
presence_ambient_temperature
err_t presence_ambient_temperature(presence_t *ctx, float *temperature)
Ambient Temperature.
PRESENCE_OK
#define PRESENCE_OK
Definition: presence.h:62
presence_cfg_setup
void presence_cfg_setup(presence_cfg_t *cfg)
Config Object Initialization function.
application_task
void application_task(void)
Definition: main.c:67
presence_init
err_t presence_init(presence_t *ctx, presence_cfg_t *cfg)
Initialization function.
presence_t
Click ctx object definition.
Definition: presence.h:198
PRESENCE_REG_INTERRUPT_STATUS
#define PRESENCE_REG_INTERRUPT_STATUS
Definition: presence.h:89
PRESENCE_REG_TP_PRESENCE
#define PRESENCE_REG_TP_PRESENCE
Definition: presence.h:86
PRESENCE_INT_MASK1_TP_OT
#define PRESENCE_INT_MASK1_TP_OT
Definition: presence.h:154
presence_object_temperature
err_t presence_object_temperature(presence_t *ctx, float *temperature)
Object Temperature.
presence_default_cfg
err_t presence_default_cfg(presence_t *ctx)
Presence default configuration function.
PRESENCE_INT_MASK1_PRESENCE
#define PRESENCE_INT_MASK1_PRESENCE
Definition: presence.h:155
application_init
void application_init(void)
Definition: main.c:35
presence_generic_read
err_t presence_generic_read(presence_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
PRESENCE_REG_TP_MOTION
#define PRESENCE_REG_TP_MOTION
Definition: presence.h:87
presence_cfg_t
Click configuration structure definition.
Definition: presence.h:216