ESP32-S3 QR Code Recognition Demo

This example project demonstrates how an ESP32-S3 can be used to scan QR codes.

This demo is an ESP-IDF application. Aside from ESP-IDF, it relies on several components from IDF Component Registry:

• espressif/esp32-camera — to obtain an image from the camera
• espressif/esp32_s3_eye — board support package for ESP32-S3-EYE board
• espressif/quirc — QR code decoding library
• lvgl/lvgl — for the UI

Hardware Required

This demo runs on an ESP32-S3-EYE board. With some work, it can be adapted to other ESP32 and ESP32-S3 boards.

This demo also requires an SD card.

Building and Running

This demo has been tested with ESP-IDF v5.2-rc1.

To build, activate ESP-IDF build environment and run:

idf.py build

To flash the demo to the board and see the console output, run:

idf.py flash monitor

Preparing the SD Card

Make sure the SD card is formatted as FAT, and place the following files on the card:

1. qrclass.txt with the list of QR code classification rules. Each rule is a pair of <regular expression> <png file name>. If the QR code matches the <regular expression> then the demo will display the corresponding PNG file on the screen.

   ^:WiFi.* wifi.png
   .* unknown.png
   

2. For each classifier, a PNG file with a 192x192 image. With the example above, wifi.png and unknown.png.

License

The code in this repository is Copyright (c) 2022-2023 Espressif Systems (Shanghai) Co. Ltd. and licensed under Apache 2.0 license.