rgbring  2.1.0.0
Data Structures | Macros | Typedefs | Enumerations | Functions
rgbring.h File Reference

This file contains API for RGB Ring Click Driver. More...

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

Go to the source code of this file.

Data Structures

struct  rgbring_color_t
 RGB Ring Click RGB color object. More...
 
struct  rgbring_led_t
 RGB Ring Click led object. More...
 
struct  rgbring_t
 RGB Ring Click context object. More...
 
struct  rgbring_cfg_t
 RGB Ring Click configuration object. More...
 

Macros

#define RGBRING_LED_0   0
 RGB Ring LED selection values. More...
 
#define RGBRING_LED_1   1
 
#define RGBRING_LED_2   2
 
#define RGBRING_LED_3   3
 
#define RGBRING_LED_4   4
 
#define RGBRING_LED_5   5
 
#define RGBRING_LED_6   6
 
#define RGBRING_LED_7   7
 
#define RGBRING_NUM_LEDS   8
 
#define RGBRING_COLOR_BLACK   0x000000ul
 RGB Ring 24-bit RGB color codes. More...
 
#define RGBRING_COLOR_WHITE   0xFFFFFFul
 
#define RGBRING_COLOR_RED   0xFF0000ul
 
#define RGBRING_COLOR_LIME   0x00FF00ul
 
#define RGBRING_COLOR_BLUE   0x0000FFul
 
#define RGBRING_COLOR_YELLOW   0xFFFF00ul
 
#define RGBRING_COLOR_CYAN   0x00FFFFul
 
#define RGBRING_COLOR_MAGENTA   0xFF00FFul
 
#define RGBRING_COLOR_SILVER   0xC0C0C0ul
 
#define RGBRING_COLOR_GRAY   0x808080ul
 
#define RGBRING_COLOR_MAROON   0x800000ul
 
#define RGBRING_COLOR_OLIVE   0x808000ul
 
#define RGBRING_COLOR_GREEN   0x008000ul
 
#define RGBRING_COLOR_PURPLE   0x800080ul
 
#define RGBRING_COLOR_TEAL   0x008080ul
 
#define RGBRING_COLOR_NAVY   0x000080ul
 
#define RGBRING_NUM_COLORS   16
 
#define RGBRING_SIZE_COLOR_NAME   32
 
#define RGBRING_BUTTON_PRESSED   0
 RGB Ring button state setting. More...
 
#define RGBRING_BUTTON_RELESED   1
 
#define RGBRING_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Typedefs

typedef void(* rgbring_logic_t) (void)
 Function pointer for logic level one and zero. More...
 

Enumerations

enum  rgbring_return_value_t { RGBRING_OK = 0, RGBRING_ERROR = -1 }
 RGB Ring Click return value data. More...
 

Functions

void rgbring_cfg_setup (rgbring_cfg_t *cfg)
 RGB Ring configuration object setup function. More...
 
err_t rgbring_init (rgbring_t *ctx, rgbring_logic_t logic_zero, rgbring_logic_t logic_one, rgbring_cfg_t *cfg)
 RGB Ring initialization function. More...
 
err_t rgbring_default_cfg (rgbring_t *ctx)
 RGB Ring default configuration function. More...
 
err_t rgbring_write_leds (rgbring_t *ctx, rgbring_led_t *leds, uint8_t num_leds)
 RGB Ring write LEDs function. More...
 
err_t rgbring_write_led_matrix (rgbring_t *ctx)
 RGB Ring write LED matrix function. More...
 
void rgbring_set_led_color (rgbring_t *ctx, uint8_t led_num, uint32_t rgb)
 RGB Ring set LED color function. More...
 
void rgbring_set_leds_color (rgbring_t *ctx, uint32_t rgb)
 RGB Ring set LEDs color function. More...
 
uint8_t rgbring_get_int_pin (rgbring_t *ctx)
 RGB Ring get int pin function. More...
 

Detailed Description

This file contains API for RGB Ring Click Driver.

Typedef Documentation

◆ rgbring_logic_t

typedef void( * rgbring_logic_t) (void)

Function pointer for logic level one and zero.

Function pointer definition of RGB Ring Click driver.

Enumeration Type Documentation

◆ rgbring_return_value_t

RGB Ring Click return value data.

Predefined enum values for driver return values.

Enumerator
RGBRING_OK 
RGBRING_ERROR