buttony 2.0.0.0
buttony.h File Reference

This file contains API for Button Y 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  buttony_t
 Button Y Click driver selector. More...
 
struct  buttony_cfg_t
 Button Y Click configuration object. More...
 

Macros

#define BUTTONY_DEF_FREQ   500
 Button Y default PWM frequency.
 
#define BUTTONY_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  buttony_return_value_t { BUTTONY_OK = 0 , BUTTONY_ERROR = -1 }
 Button Y Click return value data. More...
 

Functions

void buttony_cfg_setup (buttony_cfg_t *cfg)
 Button Y configuration object setup function.
 
err_t buttony_init (buttony_t *ctx, buttony_cfg_t *cfg)
 Button Y initialization function.
 
err_t buttony_set_duty_cycle (buttony_t *ctx, float duty_cycle)
 Button Y sets PWM duty cycle.
 
err_t buttony_pwm_stop (buttony_t *ctx)
 Button Y stop PWM module.
 
err_t buttony_pwm_start (buttony_t *ctx)
 Button Y start PWM module.
 
uint8_t buttony_get_button_state (buttony_t *ctx)
 Button Y get button state function.
 

Detailed Description

This file contains API for Button Y Click Driver.

Enumeration Type Documentation

◆ buttony_return_value_t

Button Y Click return value data.

Predefined enum values for driver return values.

Enumerator
BUTTONY_OK 
BUTTONY_ERROR