Updated readme

This commit is contained in:
Daniele Verducci (Slimpenguin) 2023-12-21 08:38:35 +01:00
parent a146b668f9
commit 07e1126a58
2 changed files with 24 additions and 20 deletions

View File

@ -29,7 +29,9 @@ Please see [mddclient documentation](mddclient/README.md)
A status LCD for your homelab! Low cost (about 20€ in parts), simple to build (no circuit board, no components, only an LCD, a ESP32 and, if needed, a potentiometer). Connects to your local wifi and receives HTTP requests from your homelab machines, and shows them to the screen.
![ESP32-LCD prototype](../images/esp32-lcd.jpg)
![ESP32-LCD prototype](images/esp32-lcd.jpg)
Please see [ESP32-LCD documentation](esp32-lcd/README.md)
# License
This whole repository is released under GNU General Public License version 3: see http://www.gnu.org/licenses/

View File

@ -14,24 +14,24 @@ A status LCD for your homelab.
Connect the LCD to the board:
LCD Pin ESP32 Pin
____________________________________
PIN01-VSS GND
PIN02-VDD 5V
PIN03 V0 10K Pot (Middle pin)
PIN04 RS GPIO19
PIN05 RW GND
PIN06 E GPIO23
PIN07 D0 NOT USED
PIN08 D1 NOT USED
PIN09 D2 NOT USED
PIN10 D3 NOT USED
PIN11 D4 GPIO18
PIN12 D5 GPIO17
PIN13 D6 GPIO16
PIN14 D7 GPIO15
PIN15 A 5V
PIN16 K GND
**LCD Pin -> ESP32 Pin**
- PIN01-VSS -> GND
- PIN02-VDD -> 5V
- PIN03 V0 -> 10K Pot (Middle pin)
- PIN04 RS -> GPIO19
- PIN05 RW -> GND
- PIN06 E -> GPIO23
- PIN07 D0 -> NOT USED
- PIN08 D1 -> NOT USED
- PIN09 D2 -> NOT USED
- PIN10 D3 -> NOT USED
- PIN11 D4 -> GPIO18
- PIN12 D5 -> GPIO17
- PIN13 D6 -> GPIO16
- PIN14 D7 -> GPIO15
- PIN15 A -> 5V
- PIN16 K -> GND
Connect the potentiometer lateral pins to VCC and GND. Use the potentiometer to set the screen contrast.
@ -47,8 +47,10 @@ Restart the ESP32. The display shows "Conn to wifi..." with the WIFI name in the
- Make a GET request to the same IP address with a parameter "message" containing some text
> Example: to make the request using CURL from command line, try something along this lines (replace the IP addr with the one shown in the display):
> curl -G http://192.168.1.78 --data-urlencode "message=Something interesting happened!"
> `curl -G http://192.168.1.78 --data-urlencode "message=Something interesting happened!"`
## Troubleshooting
The ESP32 logs are written in the serial monitor at 115200 baud. Just open the Arduino ide Serial Monitor from Tools menu and look at the logs.
If the screen is supplied with power but not initialized (maybe due to bad contacts or non working esp32 firmware), it should show some black blocks on the first line. If you canot see those (nor any other text), first of all check the contrast using the potentiometer.