methane 2.0.0.0
Main Page

Methane click

Methane click carries an MQ-4 sensor for methane (CH4). The gas sensing layer on the sensor unit is made of tin dioxide (SnO2), which has lower conductivity in clean air.

click Product page


Click library

  • Author : Stefan Ilic
  • Date : Jun 2021.
  • Type : ADC type

Software Support

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

Standard key functions :

  • methane_cfg_setup Config Object Initialization function.
    void methane_cfg_setup(methane_cfg_t *cfg)
    Methane configuration object setup function.
    Methane Click configuration object.
    Definition methane.h:89
  • methane_init Initialization function.
    METHANE_RETVAL methane_init ( methane_t *ctx, methane_cfg_t *cfg );
    err_t methane_init(methane_t *ctx, methane_cfg_t *cfg)
    Methane initialization function.
    Methane Click context object.
    Definition methane.h:79
  • methane_default_cfg Click Default Configuration function.
    void methane_default_cfg ( methane_t *ctx );

Example key functions :

Example Description

‍The demo application shows the reading of the adc values given by the sensors.

The demo application is composed of two sections :

Application Init

‍Configuring clicks and log objects.

void application_init ( void ) {
log_cfg_t log_cfg;
methane_cfg_t methane_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
methane_cfg_setup( &methane_cfg );
METHANE_MAP_MIKROBUS( methane_cfg, MIKROBUS_1 );
if ( methane_init( &methane, &methane_cfg ) == ADC_ERROR ) {
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
log_info( &logger, " Application Task " );
}
#define METHANE_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition methane.h:67
void application_init(void)
Definition main.c:28

Application Task

‍Reads the adc value and prints in two forms adc value and voltage.

void application_task ( void ) {
uint16_t methane_an_value = 0;
if ( methane_read_an_pin_value ( &methane, &methane_an_value ) != ADC_ERROR ) {
log_printf( &logger, " ADC Value : %u\r\n", methane_an_value );
}
float methane_an_voltage = 0;
if ( methane_read_an_pin_voltage ( &methane, &methane_an_voltage ) != ADC_ERROR ) {
log_printf( &logger, " AN Voltage : %.3f[V]\r\n\n", methane_an_voltage );
}
Delay_ms ( 1000 );
}
void application_task(void)
Definition main.c:58

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

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.