2019-04-17 10:15:52 -04:00
|
|
|
# esp-idf-ssd1306
|
2021-01-29 21:01:13 -05:00
|
|
|
SSD1306/SH1106 driver for esp-idf
|
2019-04-19 21:00:50 -04:00
|
|
|
|
2019-07-11 11:30:32 -04:00
|
|
|
I used [this](https://github.com/yanbe/ssd1306-esp-idf-i2c) repository as a reference.
|
|
|
|
|
I used [this](https://github.com/dhepper/font8x8) font file.
|
2019-04-21 00:28:48 -04:00
|
|
|
|
2021-09-17 22:28:09 -04:00
|
|
|
# Software requirements
|
2024-08-22 01:21:23 -04:00
|
|
|
ESP-IDF V5.0 or later.
|
|
|
|
|
ESP-IDF V4.4 release branch reached EOL in July 2024.
|
2023-01-29 00:54:57 -05:00
|
|
|
|
2023-01-29 22:05:45 -05:00
|
|
|
__Note for ESP32C2.__
|
2023-01-29 00:54:57 -05:00
|
|
|
ESP-IDF V5.0 ESP32C2 i2c driver has a bug.
|
2023-06-19 08:03:09 -04:00
|
|
|
ESP-IDF V5.1 is required when using i2c of ESP32C2.
|
2021-09-17 22:28:09 -04:00
|
|
|
|
2024-03-23 23:39:11 -04:00
|
|
|
__Note for ESP32C6 and ESP32H2.__
|
|
|
|
|
ESP-IDF V5.1 is required when using ESP32C6 and ESP32H2.
|
2023-07-09 02:49:30 -04:00
|
|
|
|
2024-03-23 19:14:25 -04:00
|
|
|
__Note for ESP-IDF V5.2.__
|
|
|
|
|
A new i2c driver is now available in ESP-IDF V5.2.
|
2024-08-18 06:17:32 -04:00
|
|
|
Under ESP-IDF V5.2 or later, this project uses a new i2c driver.
|
2024-03-23 19:14:25 -04:00
|
|
|
|
2022-06-06 22:52:21 -04:00
|
|
|
# Installation
|
2020-12-06 04:11:27 -05:00
|
|
|
|
|
|
|
|
```
|
|
|
|
|
git clone https://github.com/nopnop2002/esp-idf-ssd1306
|
2022-04-26 02:21:29 -04:00
|
|
|
cd esp-idf-ssd1306/TextDemo/
|
2024-03-23 23:32:06 -04:00
|
|
|
idf.py set-target {esp32/esp32s2/esp32s3/esp32c2/esp32c3/esp32c6/esp32h2}
|
2021-07-26 20:34:50 -04:00
|
|
|
idf.py menuconfig
|
|
|
|
|
idf.py flash
|
|
|
|
|
```
|
|
|
|
|
|
2022-11-05 21:25:51 -04:00
|
|
|
__Note for ESP32C3__
|
2022-01-07 06:29:05 -05:00
|
|
|
For some reason, there are development boards that cannot use GPIO06, GPIO08, GPIO09, GPIO19 for SPI clock pins.
|
|
|
|
|
According to the ESP32C3 specifications, these pins can also be used as SPI clocks.
|
|
|
|
|
I used a raw ESP-C3-13 to verify that these pins could be used as SPI clocks.
|
2021-09-17 22:31:50 -04:00
|
|
|
|
2021-07-26 20:34:50 -04:00
|
|
|
# Configuration
|
2019-04-19 20:44:55 -04:00
|
|
|
You have to set this config value with menuconfig.
|
2020-02-06 17:18:59 -05:00
|
|
|
- CONFIG_INTERFACE
|
|
|
|
|
- CONFIG_PANEL
|
2021-01-30 11:23:39 -05:00
|
|
|
- CONFIG_OFFSETX
|
2021-04-23 21:15:14 -04:00
|
|
|
- CONFIG_FLIP
|
2020-02-06 17:18:59 -05:00
|
|
|
- CONFIG_SDA_GPIO
|
|
|
|
|
- CONFIG_SCL_GPIO
|
|
|
|
|
- CONFIG_RESET_GPIO
|
2020-12-06 04:11:27 -05:00
|
|
|
- CONFIG_MOSI_GPIO
|
|
|
|
|
- CONFIG_SCLK_GPIO
|
2020-02-06 17:18:59 -05:00
|
|
|
- CONFIG_CS_GPIO
|
|
|
|
|
- CONFIG_DC_GPIO
|
2019-04-19 20:44:55 -04:00
|
|
|
|
2019-04-19 21:08:43 -04:00
|
|
|
|
2020-12-06 04:11:27 -05:00
|
|
|
|
2019-04-19 20:44:55 -04:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2021-01-29 20:57:39 -05:00
|
|
|
# Generic SSD1306 128x32 i2c
|
2019-04-19 20:44:55 -04:00
|
|
|
|
|
|
|
|
|
2023-07-24 17:18:04 -04:00
|
|
|
|
2019-04-19 20:44:55 -04:00
|
|
|
|
2021-01-29 20:57:39 -05:00
|
|
|
# Generic SSD1306 128x64 i2c
|
2019-04-19 20:44:55 -04:00
|
|
|
|
|
|
|
|
|
2023-07-24 17:18:04 -04:00
|
|
|
|
2019-04-19 20:44:55 -04:00
|
|
|
|
2021-01-29 20:57:39 -05:00
|
|
|
# Generic SH1106 128x64 i2c
|
2024-08-28 19:24:00 -04:00
|
|
|
Many sellers sell SH1106 as SSD1306.
|
|
|
|
|
__SH1106 does not support hardware scrolling.__
|
2021-01-29 21:01:13 -05:00
|
|
|
Left:1.3 inch SH1106
|
2021-01-29 21:02:37 -05:00
|
|
|
Right:0.96 inch SSD1306
|
2021-01-29 21:01:13 -05:00
|
|
|
|
2021-01-29 20:57:39 -05:00
|
|
|
|
2023-07-24 17:18:04 -04:00
|
|
|
|
2021-01-29 20:57:39 -05:00
|
|
|
|
2021-01-30 11:26:28 -05:00
|
|
|
# 128x64 TTGO
|
2021-07-26 20:56:09 -04:00
|
|
|
Unlike other ESP32 development boards, the RTC_CLOCK crystal on this board uses a 26MHz one.
|
2024-08-11 16:59:19 -04:00
|
|
|
You need to change the Main XTAL frequency to 26MHz using menuconfig.
|
2019-04-19 20:44:55 -04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2023-07-24 17:18:04 -04:00
|
|
|
|
2024-08-11 16:59:19 -04:00
|
|
|
|
2019-04-19 20:44:55 -04:00
|
|
|
|
2021-01-30 11:26:28 -05:00
|
|
|
# 128x64 ESP-WROOM-32
|
2019-05-02 04:17:33 -04:00
|
|
|
|
|
|
|
|
|
2023-07-24 17:18:04 -04:00
|
|
|
|
2021-01-29 20:57:39 -05:00
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Generic SSD1306 128x32 SPI
|
|
|
|
|
|
|
|
|
|
|
2022-11-18 17:50:20 -05:00
|
|
|
|
2019-05-02 04:17:33 -04:00
|
|
|
|
|
|
|
|
|
2021-01-29 20:57:39 -05:00
|
|
|
# Generic SSD1306 128x64 SPI
|
2020-12-06 04:14:27 -05:00
|
|
|
D0 is SCLK.
|
|
|
|
|
D1 is MOSI.
|
2019-04-19 20:44:55 -04:00
|
|
|
|
2019-04-27 00:13:57 -04:00
|
|
|
|
2022-11-18 17:50:20 -05:00
|
|
|
|
2019-04-19 20:44:55 -04:00
|
|
|
|
2021-01-29 20:57:39 -05:00
|
|
|
|
|
|
|
|
# Generic SH1106 128x64 SPI
|
2024-08-28 19:24:00 -04:00
|
|
|
Many sellers sell SH1106 as SSD1306.
|
|
|
|
|
__SH1106 does not support hardware scrolling.__
|
2021-01-29 21:01:13 -05:00
|
|
|
Left:1.3 inch SH1106
|
2021-01-29 21:02:37 -05:00
|
|
|
Right:0.96 inch SSD1306
|
2021-01-29 20:57:39 -05:00
|
|
|
|
|
|
|
|
|
2022-11-18 17:50:20 -05:00
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2024-03-25 09:28:55 -04:00
|
|
|
# I2C Clock speed
|
|
|
|
|
According to the SSD1306 datasheet, the minimum i2c clock cycle time is 2.5us.
|
|
|
|
|
Therefore, the maximum i2c clock frequency is 400KHz.
|
|
|
|
|
The i2c clock frequency used by this project is 400KHz.
|
|
|
|
|
|
2023-07-24 17:18:04 -04:00
|
|
|
# I2C Port selection
|
2024-09-06 22:43:16 -04:00
|
|
|
|
2023-07-24 17:18:04 -04:00
|
|
|
|
2024-09-06 22:48:09 -04:00
|
|
|
XTENSA's ESP32 has two i2c port: I2C_NUM_0/1.
|
2023-07-24 17:18:04 -04:00
|
|
|
You can use these two ports freely.
|
|
|
|
|
If you use this module at the same time as another I2C device using I2C port 0, you must change it to I2C port 1.
|
|
|
|
|
|
2024-09-06 22:43:16 -04:00
|
|
|
# Force legacy i2c driver
|
2024-09-06 22:48:09 -04:00
|
|
|
XTENSA's ESP32 has two i2c port: I2C_NUM_0/1.
|
2024-09-06 22:43:16 -04:00
|
|
|
I2C_NUM_0/1 are initialized independently, but legacy i2c drivers and new i2c drivers cannot be mixed.
|
|
|
|
|
If I2C_NUM_0 is initialized with the legacy i2c driver, I2C_NUM_1 must also be initialized with the legacy i2c driver.
|
|
|
|
|
If you use the SSD1306 at the same time as an I2C device that uses a legacy I2C driver, you must initialize the SSD1306 with the legacy I2C driver.
|
|
|
|
|
Enabling this will use the legacy i2c driver even after ESP-IDF V5.2.
|
|
|
|
|
|
|
|
|
|
|
2023-07-24 17:18:04 -04:00
|
|
|
---
|
|
|
|
|
|
2024-03-25 09:28:55 -04:00
|
|
|
# SPI Clock speed
|
|
|
|
|
According to the SSD1306 datasheet, the minimum SPI clock cycle time is 100ns.
|
|
|
|
|
Therefore, the maximum SPI clock frequency is 10MHz.
|
|
|
|
|
The SPI clock frequency used by this project is 1MHz.
|
|
|
|
|
Higher SPI clock frequencies can be specified using ```spi_clock_speed()```.
|
2024-03-25 09:31:06 -04:00
|
|
|
When using 10MHz, you need to be careful about the length of the wire cable.
|
2024-03-25 09:28:55 -04:00
|
|
|
```
|
|
|
|
|
//int speed = 1000000; // 1MHz
|
|
|
|
|
//int speed = 2000000; // 2MHz
|
|
|
|
|
//int speed = 4000000; // 4MHz
|
|
|
|
|
//int speed = 6000000; // 6MHz
|
|
|
|
|
//int speed = 8000000; // 8MHz
|
|
|
|
|
int speed = 10000000; // 10MHz
|
|
|
|
|
spi_clock_speed(speed);
|
|
|
|
|
spi_master_init(&dev, CONFIG_MOSI_GPIO, CONFIG_SCLK_GPIO, CONFIG_CS_GPIO, CONFIG_DC_GPIO, CONFIG_RESET_GPIO);
|
|
|
|
|
```
|
|
|
|
|
|
2022-11-18 17:50:20 -05:00
|
|
|
# SPI BUS selection
|
|
|
|
|
|
|
|
|
|
|
2024-03-23 19:26:33 -04:00
|
|
|
The ESP32 XTENSA series has three SPI BUSs.
|
2022-11-18 17:50:20 -05:00
|
|
|
SPI1_HOST is used for communication with Flash memory.
|
|
|
|
|
You can use SPI2_HOST and SPI3_HOST freely.
|
|
|
|
|
When you use SDSPI(SD Card via SPI), SDSPI uses SPI2_HOST BUS.
|
|
|
|
|
When using this module at the same time as SDSPI or other SPI device using SPI2_HOST, it needs to be changed to SPI3_HOST.
|
|
|
|
|
When you don't use SDSPI, both SPI2_HOST and SPI3_HOST will work.
|
|
|
|
|
Previously it was called HSPI_HOST / VSPI_HOST, but now it is called SPI2_HOST / SPI3_HOST.
|
2021-01-30 11:23:39 -05:00
|
|
|
|
2021-04-23 21:15:14 -04:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Flip upside down
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-01-29 18:51:53 -05:00
|
|
|
|
