ESP32-S3-Matrix

From Waveshare Wiki
Jump to: navigation, search
ESP32-S3-Matrix
ESP32-S3-Matrix.jpg

ESP32-S3, USB Type-C
{{{name2}}}

{{{name3}}}

{{{name4}}}

{{{name5}}}

Overview

Introduction

ESP32-S3-Matrix is a compact microcontroller development board with multiple digital interfaces, such as 20x GPIO pin headers, and onboard 8*8 RGB LED matrix, which can be used for displaying cool RGB LED effects or simple images.
In terms of hardware, it adopts ESP32-S3 as the main chip, integrates high-performance Xtensa® 32-bit LX7 dual-core processor, low-power co-processor, WiFi, Bluetooth, RF module, and other peripheral interfaces, enabling it to be compatible with other devices, and is easy to use.
In terms of software, you can choose the ESP-IDF development environment or develop on the Arduino IDE, and you can easily get started with it and apply it to your projects.

Features

  • Adopts ESP32-S3 chip, integrates high-performance Xtensa® 32-bit LX7 dual-core processor, the main frequency is up to 240MHz.
  • Integrates 512KB SRAM, 384KB ROM, 16KB RTC SRAM, and 4MB Flash memory storage.
  • Integrates low energy Bluetooth(Bluetooth LE) wireless communication, 2.4GHZ WiFi, and superior RF performance.
  • USB Type-C connector, easier to use.
  • Adapting multiple peripheral interfaces, onboard 8*8 beads matrix of 64 RGB beads, for displaying cool RGB LED effects or simple images.
  • Support multiple low-power working effects, balancing the communication distance, data rate, and power consumption, meeting various application requirements.
  • Please note that the LED brightness should not be set too high, it will cause a rapid temperature increase, which can result in damage to the board.

Function Block

ESP32-S3-Matrix func.png

Pinout Definition

ESP32-S3-Matrix OR.png

Dimensions

ESP32-S3-Matrix Dim.jpg

Working with ESP-IDF

The following development system is Windows by default, and it is recommended to use the VSCode plug-in for development.

Develop with VSCode Plug-in

Install VSCode

1. Open the download page of the official VSCode website, and select the corresponding system and system bit to download.
ESP32-S3-Pico 05.jpg
2. After running the installation package, the rest can be installed by default, but here for the subsequent experience, it is recommended to check boxes 1, 2, and 3.
  • After the first two items are enabled, you can open VSCode directly by right-clicking files or directories, which can improve the subsequent user experience.
  • After the third item is enabled, you can select VSCode directly when you choose how to open it.
ESP32-S3-Pico 06.jpg

Install Espressif IDF Plug-in

  • Note: Currently the latest version of the plugin is V1.6.4, users can choose the same version as us for a consistent experience!
  • Open VSCode, use Shift+Ctrl+X to enter the plug-in manager.

ESP32-C6-DEV-KIT-N8-03.png

  • In the search bar, enter Espressif IDF to select the corresponding plug-in and click "Install".

ESP32-C6-DEV-KIT-N8-04.png

ESP32-C6-DEV-KIT-N8-05.png

  • Press F1 to input:
esp-idf: configure esp-idf extension

ESP32-C6-DEV-KIT-N8-06.png

  • Select express (This tutorial is intended for first-time installation users, so only the first general installation tutorial is covered).

ESP32-C6-DEV-KIT-N8-07.png

  • Select download sever.

ESP32-C6-DEV-KIT-N8-08.png

  • Select the version of ESP-IDF you want to use now, we choose the latest V5.1.1.

ESP32-C6-DEV-KIT-N8-09.png

  • The following two are the installation paths respectively for the ESP-IDF container directory and the ESP-IDF Tools directory.

ESP32-C6-DEV-KIT-N8-10.png

  • Note: If you have installed ESP-IDF before, or failed to do so, please be sure to delete the file completely or create a new path without Chinese.
  • After configuring, click "Install" to download:

ESP32-C6-DEV-KIT-N8-19.png

  • Enter the download interface, and then it will automatically install the corresponding tools and environment, just wait for a second.

ESP32-C6-DEV-KIT-N8-11.png

  • After the installation is complete, you will enter the following interface, indicating that the installation is finished.

ESP32-C6-DEV-KIT-N8-12.png

Official Demo Usage GUIDE

Create Demo

  • Press F1 to enter:
esp-idf:show examples projects

ESP32-C6-DEV-KIT-N8-13.png

  • Select your current IDF version:

ESP32-C6-DEV-KIT-N8-14.png

  • Take the Hello World demo as an example:
    • ①Select the corresponding demo.
    • ②Its readme will state what chip the demo applies to (how the demo is used and the file structure are described below, omitted here).
    • ③Click to create the demo.

ESP32-C6-DEV-KIT-N8-15.png
Select the path to place the demo, no folder with the same name as the demo is required
ESP32-C6-DEV-KIT-N8-16.png

Modify COM Port

  • The corresponding COM ports are shown here, click to modify them.
  • Please select the COM ports according to your device. (You can view it from the device manager.)
  • In case of a download failure, please press the reset button for more than 1 second or enter download mode, and wait for the PC to recognize the device again before downloading once more.

SP32-S3 TO Program Add 1.png

  • Select the project or demo to use:

ESP32-C6-DEV-KIT-N8-18.png

  • Then we finish the modification of the COM ports.

Modify the Driver Object

  • The driver object is displayed here, and you can modify it by clicking on it.
  • Select the project or demo to use.

ESP32-C6-DEV-KIT-N8-20.png

  • Wait for a minute after clicking.

ESP32-C6-DEV-KIT-N8-21.png

  • Select the object we need to drive, which is our main chip, ESP32S3.

ESP32-S3-DEV-KIT-22.png

  • Choose the path to openocd, it doesn't affect us here, so let's just choose one at random.

ESP32-S3-DEV-KIT-23.png

The Rest of the Status Bar

  • ①SDK configuration editor, supports modifying many features and configurations of ESP-IDF.
  • ②All cleanup, and clear all compiled files.
  • ③Compile.
  • ④Current download mode, default is UART.
  • ⑤Burn the current firmware, please do it after compiling.
  • ⑥Open the serial port monitor, used to view the serial port information.
  • ⑦Compile, burn, open the serial monitor all-in-one button, (most commonly used for debugging).
ESP32-C6-DEV-KIT-N8-24.png

Compile, Program, Serial Port Monitoring

  • Click on the all-in-one button we described before to compile, burn, and open the serial port monitor.
ESP32-C6-DEV-KIT-N8-25.png
  • It may take a long time to compile especially for the first time.
ESP32-C6-DEV-KIT-N8-26.png
  • During this process, the ESP-IDF may take up a lot of CPU resources, so it may cause the system to lag.
  • If it is the first time to burn the program for a new project, you will need to select the download method, and select UART.
ESP32-C6-DEV-KIT-N8-27.png
  • This can also be changed later in the Download Methods section (click on it to bring up the options).
ESP32-C6-DEV-KIT-N8-28.png
  • As it comes with the onboard automatic download circuit, there is no need for manual operation to download automatically.
ESP32-C6-DEV-KIT-N8-29.png
  • After successful download, automatically enter the serial monitor, you can see the chip output the corresponding information and be prompted to restart after 10S.
ESP32-C6-DEV-KIT-N8-30.png

Erase Device Flash

  • Unpack the software resource package (Flash debugging software).
  • Open flash_download_tool_3.9.5.exe software, select ESP32-S3 and USB.

ESP32-S3-Relay-6CH TO MicroPython Firmware 1.png

  • Select the UART port number, and click START (not select any bin file).

ESP32-S3-DEV-KIT-N8-84.png

  • After programming, click on "ERASE".

ESP32-S3-DEV-KIT-N8-85.png

  • Waiting for Erase to Finish.

ESP32-S3-DEV-KIT-N8-86.png

Working with Arduino

Environment Set-up

ESP32-C6-DEV-KIT-N8-Arduino01.png

  • Enter Arduino IDE after installation.

ESP32-C6-DEV-KIT-N8-Arduino02.png

  • Go to the board manager, search for esp32, select the latest version of esp32 by Espressif Systems at the bottom, and click install (if it doesn't install correctly, you can try using a phone hotspot).

ESP32-S3-DEV-KIT-N8-Arduino07.png

  • Restart the Arduino IDE after installation, and then you can use it.

ESP32-S3-DEV-KIT-N8-Arduino09.png

If the installation fails

  • Failed to install 2.0.11 version:

ESP32-S3-DEV-KIT-N8-install.png

ESP32-S3-DEV-KIT-N8-install02.png

  • Click on the path from the resource manager "c:\Users\Waveshare\AppData\Local\Arduino15\packages" (Waveshare is the user name of the computer, and you need to turn on Show Hidden Files).

ESP32-S3-DEV-KIT-N8-install03.png

  • Unzip the downloaded files to the packages file folder:

ESP32-S3-DEV-KIT-N8-install04.png

  • Install it again:

ESP32-S3-DEV-KIT-N8-Arduino07.png

  • Restart the Arduino IDE after installation and you're ready to go!

ESP32-S3-DEV-KIT-N8-Arduino09.png

Run Example

Create Example

  • Above, change the project folder to c:\Users\Waveshare\AppData\Local\Arduino15\packages (Waveshare is the computer username).

ESP32-S3-Tiny-09.png
ESP32-S3-Tiny-10.png

  • Open Arduino IDE again.
  • Demos can be created from the examples in the Project folder under File.

ESP32-C6-DEV-KIT-N8-Arduino10.png

  • The following is the RGB flashing example (File -> Sketchbook -> esp32 -> hardware -> esp32 -> 2.0.11 -> libraries -> ESP32 -> examples -> BlinkRGB under GPIO).

ESP32-S3-DEV-KIT-N8-Arduino11.png

  • Please replace the demo with the following code:
#define PIN_NEOPIXEL 14
void setup() {
  // No need to initialize the RGB LED
}
// the loop function runs over and over again forever
void loop() {
  neopixelWrite(PIN_NEOPIXEL, RGB_BRIGHTNESS, 0, 0);  // Red
  delay(1000);
  neopixelWrite(PIN_NEOPIXEL, 0, RGB_BRIGHTNESS, 0);  // Green
  delay(1000);
  neopixelWrite(PIN_NEOPIXEL, 0, 0, RGB_BRIGHTNESS);  // Blue
  delay(1000);
  neopixelWrite(PIN_NEOPIXEL, 0, 0, 0);  // Off / black
  delay(1000);
}

Upload Demo

  • Note that the pins need to be modified to the corresponding RGB pins!
  • Select the development board and port.

ESP32-C6-DEV-KIT-N8-Arduino12.png

  • Search esp32s3, select ESP32S3 Dev Module, and the ports to download.

ESP32-S3-DEV-KIT-N8-Arduino13.png

  • After selecting, click to upload and Arduino IDE will start to compile and program the demo.

ESP32-S3-DEV-KIT-N8-Arduino14.png

  • After uploading, you can see the effect on the development board.

ESP32-S3-DEV-KIT-N8-Arduino15.png

Examples

The following demonstrates device control on the Arduino IDE.

Library Installation

  • Install Adafruit NeoPixel library:

ESP32-S3 TO Arduino Add 1.png

  • Install Adafruit NeoMatrix library:

ESP32-S3 TO Arduino Add 2.png

  • Install ALL:

ESP32-S3 TO Arduino Add 3.png

  • Install Adafruit GFX Library:

ESP32-S3 TO Arduino Add 4.png

  • Install ALL:

ESP32-S3 TO Arduino Add 5.png

  • Install FastLED library:

ESP32-S3 TO Arduino Add 6.png

  • Install SensorLib library for QMI8658:

ESP32-S3 TO Arduino Add 7.png

Display Characters

ESP32-S3 TO Arduino sample1 1.png

  • The characters inside the quotation marks can be modified to display the corresponding characters on the ESP32-S3-Matrix.
  • After modification, upload the demo and use.

Dynamic Game

  • Install the corresponding library files.
  • Download the sample demo, The example in the "Game" folder of the sample is a small game where a light bead moves aligning with the tilt of ESP32-S3-Matrix.
  • Uploading the demo and use it.
  • After successfully uploading the demo, a bead will be on near the center position.
  • The lit bead will move according to the current tilt angle of the device.
  • The demo can be modified according to the requirement to achieve more complex operations.

RGB Color

  • Install the corresponding library files.
  • Download the sample demo. The example in the "Color" folder of the sample is a rather cool color flow.
  • Upload the demo and use it.
  • After successfully uploading the demo, the board will display colors in a flowing state.
  • The demo can be modified according to requirements to achieve more complex operations.

Web Page Control

  • Install the corresponding library files.
  • Download the sample demo. The example in the "HTTP" folder of the sample allows controlling ESP32-S3-Matrix display via a web page.
  • Uploading the demo to use it. Once the demo is successfully uploaded, follow the instructions below
  • Control the device (phone, computer, etc.) to connect to the WIFI named ESP32-S3-Matrix.

ESP32-S3 TO Arduino sample3 1'.png

  • Once successfully connected to the WIFI, you can enter the ESP32-S3-Matrix control page by typing "10.10.10.1" into your browser's address bar and pressing Enter.
 10.10.10.1
  • The web page contains two global refresh buttons for controlling ESP32-S3-Matrix, as well as a text box and a submit button.

ESP32-S3 TO Arduino sample3 2.png

  • After entering characters into the text box, clicking the Submit button will cause the characters in the text box to flow and display on the ESP32-S3-Matrix.

Resource

Demo

Software

Programming Software

UART

Flash

Bluetooth

Schematic

ESP32-S3 Datasheet

Official ESP32 Documentation

FAQ

 Answer:

Please check if the configuration options are matched.
ESP32-S3-Matrix-faq01.png

{{{5}}}


 Answer:

Please select the driver object again and compile it again.
ESP32-C6-DEV-KIT-N8-20.png
ESP32-S3-DEV-KIT-22.png

{{{5}}}


 Answer:

Method 1: Press the reset button for more than 1 second, wait for the PC to recognize the device again, and then proceed with the download.
Method 2: You can long-press the BOOT button, simultaneously press the RESET button, then release the RESET button, and finally release the BOOT button. This will put the module into download mode and can resolve most download issues.

{{{5}}}


 Answer:

In VSCode, click the shortcut F1, and search for Espressif IDF, you will find that it is designated as an untrusted extension, set it as trusted.

{{{5}}}


 Answer:

Please select the COM port and driver object again after switching ESP, then compile and burn.

{{{5}}}


 Answer:

Check whether the power supply voltage for the USB port is less than 5V, in general, if it is 4.9V or more, the module's two USB ports can be used normally. If it is lower than 4.9V, the power supply may be insufficient and the USB port may disconnect. In this case, you should replace it with a USB port with sufficient voltage.

{{{5}}}


 Answer:

Close OpenOCD below and reopen OpenOCD.

{{{5}}}


Support



Technical Support

If you need technical support or have any feedback/review, please click the Submit Now button to submit a ticket, Our support team will check and reply to you within 1 to 2 working days. Please be patient as we make every effort to help you to resolve the issue.
Working Time: 9 AM - 6 PM GMT+8 (Monday to Friday)