oledswitch 2.0.0.0
oledswitch.h File Reference

This file contains API for OLED Switch 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  oledswitch_scroll_t
 Scroll structure. More...
 
struct  oledswitch_coordinate_t
 Coordinate structure. More...
 
struct  oledswitch_color_t
 Color structure. More...
 
struct  oledswitch_contrast_t
 Contrast structure. More...
 
struct  oledswitch_t
 Click ctx object definition. More...
 
struct  oledswitch_cfg_t
 Click configuration structure definition. More...
 

Macros

#define OLEDSWITCH_MAP_MIKROBUS(cfg, mikrobus)
 
#define OLEDSWITCH_RETVAL   uint8_t
 
#define OLEDSWITCH_OK   0x00
 
#define OLEDSWITCH_INIT_ERROR   0xFF
 
#define OLEDSWITCH_15_CONTRAST_FOR_COLOR_A_1   0x81
 
#define OLEDSWITCH_15_CONTRAST_FOR_COLOR_A_2   0x19
 
#define OLEDSWITCH_15_CONTRAST_FOR_COLOR_B_1   0x82
 
#define OLEDSWITCH_15_CONTRAST_FOR_COLOR_B_2   0x14
 
#define OLEDSWITCH_15_CONTRAST_FOR_COLOR_C_1   0x83
 
#define OLEDSWITCH_15_CONTRAST_FOR_COLOR_C_2   0x24
 
#define OLEDSWITCH_30_CONTRAST_FOR_COLOR_A_1   0x81
 
#define OLEDSWITCH_30_CONTRAST_FOR_COLOR_A_2   0x15
 
#define OLEDSWITCH_30_CONTRAST_FOR_COLOR_B_1   0x82
 
#define OLEDSWITCH_30_CONTRAST_FOR_COLOR_B_2   0x1A
 
#define OLEDSWITCH_30_CONTRAST_FOR_COLOR_C_1   0x83
 
#define OLEDSWITCH_30_CONTRAST_FOR_COLOR_C_2   0x17
 
#define OLEDSWITCH_MASTER_CURRENT_CONTROL_1   0x87
 
#define OLEDSWITCH_MASTER_CURRENT_CONTROL_2   0x0F
 
#define OLEDSWITCH_REMAP_AND_COLOR_DEPTH_SETTING_1   0xA0
 
#define OLEDSWITCH_REMAP_AND_COLOR_DEPTH_SETTING_2   0x70
 
#define OLEDSWITCH_SET_DISPLAY_START_LINE_1   0xA1
 
#define OLEDSWITCH_SET_DISPLAY_START_LINE_2   0x00
 
#define OLEDSWITCH_SET_DISPLAY_OFFSET_1   0xA2
 
#define OLEDSWITCH_SET_DISPLAY_OFFSET_2   0x10
 
#define OLEDSWITCH_NORMAL_DISPLAY   0xA4
 
#define OLEDSWITCH_MULTIPLEX_RATIO_1   0xA8
 
#define OLEDSWITCH_MULTIPLEX_RATIO_2   0x2F
 
#define OLEDSWITCH_DIM_MODE_SETTING_FOR_COLOR_A_B_C_1   0xAB
 
#define OLEDSWITCH_DIM_MODE_SETTING_FOR_COLOR_A_B_C_2   0x00
 
#define OLEDSWITCH_DIM_MODE_SETTING_FOR_COLOR_A_B_C_3   0x12
 
#define OLEDSWITCH_DIM_MODE_SETTING_FOR_COLOR_A_B_C_4   0x0C
 
#define OLEDSWITCH_DIM_MODE_SETTING_FOR_COLOR_A_B_C_5   0x14
 
#define OLEDSWITCH_DIM_MODE_SETTING_FOR_COLOR_A_B_C_6   0x12
 
#define OLEDSWITCH_MASTER_CONFIGURATION_1   0xAD
 
#define OLEDSWITCH_MASTER_CONFIGURATION_2   0x8E
 
#define OLEDSWITCH_POWER_SAVE_MODE_1   0xB0
 
#define OLEDSWITCH_POWER_SAVE_MODE_2   0x0B
 
#define OLEDSWITCH_PHASE_1_AND_2_PERIOD_ADJUSTMENT_1   0xB1
 
#define OLEDSWITCH_PHASE_1_AND_2_PERIOD_ADJUSTMENT_2   0x44
 
#define OLEDSWITCH_DISPLAY_CLOCK_DIVIDER_OSCILLATOR_FREQUENCY_1   0xB3
 
#define OLEDSWITCH_DISPLAY_CLOCK_DIVIDER_OSCILLATOR_FREQUENCY_2   0xA0
 
#define OLEDSWITCH_ENABLE_LINEAR_GRAY_SCALE   0xB9
 
#define OLEDSWITCH_PRE_CHARGE_LEVEL_1   0xBB
 
#define OLEDSWITCH_PRE_CHARGE_LEVEL_2   0x12
 
#define OLEDSWITCH_15_SET_VCOMH_1   0xBE
 
#define OLEDSWITCH_15_SET_VCOMH_2   0x28
 
#define OLEDSWITCH_30_SET_VCOMH_1   0xBE
 
#define OLEDSWITCH_30_SET_VCOMH_2   0x3E
 
#define OLEDSWITCH_DISPLAY_ON_IN_NORMAL_MODE   0xAF
 
#define OLEDSWITCH_BUFFER_SIZE_BIG   0x00
 
#define OLEDSWITCH_BUFFER_SIZE_SMALL   0x01
 
#define OLEDSWITCH_FILL_ENABLE_DISABLE   0x26
 
#define OLEDSWITCH_ROW_RANGE   0x75
 
#define OLEDSWITCH_COLUMN_RANGE   0x15
 
#define OLEDSWITCH_CLEAR_WINDOW   0x25
 
#define OLEDSWITCH_DEACTIVATE_SCROLLING   0x2E
 
#define OLEDSWITCH_ACTIVATE_SCROLLING   0x2F
 
#define OLEDSWITCH_SCROLLING_SETUP   0x27
 
#define OLEDSWITCH_IMG_SIZE_NORMAL   6144
 
#define OLEDSWITCH_IMG_SIZE_BIG   12288
 

Functions

void oledswitch_cfg_setup (oledswitch_cfg_t *cfg)
 Config Object Initialization function.
 
OLEDSWITCH_RETVAL oledswitch_init (oledswitch_t *ctx, oledswitch_cfg_t *cfg)
 Initialization function.
 
void oledswitch_default_cfg (oledswitch_t *ctx, uint8_t buffer_size)
 Click Default Configuration function.
 
void oledswitch_reg_write (oledswitch_t *ctx, uint8_t *write_buf, uint8_t len)
 Register write function.
 
void oledswitch_draw_image (oledswitch_t *ctx, const uint8_t *image_buf, uint16_t image_size)
 Register write function.
 
void oledswitch_set_contrast (oledswitch_t *ctx)
 Set contrast function.
 
void oledswitch_set_master_current (oledswitch_t *ctx)
 Set master current function.
 
void oledswitch_set_remap_color_depth (oledswitch_t *ctx)
 Set remap color depth function.
 
void oledswitch_set_display_start_line (oledswitch_t *ctx)
 Set display start line function.
 
void oledswitch_set_display_offset (oledswitch_t *ctx)
 Set display offset function.
 
void oledswitch_set_normal_display (oledswitch_t *ctx)
 Set normal display function.
 
void oledswitch_set_multiplex_ratio (oledswitch_t *ctx)
 Set multiplex ratio function.
 
void oledswitch_set_dim_mode (oledswitch_t *ctx)
 Set dim mode function.
 
void oledswitch_set_master_config (oledswitch_t *ctx)
 Set master config function.
 
void oledswitch_set_power_save_mode (oledswitch_t *ctx)
 Set power save mode function.
 
void oledswitch_set_phase_period_adjustment (oledswitch_t *ctx)
 Set phase period adjustment function.
 
void oledswitch_display_clock_divider_oscillator_frequency (oledswitch_t *ctx)
 Display clock divider oscillator frequency function.
 
void oledswitch_enable_linear_gray_scale (oledswitch_t *ctx)
 Enable linear gray scale function.
 
void oledswitch_pre_charge_level (oledswitch_t *ctx)
 Set pre-charge level function.
 
void oledswitch_set_vcomh (oledswitch_t *ctx)
 Set vcomh function.
 
void oledswitch_display_normal_mode (oledswitch_t *ctx)
 Display normal mode function.
 
void oledswitch_set_row_range (oledswitch_t *ctx, uint8_t start, uint8_t end)
 Set row range function.
 
void oledswitch_set_column_range (oledswitch_t *ctx, uint8_t start, uint8_t end)
 Set column range function.
 
void oledswitch_clear_window (oledswitch_t *ctx)
 Clear window function.
 
void oledswitch_deactivate_scrolling (oledswitch_t *ctx)
 Deactivate scrolling function.
 
void oledswitch_activate_scrolling (oledswitch_t *ctx)
 Activate scrolling function.
 
void oledswitch_demo_scrolling_setup (oledswitch_t *ctx)
 Demo scroling setup function.
 
void oledswitch_software_reset (oledswitch_t *ctx)
 Software reset function.
 
void oledswitch_digital_write_pwm (oledswitch_t *ctx, uint8_t signal)
 Digital write pwm function.
 
void oledswitch_digital_write_rst (oledswitch_t *ctx, uint8_t signal)
 Digital write reset function.
 

Detailed Description

This file contains API for OLED Switch Click driver.