Skip to content
This repository has been archived by the owner on Aug 23, 2024. It is now read-only.

Commit

Permalink
Merge pull request #59 from dj1ch/development
Browse files Browse the repository at this point in the history
restyle(s)
  • Loading branch information
dj1ch committed Jul 22, 2024
2 parents 2287f18 + cd82dba commit 9a04a72
Show file tree
Hide file tree
Showing 8 changed files with 1,184 additions and 1,010 deletions.
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32
- Remove/uninstall/modify your screen library depending on your display for `Config::screen` below, some of these dependencies may have already been installed previously.
- Sometimes the repository owner of certain libraries may require you to install it a certain way, be sure to follow their guides if needed/included.

| `SSD1306` | `WEMOS_OLED_SHIELD` | `CYD` | `T_DISPLAY_S3` | Any `M5`* board | `SSD1305` | `IDEASPARK_SSD1306` | `SH1106` |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | -------------------------- | -------------------------- | -------------------------- |
| `SSD1306` | `WEMOS_OLED_SHIELD` | `CYD` | `T_DISPLAY_S3` | Any `M5`\* board | `SSD1305` | `IDEASPARK_SSD1306` | `SH1106` |
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------ | -------------------------- | -------------------------- | -------------------------- |
| `Adafruit SSD1306`, remove `Adafruit SSD1306 Wemos Mini OLED` if installed | `Adafruit SSD1306 Wemos Mini OLED`, remove `Adafruit SSD1306` if installed | Follow the [CYD documentation](https://github.com/witnessmenow/ESP32-Cheap-Yellow-Display/blob/main/SETUP.md), it uses a similar library much like the `T_DISPLAY_S3` | Follow the [T-Display-S3 documentation](https://github.com/Xinyuan-LilyGO/T-Display-S3/tree/main?tab=readme-ov-file#4%EF%B8%8F%E2%83%A3--arduino-ide-manual-installation), it uses a library similar to the `CYD`. If it's an off-brand/clone of some sort, install `TFT_eSPI` and follow this [guide](/TFT) | Install `TFT_eSPI` and follow this [guide](/TFT) | Install `Adafruit SSD1305` | Install the `u8g2` library | Install the `u8g2` library |

Make sure you install the correct library, they aren't the same library and if you install the wrong one it will result in the compilation failing.
Expand Down
14 changes: 9 additions & 5 deletions TFT/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## Custom User_Setup Files for Specific Firmwares and Devices

<p>Custom User_Setup files are essential for ensuring proper functionality of certain devices. These files contain crucial information such as GPIO pins, display configurations, and other necessary settings.

Utilizing these files is straightforward, as each is designed with clear and intuitive naming conventions to simplify device configuration.</p>
Expand All @@ -14,19 +15,22 @@ These files need to be integrated into your TFT_eSPI library. The images below i
Inside this file, identify the specific display you are using (refer to the User_Setup file Screenshot for guidance). To activate your preferred display device, uncomment the corresponding entry by removing the "//" preceding it. It is crucial to have only one display configuration uncommented at any given time and to verify the accuracy of the display name to avoid errors.

## User_Setup file Screenshot
![user_setup_sel](images/user_setup_sel.png)

![user_setup_sel](images/user_setup_sel.png)

---

Board selction in Arduino IDE for the M5 devices, the CYD and the non branded TTGO T-display are shown below. The partition scheme for the CYD is the same as the
M5 devices which is Minimal SPIFFS (Large APPS with OTA).

## CYD board selection Screenshot

![board-choice](images/cyd_screen.png)

---

## M5 board selection Screenshots

![board-choice](images/board-choice.png) ![partition](images/part-scheme.png)

---
Expand All @@ -37,15 +41,15 @@ M5 devices which is Minimal SPIFFS (Large APPS with OTA).
<summary>Minigotchi Configurations</summary>
<p align="left">If you intend to flash the minigotchi firmware to an M5 device or a generic ttgo t-display, ensure you select one of the following User_Setup files that corresponds with the device available in the firmware:
<br>
- (User_Setup_CYD.h) For use with a ESP32-2432S028R also called a CYD
- (User_Setup_CYD.h) For use with a ESP32-2432S028R also called a CYD
<br>
- (User_Setup_CYD2USB.h) For use with a CYD that has microUSB & USB-C. Only define in User_Setup_Select.h & not in minigotchi firmware
<br>
- (User_Setup_m5stickc.h) For use with a M5Stick C Plus 1.1
- (User_Setup_m5stickc.h) For use with a M5Stick C Plus 1.1
<br>
- (User_Setup_m5stickcp2.h) For use with a M5Stick C Plus 2
- (User_Setup_m5stickcp2.h) For use with a M5Stick C Plus 2
<br>
- (User_Setup_m5cardputer.h) For use with a M5Cardputer
- (User_Setup_m5cardputer.h) For use with a M5Cardputer
<br>
- (User_Setup_TTGO_NoTouch.h) Can be used with a generic (Non branded) TTGO T-Display
</p>
Expand Down
Loading

0 comments on commit 9a04a72

Please sign in to comment.