https://github.com/nopnop2002/esp-idf-ssd1283
SSD1283 Driver for esp-idf
https://github.com/nopnop2002/esp-idf-ssd1283
bmp esp-idf esp32 jpeg jpeg-decoder png png-decoder ssd1283
Last synced: 7 months ago
JSON representation
SSD1283 Driver for esp-idf
- Host: GitHub
- URL: https://github.com/nopnop2002/esp-idf-ssd1283
- Owner: nopnop2002
- License: mit
- Created: 2021-07-17T22:15:36.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-29T08:58:52.000Z (almost 2 years ago)
- Last Synced: 2025-02-28T19:53:16.984Z (8 months ago)
- Topics: bmp, esp-idf, esp32, jpeg, jpeg-decoder, png, png-decoder, ssd1283
- Language: C
- Homepage:
- Size: 146 KB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# esp-idf-ssd1283
SSD1283 Driver for esp-idf.
My SSD1283 is 1.6" 130x130.
# Software requirements
ESP-IDF V4.4/V5.x.
# Installation for ESP-IDF V4.4
```
git clone -b v4.4 https://github.com/nopnop2002/esp-idf-ssd1283
cd esp-idf-ssd1283
idf.py set-target {esp32/esp32s2/esp32c3}
idf.py menuconfig
idf.py flash
```
__Note for ESP32-S2__
The tjpgd library is not included in the ESP32-S2 ROM because the ROM of the ESP32-S2 is small.
Therefore, the JPEG file cannot be displayed.
__Note for ESP32-C3__
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.
# Installation for ESP-IDF V5.x
```Shell
git clone https://github.com/nopnop2002/esp-idf-ssd1283
cd esp-idf-ssd1283
idf.py set-target {esp32/esp32s2/esp32s3/esp32c2/esp32c3/esp32c6}
idf.py menuconfig
idf.py flash
```
__Note for ESP32-S2/ESP32-C2__
The tjpgd library is not included in the ESP32-S2/ESP32-C2 ROM.
However, you can use [this](https://components.espressif.com/components/espressif/esp_jpeg) IDF component registry.
JPEG files can be displayed.
__Note for ESP32-C6__
ESP-IDF V5.1 is required when using ESP32-C6.
# Configuration
You have to set this config value with menuconfig.
- CONFIG_WIDTH
- CONFIG_HEIGHT
- CONFIG_OFFSETX
- CONFIG_OFFSETY
- CONFIG_MOSI_GPIO
- CONFIG_SCLK_GPIO
- CONFIG_CS_GPIO
- CONFIG_DC_GPIO
- CONFIG_RESET_GPIO
- CONFIG_BL_GPIO
# Graphic support
# Fonts support
It's possible to text rotation and invert.
It's possible to indicate more than one font at the same time.
# Image support
BMP file
The image file is quoted from [here](https://hombre-nuevo.com/microcomputer/esp320001/).
JPEG file
PNG file
# JPEG Decoder
The ESP-IDF component includes Tiny JPEG Decompressor.
The document of Tiny JPEG Decompressor is [here](http://elm-chan.org/fsw/tjpgd/00index.html).
This can reduce the image to 1/2 1/4 1/8.
# PNG Decoder
The ESP-IDF component includes part of the miniz library, such as mz_crc32.
But it doesn't support all of the miniz.
The document of miniz library is [here](https://github.com/richgel999/miniz).
And I ported the pngle library from [here](https://github.com/kikuchan/pngle).
This can reduce the image to any size.
# Font File
You can add your original fonts.
The format of the font file is the FONTX format.
Your font file is put in font directory.
Your font file is uploaded to SPIFFS partition using meke flash.
Please refer [this](http://elm-chan.org/docs/dosv/fontx_e.html) page about FONTX format.
# Font File Editor(FONTX Editor)
[There](http://elm-chan.org/fsw/fontxedit.zip) is a font file editor.
This can be done on Windows 10.
Developer page is [here](http://elm-chan.org/fsw_e.html).
This library uses the following as default fonts:
- font/ILGH16XB.FNT // 8x16Dot Gothic
- font/ILGH24XB.FNT // 12x24Dot Gothic
- font/ILGH32XB.FNT // 16x32Dot Gothic
- font/ILMH16XB.FNT // 8x16Dot Mincyo
- font/ILMH24XB.FNT // 12x24Dot Mincyo
- font/ILMH32XB.FNT // 16x32Dot Mincyo
From 0x00 to 0x7f, the characters image of Alphanumeric are stored.
From 0x80 to 0xff, the characters image of Japanese are stored.
Changing this file will change the font.
# How to build your own font file
step1)
download fontxedit.exe.
step2)
download BDF font file from Internet.
I downloaded from [here](https://github.com/fcambus/spleen).
fontxedit.exe can __ONLY__ import Monospaced bitmap fonts file.
Monospaced bitmap fonts can also be downloaded [here](https://github.com/Tecate/bitmap-fonts).
step3)
import the BDF font file into your fontxedit.exe.
this tool can convert from BDF to FONTX.
step4)
adjust font size.
step5)
check font pattern.
step6)
save as .fnt file from your fontedit.exe.
step7)
upload your font file to $HOME/esp-idf-st7789/fonts directory.
step8)
add font to use
```
FontxFile fx32L[2];
InitFontx(fx32L,"/spiffs/LATIN32B.FNT",""); // 16x32Dot LATIN
```
Font file that From 0x80 to 0xff, the characters image of Japanese are stored.
Font file that From 0x80 to 0xff, the characters image of Latin are stored.
