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

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

#include "mikrosdk_version.h"
#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  rotaryr_t
 ROTARY R Click context object. More...
 
struct  rotaryr_cfg_t
 ROTARY R Click configuration object. More...
 

Macros

#define ROTARYR_ONE_LED   0x0001
 ROTARY R Number of LED's. More...
 
#define ROTARYR_TWO_LED   0x0101
 
#define ROTARYR_FOUR_LED   0x1111
 
#define ROTARYR_EIGHT_LED   0x5555
 
#define ROTARYR_RESET_LED   0x0000
 
#define ROTARYR_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  rotaryr_return_value_t { ROTARYR_OK = 0, ROTARYR_ERROR = -1 }
 ROTARY R Click return value data. More...
 

Functions

void rotaryr_cfg_setup (rotaryr_cfg_t *cfg)
 ROTARY R configuration object setup function. More...
 
err_t rotaryr_init (rotaryr_t *ctx, rotaryr_cfg_t *cfg)
 ROTARY R initialization function. More...
 
void rotaryr_generic_transfer (rotaryr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 ROTARY R data transfer function. More...
 
void rotaryr_turn_on_led_by_data (rotaryr_t *ctx, uint16_t write_data)
 ROTARY R generic data write function. More...
 
void rotaryr_turn_on_led_by_position (rotaryr_t *ctx, uint8_t led_position)
 ROTARY R turn on led by position function. More...
 
uint8_t rotaryr_button_push (rotaryr_t *ctx)
 Button push state. More...
 
uint16_t rotaryr_get_led_data (uint8_t current_led_state)
 Get led data state. More...
 
void rotaryr_reset_led (rotaryr_t *ctx)
 Reset led. More...
 
uint8_t rotaryr_get_ecb_state (rotaryr_t *ctx)
 State ecb pin. More...
 
uint8_t rotaryr_get_eca_state (rotaryr_t *ctx)
 State eca pin. More...
 

Detailed Description

This file contains API for ROTARY R Click Driver.

Enumeration Type Documentation

◆ rotaryr_return_value_t

ROTARY R Click return value data.

Predefined enum values for driver return values.

Enumerator
ROTARYR_OK 
ROTARYR_ERROR