ssd1306.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2020 nopnop2002
 * Copyright (c) 2021 wolffshots
 *
 * 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 MAIN_SSD1306_H
#define MAIN_SSD1306_H
 
#include "driver/spi_master.h"
 
// Following definitions are bollowed from
// http://robotcantalk.blogspot.com/2015/03/interfacing-arduino-with-ssd1306-driven.html
 
/* Control byte for i2c
Co : bit 8 : Continuation Bit 
 * 1 = no-continuation (only one byte to follow) 
 * 0 = the controller should expect a stream of bytes. 
D/C# : bit 7 : Data/Command Select bit 
 * 1 = the next byte or byte stream will be Data. 
 * 0 = a Command byte or byte stream will be coming up next. 
 Bits 6-0 will be all zeros. 
Usage: 
0x80 : Single Command byte 
0x00 : Command Stream 
0xC0 : Single Data byte 
0x40 : Data Stream
*/
#define OLED_CONTROL_BYTE_CMD_SINGLE 0x80
#define OLED_CONTROL_BYTE_CMD_STREAM 0x00
#define OLED_CONTROL_BYTE_DATA_SINGLE 0xC0
#define OLED_CONTROL_BYTE_DATA_STREAM 0x40
 
// Fundamental commands (pg.28)
#define OLED_CMD_SET_CONTRAST 0x81 // follow with 0x7F
#define OLED_CMD_DISPLAY_RAM 0xA4
#define OLED_CMD_DISPLAY_ALLON 0xA5
#define OLED_CMD_DISPLAY_NORMAL 0xA6
#define OLED_CMD_DISPLAY_INVERTED 0xA7
#define OLED_CMD_DISPLAY_OFF 0xAE
#define OLED_CMD_DISPLAY_ON 0xAF
 
// Addressing Command Table (pg.30)
#define OLED_CMD_SET_MEMORY_ADDR_MODE 0x20
#define OLED_CMD_SET_HORI_ADDR_MODE 0x00 // Horizontal Addressing Mode
#define OLED_CMD_SET_VERT_ADDR_MODE 0x01 // Vertical Addressing Mode
#define OLED_CMD_SET_PAGE_ADDR_MODE 0x02 // Page Addressing Mode
#define OLED_CMD_SET_COLUMN_RANGE 0x21   // can be used only in HORZ/VERT mode - follow with 0x00 and 0x7F = COL127
#define OLED_CMD_SET_PAGE_RANGE 0x22     // can be used only in HORZ/VERT mode - follow with 0x00 and 0x07 = PAGE7
 
// Hardware Config (pg.31)
#define OLED_CMD_SET_DISPLAY_START_LINE 0x40
#define OLED_CMD_SET_SEGMENT_REMAP_0 0xA0
#define OLED_CMD_SET_SEGMENT_REMAP_1 0xA1
#define OLED_CMD_SET_MUX_RATIO 0xA8 // follow with 0x3F = 64 MUX
#define OLED_CMD_SET_COM_SCAN_MODE 0xC8
#define OLED_CMD_SET_DISPLAY_OFFSET 0xD3 // follow with 0x00
#define OLED_CMD_SET_COM_PIN_MAP 0xDA    // follow with 0x12
#define OLED_CMD_NOP 0xE3                // NOP
 
// Timing and Driving Scheme (pg.32)
#define OLED_CMD_SET_DISPLAY_CLK_DIV 0xD5 // follow with 0x80
#define OLED_CMD_SET_PRECHARGE 0xD9       // follow with 0xF1
#define OLED_CMD_SET_VCOMH_DESELCT 0xDB   // follow with 0x30
 
// Charge Pump (pg.62)
#define OLED_CMD_SET_CHARGE_PUMP 0x8D // follow with 0x14
 
// Scrolling Command
#define OLED_CMD_HORIZONTAL_RIGHT 0x26
#define OLED_CMD_HORIZONTAL_LEFT 0x27
#define OLED_CMD_CONTINUOUS_SCROLL 0x29
#define OLED_CMD_DEACTIVE_SCROLL 0x2E
#define OLED_CMD_ACTIVE_SCROLL 0x2F
#define OLED_CMD_VERTICAL 0xA3
 
#define I2CAddress 0x3C
#define SPIAddress 0xFF
 
typedef enum
{
    SCROLL_RIGHT = 1,
    SCROLL_LEFT = 2,
    SCROLL_DOWN = 3,
    SCROLL_UP = 4,
    SCROLL_STOP = 5
} ssd1306_scroll_type_t;
 
typedef struct
{
    bool _valid;
    int _segLen; // 0-128
    uint8_t _segs[128];
} PAGE_t;
 
typedef struct
{
    int _address;
    int _width;
    int _height;
    int _pages;
    int _dc;
    spi_device_handle_t _SPIHandle;
    bool _scEnable;
    int _scStart;
    int _scEnd;
    int _scDirection;
    PAGE_t _page[8];
    bool _flip;
} SSD1306_t;
 
void ssd1306_init(SSD1306_t *dev);
void ssd1306_deinit(SSD1306_t *dev);
void ssd1306_display_text(SSD1306_t *dev, int page, char *text, int text_len, bool invert);
void ssd1306_wrapped_display_text(SSD1306_t *dev, int line, char *text);
void ssd1306_display_image(SSD1306_t *dev, int page, int seg, uint8_t *images, int width);
void ssd1306_clear_screen(SSD1306_t *dev, bool invert);
void ssd1306_clear_line(SSD1306_t *dev, int page, bool invert);
void ssd1306_contrast(SSD1306_t *dev, int contrast);
void ssd1306_software_scroll(SSD1306_t *dev, int start, int end);
void ssd1306_scroll_text(SSD1306_t *dev, char *text, int text_len, bool invert);
void ssd1306_scroll_clear(SSD1306_t *dev);
void ssd1306_hardware_scroll(SSD1306_t *dev, ssd1306_scroll_type_t scroll);
void ssd1306_hardware_scroll_line(SSD1306_t *dev, int page, ssd1306_scroll_type_t scroll);
void ssd1306_invert(uint8_t *buf, size_t blen);
void ssd1306_flip(uint8_t *buf, size_t blen);
uint8_t ssd1306_rotate(uint8_t ch1);
void ssd1306_fadeout(SSD1306_t *dev);
void ssd1306_dump(SSD1306_t dev);
 
void i2c_master_init(SSD1306_t *dev, int16_t sda, int16_t scl, int16_t reset);
void i2c_init(SSD1306_t *dev, int width, int height);
void i2c_display_image(SSD1306_t *dev, int page, int seg, uint8_t *images, int width);
void i2c_contrast(SSD1306_t *dev, int contrast);
void i2c_hardware_scroll(SSD1306_t *dev, ssd1306_scroll_type_t scroll);
void i2c_hardware_scroll_line(SSD1306_t *dev, int page, ssd1306_scroll_type_t scroll);
 
void spi_master_init(SSD1306_t *dev, int16_t GPIO_MOSI, int16_t GPIO_SCLK, int16_t GPIO_CS, int16_t GPIO_DC, int16_t GPIO_RESET);
bool spi_master_write_byte(spi_device_handle_t SPIHandle, const uint8_t *Data, size_t DataLength);
bool spi_master_write_command(SSD1306_t *dev, uint8_t Command);
bool spi_master_write_data(SSD1306_t *dev, const uint8_t *Data, size_t DataLength);
void spi_init(SSD1306_t *dev, int width, int height);
void spi_display_image(SSD1306_t *dev, int page, int seg, uint8_t *images, int width);
void spi_contrast(SSD1306_t *dev, int contrast);
void spi_hardware_scroll(SSD1306_t *dev, ssd1306_scroll_type_t scroll);
void spi_hardware_scroll_line(SSD1306_t *dev, int page, ssd1306_scroll_type_t scroll);
 
#endif /* MAIN_SSD1306_H */