Skip to content

Latest commit

 

History

History
68 lines (37 loc) · 2.7 KB

README.md

File metadata and controls

68 lines (37 loc) · 2.7 KB
Raw

Ring Doorbell Screen ESP32

This project is a proof of concept (POC) for displaying a live feed from a Ring doorbell on an ESP32 with a TFT display.

Project Image

Parts and Components

This setup is designed to run on a single server/computer.

The ESP32 used is an all-in-one package with a display and additional features:

To make this project work, a few key parts are needed:

Part 1: Ring API Interface

Folder: rtsp-proxy

While Ring doesn't provide a public API, there are several projects that reverse-engineer this functionality. The best one I found is a Node.js library called ring-client-api. This library provides a way to get a livestream that can be processed using ffmpeg. Although it's not the most ideal, it allows streaming to different formats and locations, such as an RTSP server.

Part 2: RTSP Server

Folder: rtsp-server

I opted to use an RTSP server to facilitate easier processing through existing technologies. For the RTSP server, I used mediamtx.

Part 3: ESP-Proxy Server

Folder: esp-proxy

To make the ESP display as responsive as possible, I created a proxy server that converts the RTSP stream to a more ESP-friendly format.

Part 4: ESP Display

Folder: esp-display

The display gathers individual frames from the ESP-proxy and renders them on the screen. Due to the limited heap space, a compressed JPEG is used.

For detailed setup and configuration instructions, refer to the ESP Display Documentation.

Getting Started

Follow these steps to set up and run the project:

  1. Run the RTSP Server:

    • Ensure the RTSP server is up and running. This will handle the live feed from the Ring doorbell.

  2. Run the RTSP-Proxy:

    • Set up and run the rtsp-proxy to interface with the Ring doorbell and stream to the RTSP server.

  3. Run the ESP-Proxy:

    • Set up and run the esp-proxy to convert the RTSP stream into a format suitable for the ESP32.

  4. Run the ESP Display:

    • Configure and run the ESP32 to connect to the ESP-proxy and display the live feed.

For specific instructions on setting up each part, refer to the respective folders and documentation: