oledswitch.h

Go to the documentation of this file.

/*
 * MikroSDK - MikroE Software Development Kit
 * Copyright© 2020 MikroElektronika d.o.o.
 * 
 * Permission is hereby granted, free of charge, to any person 
 * obtaining a copy of this software and associated documentation 
 * files (the "Software"), to deal in the Software without restriction, 
 * including without limitation the rights to use, copy, modify, merge, 
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE 
 * OR OTHER DEALINGS IN THE SOFTWARE. 
 */
 
// ----------------------------------------------------------------------------
 
#ifndef OLEDSWITCH_H
#define OLEDSWITCH_H
 
#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_spi_master.h"
 
// -------------------------------------------------------------- PUBLIC MACROS 
#define OLEDSWITCH_MAP_MIKROBUS( cfg, mikrobus ) \
   cfg.miso  = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
   cfg.mosi  = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
   cfg.sck   = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
   cfg.cs    = MIKROBUS( mikrobus, MIKROBUS_CS ); \
   cfg.rst   = MIKROBUS( mikrobus, MIKROBUS_RST ); \
   cfg.cd    = MIKROBUS( mikrobus, MIKROBUS_PWM )
#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
 // End group macro 
// --------------------------------------------------------------- PUBLIC TYPES
typedef struct 
{
    uint8_t column_horizontal_shift;
    uint8_t row_horizontal_shift;
    uint8_t row_vertical_shift;
    uint8_t row_offset;
    uint8_t interval;
 
} oledswitch_scroll_t;
 
typedef struct
{
    uint8_t column_start;
    uint8_t column_end;
    uint8_t row_start;
    uint8_t row_end;
 
} oledswitch_coordinate_t;
 
typedef struct
{
    uint8_t r;
    uint8_t g;
    uint8_t b;
 
} oledswitch_color_t;
 
typedef struct
{
    uint8_t a;
    uint8_t b;
    uint8_t c;
 
} oledswitch_contrast_t;
 
typedef struct
{
    // Output pins 
 
    digital_out_t rst;
    digital_out_t cd;
    digital_out_t cs;
    
    // Modules 
 
    spi_master_t spi;
    pin_name_t chip_select;
 
    oledswitch_coordinate_t coordinate;
    oledswitch_contrast_t contrast;
    oledswitch_scroll_t scroll;
    oledswitch_color_t color;
 
} oledswitch_t;
 
typedef struct
{
    // Communication gpio pins 
 
    pin_name_t miso;
    pin_name_t mosi;
    pin_name_t sck;
    pin_name_t cs;
 
    // Additional gpio pins 
 
    pin_name_t rst;
    pin_name_t cd;
 
    // static variable 
 
    uint32_t spi_speed;
    spi_master_mode_t spi_mode;
    spi_master_chip_select_polarity_t cs_polarity;
 
} oledswitch_cfg_t;
 
 // End types group
// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
 
#ifdef __cplusplus
extern "C"{
#endif
 
void oledswitch_cfg_setup ( oledswitch_cfg_t *cfg );
 
OLEDSWITCH_RETVAL oledswitch_init ( oledswitch_t *ctx, oledswitch_cfg_t *cfg );
 
void oledswitch_default_cfg ( oledswitch_t *ctx, uint8_t buffer_size );
 
void oledswitch_reg_write ( oledswitch_t *ctx, uint8_t *write_buf, uint8_t len );
 
void oledswitch_draw_image ( oledswitch_t *ctx, const uint8_t *image_buf, uint16_t image_size );
 
void oledswitch_set_contrast ( oledswitch_t *ctx );
 
void oledswitch_set_master_current ( oledswitch_t *ctx );
 
void oledswitch_set_remap_color_depth ( oledswitch_t *ctx );
 
void oledswitch_set_display_start_line ( oledswitch_t *ctx );
 
void oledswitch_set_display_offset ( oledswitch_t *ctx );
 
void oledswitch_set_normal_display ( oledswitch_t *ctx );
 
void oledswitch_set_multiplex_ratio ( oledswitch_t *ctx );
 
void oledswitch_set_dim_mode ( oledswitch_t *ctx );
 
void oledswitch_set_master_config ( oledswitch_t *ctx );
 
void oledswitch_set_power_save_mode ( oledswitch_t *ctx );
 
void oledswitch_set_phase_period_adjustment ( oledswitch_t *ctx );
 
void oledswitch_display_clock_divider_oscillator_frequency ( oledswitch_t *ctx );
 
void oledswitch_enable_linear_gray_scale ( oledswitch_t *ctx );
 
void oledswitch_pre_charge_level ( oledswitch_t *ctx );
 
void oledswitch_set_vcomh ( oledswitch_t *ctx );
 
void oledswitch_display_normal_mode ( oledswitch_t *ctx );
 
void oledswitch_set_row_range ( oledswitch_t *ctx, uint8_t start, uint8_t end );
 
void oledswitch_set_column_range ( oledswitch_t *ctx, uint8_t start, uint8_t end );
 
void oledswitch_clear_window ( oledswitch_t *ctx );
 
void oledswitch_deactivate_scrolling ( oledswitch_t *ctx );
 
void oledswitch_activate_scrolling ( oledswitch_t *ctx );
 
void oledswitch_demo_scrolling_setup ( oledswitch_t *ctx );
 
void oledswitch_software_reset ( oledswitch_t *ctx );
 
void oledswitch_digital_write_pwm ( oledswitch_t *ctx, uint8_t signal );
 
void oledswitch_digital_write_rst ( oledswitch_t *ctx, uint8_t signal );
 
#ifdef __cplusplus
}
#endif
#endif  // _OLEDSWITCH_H_
 
 // End public_function group
 
// ------------------------------------------------------------------------- END