Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md


Spectral 3 Click

Spectral 3 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 : Apr 2020.
  • Type : UART GPS/GNSS type

Software Support

Example Description

This example reads and processes data from Spectral 3 Clicks.

Example Libraries

  • MikroSDK.Board
  • MikroSDK.Log
  • Click.Spectral3

Example Key Functions

  • spectral3_cfg_setup Config Object Initialization function.
void spectral3_cfg_setup ( spectral3_cfg_t *cfg );
  • spectral3_init Initialization function.
err_t spectral3_init ( spectral3_t *ctx, spectral3_cfg_t *cfg );
  • spectral3_module_reset Reset module.
void spectral3_module_reset ( spectral3_t *ctx );
  • spectral3_send_command Send command.
void spectral3_send_command ( spectral3_t *ctx, char *command );
  • spectral3_get_data Read raw X, Y, Z and NIR data as well as two special internal registers D, & C.
void spectral3_get_data ( char *rsp, uint16_t *c_data );

Application Init

Initializes the driver and configures the sensor.

void application_init ( void )
{
    log_cfg_t log_cfg;
    spectral3_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.

    spectral3_cfg_setup( &cfg );
    SPECTRAL3_MAP_MIKROBUS( cfg, MIKROBUS_POSITION_SPECTRAL3 );
    spectral3_init( &spectral3, &cfg );

    spectral3_module_reset( &spectral3 );
    Delay_ms ( 500 );
    
    log_printf( &logger, "Configuring the sensor...\r\n" );
    spectral3_send_command( &spectral3, SPECTRAL3_CMD_AT );
    spectral3_process( );
    spectral3_send_command( &spectral3, SPECTRAL3_CMD_GAIN );
    spectral3_process( );
    spectral3_send_command( &spectral3, SPECTRAL3_CMD_MODE );
    spectral3_process( );
    log_printf( &logger, "The sensor has been configured!\r\n" );
    Delay_ms ( 1000 );
}

Application Task

Reads the values of all 6 channels and parses it to the USB UART each second.

void application_task ( void )
{
    parser_application( );
}

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.