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

This file contains API for ROTARY G Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"

Go to the source code of this file.

Data Structures

struct  rotaryg_t
 ROTARY G Click context object. More...
 
struct  rotaryg_cfg_t
 ROTARY G Click configuration object. More...
 

Macros

#define ROTARYG_ONE_LED   0x0001
 ROTARY G Number of LED's. More...
 
#define ROTARYG_TWO_LED   0x0101
 
#define ROTARYG_FOUR_LED   0x1111
 
#define ROTARYG_EIGHT_LED   0x5555
 
#define ROTARYG_RESET_LED   0x0000
 
#define ROTARYG_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  rotaryg_return_value_t { ROTARYG_OK = 0, ROTARYG_ERROR = -1 }
 ROTARY G Click return value data. More...
 

Functions

void rotaryg_cfg_setup (rotaryg_cfg_t *cfg)
 ROTARY G configuration object setup function. More...
 
err_t rotaryg_init (rotaryg_t *ctx, rotaryg_cfg_t *cfg)
 ROTARY G initialization function. More...
 
void rotaryg_generic_transfer (rotaryg_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 ROTARY G data transfer function. More...
 
void rotaryg_turn_on_led_by_data (rotaryg_t *ctx, uint16_t write_data)
 ROTARY G generic data write function. More...
 
void rotaryg_turn_on_led_by_position (rotaryg_t *ctx, uint8_t led_position)
 ROTARY G turn on led by position function. More...
 
uint8_t rotaryg_button_push (rotaryg_t *ctx)
 Button push state. More...
 
uint16_t rotaryg_get_led_data (uint8_t current_led_state)
 Get led data state. More...
 
void rotaryg_reset_led (rotaryg_t *ctx)
 Reset led. More...
 
uint8_t rotaryg_get_ecb_state (rotaryg_t *ctx)
 State ecb pin. More...
 
uint8_t rotaryg_get_eca_state (rotaryg_t *ctx)
 State eca pin. More...
 

Detailed Description

This file contains API for ROTARY G Click Driver.

Enumeration Type Documentation

◆ rotaryg_return_value_t

ROTARY G Click return value data.

Predefined enum values for driver return values.

Enumerator
ROTARYG_OK 
ROTARYG_ERROR