Skip to content

Latest commit

 

History

History
139 lines (105 loc) · 4.03 KB

README.md

File metadata and controls

139 lines (105 loc) · 4.03 KB

Noise Click

Noise Click demo application is developed using the NECTO Studio, ensuring compatibility with mikroSDK's open-source libraries and tools. Designed for plug-and-play implementation and testing, the demo is fully compatible with all development, starter, and mikromedia boards featuring a mikroBUS™ socket.

Click Library

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

Software Support

Example Description

This example performs an ambient noise monitoring using the Noise Click board.

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Noise

Example Key Functions

  • noise_cfg_setup Config Object Initialization function.
void noise_cfg_setup ( noise_cfg_t *cfg );
  • noise_init Initialization function.
err_t noise_init ( noise_t *ctx, noise_cfg_t *cfg );
  • noise_default_cfg Click Default Configuration function.
void noise_default_cfg ( noise_t *ctx );
  • noise_set_cmd_reg This function sets command register.
err_t noise_set_cmd_reg ( noise_t *ctx, uint8_t configuration, uint16_t threshold );
  • noise_set_state This function switches Click on or off.
void noise_set_state ( noise_t *ctx, uint8_t state );
  • noise_read_an_pin_voltage This function reads results of AD conversion of the AN pin and converts them to proportional voltage level.
err_t noise_read_an_pin_voltage ( noise_t *ctx, float *data_out );

Application Init

Device initialization.

void application_init ( void )
{
    log_cfg_t log_cfg;
    noise_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.
    noise_cfg_setup( &cfg );
    NOISE_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    noise_init( &noise, &cfg );

    noise_default_cfg( &noise );
}

Application Task

Reads the voltage from AN pin which presents the noise level and displays it on the USB UART every 5ms. If the noise is above predefined threshold (25 percents of max noise, i.e. about 0.4V) an alarm message is being shown.

void application_task ( void )
{
    float voltage = 0;
    if ( NOISE_OK == noise_read_an_pin_voltage ( &noise, &voltage ) )
    {
        log_printf( &logger, "%.3f\r\n", voltage );
    }
    if ( noise_check_int_pin( &noise ) )
    {
        log_printf( &logger, " Sound overlimit detected!\r\n" );
    }
    Delay_ms ( 5 );
}

Note

We recommend using the SerialPlot tool for data visualizing.

Application Output

This Click board can be interfaced and monitored in two ways:

  • Application Output - Use the "Application Output" window in Debug mode for real-time data monitoring. Set it up properly by following this tutorial.
  • UART Terminal - Monitor data via the UART Terminal using a USB to UART converter. For detailed instructions, check out this tutorial.

Additional Notes and Information

The complete application code and a ready-to-use project are available through the NECTO Studio Package Manager for direct installation in the NECTO Studio. The application code can also be found on the MIKROE GitHub account.