clockgen5  2.0.0.0
Main Page

Clock Gen 5 click

Clock Gen 5 Click is a compact add-on board that contains a digital programmable oscillator solution. This board features the LTC6903, a low-power self-contained digital frequency source providing a precision frequency from 1kHz to 68MHz set through a 3-wire SPI digital interface from Analog Devices.

click Product page


Click library

  • Author : Stefan Ilic
  • Date : Jul 2021.
  • Type : SPI type

Software Support

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

Standard key functions :

Example key functions :

Example Description

This is an example that demonstrates the use of the Clock Gen 5 click board.

The demo application is composed of two sections :

Application Init

Initialization driver enables - SPI, set output configuration CLK 180, also write log.

void application_init ( void ) {
log_cfg_t log_cfg;
clockgen5_cfg_t clockgen5_cfg;
LOG_MAP_USB_UART( log_cfg );
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
clockgen5_cfg_setup( &clockgen5_cfg );
CLOCKGEN5_MAP_MIKROBUS( clockgen5_cfg, MIKROBUS_1 );
err_t init_flag = clockgen5_init( &clockgen5, &clockgen5_cfg );
if ( SPI_MASTER_ERROR == init_flag ) {
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... %d", init_flag );
for ( ; ; );
}
log_printf( &logger, "-----------------------\r\n" );
log_printf( &logger, " Enabling Output \r\n" );
log_printf( &logger, "-----------------------\r\n" );
log_printf( &logger, " Set configuration \r\n" );
log_printf( &logger, "-----------------------\r\n" );
Delay_ms( 500 );
log_info( &logger, " Application Task " );
}

Application Task

In this example, we adjusts different frequencies every 3 sec. Results are being sent to the Usart Terminal where you can track their changes.

void application_task ( void ) {
log_printf( &logger, "-----------------------\r\n" );
log_printf( &logger, " 12.0 MHz \r\n" );
clockgen5_set_freq( &clockgen5, 12000.0 );
Delay_ms( 3000 );
log_printf( &logger, "-----------------------\r\n" );
log_printf( &logger, " 8.0 MHz \r\n" );
clockgen5_set_freq( &clockgen5, 8000.0 );
Delay_ms( 3000 );
log_printf( &logger, "-----------------------\r\n" );
log_printf( &logger, " 5.5 MHz \r\n" );
clockgen5_set_freq( &clockgen5, 5500.0 );
Delay_ms( 3000 );
log_printf( &logger, "-----------------------\r\n" );
log_printf( &logger, " 2.7 MHz \r\n" );
clockgen5_set_freq( &clockgen5, 2700.0 );
Delay_ms( 3000 );
log_printf( &logger, "-----------------------\r\n" );
log_printf( &logger, " 0.8 MHz \r\n" );
clockgen5_set_freq( &clockgen5, 800.0 );
Delay_ms( 3000 );
log_printf( &logger, "-----------------------\r\n" );
log_printf( &logger, " 0.2 MHz \r\n" );
clockgen5_set_freq( &clockgen5, 200.0 );
Delay_ms( 3000 );
}

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

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.


clockgen5_set_config
void clockgen5_set_config(clockgen5_t *ctx, uint8_t cfg)
Set configuration function.
CLOCKGEN5_CFG_ON_CLK_180
#define CLOCKGEN5_CFG_ON_CLK_180
Clock Gen 5 config settings.
Definition: clockgen5.h:99
clockgen5_set_freq
void clockgen5_set_freq(clockgen5_t *ctx, float freq)
Set frequency function.
CLOCKGEN5_OUTPUT_ENABLE
#define CLOCKGEN5_OUTPUT_ENABLE
Definition: clockgen5.h:93
clockgen5_init
err_t clockgen5_init(clockgen5_t *ctx, clockgen5_cfg_t *cfg)
Clock Gen 5 initialization function.
clockgen5_out_enable
void clockgen5_out_enable(clockgen5_t *ctx, uint8_t en_out)
Enable output function.
CLOCKGEN5_MAP_MIKROBUS
#define CLOCKGEN5_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: clockgen5.h:131
application_task
void application_task(void)
Definition: main.c:71
clockgen5_cfg_setup
void clockgen5_cfg_setup(clockgen5_cfg_t *cfg)
Clock Gen 5 configuration object setup function.
application_init
void application_init(void)
Definition: main.c:30
clockgen5_cfg_t
Clock Gen 5 Click configuration object.
Definition: clockgen5.h:164
clockgen5_t
Clock Gen 5 Click context object.
Definition: clockgen5.h:146