T-Dongle-S3 User Guide Version 1.0 Copyright 2023 About This Guide This document is intended to help users set up the basic software development environment for developing applications using hardware based on the T-Dongle-S3. Through a simple example, this document illustrates how to use Arduino, including the menu based conguration wizard, compiling the Arduino and rmware download to the ESP32-S3 module. Release Notes Date 2023.09 Version V1.0 Release notes First release. Table of Contents 1. Introduction
............................................................................................................................. 1 1.1. T-Dongle-S3 .........................................................................................................................1 1 1.2. Arduino
..................................................................................................................................... 1.3. Preparation
................................................................................................................................. 1 2. Get Started
............................................................................................................................. 2 2.1. Download the Arduino Software ...............................................................................................2 Install Prerequisites .......................................................................................................2 2.1.1. 2.1.2. Toolchain Setup ............................................................................................................2 2.2. Install the Arduino Software ......................................................................................................3 2.3. Set up Path ................................................................................................................................3 3. Configure
................................................................................................................................4 4. Connect
.................................................................................................................................. 5 5. Test Demo
...........................................................................................................................6 6. Upload Sketch
....................................................................................................................... 7 6.1. Build and Flash
.......................................................................................................................... 7 6.2. Monitor
....................................................................................................................................... 8 7. SSC Command Reference
..................................................................................................... 9 7.1. op
............................................................................................................................................... 9 7.2. sta
.............................................................................................................................................. 9 7.3. ap
............................................................................................................................................. 10 7.4. mac
.......................................................................................................................................... 10 7.5. dhcp
......................................................................................................................................... 11 7.6. 7.7. 7.8. ip
.............................................................................................................................................. 11 reboot
....................................................................................................................................... 12 ram
........................................................................................................................................... 12 1. 1.1. T-Dongle-S3 1. Introduction Introduction T-Dongle-S3 is a development board. It can work independently. It consists of ESP32-S3 MCU supporting Wi-Fi + BLE communication protocol and motherboard PCB. The screen is 0.96 inch IPS LCD ST7735. At the core of this module is the ESP32S3R8 chip. ESP32-S3 integrates Wi-Fi (2.4 GHz band) and Bluetooth 5.0 solutions on a single chip, along with dual high performance cores and many other versatile peripherals. Powered by 40 nm technology, ESP32-S3 provides a robust, highly integrated platform to meet the continuous demands for efcient power usage, compact design, security, high performance, and reliability. Xinyuan provides the basic hardware and software resources that empowers application developers to build their ideas around the ESP32-S3 series hardware. The software development framework provided by Xinyuan is intended for rapidly developing Internet-
of-Things (IoT) applications, with Wi-Fi, Bluetooth, exible power management and other advanced system features. The RF frequency range is BLE: 2402-2480MHz and 2.4G Wi-Fi: 2412-2462MHz The T-Dongle-S3 manufacturer is Shenzhen Xin Yuan Electronic Technology Co., Ltd. 1.2. Arduino A set of cross-platform applications written in Java. The Arduino Software IDE is derived from the Processing programming language and the integrated development environment of the Wiring program. Users can develop applications in Windows/Linux/
MacOS based on Arduino. It is recommended to use Windows 10. Windows OS has been used as an example in this document for illustration purposes. 1.3. Preparation To develop applications for ESP32-S3 you need:
PC loaded with either Windows, Linux or Mac operating system Toolchain to build the Application for ESP32-S3 Arduino that essentially contains API for ESP32-S3 and scripts to operate the Toolchain The ESP32-S3 board itself and a USB cable to connect it to the PC Xinyuan
! /121 2023.09
2. 2. Get Started Get Started 2.1. Download the Arduino Software The quickest how to install the Arduino Software (IDE) on Windows machines 2.1.1. Quick Start Guide The website provides a quick start tutorial Windows:
https://www.arduino.cc/en/Guide/Windows Linux:
https://www.arduino.cc/en/Guide/Linux Mac OS X:
https://www.arduino.cc/en/Guide/MacOSX 2.1.2. Installation steps for Windows platform Arduino Enter the download interface, select Windows installer to install directly Xinyuan
! /122 2023.09
2.2. Install the Arduino Software 2. Get Started Wait for installation Xinyuan
! /123 2023.09
3. Start a Project Configure 3. 3.1. Download Git Download the installation package Git.exe 3.2. Pre-build configuration Click Arduino icon, then right click and select ``Open folder where ``
Select hardware ->
Mouse ** Right click ** ->
Click Git Bash Here 3.3. Cloning a remote repository
$ mkdir espressif
$ cd espressif
$ git clone --recursive https://github.com/espressif/arduino-esp32.git esp32 Xinyuan
! /124 2023.09
4. With screen 4. Connect Connect You are almost there. To be able to proceed further, connect ESP32-S3 board to PC, check under what serial port the board is visible and verify if serial communication works. After connecting USB to power on. The screen can directly display the electronic label for two seconds. Without screen See the label on the product. Xinyuan
! /125 2023.09
5. Select File>>Example>>WiFi>>WiFiScan 4. Congure Test Demo Xinyuan
! /126 2023.09
6. 6.1. Select Board Tools<<Board<<ESP32S3 Dev Module 5. Build and Flash Upload Sketch 6.2. Upload Sketch -> Upload Xinyuan
! /127 2023.09
6.2. Serial Monitor Tools ->Serial Monitor 5. Build and Flash Xinyuan
! /128 2023.09
6. SSC Command Reference 7. SSC Command Reference Here lists some common Wi-Fi commands for you to test the module. 7.1. op Description op commands are used to set and query the Wi-Fi mode of the system. Example op -Q op -S -o wmode Parameter Parameter
-Q
-S wmode Table 6-1. op Command Parameter Description Query Wi-Fi mode. Set Wi-Fi mode. There are 3 Wi-Fi modes:
mode = 1: STA mode mode = 2: AP mode mode = 3: STA+AP mode 7.2. sta Description sta commands are used to scan the STA network interface, connect or disconnect AP, and query the connecting status of STA network interface. Example sta -S [-s ssid] [-b bssid] [-n channel] [-h]
sta -Q sta -C [-s ssid] [-p password]
sta -D Parameter Parameter
-S scan Table 6-2. sta Command Parameter Description Scan Access Points. Xinyuan
! /129 2023.09
6. SSC Command Reference Description Scan or connect Access Points with the ssid. Scan the Access Points with the bssid. Scan the channel. Show scan results with hidden ssid Access Points. Show STA connect stutus. Disconnected with current Access Points. Parameter
-s ssid
-b bssid
-n channel
-h
-Q
-D 7.3. ap Description ap commands are used to set the parameter of AP network interface. Example ap -S [-s ssid] [-p password] [-t encrypt] [-n channel] [-h] [-m max_sta]
ap Q ap L Parameter Parameter
-S
-s ssid
-p password
-t encrypt
-h
-m max_sta
-Q
-L Table 6-3. ap Command Parameter Description Set AP mode. Set AP ssid. Set AP password. Set AP encrypt mode. Hide ssid. Set AP max connections. Show AP parameters. Show MAC Address and IP Address of the connected station. 7.4. mac Description mac commands are used to query the MAC address of the network interface. Example mac -Q [-o mode]
Xinyuan 10
/12 2023.09
6. SSC Command Reference Table 6-4. mac Command Parameter Description Show MAC address. mode = 1: MAC address in STA mode. mode = 2: MAC address in AP mode. Parameter Parameter
-Q
-o mode 7.5. dhcp Description dhcp commands are used to enable or disable dhcp server/client. Example dchp -S [-o mode]
dhcp -E [-o mode]
dhcp -Q [-o mode]
Parameter Parameter Description Table 6-5. dhcp Command Parameter
-S
-E
-Q
-o mode 7.6. ip Description Start DHCP (Client/Server). End DHCP (Client/Server). show DHCP status. mode = 1 : DHCP client of STA interface. mode = 2 : DHCP server of AP interface. mode = 3 : both. ip command are used to set and query the IP address of the network interface. Example ip -Q [-o mode]
ip -S [-i ip] [-o mode] [-m mask] [-g gateway]
Xinyuan 11
/12 2023.09
6. SSC Command Reference Parameter Parameter
-Q
-o mode
-S
-i ip
-m mask
-g gateway Table 6-6. ip Command Parameter Description Show IP address. mode = 1 : IP address of interface STA. mode = 2 : IP address of interface AP. mode = 3 : both Set IP address. IP address. Subnet address mask. Default gateway. 7.7. reboot Description reboot command is used to reboot the board. Example reboot 7.8. ram ram command is used to query the size of the remaining heap in the system. Example ram Xinyuan 12
/12 2023.09
FCC Caution:
Any Changes or modifications not expressly approved by the party responsible for compliance could void the user's authority to operate the equipment. This device complies with part 15 of the FCC Rules. Operation is subject to the following two conditions: (1) This device may not cause harmful interference, and (2) this device must accept any interference received, including interference that may cause undesired operation. This transmitter must not be co-located or operating in conjunction with any other antenna or transmitter. IMPORTANT NOTE:
Note: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation. If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
Reorient or relocate the receiving antenna. Increase the separation between the equipment and receiver. Connect the equipment into an outlet on a circuit different from that to which the receiver is connected. Consult the dealer or an experienced radio/TV technician for help. FCC Radiation Exposure Statement:
This equipment complies with FCC radiation exposure limits set forth for an uncontrolled environment