Repository files navigation

Example forESP32-S3-BOX(docs),ESP32-S3-BOX-3(mouser),andLilyGo T-Deck which receives anMJPEG camera stream from thecamera-streamerapp over WiFi and displays them onthe screen.

To facilitate discovery, this sample uses mDNS to find the camera-streamer app(or any RTSP server that advertises itself as_rtsp._tcp.local).

Table of Contents

• camera-display
  • Use
    • Program
    • Configure
  • Development
    • Environment
    • Build and Flash
  • Hardware
  • Software

You must first program your hardware. Afterwards, you can configure it via a USBconnection using its built-in CLI.

Download the releaseprogrammer executable from the latestreleasespage forwindows,macos, orlinux - depending on which computer you want to use to perform theone-time programming. There are a few programmers pre-built for either theESP-BOX or theLilyGo T-Deck.

1. Download the programmer
2. Unzip it
3. Double click theexe (if windows), or open a terminal and execute it fromthe command line./camera-display-<hardware>_programmer_v2.0.0_macos.bin,where hardware is one ofesp-box ort-deck.

To configure it, simply connect it to your computer via USB and open the serialport in a terminal (e.g.screen,PuTTY, etc.) at 115200 baud. Once there,you can use it as you would any other CLI - and thehelp command will provideinfo about the commands available.

Any SSID/Password you set will be securely saved in the board's NVS, which ismanaged by the ESP-IDF WiFi subsystem.

sta> helpCommands available: - helpThis help message - exitQuit the session - log <verbosity>Set the log verbosity for the wifi sta. - connectConnect to a WiFi network with the given SSID and password. - connect <ssid> <password>Connect to a WiFi network with the given SSID and password. - disconnectDisconnect from the current WiFi network. - ssidGet the current SSID (Service Set Identifier) of the WiFi connection. - rssiGet the current RSSI (Received Signal Strength Indicator) of the WiFi connection. - ipGet the current IP address of the WiFi connection. - connectedCheck if the WiFi is connected. - macGet the current MAC address of the WiFi connection. - bssidGet the current BSSID (MAC addressof the access point) of the WiFi connection. - channelGet the current WiFi channel of the connection. - configGet the current WiFi configuration. - scan <int>Scan for available WiFi networks. - memoryDisplay minimum free memory. - statsDisplay RTSP client statistics.

If you wish to modify / recompile the code, you will need to set up yourdevelopment environment to be able to build and flash your target hardware.

This project is an ESP-IDF project, currentlyESP-IDFv.5.5.1.

For information about setting upESP-IDF v5.5.1, please seethe officialESP-IDF getting starteddocumentation.

Build the project and flash it to the board, then run monitor tool to view serial output:

idf.py -p PORT flash monitor

(Replace PORT with the name of the serial port to use.)

(To exit the serial monitor, typeCtrl-].)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

This sample is designed to run on the ESP32-S3-BOX, ESP32-S3-BOX-3, and LilyGoT-Deck all of which have a 320x240 LCD (over SPI) running on a ESP32-S3.

This sample has two main tasks:

1. RTSP client that receives mjpeg frames split into RTP packets, turns themback into JPEG images, and pushes them into a queue.
2. Display task, which pulls image data from the queue, decodes the jpeg, anddisplays it on the screen.

It is built with these libraries:

• ESPP
• JPEGDEC
• ESP-IDF
• mDNS