buttonalarm 2.0.0.0
buttonalarm.h File Reference

This file contains API for Button Alarm 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  buttonalarm_t
 Button Alarm Click driver selector. More...
 
struct  buttonalarm_cfg_t
 Button Alarm Click configuration object. More...
 

Macros

#define BUTTONALARM_DEF_FREQ   500
 ButtonAlarm default PWM frequency.
 
#define BUTTONALARM_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  buttonalarm_return_value_t { BUTTONALARM_OK = 0 , BUTTONALARM_ERROR = -1 }
 Button Alarm Click return value data. More...
 

Functions

void buttonalarm_cfg_setup (buttonalarm_cfg_t *cfg)
 Button Alarm configuration object setup function.
 
err_t buttonalarm_init (buttonalarm_t *ctx, buttonalarm_cfg_t *cfg)
 Button Alarm initialization function.
 
err_t buttonalarm_set_duty_cycle (buttonalarm_t *ctx, float duty_cycle)
 Button Alarm sets PWM duty cycle.
 
err_t buttonalarm_pwm_stop (buttonalarm_t *ctx)
 Button Alarm stop PWM module.
 
err_t buttonalarm_pwm_start (buttonalarm_t *ctx)
 Button Alarm start PWM module.
 
uint8_t buttonalarm_get_button_state (buttonalarm_t *ctx)
 Button Alarm get button state function.
 

Detailed Description

This file contains API for Button Alarm Click Driver.

Enumeration Type Documentation

◆ buttonalarm_return_value_t

Button Alarm Click return value data.

Predefined enum values for driver return values.

Enumerator
BUTTONALARM_OK 
BUTTONALARM_ERROR