buttonr 2.0.0.0
buttonr.h File Reference

This file contains API for Button R Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_pwm.h"

Go to the source code of this file.

Data Structures

struct  buttonr_t
 Button R Click driver selector. More...
 
struct  buttonr_cfg_t
 Button R Click configuration object. More...
 

Macros

#define BUTTONR_DEF_FREQ   500
 Button R default PWM frequency.
 
#define BUTTONR_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  buttonr_return_value_t { BUTTONR_OK = 0 , BUTTONR_ERROR = -1 }
 Button R Click return value data. More...
 

Functions

void buttonr_cfg_setup (buttonr_cfg_t *cfg)
 Button R configuration object setup function.
 
err_t buttonr_init (buttonr_t *ctx, buttonr_cfg_t *cfg)
 Button R initialization function.
 
err_t buttonr_set_duty_cycle (buttonr_t *ctx, float duty_cycle)
 Button R sets PWM duty cycle.
 
err_t buttonr_pwm_stop (buttonr_t *ctx)
 Button R stop PWM module.
 
err_t buttonr_pwm_start (buttonr_t *ctx)
 Button R start PWM module.
 
uint8_t buttonr_get_button_state (buttonr_t *ctx)
 Button R get button state function.
 

Detailed Description

This file contains API for Button R Click Driver.

Enumeration Type Documentation

◆ buttonr_return_value_t

Button R Click return value data.

Predefined enum values for driver return values.

Enumerator
BUTTONR_OK 
BUTTONR_ERROR