/** \file ssd1306.h */ #if !defined(SSD1306_H__C33398CC_133C_46F3_B9C5_5D678D1943A7__INCLUDED_) #define SSD1306_H__C33398CC_133C_46F3_B9C5_5D678D1943A7__INCLUDED_ #include "board_config.h" // Success / Error // ------------------------------------------------------------------------------------ #define SSD1306_SUCCESS 0 #define SSD1306_ERROR 1 // Address definition // ------------------------------------------------------------------------------------ #define SSD1306_ADDR 0x3C // Command definition // ------------------------------------------------------------------------------------ #define SSD1306_COMMAND 0x80 // Continuation bit=1, D/C=0; 1000 0000 #define SSD1306_COMMAND_STREAM 0x00 // Continuation bit=0, D/C=0; 0000 0000 #define SSD1306_DATA 0xC0 // Continuation bit=1, D/C=1; 1100 0000 #define SSD1306_DATA_STREAM 0x40 // Continuation bit=0, D/C=1; 0100 0000 #define SSD1306_SET_MUX_RATIO 0xA8 // Set MUX ratio to N+1 MUX, N=A[5:0] : from 16MUX to 64MUX #define SSD1306_DISPLAY_OFFSET 0xD3 // Set Display Offset #define SSD1306_DISPLAY_ON 0xAF // Display ON in normal mode #define SSD1306_DISPLAY_OFF 0xAE // Display OFF (sleep mode) #define SSD1306_DIS_ENT_DISP_ON 0xA4 // Entire Display ON, Output ignores RAM content #define SSD1306_DIS_IGNORE_RAM 0xA5 // Resume to RAM content display, Output follows RAM content #define SSD1306_DIS_NORMAL 0xA6 // Normal display, 0 in RAM: OFF in display panel, 1 in RAM: ON in display panel #define SSD1306_DIS_INVERSE 0xA7 // Inverse display, 0 in RAM: ON in display panel, 1 in RAM: OFF in display panel #define SSD1306_DEACT_SCROLL 0x2E // Stop scrolling that is configured by command 26h/27h/29h/2Ah #define SSD1306_ACTIVE_SCROLL 0x2F // Start scrolling that is configured by the scrolling setup commands:26h/27h/29h/2Ah #define SSD1306_SET_START_LINE 0x40 // Set Display Start Line #define SSD1306_MEMORY_ADDR_MODE 0x20 // Set Memory, Addressing Mode #define SSD1306_SET_COLUMN_ADDR 0x21 // Set Column Address #define SSD1306_SET_PAGE_ADDR 0x22 // Set Page Address #define SSD1306_SEG_REMAP 0xA0 // Set Segment Re-map, X[0]=0b column address 0 is mapped to SEG0 #define SSD1306_SEG_REMAP_OP 0xA1 // Set Segment Re-map, X[0]=1b: column address 127 is mapped to SEG0 #define SSD1306_COM_SCAN_DIR 0xC0 // Set COM Output, X[3]=0b: normal mode (RESET) Scan from COM0 to COM[N –1], e N is the Multiplex ratio #define SSD1306_COM_SCAN_DIR_OP 0xC8 // Set COM Output, X[3]=1b: remapped mode. Scan from COM[N-1] to COM0, e N is the Multiplex ratio #define SSD1306_COM_PIN_CONF 0xDA // Set COM Pins Hardware Configuration, // A[4]=0b, Sequential COM pin configuration, A[4]=1b(RESET), Alternative COM pin configuration // A[5]=0b(RESET), Disable COM Left/Right remap, A[5]=1b, Enable COM Left/Right remap #define SSD1306_SET_CONTRAST 0x81 // Set Contrast Control, Double byte command to select 1 to 256 contrast steps, increases as the value increases #define SSD1306_SET_OSC_FREQ 0xD5 // Set Display Clock Divide Ratio/Oscillator Frequency // A[3:0] : Define the divide ratio (D) of the display clocks (DCLK): Divide ratio= A[3:0] + 1, RESET is 0000b (divide ratio = 1) // A[7:4] : Set the Oscillator Frequency, FOSC. Oscillator Frequency increases with the value of A[7:4] and vice versa. RESET is 1000b #define SSD1306_SET_CHAR_REG 0x8D // Charge Pump Setting, A[2] = 0b, Disable charge pump(RESET), A[2] = 1b, Enable charge pump during display on // The Charge Pump must be enabled by the following command: // 8Dh ; Charge Pump Setting // 14h ; Enable Charge Pump // AFh; Display ON #define SSD1306_SET_PRECHARGE 0xD9 // Set Pre-charge Period #define SSD1306_VCOM_DESELECT 0xDB // Set VCOMH Deselect Leve #define SSD1306_NOP 0xE3 // No operation #define SSD1306_RESET 0xE4 // Maybe SW RESET, @source https://github.com/SmingHub/Sming/issues/501 // Clear Color // ------------------------------------------------------------------------------------ #define CLEAR_COLOR 0x00 // Init Status // ------------------------------------------------------------------------------------ #define INIT_STATUS 0xFF // AREA definition // ------------------------------------------------------------------------------------ #define START_PAGE_ADDR 0 #define END_PAGE_ADDR 3 // 7 for 128x64, 3 for 128x32 version #define START_COLUMN_ADDR 0 #define END_COLUMN_ADDR 127 #define RAM_X_END END_COLUMN_ADDR + 1 #define RAM_Y_END END_PAGE_ADDR + 1 #define CACHE_SIZE_MEM (1 + END_PAGE_ADDR) * (1 + END_COLUMN_ADDR) #define MAX_X END_COLUMN_ADDR #define MAX_Y (END_PAGE_ADDR + 1) * 8 // @var set area extern unsigned int _counter; /** * --------------------------------------------------------------------------------------------+ * PRIVATE FUNCTIONS * --------------------------------------------------------------------------------------------+ */ /** * @brief SSD1306 Init * * @param uint8_t * * @return uint8_t */ uint8_t SSD1306_Init (uint8_t); /** * @brief SSD1306 Send Start and SLAW request * * @param uint8_t * * @return uint8_t */ uint8_t SSD1306_Send_StartAndSLAW (uint8_t); /** * @brief SSD1306 Send command * * @param uint8_t * * @return uint8_t */ uint8_t SSD1306_Send_Command (uint8_t); /** * +------------------------------------------------------------------------------------+ * |== PUBLIC FUNCTIONS ================================================================| * +------------------------------------------------------------------------------------+ */ /** * @brief SSD1306 Clear screen * * @param void * * @return void */ void SSD1306_ClearScreen (void); /** * @brief SSD1306 Normal colors * * @param uint8_t * * @return uint8_t */ uint8_t SSD1306_NormalScreen (uint8_t); /** * @brief SSD1306 Inverse colors * * @param uint8_t * * @return uint8_t */ uint8_t SSD1306_InverseScreen (uint8_t); /** * @brief SSD1306 Update screen * * @param uint8_t * * @return uint8_t */ uint8_t SSD1306_UpdateScreen (uint8_t); /** * @brief SSD1306 Update text position * * @param void * * @return uint8_t */ uint8_t SSD1306_UpdatePosition (void); /** * @brief SSD1306 Set position * * @param uint8_t * @param uint8_t * * @return void */ void SSD1306_SetPosition (uint8_t, uint8_t); /** * @brief SSD1306 Draw character * * @param char * * @return uint8_t */ uint8_t SSD1306_DrawChar (char); /** * @brief SSD1306 Draw string * * @param char * * * @return void */ void SSD1306_DrawString (char *); /** * @brief Draw pixel * * @param uint8_t * @param uint8_t * * @return uint8_t */ uint8_t SSD1306_DrawPixel (uint8_t, uint8_t); /** * @brief Draw line * * @param uint8_t * @param uint8_t * @param uint8_t * @param uint8_t * * @return uint8_t */ uint8_t SSD1306_DrawLine (uint8_t, uint8_t, uint8_t, uint8_t); #if 0 #define OzOLED_Max_X 128 //128 Pixels #define OzOLED_Max_Y 64 //64 Pixels #define OLED_ADDRESS_W 0x3C #define OLED_ADDRESS_R 0x3D #define I2C_400KHZ 1 // 0 to use default 100Khz, 1 for 400Khz // registers #define OzOLED_COMMAND_MODE 0x80 #define OzOLED_DATA_MODE 0x40 // commands #define OzOLED_CMD_DISPLAY_OFF 0xAE #define OzOLED_CMD_DISPLAY_ON 0xAF #define OzOLED_CMD_NORMAL_DISPLAY 0xA6 #define OzOLED_CMD_INVERSE_DISPLAY 0xA7 #define OzOLED_CMD_SET_BRIGHTNESS 0x81 #define OzOLED_RIGHT_SCROLL 0x26 #define OzOLED_LEFT_SCROLL 0x27 #define OzOLED_SET_VERTICAL_SCROLL_AREA 0xA3 #define OzOLED_VERTICAL_RIGHT_SCROLL 0x29 #define OzOLED_VERTICAL_LEFT_SCROLL 0x2A #define OzOLED_CMD_ACTIVATE_SCROLL 0x2F #define OzOLED_CMD_DEACTIVATE_SCROLL 0x2E #define HORIZONTAL_ADDRESSING 0x00 #define PAGE_ADDRESSING 0x02 #define Scroll_Left 0x00 #define Scroll_Right 0x01 #define Scroll_Up 0x02 #define Scroll_Down 0x03 #define Scroll_2Frames 0x07 #define Scroll_3Frames 0x04 #define Scroll_4Frames 0x05 #define Scroll_5Frames 0x00 #define Scroll_25Frames 0x06 #define Scroll_64Frames 0x01 #define Scroll_128Frames 0x02 #define Scroll_256Frames 0x03 // =================== High Level =========================== #define OLED_I2C_ADDRESS 0x3C // The SSD1306 datasheet (pg.20) says that a control byte has to be sent before sending a command #define OLED_CONTROL_BYTE_CMD_SINGLE 0x80 #define OLED_CONTROL_BYTE_CMD_STREAM 0x00 #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 // follow with 0x00 = HORZ mode = Behave like a KS108 graphic LCD #define OLED_CMD_SET_COLUMN_RANGE 0x21 // can be used only in HORZ/VERT mode - follow with 0x00 + 0x7F = COL127 #define OLED_CMD_SET_PAGE_RANGE 0x22 // can be used only in HORZ/VERT mode - follow with 0x00 + 0x07 = PAGE7 // Hardware Config (pg.31) #define OLED_CMD_SET_DISPLAY_START_LINE 0x40 #define OLED_CMD_SET_SEGMENT_REMAP 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 // 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 0x22 #define OLED_CMD_SET_VCOMH_DESELCT 0xDB // follow with 0x30 // Charge Pump (pg.62) #define OLED_CMD_SET_CHARGE_PUMP 0x8D // follow with 0x14 // NOP #define OLED_CMD_NOP 0xE3 void Oled_SendCommand(unsigned char command); void Oled_SendData(unsigned char data); void Oled_PrintCharXY(char C, unsigned char X, unsigned char Y); void Oled_PrintChar(char C); void Oled_PrintString(const char *String, unsigned char X, unsigned char Y, unsigned char numChar); void Oled_SetCursorXY(unsigned char X, unsigned char Y); unsigned char Oled_PrintNumberXY(long long_num, unsigned char X, unsigned char Y); unsigned char Oled_PrintNumber(long long_num); unsigned char Oled_PrintFloatXY(float float_num, unsigned char prec, unsigned char X, unsigned char Y); void Oled_SetPowerOff(void); void Oled_SetPowerOn(void); void Oled_SetNormalDisplay(void); void Oled_SetPageMode(void); void Oled_ClearDisplay(void); void Oled_Initialization(void); void begin_oled_i2c_ssd1306_12864(); void oled_command(unsigned char data); void oled_data(unsigned char data); void oled_black_white(); void dispaly_bmp_image(unsigned char __flash *img_buf); #endif #endif