ssd130x.h

Go to the documentation of this file.

 
#ifndef SSD130X_H_
#define SSD130X_H_
 
    #ifndef SSD130X_USE_SOFT_TWI
        //#define SSD130X_USE_SOFT_TWI
 
        #ifdef _DOXYGEN_    // Used for documentation, can be ignored
            #define SSD130X_USE_SOFT_TWI
        #endif
    #endif
    
    #ifndef SSD130X_HAL_PLATFORM
        #define SSD130X_HAL_PLATFORM avr
    #endif
 
    #ifndef SSD130X_ADDRESS
        #define SSD130X_ADDRESS 0x3C
    #endif
 
    #ifndef SSD130X_CONTROL_COMMAND
        #define SSD130X_CONTROL_COMMAND 0x80
    #endif
 
    #ifndef SSD130X_CONTROL_DATA
        #define SSD130X_CONTROL_DATA 0x40
    #endif
    
    #ifndef SSD130X_PAGE_SIZE
        #define SSD130X_PAGE_SIZE 8UL
    #endif
    
    #ifndef SSD130X_ROW_SIZE
        #define SSD130X_ROW_SIZE 64UL
    #endif
    
    #ifndef SSD130X_COLUMN_SIZE
        #define SSD130X_COLUMN_SIZE 128UL
    #endif
    
    #ifndef SSD130X_IDLE_TIME_US
        #define SSD130X_IDLE_TIME_US 10
    #endif
 
    #ifndef SSD130X_INIT_ROUTINE_IN_EEPROM
        // #define SSD130X_INIT_ROUTINE_IN_EEPROM
 
        #ifdef _DOXYGEN_    // Used for documentation, can be ignored
            #define SSD130X_INIT_ROUTINE_IN_EEPROM
        #endif
    #endif
 
    #ifndef SSD130X_INIT_ROUTINE_IN_EEPROM
        #ifndef SSD130X_INIT_ROUTINE_IN_PROGMEM
            // #define SSD130X_INIT_ROUTINE_IN_PROGMEM
        #endif
    #endif

    #ifndef SSD130X_CMD_SET_DISPLAY
        #define SSD130X_CMD_SET_DISPLAY 0xAE
        
        #define SSD130X_CMD_SET_DISPLAY_ON 0x01

        #define SSD130X_CMD_SET_DISPLAY_OFF 0x00
    #endif

    #ifndef SSD130X_CMD_SET_DISPLAY_CLOCK
        #define SSD130X_CMD_SET_DISPLAY_CLOCK 0xD5
        
        #define SSD130X_CMD_SET_DISPLAY_CLOCK_DIVIDE_RATIO 0x00
        
        #define SSD130X_CMD_SET_DISPLAY_CLOCK_FREQUENCY 0x80
    #endif
    
    #ifndef SSD130X_CMD_SET_MULTIPLEX_RATIO
        #define SSD130X_CMD_SET_MULTIPLEX_RATIO 0xA8
        
        #define SSD130X_CMD_SET_MULTIPLEX_RATIO_16_MUX 0x1F
        
        #define SSD130X_CMD_SET_MULTIPLEX_RATIO_32_MUX 0x2F
        
        #define SSD130X_CMD_SET_MULTIPLEX_RATIO_64_MUX 0x3F
    #endif
    
    #ifndef SSD130X_CMD_SET_DISPLAY_OFFSET
        #define SSD130X_CMD_SET_DISPLAY_OFFSET 0xD3
        
        #define SSD130X_CMD_SET_DISPLAY_OFFSET_VALUE 0x00
    #endif
    
    #ifndef SSD130X_CMD_SET_DISPLAY_START_LINE
        /* Possible line offset 0x00 - 0x3F */
        #define SSD130X_CMD_SET_DISPLAY_START_LINE_OFFSET 0x00
        
        #define SSD130X_CMD_SET_DISPLAY_START_LINE (0x40 | SSD130X_CMD_SET_DISPLAY_START_LINE_OFFSET)
    #endif
    
    #ifndef SSD130X_CMD_SET_CHARGE_PUMP
        #define SSD130X_CMD_SET_CHARGE_PUMP 0x8D

        #define SSD130X_CMD_SET_CHARGE_PUMP_EXTERNAL 0x10

        #define SSD130X_CMD_SET_CHARGE_PUMP_INTERNAL 0x14
    #endif
    
    #ifndef SSD130X_CMD_SET_SEGMENT_REMAP
        #define SSD130X_CMD_SET_SEGMENT_REMAP_STANDARD 0x00
        #define SSD130X_CMD_SET_SEGMENT_REMAP_REVERSED 0x01

        #define SSD130X_CMD_SET_SEGMENT_REMAP (0xA0 | SSD130X_CMD_SET_SEGMENT_REMAP_REVERSED)
    #endif
    
    #ifndef SSD130X_CMD_SET_COM_OUTPUT_SCAN_DIRECTION
        #define SSD130X_CMD_SET_COM_OUTPUT_SCAN_DIRECTION_NORMAL 0x00
        #define SSD130X_CMD_SET_COM_OUTPUT_SCAN_DIRECTION_REVERSED 0x08

        #define SSD130X_CMD_SET_COM_OUTPUT_SCAN_DIRECTION (0xC0 | SSD130X_CMD_SET_COM_OUTPUT_SCAN_DIRECTION_REVERSED)
    #endif
    
    #ifndef SSD130X_CMD_SET_COM_PINS_HARDWARE_CONFIGURATION
        #define SSD130X_CMD_SET_COM_PINS_HARDWARE_CONFIGURATION 0xDA
        
        #define SSD130X_CMD_SET_COM_PINS_HARDWARE_CONFIGURATION_SEQUENTIAL  0x02
        
        #define SSD130X_CMD_SET_COM_PINS_HARDWARE_CONFIGURATION_ALTERNATIVE 0x12
        
        #define SSD130X_CMD_SET_COM_PINS_HARDWARE_CONFIGURATION_NOREMAP 0x02
        
        #define SSD130X_CMD_SET_COM_PINS_HARDWARE_CONFIGURATION_REMAP 0x22

        #define SSD130X_CMD_SET_COM_PINS_HARDWARE_CONFIGURATION_SETUP (SSD130X_CMD_SET_COM_PINS_HARDWARE_CONFIGURATION_ALTERNATIVE | SSD130X_CMD_SET_COM_PINS_HARDWARE_CONFIGURATION_NOREMAP)
    #endif
    
    #ifndef SSD130X_CMD_SET_CONTRAST
        #define SSD130X_CMD_SET_CONTRAST 0x81

        #define SSD130X_CMD_SET_CONTRAST_VALUE 0x7F
    #endif
    
    #ifndef SSD130X_CMD_ENTIRE_DISPLAY_ON
        #define SSD130X_CMD_ENTIRE_DISPLAY_ON_RESUME_RAM 0x00
        #define SSD130X_CMD_ENTIRE_DISPLAY_ON_IGNORE_RAM 0x01

        #define SSD130X_CMD_ENTIRE_DISPLAY_ON (0xA4 | SSD130X_CMD_ENTIRE_DISPLAY_ON_RESUME_RAM)
    #endif
    
    #ifndef SSD130X_CMD_SET_DISPLAY_MODE
        #define SSD130X_CMD_SET_DISPLAY_MODE_NORMAL 0x00
        #define SSD130X_CMD_SET_DISPLAY_MODE_INVERSE 0x01

        #define SSD130X_CMD_SET_DISPLAY_MODE (0xA6 | SSD130X_CMD_SET_DISPLAY_MODE_NORMAL)
    #endif
    
    #ifndef SSD130X_CMD_SET_MEMORY_ADDRESSING_MODE
        #define SSD130X_CMD_SET_MEMORY_ADDRESSING_MODE 0x20

        #define SSD130X_CMD_SET_MEMORY_ADDRESSING_MODE_HORIZONTAL 0x00

        #define SSD130X_CMD_SET_MEMORY_ADDRESSING_MODE_VERTICAL   0x01

        #define SSD130X_CMD_SET_MEMORY_ADDRESSING_MODE_PAGE       0x02
    #endif
    
    #ifndef SSD130X_CMD_SET_PAGE_START_ADDRESS
        #define SSD130X_CMD_SET_PAGE_START_ADDRESS 0xB0
    #endif
    
    #ifndef SSD130X_CMD_SET_LOWER_START_COLUMN_ADDRESS
        #define SSD130X_CMD_SET_LOWER_START_COLUMN_ADDRESS 0x00
    #endif

    #ifndef SSD130X_CMD_SET_HIGHER_START_COLUMN_ADDRESS
        #define SSD130X_CMD_SET_HIGHER_START_COLUMN_ADDRESS 0x10
    #endif
    
    #ifdef SSD130X_INIT_ROUTINE_IN_EEPROM
        #include <avr/eeprom.h>
    #else
        #ifdef SSD130X_INIT_ROUTINE_IN_PROGMEM
            #include <avr/pgmspace.h>
        #endif
    #endif
 
    #include "../../../utils/macros/stringify.h"
    #include "../../../utils/systick/systick.h"

    #ifdef SSD130X_USE_SOFT_TWI
        #define TWI_SOFT_HEADER _STR(../../../hal/SSD130X_HAL_PLATFORM/twi_soft/twi_soft.h)
        #include TWI_SOFT_HEADER
 
        #define SSD130X_START(MODE) { twi_soft_start(); twi_soft_address(SSD130X_ADDRESS, MODE); }
        #define SSD130X_STOP() { twi_soft_stop(); systick_timer_wait_us(SSD130X_IDLE_TIME_US); }
        #define SSD130X_DATA() (twi_soft_set(SSD130X_CONTROL_DATA))
    #else
        #define TWI_HEADER _STR(../../../hal/SSD130X_HAL_PLATFORM/twi/twi.h)
        #include TWI_HEADER
 
        #define SSD130X_START(MODE) { twi_start(); twi_address(SSD130X_ADDRESS, MODE); }
        #define SSD130X_STOP() { twi_stop(); systick_timer_wait_us(SSD130X_IDLE_TIME_US); }
        #define SSD130X_DATA() (twi_set(SSD130X_CONTROL_DATA))
    #endif

    #define SSD130X_HOME() (ssd130x_position(0, 0))
    
    void ssd130x_init(void);
    void ssd130x_disable(void);
    void ssd130x_home(void);
    void ssd130x_position(unsigned char column, unsigned char row);
    void ssd130x_scroll_vertical(unsigned char scroll);
    void ssd130x_frame(unsigned char *frame);
    void ssd130x_page(unsigned char *data, unsigned char page);
    void ssd130x_page_segment(unsigned char *data, unsigned char column_start, unsigned char column_stop, unsigned char page);
    void ssd130x_column(unsigned char data, unsigned char column, unsigned char page);
    void ssd130x_clear(void);
    void ssd130x_clear_page(unsigned char page);
    void ssd130x_clear_page_segment(unsigned char column_start, unsigned char column_stop, unsigned char page);
    void ssd130x_clear_column(unsigned char column, unsigned char page);
 
#endif /* SSD130X_H_ */