https://github.com/wokwi/esp-idf-oled-ssd1306
I2C OLED with ESP-IDF and Wokwi Simulation
https://github.com/wokwi/esp-idf-oled-ssd1306
Last synced: 8 months ago
JSON representation
I2C OLED with ESP-IDF and Wokwi Simulation
- Host: GitHub
- URL: https://github.com/wokwi/esp-idf-oled-ssd1306
- Owner: wokwi
- Created: 2024-03-04T20:12:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T08:58:33.000Z (over 1 year ago)
- Last Synced: 2025-03-27T22:01:38.311Z (9 months ago)
- Language: C
- Size: 8.79 KB
- Stars: 10
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# I2C OLED with ESP-IDF and Wokwi Simulation
[esp_lcd](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/lcd.html) supports I2C interfaced OLED LCD, whose color depth is usually 1bpp.
This example shows how to make use of the SSD1306 panel driver from `esp_lcd` component to facilitate the porting of LVGL library. In the end, example will display a scrolling text on the OLED screen.
## Building
We recommend using the [ESP-IDF VSCode extension](https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension) to build the project. Alternatively, you can use the command line: `idf.py build`.
## Simulation
To simulate this project, install [Wokwi for VS Code](https://marketplace.visualstudio.com/items?itemName=wokwi.wokwi-vscode). Open the project directory in Visual Studio Code, press **F1** and select "Wokwi: Start Simulator".
## Debugging
The project is already set up for debugging. To debug the project, first start Wokwi in debug mode (press **F1** and select "Wokwi: Start Simulator and Wait for Debugger"). Then press **F5** to start the debugger. You can set breakpoints, step through the code, and inspect variables.
The debugger is configured to use TCP port 3333. If this port is already in use on your computer, you can change it in the `.vscode/launch.json` file (`miDebuggerServerAddress`) and in `wokwi.toml` (`gdbServerPort`).
Note that the debugger setup requires the ESP-IDF extension to be installed in VS Code. If you don't have the ESP-IDF extension, you can manually set `miDebuggerServerAddress` in `.vscode/launch.json` to point to your local installation of the `xtensa-esp32-elf-gdb` debugger (it's usually installed in the esp tools directory, under `tools/xtensa-esp-elf-gdb//xtensa-esp-elf-gdb/bin`).