buttonr  2.0.0.0
Main Page

Button R click

Button R click is the simplest solution for adding a single pushbutton to your design. The button itself is transparent, 6.8mm in diameter and has a red LED backlight. When pressed, it sends an interrupt signal to the target board microcontroller. The backlight LED is controlled separately through the mikroBUS PWM pin, so you can program all kinds of patterns (varying level of light intensity or rate of blinking on subsequent button presses). The board can use either a 3.3V or a 5V power supply.

click Product page


Click library

  • Author : Jelena Milosavljevic
  • Date : Jun 2021.
  • Type : PWM type

Software Support

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

Standard key functions :

Example key functions :

Example Description

This example showcases how to initialize and use the whole family of Button R clicks. One library is used for every single one of them. They are simple touch detectors which send a pressed/released signal and receive a PWM output which controls the backlight on the button.

The demo application is composed of two sections :

Application Init

This function initializes and configures the logger and click modules.

void application_init ( void ) {
log_cfg_t log_cfg;
buttonr_cfg_t buttonr_cfg;
// Logger initialization.
LOG_MAP_USB_UART( log_cfg );
log_cfg.level = LOG_LEVEL_DEBUG;
log_cfg.baud = 115200;
log_init( &logger, &log_cfg );
log_info( &logger, " Application Init " );
// Click initialization.
buttonr_cfg_setup( &buttonr_cfg );
BUTTONR_MAP_MIKROBUS( buttonr_cfg, MIKROBUS_2 );
err_t init_flag = buttonr_init( &buttonr, &buttonr_cfg );
if ( PWM_ERROR == init_flag ) {
log_error( &logger, " Application Init Error. " );
log_info( &logger, " Please, run program again... " );
for ( ; ; );
}
Delay_ms( 500 );
buttonr_set_duty_cycle ( &buttonr, 0.0 );
buttonr_pwm_start( &buttonr );
backlight_on( );
Delay_ms( 500 );
backligh_off( );
Delay_ms( 500 );
backlight_on( );
button_state = buttonr_get_button_state( &buttonr );
button_state_old = button_state;
log_info( &logger, " Application Task " );
}

Application Task

This function first turns the backlight on the button ON/OFF and then checks if the button has been pressed and reports the event in the console using UART communication.

void application_task ( void ) {
button_state = buttonr_get_button_state( &buttonr );
if ( button_state && ( button_state != button_state_old ) ) {
backligh_off( );
button_state_old = button_state;
Delay_ms( 500 );
} else if ( !button_state && ( button_state != button_state_old ) ) {
backlight_on( );
button_state_old = button_state;
Delay_ms( 500 );
}
}

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

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.


buttonr_get_button_state
uint8_t buttonr_get_button_state(buttonr_t *ctx)
Button R get button state function.
buttonr_pwm_start
err_t buttonr_pwm_start(buttonr_t *ctx)
Button R start PWM module.
buttonr_pwm_stop
err_t buttonr_pwm_stop(buttonr_t *ctx)
Button R stop PWM module.
application_task
void application_task(void)
Definition: main.c:88
buttonr_set_duty_cycle
err_t buttonr_set_duty_cycle(buttonr_t *ctx, float duty_cycle)
Button R sets PWM duty cycle.
buttonr_cfg_t
Button R Click configuration object.
Definition: buttonr.h:110
buttonr_init
err_t buttonr_init(buttonr_t *ctx, buttonr_cfg_t *cfg)
Button R initialization function.
buttonr_t
Button R Click driver selector.
Definition: buttonr.h:94
buttonr_cfg_setup
void buttonr_cfg_setup(buttonr_cfg_t *cfg)
Button R configuration object setup function.
application_init
void application_init(void)
Definition: main.c:48
BUTTONR_MAP_MIKROBUS
#define BUTTONR_MAP_MIKROBUS(cfg, mikrobus)
MikroBUS pin mapping.
Definition: buttonr.h:77