Skip to content

Latest commit

 

History

History
125 lines (93 loc) · 3.98 KB

README.md

File metadata and controls

125 lines (93 loc) · 3.98 KB

Voltmeter Click

Voltmeter 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 : Dec 2019.
  • Type : SPI type

Software Support

Example Description

This application reads the voltage measurement and displays the results on the USB UART.

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Voltmeter

Example Key Functions

  • voltmeter_cfg_setup Config Object Initialization function.
void voltmeter_cfg_setup ( voltmeter_cfg_t *cfg ); 
  • voltmeter_init Initialization function.
err_t voltmeter_init ( voltmeter_t *ctx, voltmeter_cfg_t *cfg );
  • voltmeter_read_raw_data This function reads raw ADC value.
int16_t voltmeter_read_raw_data ( voltmeter_t *ctx );
  • voltmeter_calculate_voltage This function converts the raw ADC value to proportional voltage level.
float voltmeter_calculate_voltage ( voltmeter_t *ctx, int16_t raw_adc, uint8_t iso_gnd );

Application Init

Initialization the driver and logger.

void application_init ( void )
{
    log_cfg_t log_cfg;
    voltmeter_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.
    voltmeter_cfg_setup( &cfg );
    VOLTMETER_MAP_MIKROBUS( cfg, MIKROBUS_1 );
    voltmeter_init( &voltmeter, &cfg );
    Delay_ms ( 100 );
    
    log_info( &logger, " Application Task " );
}

Application Task

Reads the raw ADC measurement once per second and converts it to the proportional voltage level. All data are being displayed on the USB UART where you can track their changes.

void application_task ( void )
{
    int16_t adc_value = 0;
    float voltage = 0;

    adc_value = voltmeter_read_raw_data( &voltmeter );
    log_printf( &logger, " ADC Value: %d\r\n", adc_value );

    voltage = voltmeter_calculate_voltage( &voltmeter, adc_value, VOLTMETER_GND_ISO );
    log_printf( &logger, " Voltage  : %.3f V\r\n", voltage );
    log_printf( &logger, "------------------------\r\n");
    Delay_ms ( 1000 );
}

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.