Repository navigation
Flashing the access point
The Flash AP tab is a guide in three steps. It needs Chrome or Edge on a computer.
- Choose AP. Pick the card for your setup (Choosing a board).
- Flash. Plug in each board when the page asks and press Connect and flash. With a C6 radio, the C6 comes first, then the S3 on its port marked USB. If a board is not found, hold BOOT while you plug it in. The page checks that the chip is the one the step is for, and reads what is on the board: an AP that runs OpenESL keeps its data, a new board is erased first.
- WiFi and token. Over the same USB cable, give the AP your WiFi, a name and an API token (WiFi and API token). Keep a copy of the token. An AP that is on your WiFi already keeps it and its token; press Continue, or change them. With the radio over WiFi, the page then gives the C6 the same network and the S3's address.
The last step shows the AP's address and opens its dashboard. The page always flashes the latest release.
The AP stores its labels, layouts, WiFi and token in flash (NVS). How you flash decides whether they survive:
| Way | Labels, layouts, WiFi, token |
|---|---|
| Flash AP tab, on an AP that runs OpenESL | kept |
Over the air (Dashboard, or esl-client ota ...-ota.bin) |
kept |
idf.py flash |
kept |
A release's single openesl-ap-...-v<version>.bin (without -ota) written at 0x0 |
erased |
| Flash AP tab, after you choose Erase and flash as new | erased |
So the single .bin file is only for a new board or one you erase anyway. Take a backup before anything that erases (Backup and restore).
The page first reads the partition table on the board. The same table as the new firmware's: everything is kept. Nothing there (a new board): the board is erased and flashed. Another table (OpenESL from before 0.3.0, or other firmware): it stops and offers Erase and flash as new, so take a backup first.
Both boards are flashed from the web page: the C6 radio first (plain or with screen), then the S3. See ESP32-S3 + C6 and ESP32-S3 with a wireless C6 radio.
ESP-IDF v5.5.5. Each board has its own settings in ap/boards:
cd ap
python build.py --list # the boards
python build.py c6-supermini-lcd # build one board
idf.py -B build-c6-supermini-lcd -p /dev/ttyACM0 flash monitorMore in Building from source.
OpenESL is released under the MIT licence. These pages are made from the wiki/ folder in the repository: to fix something, send a pull request there, or open an issue.
Getting started
Access point
Labels
Layouts
Sending content
- Overview
- HTTP API
- esl-client
- Price lists from CSV
- Scheduled prices
- Home Assistant
- Weather on a label
Running it
- Dashboard
- Health and webhook
- Updating the AP
- Updating labels
- Upgrading from older versions
- Backup and restore
- Moving to a new AP
Help
Developers