oledc  2.0.0.0
Data Structures | Macros | Functions
oledc.h File Reference

This file contains API for OLED C Click driver. More...

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

Go to the source code of this file.

Data Structures

struct  oledc_t
 Click context object definition. More...
 
struct  oledc_cfg_t
 Click configuration structure definition. More...
 

Macros

#define OLEDC_FO_HORIZONTAL   0x00
 
#define OLEDC_FO_VERTICAL   0x01
 
#define OLEDC_FO_VERTICAL_COLUMN   0x02
 
#define OLEDC_RMP_INC_HOR   0x00
 
#define OLEDC_RMP_INC_VER   0x01
 
#define OLEDC_RMP_COLOR_NOR   0x00
 
#define OLEDC_RMP_COLOR_REV   0x02
 
#define OLEDC_RMP_SEQ_RGB   0x00
 
#define OLEDC_RMP_SEQ_BGR   0x04
 
#define OLEDC_RMP_SCAN_NOR   0x00
 
#define OLEDC_RMP_SCAN_REV   0x10
 
#define OLEDC_RMP_SPLIT_DISABLE   0x00
 
#define OLEDC_RMP_SPLIT_ENABLE   0x20
 
#define OLEDC_COLOR_65K   0x00
 
#define OLEDC_COLOR_262K   0x80
 
#define OLEDC_IMG_HEAD   0x06
 
#define OLEDC_SCREEN_WIDTH   0x60
 
#define OLEDC_SCREEN_HEIGHT   0x60
 
#define OLEDC_SCREEN_SIZE   0x2400
 
#define OLEDC_ROW_OFF   0x00
 
#define OLEDC_COL_OFF   0x10
 
#define OLEDC_SET_COL_ADDRESS   0x15
 
#define OLEDC_SET_ROW_ADDRESS   0x75
 
#define OLEDC_WRITE_RAM   0x5C
 
#define OLEDC_READ_RAM   0x5D
 
#define OLEDC_SET_REMAP   0xA0
 
#define OLEDC_SET_START_LINE   0xA1
 
#define OLEDC_SET_OFFSET   0xA2
 
#define OLEDC_MODE_OFF   0xA4
 
#define OLEDC_MODE_ON   0xA5
 
#define OLEDC_MODE_NORMAL   0xA6
 
#define OLEDC_MODE_INVERSE   0xA7
 
#define OLEDC_FUNCTION   0xAB
 
#define OLEDC_SLEEP_ON   0xAE
 
#define OLEDC_SLEEP_OFF   0xAF
 
#define OLEDC_NOP   0xB0
 
#define OLEDC_SET_RESET_PRECH   0xB1
 
#define OLEDC_ENHANCEMENT   0xB2
 
#define OLEDC_CLOCK_DIV   0xB3
 
#define OLEDC_VSL   0xB4
 
#define OLEDC_GPIO   0xB5
 
#define OLEDC_SETSEC_PRECH   0xB6
 
#define OLEDC_GREY_SCALE   0xB8
 
#define OLEDC_LUT   0xB9
 
#define OLEDC_PRECH_VOL   0xBB
 
#define OLEDC_VCOMH   0xBE
 
#define OLEDC_CONTRAST   0xC1
 
#define OLEDC_MASTER_CONTRAST   0xC7
 
#define OLEDC_MUX_RATIO   0xCA
 
#define OLEDC_COMMAND_LOCK   0xFD
 
#define OLEDC_SCROLL_HOR   0x96
 
#define OLEDC_START_MOV   0x9E
 
#define OLEDC_STOP_MOV   0x9F
 
#define OLEDC_MAP_MIKROBUS(cfg, mikrobus)
 

Functions

void oledc_cfg_setup (oledc_cfg_t *cfg)
 Configuartion Object Setup. More...
 
int8_t oledc_init (oledc_t *ctx, oledc_cfg_t *cfg)
 Click Initialization. More...
 
void oledc_default_cfg (oledc_t *ctx)
 Click Default Configuration. More...
 
void oledc_reset (oledc_t *ctx)
 Click Hardware Reset. More...
 
void oledc_enable (oledc_t *ctx, uint8_t state)
 Click Enable/Disable. More...
 
void oledc_command (oledc_t *ctx, uint8_t cmd, uint8_t *args, uint16_t args_len)
 Command Send. More...
 
void oledc_fill_screen (oledc_t *ctx, uint16_t color)
 Fill Screen. More...
 
void oledc_rectangle (oledc_t *ctx, uint8_t col_off, uint8_t row_off, uint8_t col_end, uint8_t row_end, uint16_t color)
 Draw Rectangle. More...
 
void oledc_image (oledc_t *ctx, const uint8_t *img, uint8_t column_off, uint8_t row_off)
 Draw BMP Image. More...
 
void oledc_text (oledc_t *ctx, uint8_t *text, uint16_t col_off, uint16_t row_off)
 Draw Text. More...
 
void oledc_set_font (oledc_t *ctx, const uint8_t *font, uint16_t color, uint8_t orientation)
 Font Setup. More...
 
void oledc_fill_area (oledc_t *ctx, uint16_t top, uint16_t left, uint16_t bottom, uint16_t right, uint16_t color)
 Fill Area. More...
 
void oledc_begin_frame (oledc_t *ctx, uint16_t top, uint16_t left, uint16_t bottom, uint16_t right)
 Begin Frame. More...
 
void oledc_frame_data (oledc_t *ctx, uint16_t color)
 Frame Data. More...
 
void oledc_end_frame (oledc_t *ctx)
 End Frame. More...
 

Detailed Description

This file contains API for OLED C Click driver.