esp32/ESP32-Cheap-Yellow-Display
1
0
Fork 0
mirror of https://github.com/witnessmenow/ESP32-Cheap-Yellow-Display.git synced 2026-03-13 08:32:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

License, Readme tidy up and spelling fixes

Browse Source
This commit is contained in:
witnessmenow
2023-10-31 16:02:12 +00:00
parent 1f28d91bf5
commit 8dec527468
6 changed files with 184 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
ADDONS.md
View File

@@ -1,15 +1,86 @@
# Add-Ons
Here is a list of aditional hardware add-ons that can add funcitonality to your CYD
Here is a list of additional hardware add-ons that can add functionality to your CYD
## SD Card Sniffer
If you want to use the pins of the SD card for a different purpose, the easiest way to do that is with an "SD card sniffer", which basically plugs into the SD card slot and breaks out the pins. It's particularly useful for SPI devices.
## Pin-out of the Sniffer board
| Sniffer Board Label | ESP32 Pin | SPI Use |
| ------------------- | --------- | --------- |
| DAT2 | - | - |
| CD | IO5 | CS |
| CMD | IO23 | DI / MOSI |
| GND | GND | - |
| VCC | 3.3V | - |
| CLK | IO18 | SCLK |
| DAT0 | IO19 | DO / MISO |
| DAT1 | - | - |
### Links
- [Micro SD Card Snigger - Aliexpress\*](https://s.click.aliexpress.com/e/_Ddwcy9h)
## Nintendo Wii Nunchuck
A Nunchuck controller from a Nintendo Wii is a great input device for CYD projects as they are inexpensive and, since they use i2c for communication, they only require 2 GPIO pins to connect them up.
For these two pins you get:
- An analog stick
- 2 Buttons
- An accelerometer
## Hardware Required
### Nunchuck controllers
Official Nintendo ones are generally better (maybe try second-hand options), but third-party ones also work fine.
- [Amazon.co.uk Search\*](https://amzn.to/3nQrXcE)
- [Amazon.com Search\*](https://amzn.to/3nRJTUd)
- [Aliexpress (Third Party)\*](https://s.click.aliexpress.com/e/_AaQbXh)
### Nunchuck controllers
There are many different options available for these, even the cheap ones from Aliexpress work perfectly.
- [Aliexpress](https://s.click.aliexpress.com/e/_AEEtc3)
- [My Open source one from Oshpark](https://oshpark.com/shared_projects/RcIxSx2D)
- [Adafaruit](https://www.adafruit.com/product/4836)
## Wiring
The easiest way to wire this up is to use the wire that came with the CYD and the **CN1** JST connector (the one closest to the Micro SD card slot)
Connect the wire to your breakout board as follows:
| CYD CN1 | Adapter | Note |
| ------- | ----------- | ------------------ |
| GND | - (AKA GND) | Black wire for me |
| 3.3V | + (AKA 3V) | Red wire for me |
| IO22 | d (AKA SDA) | Blue wire for me |
| IO27 | c (AKA SCL) | Yellow wire for me |
Note: I have found pull-ups resistors are not required on SDA and SCL
## Example
Check out the [NunchuckTest](/Examples/InputTests/NunchuckTest) example for code how to use it.
## Speakers
A speaker can be attached to the display with a 1.25mm JST connector to the connector labled "SPEAK" (or soldered)
A speaker can be attached to the display with a 1.25mm JST connector to the connector labeled "SPEAK" (or soldered)
Check out the [HelloRadio](/Examples/Basics/7-HelloRadio) example for the code on how to use it.
Most small 8 Ohm speakers should work. Maybe worth adding a 1.25mm JST connector to it to make it easy to add remove.
Most small 8 Ohm speakers should work. Maybe worth adding a 1.25mm JST connector to it to make it easy to add remove.
### Links
- [Speaker with 1.25mm JST connector (2pcs) - Aliexpress*](https://s.click.aliexpress.com/e/_DBOJoh7) - Tested, works right out of the package.
- [2pin 1.25mm JST connectors - Aliexpress*](https://s.click.aliexpress.com/e/_DlbPkWH) - Not purchased by me, but should work
- [Speaker with 1.25mm JST connector (2pcs) - Aliexpress\*](https://s.click.aliexpress.com/e/_DBOJoh7) - Tested, works right out of the package.
- [2pin 1.25mm JST connectors - Aliexpress\*](https://s.click.aliexpress.com/e/_DlbPkWH) - Not purchased by me, but should work
\* = Affiliate Link - It doesn't cost you any extra but I receive a small portion of the sale.

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 Brian Lough
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

12
MEDIA.md Normal file
View File

@@ -0,0 +1,12 @@
# Media and Mentions
This page can document any times the CYD project was mentioned somewhere!
## Videos
- [Brian Lough (hey, thats me!) - Cheap and Easy to Use ESP32 Screen!](https://www.youtube.com/watch?v=0AVyvwv0agk)
## Articles
- [Hackaday.com - “Cheap Yellow Display” Builds Community Through Hardware](https://hackaday.com/2023/10/28/cheap-yellow-display-builds-community-through-hardware/)
- [Hackster.io - Brian Lough Looks to Build a Community Around the Espressif ESP32-Powered "Cheap Yellow Display"](https://www.hackster.io/news/brian-lough-looks-to-build-a-community-around-the-espressif-esp32-powered-cheap-yellow-display-66d23972910d)

4
OriginalDocumentation/Readme.md
View File

@@ -6,6 +6,10 @@ Please use these files at your own risk
I downloaded this from the [Sunton Store listing](https://www.aliexpress.com/item/1005004502250619.html) on May 21st, 2023
## License Note:
This folder is **NOT** covered by the MIT license as I do not have authority to do that. You will need to contact Sunton to get license information for it.
## Removed folders
I have removed two folders from the original download as some contain executables and are also quite large. These were labeled:

26
PINS.md
View File

@@ -2,17 +2,31 @@
This page talks about the pins on the CYD.
## What pins are available on the CYD?
There are 3 easily accessible GPIO pins
|Pin|Location|Note|
|---|---|----|
|IO35|**P3** JST connector|Input only pin, no internal pull-ups available|
|IO22|**P3** and **CN1** JST connector||
|IO27|**CN1** JST connector||
If you need more than that, you need to start taking them from something else. An SD Card sniffer like mentioned in the [Add-ons](/ADDONS.md) is probably the next easiest.
After that you're probably de-soldering something!
## Broken Out Pins
There are three 4P 1.25mm JST connectors on the board, here are the broken out pins.
There are three 4P 1.25mm JST connectors on the board
### P3
|Pin|Use|Note|
|---|---|----|
|GND|||
|IO35||Input only pin, no internal pullups available|
|IO35||Input only pin, no internal pull-ups available|
|IO22||Also on the **CN1** connector|
|IO21||Used for the TFT Backlight, so not really usuable|
|IO21||Used for the TFT Backlight, so not really usable|
### CN1
This is a great candidate for I2C devices
@@ -43,7 +57,7 @@ The CYD has two buttons, reset and boot.
## Speaker
The speaker connector is a 2P 1.25mm JST connector that is connected to the amplifier, so not usuable as GPIO at the speaker connector
The speaker connector is a 2P 1.25mm JST connector that is connected to the amplifier, so not usable as GPIO at the speaker connector
|Pin|Use|Note|
|---|---|----|
@@ -51,7 +65,7 @@ The speaker connector is a 2P 1.25mm JST connector that is connected to the ampl
## RGB LED
If your project requires addtional pins to what is available elsewhere, this might be a good candidate to sacrifice.
If your project requires additional pins to what is available elsewhere, this might be a good candidate to sacrifice.
Note: LEDs are "active low", meaning HIGH == off, LOW == on
@@ -68,7 +82,7 @@ Note: LEDs are "active low", meaning HIGH == off, LOW == on
|IO5|SD_CS||
|IO18|SD_SCK||
|IO19|SD_MISO||
|IO23|SD_MOSI
|IO23|SD_MOSI||
## Touch Screen

66
README.md
View File

@@ -1,10 +1,9 @@
# ESP32-Cheap-Yellow-Display
There is an ESP32 with a built in 320 x 240 LCD display with a touch screen called the "ESP32-2432S028R", since this doesn't roll of the tounge, I propose it should be renamed the "Cheap Yellow Display" or CYD for short. This display is only about $15 delievered so I think it's really good value.
There is an ESP32 with a built in 320 x 240 LCD display with a touch screen called the "ESP32-2432S028R", since this doesn't roll of the tongue, I propose it should be renamed the "Cheap Yellow Display" or CYD for short. This display is only about $15 delivered so I think it's really good value.
![image](https://github.com/witnessmenow/ESP32-Cheap-Yellow-Display/assets/1562562/76c3d481-2523-4b6f-881c-2e29f9368cd0)
## Features
The CYD has the following features:
@@ -13,51 +12,88 @@ The CYD has the following features:
- 320 x 240 LCD Display
- Touch Screen (Resistive)
- USB for powering and programming
- SD Card Slot, LED and some addtional pins broken out
- SD Card Slot, LED and some additional pins broken out
## Who is it good for?
I think it's useful for the following types of people:
- **People just getting started with working hardware** - as everything is already connected, there is no soldering or additional components required
- **People who are familar with working with hardware, but are lazy** - (like me) Sometimes you just want to build a project without having to assemble any hardware
- **People who are familiar with working with hardware, but are lazy** - (like me) Sometimes you just want to build a project without having to assemble any hardware
- **People who aren't really looking to learn anything, but just want to build some cool things** - More about this later.
## What is the purpose of this page?
So this is pretty nice hardware and a cheap price, but the software instructions/support around it is pretty poor. Just a single link to a zip file on a random website.
A couple of years ago I released the [ESP32 Trinity](https://github.com/witnessmenow/ESP32-Trinity), which is an open source ESP32 board for controlling Matrix panels. I think the main benifit people get out of the work I did on the Trinty is not the hardware, but the documentation, example code and ready to go projects.
A couple of years ago I released the [ESP32 Trinity](https://github.com/witnessmenow/ESP32-Trinity), which is an open source ESP32 board for controlling Matrix panels. I think the main benefit people get out of the work I did on the Trinty is not the hardware, but the documentation, example code and ready to go projects.
I'm no longer creating hardware products, but I think it would be interesting if we could create the same kind of community around this display, where people can share examples and projects made for this display.
I'm no longer creating hardware products, but I think it would be interesting if we could create the same kind of community around this display, where people can share examples and projects made for this display.
## Where to buy?
Buy from wherever works out cheapest for you:
- [Aliexpress*](https://s.click.aliexpress.com/e/_DkSpIjB)
- [Aliexpress*](https://s.click.aliexpress.com/e/_DkcmuCh)
- [Aliexpress\*](https://s.click.aliexpress.com/e/_DkSpIjB)
- [Aliexpress\*](https://s.click.aliexpress.com/e/_DkcmuCh)
- [Aliexpress](https://www.aliexpress.com/item/1005004502250619.html)
- [Makerfabs](https://www.makerfabs.com/sunton-esp32-2-8-inch-tft-with-touch.html) - Seems to come with a 16GB SD card. Makerfabs also stock my [ESP32 Trinity](https://github.com/witnessmenow/ESP32-Trinity)
\* = Affilate Link
## Getting Started With Your CYD
- [Makerfabs](https://www.makerfabs.com/sunton-esp32-2-8-inch-tft-with-touch.html) - Seems to come with a 16GB SD card. Makerfabs also stock my [ESP32 Trinity](https://github.com/witnessmenow/ESP32-Trinity) (NOTE there will be import due in the EU from makerfabs)
\* = Affiliate Link
## Getting Started With Your CYD
For details on how to get started with your CYD, please check out the [Setup and Configuration](/SETUP.md) page
## Examples
## Code Examples
### The Basics
A collection of examples demonstrating how to use the different features of the CYD, this is a good place to get started. [Check them out here.](/Examples/Basics)
### Alternative Display Libraries
The basics examples are based on the TFT_eSPI display library, but the CYD also works with other display libraries too. Here is some example code if you prefer to use an alternative Arduino library. [Check them out here.](/Examples/AlternativeLibraries)
### ESPHome
Some examples for using the CYD in ESPHome. [Check them out here.](/Examples/ESPHome)
## Additional Info and Links
### Discord
Join the CYD discussion on [my Discord channel](https://discord.gg/nnezpvq)
### 3DPrinting
Some examples of 3D printed stands. [Check them out here.](/3dModels)
Some examples of 3D printed stands and cases. [Check them out here.](/3dModels)
### Pin Information
[This page](/PINS.md) contains information about what pins are used where, and what ones are free to use.
### Add-ons
[This page](/ADDONS.md) contains information about additional hardware add-ons that can add functionality to your CYD
### Troubleshooting
[This page](/TROUBLESHOOTING.md) contains information about how to troubleshoot your CYD device
### Hardware Mods
[This page](/Mods/README.md) contains information about some hardware mods that can be performed on the CYD to improve or change some of its functionality
### Media and Video Mentions
[This page](/MEDIA.md) lists any times the CYD project was mentioned somewhere!
## License Info
This project is licensed as MIT as per the [license file](/LICENSE)
The one exception to this is the [OriginalDocumentation](/OriginalDocumentation/) folder, that I do not have the right to license
## Help Support what I do!