Skip to content

Commit 93e0fc3

Browse files
author
Urs Weiss
committed
Add initial setup instructions
1 parent 14fc852 commit 93e0fc3

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,57 @@ Arduino code for my beautiful 3D printed LED clock in a retro 7 segment display
66

77
You can find more details about the project and all downloadable files (STL, 3MF, STEP) [on Printables.com](https://www.printables.com/model/68013-7-segment-led-clock).
88

9+
## Quick Start
10+
11+
This is the easiest and fastest way to get the LED Clock up and running.<br />
12+
I currently don't provide a dedicated web flasher, but this may is comming in the future.
13+
14+
For now you can use this guide to flash an ESP32.<br />
15+
(After the first installation you can update the firmware from the Config Portal)
16+
17+
### Initial flashing
18+
19+
1. Download the latest `bootloader.bin`, `partitions.bin` and `LedClock_YYYY-MM-DD_HHmm.bin` from [Releases](https://github.com/ursweiss/7-Segment-LED-Clock/releases)
20+
1. Connect the ESP to your computer over USB
21+
1. Open [ESP Tool](https://espressif.github.io/esptool-js/) (Chrome or Edge browser)
22+
1. Set baudrate to 115'200, click "Connect" and select the port of the ESP (e.g. cu.usbserial-0001 on a Mac)
23+
1. Add the three files as follows:
24+
- 0x1000: `bootloader.bin`
25+
- 0x8000: `partitions.bin`
26+
- 0x10000: `LedClock_YYYY-MM-DD_HHmm.bin`
27+
1. Click "Program" and wait until flashing is finished (Hard resetting via RTS pin...)
28+
29+
### Config WiFi
30+
31+
1. Connect to the WiFi SSID "LED-Clock-Config"
32+
- If the SSID doesn't show up, try to restart it
33+
1. Usually the portal should show up automatically
34+
- If not, open a browser and connect to 192.168.4.1
35+
1. Click "Configuration"
36+
1. Select your SSID and set the password
37+
- You can set two different WiFi networks, which will try to connect to one of them.<br/>
38+
Usually you will configure one network only.
39+
1. Click "Save" to connect the LED Clock to your WiFI network
40+
41+
### Config LED Clock
42+
43+
1. With a device in the same network, you now should be able to connect to http://ledclock.local
44+
1. Configure the clock as needed using the Config Portal
45+
46+
### Update firmware
47+
48+
To update a runnig LED Clock to the newest firmware version, you will only need to download the latest `LedClock_YYYY-MM-DD_HHmm.bin` from [Releases](https://github.com/ursweiss/7-Segment-LED-Clock/releases)
49+
50+
1. Access the Config Portal: http://ledclock.local
51+
1. Click on "Update", select the downloaded file and click "Upadte Firmware"
52+
53+
## ESP32
54+
55+
I mostly use "ESP-WROOM-32 Devkit" as microcontroller for my projects (I may will move to ESP32-C5 in the future as this is the only ESP also supporting 5 GHz WiFi atm.)
56+
57+
If you buy one (e.g. from AliExpress) make sure you get the correct one. It must be the 30-pin version which usually has a yellow cpacitor (many other ESP32 should wok too, but I only test with this variant):<br />
58+
![ESP-WROOM-32 Devkit](docs/images/esp-wroom-32-devkit.png)
59+
960
## Documentation
1061

1162
- **[API Reference](docs/API.md)** - REST API endpoint documentation
144 KB
Loading

0 commit comments

Comments
 (0)