Repository navigation
FAQ
Problems and fixes are on Troubleshooting.
Does it need the internet or a cloud service? No. The AP and labels work on your local network. The AP uses the internet only for the time (NTP), which you can also set from esl-client.
How many labels can one AP serve? About 500 on an ESP32-C6, with or without a screen, 1000 on the C5 or S3 + C6 (Choosing a board). For more, use several APs on different radio channels.
Tag or label? The same thing. See the Glossary.
Can I try it without hardware? Yes: the simulator runs the AP and a label on a PC, and the label designer works in any browser.
Do I need to know programming? No. Flashing, designing layouts and sending content can all be done from the web page and the AP's dashboard, and Home Assistant has an integration. The HTTP API is there when you want to connect your own software.
Can I use labels from other makers? Not yet, but the project is built to grow there. See Adding hardware.
How long does the battery last? It depends on the poll interval and how often the screen changes. The estimate and how it is worked out are in docs/strombudsjett.md.
Can I get the original firmware back? Yes, if you kept the backup the Flash tag tab made (Label backups). Write it back with ZBS_Flasher.
Still stuck? Open an issue with what you tried and what the dashboard says.
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