raspiCamSrv

The Raspberry Pi Camera Server (raspiCamSrv) is a web server which can be deployed on a Raspberry Pi device giving access to installed cameras and allows to control these.

It can be installed on all Raspberry Pi platforms which allow connection of one or multiple cameras and supports the currently existing camera types. Up to now, it was tested on Pi Zero W, Pi Zero 2 W, Pi 4 and Pi 5 running Bullseye as well as Bookworm together with camera modules 1, 2, 3, HQ and GS. On Pi 5, also parallel installation of two different cameras was tested.

raspiCamSrv is built with Flask 3.0 and uses the Picamera2 library.

Due to responsive layout from W3.CSS, all modern browsers on PC, Mac or mobile devices can be used as clients.

Feature Overview V2.9.2

For more details and update procedure, see the User Guide and Release Notes.
For installation procedure, see below.

The Live screen shows a live stream of the active camera and allows individually selecting and setting all camera controls supported by Picamera2.
The live stream (MJPEG stream) can also be directly accessed through the endpoint http://<server>:<port>/video_feed.
It can be configured whether or not authentication is required.
Web access to photo snapshots is achieved through the URL http://<server>:<port>/photo_feed.
The setting for necessity of authentication applies also to photo snapshots.
For systems with 2 Raspberry Pi cameras (currently Pi 5) both cameras can stream simultaneously.
The non-active camera stream and photo can be accessed through endpoints http://<server>:<port>/video_feed2 and http://<server>:<port>/photo_feed2, respectively.
Triggered capture of videos and photos (see Triggered Capture of Videos and Photos) with motion detection
Event viewer with calendar overview
Notification on captured events by e-Mail (see Notification)
Extended Motion Capturing Algorithms are available, including Frame Differencing, Optical Flow and Background Subtraction
The Extended Motion Capturing Algorithms can be run in a testing mode, showing live views of intermediate image processing results which can help for a better understanding of the algorithms and adjustment of their variable parameters.
For cameras with focus control (camera 3), it is also possible to graphically draw autofocus windows and trigger the autofocus to measure the LensPosition which is translated into a focal distance (see Focus handling).
For zooming, the intended image section can be drawn graphically on the live stream area.
Photos, raw photos and videos can be taken, which are shown in the lower part of the Live screen together with their metadata or alternatively with their histogram (see Photo taking).
Videos can be recorded along with audio if a microphone (e.g. USB microphone) is connected to the Raspberry Pi (see Recording Audio along with Video)
"Intelligent" camera control supporting simultaneous camera access from different tasks as long as the requested configurations are compatible (see raspiCamSrv Tasks and Background Processes).
This includes a continuous live stream while taking photos, videos or photo series.
For raw photos and videos, a jpeg placeholder is shown
The photos taken may be added to a display buffer for inspection of photos and metadata and for comparison (see Photo Display)
On the Config screen, camera configurations can be specified for four different use cases (Live View, Photo, Raw Photo and Video). These will be applied together with the selected controls when photos or videos will be taken. The Live view configuration will also be immediately applied to the Live stream.
When modifying Stream Sizes to non-standard aspect ratios, an option can assure that this is syncronously done for all camera configurations, so that Live Stream, Photos, Raw Photos and Videos have all the same aspect ratio and are not distorted.- The Info screen shows the installed cameras, and, for the active camera, the camera properties as well as the available sensor modes.
The Photos screen allows scrolling through all available photos and videos with detail views of selected items.
With the Photo Series screen, different kinds of photo series (Timelapse Series, Exposure Series, Focus Stacks) can be configured, executed and monitored during their progress.
For Timelapse Series, it is possible to define active periods depending on sunrise and sunset.
The Photo Series screen allows also to persist specific Camera Configurations together with Camera Controls in the file system for later reuse.
Photo Series can be set to be automatically continued on server start if they had been interrupted by a server stop or system shotdown or reboot.
The Settings screen allows a few configuration settings such as selection of the active camera as well as selecting the type of photos, raw photos and videos in the range supported by Picamera2
The Settings screen includes also functions to control the raspiCamSrv Server Configuration.
The entire configuration can be persisted or loaded from stored configuration files.
It is also possible to configure the server to use the persisted configuration on server startup.
Access to the server requires registration and authentification.
Generator for executable Python code including the entire interface to Picamera2 of a raspiCamSrv session.
(See Generation of Python Code for Camera)

New in V2.9.0 and V2.9.1

This version extends the Photo Viewer and allows deletion and download of selected files..
Photo Series can be downloaded.

Known Issues

In Safari (e.g. on an iPad), there is still an issue with the Live Screen:
Due to the specific timing of the onload event, AF Windows may not be visible immediately after the page has been loaded. If you just 'pull' the entire window down for a short time (don't touch the AF Windows canvas), they will show up.
If the Live stream does not show up (e.g. after visiting another screen), take a photo and then push Hide/Show. This will show the live stream.
There may be an issue configuring specific sensor modes or stream sizes for the Live View in Config. As a result, the live view will not show up and the server log will show an exception. You may need to reset the server (see Reset Server)
This is already fixed but may not yet be available in your environment (see picamera2 Issue #959)

Limitations

The software is still being tested and extended.

USB cameras are detected but currently not supported. One reason is that many USB cameras use the YUYV format whereas raspiCamSrv uses MJPEG for the Live stream and YUYV would require OpenCV for rendering.
raspiCamSrv will not automatically detect a changed camera setup, for example if cameras are plugged in and out while the Raspberry Pi is running (certainly, this would apply only to USB cameras and nobody will unplug a Pi camera without shutting down the system). However, there is a Reset Server button on the Settings screen, which, when pressed, will force the configuration to be updated.
Although the layout is responsive, it may not be "good-looking" with all sizes of browser windows

Credits

Most technical information on Picamera2 (https://github.com/raspberrypi/picamera2) has been taken from the Raspberry Pi - The Picamera2 Library document.
The implementation of live streaming with Flask has been inspired by https://blog.miguelgrinberg.com/post/video-streaming-with-flask
The detailed solution for the mjpeg_server is based on the example mjpeg_server.py of the picamera2 repository
The solution for drawing on the canvas for definition of AF Windows has been inspired by https://codepen.io/AllenT871/pen/GVyXKp
The Extended Motion Capturing Algorithms are based on work done by Isaac Berrios, published under Introduction to Motion Detection: Part 1 - 3
The algorithm code has been taken from this source as well as its GitHub Repository and integrated into the raspiCamSrv environment.

Setup / Getting Started

Required

A Raspberry Pi (Zero W, Zero 2 W, Pi 1, Pi 3, Pi 4, Pi 5)
A Raspberry Pi camera
A suitable camera cable
(Pi Zero W, Pi Zero 2 W and Pi 5 have the small CSI-2 camera port, requiring a special cable which is usually not shipped with the camera)
A microSD card
A suitable power supply
For Pi Zero W or Pi Zero 2 W, a normal mobile phone charger is sufficient as long as it has a Micro-USB connector
Optionally, a case for the specific model may ease handling.
For Pi Zero W or Zero 2 W, offerings for the official case (e.g. here) should include a special short camera cable.
The cover for the camera is fine for camera models 1 and 2. For camera model 3, some handwork is necessary to enlarge the hole to a square for the camera body.
A Wifi network with internet access and known access credentials (SSID, password)
A PC or Mac with network access and (micro)SD card reader

The setup description, below, assumes a completely autonomous or 'headless' setup, where the Raspberry Pi requires nothing but a power supply cable without any necessity to ever connect it to a display, keyboard or mouse.

Here, the camera model 2 is installed.

The described steps were successfully executed with Raspberry Pi Imager version 1.8.5 and a Raspberry Pi Zero W.

System Setup

For system setup, follow the instructions of the Raspberry Pi Getting Started Documentation for OS installation using Imager.
Make sure that SSH is enabled on the Services tab.

Once the SD card is written, insert it into the Raspberry Pi and power it up.
Initially, it will take several minutes until it is visible in the network.

RaspiCamSrv Installation

If you want to update an existing installation to the latest version, see Update Procedure.

In case of problems during installation and usage, see Troubleshooting

Step	Action
1.	Connect to the Pi using SSH: `ssh <user>@<host>` with <user> and <host> as specified during setup with Imager.
2.	Update the system `sudo apt update` `sudo apt full-upgrade`
3.	Create a root directory under which you will install programs (e.g. 'prg') `mkdir prg` `cd prg`
4.	Check that git is installed (which is usually the case in current Bullseye and Bookworm distributions) `git --version` If git is not installed, install it with `sudo apt install git`
5.	Clone the raspi-cam-srv repository: `git clone https://github.com/signag/raspi-cam-srv`
6.	Create a virtual environment ('.venv') on the 'raspi-cam-srv' folder: `cd raspi-cam-srv` `python -m venv --system-site-packages .venv` For the reasoning to include system site packages, see the picamera2-manual.pdf, chapter 9.5.
7.	Activate the virtual environment `cd ~/prg/raspi-cam-srv` `source .venv/bin/activate` The active virtual environment is indicated by `(.venv)` preceeding the system prompt
8.	Make sure that picamera2 is available on the system: `python` `>>>import picamera2` `>>>quit()` If you get a 'ModuleNotFoundError', see the picamera2 Manual, chapter 2.2, how to install picamera2. For raspiCamSrv it would be sufficient to install without GUI dependencies: `sudo apt install -y python3-picamera2 --no-install-recommends`
9.	Install Flask 3.0 with the virtual environment activated. Raspberry Pi OS distributions come with Flask preinstalled, however with versions 1.1 or 2.2. RaspiCamSrv requires Flask 3.0, which can be installed with `pip install Flask==3.0.0` If you want to check the Flask version, you may need to deactivate/activate the virtual environment first: `deactivate` `source .venv/bin/activate` `flask --version` This should reveal version 'Flask 3.0.0'. Make sure that Flask is really installed in the virtual environment: `which flask` should output `/home/<user>/prg/raspi-cam-srv/.venv/bin/flask`
10.	Optional installations: The following installations are only required if you need to visualize histograms for some of the Photo Series or if you are interesten in using Extended Motion Capturing Algorithms. It is recommended to do the installation with an activated virtual environment (see step 7), although some of these packages might come preinstalled. Install OpenCV: `sudo apt-get install python3-opencv` Install numpy: `pip install numpy` Install matplotlib: `pip install matplotlib`
11.	Initialize the database for Flask (with `raspi-cam-srv` as active directory and the virual environment activated - see step 7): `flask --app raspiCamSrv init-db`
12.	Check that the Flask default port 5000 is available `sudo netstat -nlp \| grep 5000` If an entry is shown, find another free port (e.g. 5001) and replace `port 5000` by your port in all `flask` commands, below and also in the URL in step 12.
13.	Start the server (with `raspi-cam-srv` as active directory and the virual environment activated - see step 7): `flask --app raspiCamSrv run --port 5000 --host=0.0.0.0`
14.	Connect to the server from a browser: `http://<raspi_host>:5000` This will open the Login screen.
15.	Before you can login, you first need to register. The first user will automatically be SuperUser who can later register other users (User Management)
16.	After successful log-in, the Live screen will be shown
17.	Done!
18.	For usage of raspiCamSrv, please refer to the User Guide

When the Flask server starts up, it will show a warning that this is a development server.
This is, in general, fine for private environments.
How to deploy with a production WSGI server, is described in the Flask documentation

Service Configuration

When the Flask server is started in a SSH session as described in step 10, above, it will terminate with the SSH session.

Instead, you may want the server to start up independently from any user sessions, restart after a failure and automatically start up when the device is powered up.

In order to achieve this, the Flask server start can be configured as service under control of systemd.

The following procedure is for the case where audio recording with video is not required. Otherwise, see next section.

Step	Action
1.	Open a SSH session on the Raspberry Pi
2.	Copy the service template raspiCamSrv.service which is provided with raspiCamSrv to your home directory `cp ~/prg/raspi-cam-srv/config/raspiCamSrv.service ~`
3.	Adjust the service configuration: `nano ~/raspiCamSrv.service` Replace all (4) occurrences of '<user>' with the user ID, specified during System Setup If you need a port different from 5000 (see RaspiCamSrv Installation, step 10), replace also `port 5000` by your port.
4.	Stage the service configuration file to systemd: `sudo cp ~/raspiCamSrv.service /etc/systemd/system`
5.	Start the service: `sudo systemctl start raspiCamSrv.service`
6.	Check that the Flask server has started as service: `sudo journalctl -e`
7.	Enable the service so that it automatically starts with system boot: `sudo systemctl enable raspiCamSrv.service`
8.	Reboot the system to test automatic server start: `sudo reboot`

Service Configuration for Audio Support

If it is intended to record audio along with videos, a slightly different setup is required (see Settings):
Instead of installing the service as a system unit, it needs to be installed as user unit (see systemd/User) in order to get access to PulseAudio.

Bookworm Systems

If your system is a bookworm system (lsb_release -a) follow these steps:

Step	Action
1.	Open a SSH session on the Raspberry Pi
2.	Copy the service template raspiCamSrv.service which is provided with raspiCamSrv to your home directory `cp ~/prg/raspi-cam-srv/config/raspiCamSrv.service ~`
3.	Adjust the service configuration: `nano ~/raspiCamSrv.service` Replace '<user>' with the user ID, specified during System Setup If necessary, raplace also the standard port 5000 with your port. Remove the entry User=<user> from the [System] section In section [Install], change `WantedBy=multi-user.target` to `WantedBy=default.target`
4.	Create the directory for systemd user units `mkdir -p ~/.config/systemd/user`
5.	Stage the service configuration file to systemd for user units: `cp ~/raspiCamSrv.service ~/.config/systemd/user`
6.	Start the service: `systemctl --user start raspiCamSrv.service`
7.	Check that the Flask server has started as service: `journalctl --user -e`
8.	Enable the service so that it automatically starts with a session for the active user: `systemctl --user enable raspiCamSrv.service`
9.	Enable lingering in order to start the unit right after boot and keep it running independently from a user session `loginctl enable-linger`
10.	Reboot the system to test automatic server start: `sudo reboot`

Bullseye Systems

If your system is a bullseye system (lsb_release -a), which is currently still the case for Pi Zero, follow these steps:

Step	Action
1.	Open a SSH session on the Raspberry Pi
2.	Clone branch 0_3_12_next of Picamera2 repository `cd ~/prg` `git clone -b 0_3_12_next https://github.com/raspberrypi/picamera2`
3.	Copy the service template raspiCamSrv.service which is provided with raspiCamSrv to your home directory `cp ~/prg/raspi-cam-srv/config/raspiCamSrv.service ~`
4.	Adjust the service configuration: `nano ~/raspiCamSrv.service` - Replace '<user>' with the user ID, specified during System Setup - If necessary, raplace also the standard port 5000 with your port. - Add another Environment entry: `Environment="PYTHONPATH=/home/<user>/prg/picamera2"` - Remove the entry User=<user> from the [System] section - In section [Install], change `WantedBy=multi-user.target` to `WantedBy=default.target` For an example of the final .service file, see below
5.	Create the directory for systemd user units `mkdir -p ~/.config/systemd/user`
6.	Stage the service configuration file to systemd for user units: `cp ~/raspiCamSrv.service ~/.config/systemd/user`
7.	Start the service: `systemctl --user start raspiCamSrv.service`
8.	Check that the Flask server has started as service: `journalctl --user -e`
9.	Enable the service so that it automatically starts with a session for the active user: `systemctl --user enable raspiCamSrv.service`
10.	Enable lingering in order to start the unit right after boot and keep it running independently from a user session `loginctl enable-linger`
11.	Reboot the system to test automatic server start: `sudo reboot`

Below is an example .service specification for user "sn":

[Unit]
Description=raspiCamSrv
After=network.target

[Service]
ExecStart=/home/sn/prg/raspi-cam-srv/.venv/bin/flask --app raspiCamSrv run --port 5000 --host=0.0.0.0
Environment="PATH=/home/sn/prg/raspi-cam-srv/.venv/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
Environment="PYTHONPATH=/home/sn/prg/picamera2"
WorkingDirectory=/home/sn/prg/raspi-cam-srv
StandardOutput=inherit
StandardError=inherit
Restart=always

[Install]
WantedBy=default.target

signag/raspi-cam-srv