button3  2.1.0.0
Data Structures | Macros | Enumerations | Functions
button3.h File Reference

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

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  button3_t
 Button 3 Click context object. More...
 
struct  button3_cfg_t
 Button 3 Click configuration object. More...
 

Macros

#define BUTTON3_REG_INPUT   0x00
 Button 3 registers. More...
 
#define BUTTON3_REG_OUTPUT   0x01
 
#define BUTTON3_REG_POLARITY   0x02
 
#define BUTTON3_REG_CONFIG   0x03
 
#define BUTTON3_PIN_RED_BUTTON   0x01
 Button 3 pin mask. More...
 
#define BUTTON3_PIN_RED_LED   0x02
 
#define BUTTON3_PIN_GREEN_BUTTON   0x04
 
#define BUTTON3_PIN_GREEN_LED   0x08
 
#define BUTTON3_PIN_BLUE_LED   0x10
 
#define BUTTON3_PIN_BLUE_BUTTON   0x20
 
#define BUTTON3_DEFAULT_PIN_CONFIG   0xE5
 Button 3 pin direction config. More...
 
#define BUTTON3_PIN_STATE_LOW   0
 Button 3 pin logic state setting. More...
 
#define BUTTON3_PIN_STATE_HIGH   1
 
#define BUTTON3_SWITCH_OFF   0
 Button 3 switch state setting. More...
 
#define BUTTON3_SWITCH_ON   1
 
#define BUTTON3_BUTTON_PRESSED   0
 Button 3 button state setting. More...
 
#define BUTTON3_BUTTON_RELESED   1
 
#define BUTTON3_DEVICE_ADDRESS_0   0x20
 Button 3 device address setting. More...
 
#define BUTTON3_DEVICE_ADDRESS_1   0x21
 
#define BUTTON3_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  button3_return_value_t { BUTTON3_OK = 0, BUTTON3_ERROR = -1 }
 Button 3 Click return value data. More...
 

Functions

void button3_cfg_setup (button3_cfg_t *cfg)
 Button 3 configuration object setup function. More...
 
err_t button3_init (button3_t *ctx, button3_cfg_t *cfg)
 Button 3 initialization function. More...
 
err_t button3_default_cfg (button3_t *ctx)
 Button 3 default configuration function. More...
 
err_t button3_write_reg (button3_t *ctx, uint8_t reg, uint8_t data_in)
 Button 3 write reg function. More...
 
err_t button3_read_reg (button3_t *ctx, uint8_t reg, uint8_t *data_out)
 Button 3 read reg function. More...
 
void button3_reset_device (button3_t *ctx)
 Button 3 reset device function. More...
 
void button3_set_rst_pin (button3_t *ctx, uint8_t state)
 Button 3 set RST pin function. More...
 
uint8_t button3_get_int_pin (button3_t *ctx)
 Button 3 get INT pin function. More...
 
err_t button3_get_red_button (button3_t *ctx, uint8_t *state)
 Button 3 get red button function. More...
 
err_t button3_get_green_button (button3_t *ctx, uint8_t *state)
 Button 3 get green button function. More...
 
err_t button3_get_blue_button (button3_t *ctx, uint8_t *state)
 Button 3 get blue button function. More...
 
err_t button3_get_red_led (button3_t *ctx, uint8_t *state)
 Button 3 get red led function. More...
 
err_t button3_get_green_led (button3_t *ctx, uint8_t *state)
 Button 3 get green led function. More...
 
err_t button3_get_blue_led (button3_t *ctx, uint8_t *state)
 Button 3 get blue led function. More...
 
err_t button3_enable_red_led (button3_t *ctx)
 Button 3 enable red led function. More...
 
err_t button3_enable_green_led (button3_t *ctx)
 Button 3 enable green led function. More...
 
err_t button3_enable_blue_led (button3_t *ctx)
 Button 3 enable blue led function. More...
 
err_t button3_disable_red_led (button3_t *ctx)
 Button 3 disable red led function. More...
 
err_t button3_disable_green_led (button3_t *ctx)
 Button 3 disable green led function. More...
 
err_t button3_disable_blue_led (button3_t *ctx)
 Button 3 disable blue led function. More...
 
err_t button3_toggle_red_led (button3_t *ctx)
 Button 3 toggle red led function. More...
 
err_t button3_toggle_green_led (button3_t *ctx)
 Button 3 toggle green led function. More...
 
err_t button3_toggle_blue_led (button3_t *ctx)
 Button 3 toggle blue led function. More...
 

Detailed Description

This file contains API for Button 3 Click Driver.

Enumeration Type Documentation

◆ button3_return_value_t

Button 3 Click return value data.

Predefined enum values for driver return values.

Enumerator
BUTTON3_OK 
BUTTON3_ERROR