smoke

\mainpage Main Page

---

Smoke Click

Smoke Click carries the MAX30105 high-sensitivity optical sensor for smoke detection. The Click is designed to run on either 3.3V or 5V power supply. It communicates with the target MCU over I2C interface with additional functionality provided by the INT pin on the mikroBUS™ line.

Click Product page

---

Click library

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

Software Support

We provide a library for the Smoke 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 Smoke Click driver.

Standard key functions :

• Config Object Initialization function.

void smoke_cfg_setup ( smoke_cfg_t *cfg );

• Initialization function.

SMOKE_RETVAL smoke_init ( smoke_t *ctx, smoke_cfg_t *cfg );

• Click Default Configuration function.

void smoke_default_cfg ( smoke_t *ctx );

Example key functions :

• Set registers values function.

uint8_t smoke_set_registers ( smoke_t *ctx, smoke_set_registers_t *registers );

• Enable or disable interrupt function.

uint8_t smoke_enable_disable_interrupts ( smoke_t *ctx, uint8_t interrupt_flag, uint8_t enable_flag );

• Function for reading enabled led values.

uint8_t smoke_read_leds ( smoke_t *ctx );

Examples Description

This Click includes internal LEDs, photodetectors, optical elements, and low-noise electronics with ambient light rejection. The sensor can detect a wide variety of smoke particle sizes. It also has an on-chip temperature sensor for calibrating the temperature dependence of the particle sensing subsystem. The temperature sensor has an inherent resolution 0.0625°C.

The demo application is composed of two sections :

Application Init

Initalizes I2C driver, and sets default configuration of device.

void application_init ( void )
{
    log_cfg_t log_cfg;
    smoke_cfg_t cfg;

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, "---- Application Init ----" );

    //  Click initialization.

    smoke_cfg_setup( &cfg );
    SMOKE_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    smoke_init( &smoke, &cfg );

    smoke_reset( &smoke );
    smoke_default_cfg ( &smoke );

    log_info( &logger, "---- Application Task ----" );
    Delay_ms ( 100 );
    if ( smoke_read_leds( &smoke ) != SMOKE_OK )
    {
        log_info( &logger, "---- Init Error ----" );
        for( ; ; );
    }
}
  

Application Task

This example demonstrates the use of Smoke Click board. It reads reflected red, ir, green and temperature values from an internal sensor and displays and logs it.

void application_task ( void )
{
    smoke_read_leds( &smoke );
    
    log_printf( &logger, "Red : %llu\r\n", smoke.red_value );
    log_printf( &logger, "IR : %llu\r\n", smoke.ir_value );
    log_printf( &logger, "Green : %llu\r\n", smoke.green_value );
    log_printf( &logger, "------------------------------\r\n" );
    
    temperature = smoke_read_temp( &smoke );
    
    log_printf( &logger, "Read Temperature[ degC ]: %.2f\r\n",  temperature );
    log_printf( &logger, "------------------------------\r\n" );

    Delay_ms ( 500 );
}

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.Smoke

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.

---