buttonpower  2.0.0.0
Data Structures | Macros | Enumerations | Functions
buttonpower.h File Reference

This file contains API for Button Power 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  buttonpower_t
 Button Power Click driver selector. More...
 
struct  buttonpower_cfg_t
 Button Power Click configuration object. More...
 

Macros

#define BUTTONPOWER_DEF_FREQ   500
 ButtonPower default PWM frequency. More...
 
#define BUTTONPOWER_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  buttonpower_return_value_t { BUTTONPOWER_OK = 0, BUTTONPOWER_ERROR = -1 }
 Button Power Click return value data. More...
 

Functions

void buttonpower_cfg_setup (buttonpower_cfg_t *cfg)
 Button Power configuration object setup function. More...
 
err_t buttonpower_init (buttonpower_t *ctx, buttonpower_cfg_t *cfg)
 Button Power initialization function. More...
 
err_t buttonpower_set_duty_cycle (buttonpower_t *ctx, float duty_cycle)
 Button Power sets PWM duty cycle. More...
 
err_t buttonpower_pwm_stop (buttonpower_t *ctx)
 Button Power stop PWM module. More...
 
err_t buttonpower_pwm_start (buttonpower_t *ctx)
 Button Power start PWM module. More...
 
uint8_t buttonpower_get_button_state (buttonpower_t *ctx)
 Button Power get button state function. More...
 

Detailed Description

This file contains API for Button Power Click Driver.

Enumeration Type Documentation

◆ buttonpower_return_value_t

Button Power Click return value data.

Predefined enum values for driver return values.

Enumerator
BUTTONPOWER_OK 
BUTTONPOWER_ERROR