About rpi-webrtc-streamer

rpi-webrtc-streamer is a lightweight WebRTC video streaming server designed specifically for Raspberry Pi hardware. It transforms compatible Raspberry Pi models (Pi 2, 3, Zero, Zero W) into Web Cam servers that broadcast live camera feeds directly to WebRTC-enabled browsers or native clients without requiring a separate signaling server. The software leverages the MMAL library and integrated raspivid utilities to capture and encode H.264 video from standard Pi Camera modules or Arducam sensors with high efficiency. Key features include low-CPU motion detection utilizing inline motion vectors generated during video encoding, allowing for resource-conservative surveillance applications. Additionally, it supports Telegram Messenger integration to notify users of motion events by sending alert messages and recorded video clips, effectively functioning as a private security bot. The project is available via Docker images for ARMv7l architectures, pre-built Debian packages, or source code for cross-compilation on U

k

Published by

kclyu

Visit View Profile

README.md

View on GitHub

WebRTC streamer for Raspberry PI

General

Notice: This is a work in progress,

This repo's objective is providing something like Web Cam server on the most popular Raspberry PI hardware. By integrating WebRTC and Raspberry PI, we can stream the Raspberry camera feed to browser or native client which talks WebRTC.

Generally, the components of WebRTC service are classified into Signaling Server and WebRTC client. However, RWS(Rpi-WebRTC-Streamer) is built to operate on one piece of Raspberry PI hardware and includes some of Signaling Server functionality. In other words, the Browser or Client supporting WebRTC directly connects to RWS and receives WebRTC streaming service.

Streaming camera feed

To get the camera feed from Raspberry PI, i.e. H.264 video stream, RWS use MMAL(Multi-Media Abstraction Layer) library can be found on ARM side libraries for interfacing to Raspberry Pi GPU. it provides lower level API to multi-media components running on Broadcom VideoCore. For convenience, this streamer directly integrated raspivid with encoding parameter changing in H.264 stream and passing video frame through WebRTC native code package.

Motion Detection

Motion Detection feature provided by Rpi-WebRTC-Streamer uses Inline Motion Vector which is generated during video encoding. And use this to get the approximate Motion Detection function while using minimal CPU resources.

Please refer to README_motion document.

Messenger Notification

The motion detection event message can be transmitted to the user through the telegram messenger. It can send motion detection message and detected video clip to Telegram Messenger client so that it can be used as a private security bot. For more information, Please refer to README_TelegramBot document.

Rpi WebRTC Streamer

Demo Video

Hardware Requirement

Raspberry PI

Raspberry PI 2/3
Raspberry Pi Zero/Zero W (ZeroW tested)

Video Camera

RPI Camera board V1/V2
Arducam 5 Megapixels 1080p Sensor OV5647 Mini Camera Video Module

Audio hardware

Please refer to the README_audio.md

Running RWS on Raspberry PI

Please refer to README_rws_setup.md document.

Download Docker image for Testing

In Raspberry PI, you can run the image directly after the pull from the docker hub as shown below.

docker pull kclyu/rpi-webrtc-streamer
docker container run --device=/dev/vcsm --device=/dev/vchiq --net=host --mount type=bind,source=/var/run/dbus,target=/var/run/dbus --rm -d kclyu/rpi-webrtc-streamer # note1

Note1: docker image is currently for armv7l (Raspberry PI2 and above).

Download Deb package for Testing

To download RWS deb package, please refer to the following URL. RWS is currently in development and testing, so please use it with consideration.

Please refer to Rpi-Webrtc-Streamer-deb Repo.

Cross Compile on Ubuntu Linux

Please refer to README_building.md document.

rpi-webrtc-streamer