buttonplay 2.0.0.0
buttonplay.h File Reference

This file contains API for Button Play 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  buttonplay_t
 Button Play Click driver selector. More...
 
struct  buttonplay_cfg_t
 Button Play Click configuration object. More...
 

Macros

#define BUTTONPLAY_DEF_FREQ   500
 ButtonPlay default PWM frequency.
 
#define BUTTONPLAY_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  buttonplay_return_value_t { BUTTONPLAY_OK = 0 , BUTTONPLAY_ERROR = -1 }
 Button Play Click return value data. More...
 

Functions

void buttonplay_cfg_setup (buttonplay_cfg_t *cfg)
 Button Play configuration object setup function.
 
err_t buttonplay_init (buttonplay_t *ctx, buttonplay_cfg_t *cfg)
 Button Play initialization function.
 
err_t buttonplay_set_duty_cycle (buttonplay_t *ctx, float duty_cycle)
 Button Play sets PWM duty cycle.
 
err_t buttonplay_pwm_stop (buttonplay_t *ctx)
 Button Play stop PWM module.
 
err_t buttonplay_pwm_start (buttonplay_t *ctx)
 Button Play start PWM module.
 
uint8_t buttonplay_get_button_state (buttonplay_t *ctx)
 Button Play get button state function.
 

Detailed Description

This file contains API for Button Play Click Driver.

Enumeration Type Documentation

◆ buttonplay_return_value_t

Button Play Click return value data.

Predefined enum values for driver return values.

Enumerator
BUTTONPLAY_OK 
BUTTONPLAY_ERROR