LILYGO T-BEAM-S3 Software User Guide

LILYGO T-BEAM-S3 Software

Specifications:

• Product Name: 7%($06 8VHU *XLGH
• Supported Hardware: ESP32 module
• Software: $UGXLQR
• Version: 9

Product Usage Instructions:

About This Guide

This document is designed to assist users in setting up the software development environment for applications using hardware based on the 7%($06. It includes instructions on using $UGXLQR, configuring it through the menu- based wizard, compiling, and downloading firmware to the ESP32 module.

Release Notes

Date: [Insert Date]

Version: 9

Release notes: Initial release

Get Started

1. Initialization: Ensure all necessary components are connected properly.
2. Connect: Establish connection to the hardware.
3. Configure Hardware: Set up hardware settings.
4. Build and Flash: Compile and download firmware to the ESP32 module.
5. Monitor: Monitor the application’s behavior.

SSC Command Reference

1. op: Perform operation.
2. sta: Set station mode.
3. ap: Set access point mode.
4. mac: Configure MAC address.
5. dhcp: Enable DHCP.
6. ip: Set IP address.
7. reboot: Reboot the system.

Frequently Asked Questions (FAQ):

• Q: What is the purpose of this guide?
  A: This guide helps users in setting up the software development environment for applications using hardware based on the 7%($06 and provides instructions on using $UGXLQR.

• Q: How do I compile and download firmware to the ESP32 module?
  A: To compile and download firmware, follow the steps outlined in the “Build and Flash” section under “Get Started.”

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-BEAM-S3. Through a simple example, this document illustrates how to use Arduino, including the menu based configuration wizard, compiling the Arduino and firmware download to the ESP32 module.

Release Notes

Introduction

1. T-BEAM-S3
   T-BEAM-S3 is a development board. It can work independently. It consists of ESP32-S3 MCU supporting Wi-Fi + BLE communication protocol and motherboard PCB. And this product has GPS positioning and LoRa function. GPS chip is Ublox MAX- M10S-00B or L76K(Optional version), LoRa chip is SX1262. For applications ranging from low-power sensor networks to the most demanding tasks. At the core of this module is the ESP32-S3 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. ESP32 provides a robust, highly integrated platform to meet the continuous demands for efficient power usage, compact design, security. 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 (loT) applications, with Wi-Fi, Bluetooth, flexible power management and other advanced system features. The manufacturer is Shenzhen Xin Yuan Electronic Technology Co., Ltd.

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.

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 Toolchain
• CH9102 serial port driver
• The ESP32-S3 board itself and a USB cable to connect it to the PC

Get Started

Download the Arduino Software
The quickest how to install the Arduino Software (IDE) on Windows machines

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. Installation steps for Windows platform Arduino

Enter the download interface, select Windows installer to install directly

Install the Arduino Software

Wait for installation

Configure

1. Download Git
   • Download the installation package Git.exe
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. Cloning a remote repository
   • $ mkdir espressif
   • $ cd espressif
   • $ git clone –recursive https://github.com/espressif/arduino-esp32-git esp32

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.

Test Demo

Select File>>Example>>WiFi>>WiFi Scan

Upload Sketch

1. Select Board
   Tools<<Board<<ESP32-S3 Dev Module

2. Upload
   Sketch < Upload

3. SerialMonitor
   Tools < Serial Monitor

SSC Command Reference

Here lists some common Wi-Fi commands for you to test the module.

op

1. Description
   op commands are used to set and query the Wi-Fi mode of the system.

2. Example
   

   • op -Q
   • op-S -0 wmodel
     

Parameter
Table 6-1. op Command Parameter

wmode

| There are 3 Wi-Fi modes:

•   mode = 1: STA mode

•   mode = 2: AP mode

•   mode = 3: STA+AP mode

sta

1. Description

   • sta commands are used to scan the STA network interface, connect or disconnect AP, and query the connecting status of STA network interface.

2. Example
   

   • sta -S [-s ssid] [-b bssid] [-n channel] [-h]
   • sta -Q sta -C [-s ssid] [-p password]
   • sta -D

Parameter

Table 6-2. sta Command Parameter

ap

1. Description
   

   • ap commands are used to set the parameter of AP network interface.

2. Example
   

   • ap -S [-s ssid] [-p password] [-t encrypt] [-n channel] [-h] [-m max_sta]
   • ap -Q
   • ap -L

Parameter

Table 6-3. ap Command Parameter

mac

1. Description
   • mac commands are used to query the MAC address of the network interface.
2. Example
   • mac -Q [-o mode]

Parameter
Table 6-4. mac Command Parameter

•   mode = 1: MAC address in STA mode.
•   mode = 2: MAC address in AP mode.

dhop

1. Description

   • dhep commands are used to enable or disable dhop server/client.

2. Example
   

   • ip -Q [-o mode]
   • ip -S [-i ip] [-o mode] [-m mask] [-g gateway]
     

Parameter
Table 6-5. dhcp Command Parameter

-o mode

|

• mode = 1 : DHCP client of STA interface.
•  mode = 2 : DHCP server of AP interface.
•  mode = 3 : both.

IP

1. Description

   • p command are used to set and query the IP address of the network interface.

2. Example
   

   • ip -Q [-o mode]
   • ip -S [-i ip] [-o mode] [-m mask] [-g gateway]

Parameter
Table 6-6. ip Command Parameter

-o mode

|

• mode = 1 : IP address of interface STA.
•  mode = 2 : IP address of interface AP.
•   mode = 3 : both

-S| Set IP address.
-i ip| IP address.
-m mask| Subnet address mask.
-g gateway| Default gateway.

reboot

• Description

  • reboot command is used to reboot the board.

• Example
  

  • reboot

• ram
  ram command is used to query the size of the remaining heap in the system.

• Example

  • ram

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 .This equipment should be installed and operated with minimum distance 20cm between the radiator& your body.

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>