pibooth project provides a photobooth application out-of-the-box in pure Python
for Raspberry Pi. Have a look to the wiki
to discover some realizations from GitHub users.
Even if designed for a Raspberry Pi, this software may be installed on any Unix/Linux based OS (tested on Ubuntu 16 and Mac OSX 10.14.6).
- Capture from 1 to 4 photos and concatenate them in a final picture
- Support all cameras compatible with gPhoto2, OpenCV and Raspberry Pi
- Support for hardware buttons and lamps on Raspberry Pi GPIO
- Fully driven from hardware buttons / keyboard / mouse / touchscreen
- Preview during countdown
- Auto-start at the Raspberry Pi startup
- Animate last pictures during idle time
- Store final pictures and the individual captures
- Printing final pictures using CUPS server (printing queue indication)
- Custom texts can be added on the final pictures (customizable fonts, colors, alignments)
- Custom background(s) and overlay(s) can be added on final pictures
- All settings available in a configuration file (most common options in a graphical interface)
The requirements listed below are the ones used for the development of
other configuration may work fine. All hardware buttons, lights and printer are optional,
the application can be entirely controlled using a keyboard, a mouse or a touchscreen.
- 1 Raspberry Pi 3 Model B (or higher)
- 1 Camera (Raspberry Pi Camera v2.1 8 MP 1080p or any DSLR camera compatible with gPhoto2 or any webcam compatible with OpenCV )
- 2 push buttons
- 4 LEDs
- 4 resistors of 100 Ohm
- 1 printer
Buster with desktop and recommended software
A brief description on how to set-up a Raspberry Pi to use this software.
Download the Raspbian image and set-up an SD-card. You can follow these instructions .
Insert the SD-card into the Raspberry Pi and fire it up. Use the
raspi-configtool to configure your system (e.g., expand partition, change hostname, password, enable SSH, configure to boot into GUI, etc.).
Don't forget to enable the camera in raspi-config.
Upgrade all installed software:
$ sudo apt-get update $ sudo apt-get upgrade
Optionally install the last stable
gPhoto2version (required only for DSLR camera):
$ sudo wget raw.github.com/gonzalo/gphoto2-updater/master/gphoto2-updater.sh $ sudo chmod 755 gphoto2-updater.sh $ sudo ./gphoto2-updater.sh
CUPSto handle printers (more instructions to add a new printer can be found here):
$ sudo apt-get install cups libcups2-dev
OpenCVto improve images generation efficiency or if a Webcam is used:
$ sudo apt-get install python3-opencv
piboothfrom the pypi repository:
$ sudo pip3 install pibooth
If you don't have
CUPSinstalled (steps 5. and/or 6. skipped), use the
--no-depsoption to avoid installation failures (you may need to install Python dependencies by yourself)
An editable/customizable version of
pibooth can be installed by following
these instructions .
Be aware that the code on the master branch may be unstable.
Start the photobooth application using the command:
All pictures taken are stored in the folder defined in
[GENERAL][directory]. They are named
YYYY-mm-dd-hh-mm-ss_pibooth.jpg which is the time when first capture of the sequence was taken.
A subfolder raw/YYYY-mm-dd-hh-mm-ss is created to store the single raw captures.
if you have both
DSLR cameras connected to the Raspberry Pi, both are used,
this is called the Hybrid mode. The preview is taken using the
Pi one for a better
video rendering and the capture is taken using the
DSLR one for better picture rendering.
You can display a basic help on application options by using the command:
$ pibooth --help
States and lights management
The application follows the states sequence defined in the diagram below:
The states of the LED 1 and LED 2 are modified depending on the actions available for the user. The LED 3 is switched on when the application starts and the LED 4 is switched on during the preview and photo capture.
After the graphical interface is started, the following actions are available:
|Action||Keyboard key||Physical button|
|Toggle Full screen||Ctrl + F||-|
|Choose layout||LEFT or RIGHT||Button 1 or Button 2|
|Take pictures||P||Button 1|
|Export Printer/Cloud||Ctrl + E||Button 2|
|Open/close settings||ESC||Button 1 + Button 2|
|Select option||UP or DOWN||Button 1|
|Change option value||LEFT or RIGHT||Button 2|
Final picture rendering
pibooth application handle the rendering of the final picture using 2 variables defined in
the configuration (see Configuration below):
[CAMERA][resolution] = (width, height)is the resolution of the captured picture in pixels. As explained in the configuration file, the preview size is directly dependent from this parameter.
[PICTURE][orientation] = auto/landscape/portraitis the orientation of the final picture (after concatenation of all captures). If the value is auto, the orientation is automatically chosen depending on the resolution.
The resolution is an important parameter, it is responsible for the quality of the final picture. Have a look to picamera possible resolutions .
Image effects can be applied on the capture using the
[PICTURE][effect] variable defined in the
[PICTURE] # Effect applied on all captures captures_effects = film
Instead of one effect name, a list of names can be provided. In this case, the effects are applied sequentially on the captures sequence.
[PICTURE] # Define a rolling sequence of effects. For each capture the corresponding effect is applied. captures_effects = ('film', 'cartoon', 'washedout', 'film')
Have a look to the predefined effects available depending on the camera used:
Texts can be defined by setting the option
(lets them empty to hide any text). For each one, the font, the color and the alignment can be chosen.
[PICTURE] # Same font applied on footer_text1 and footer_text2 text_fonts = Amatic-Bold
This key can also take two names or TTF file paths:
[PICTURE] # 'arial' font applied on footer_text1, 'Roboto-BoldItalic' font on footer_text2 text_fonts = ('arial', 'Roboto-BoldItalic')
The available fonts can be listed using the following the command:
$ pibooth --fonts
At the first run, a configuration file is generated in
which permits to configure the behavior of the application.
A quick configuration GUI menu (see Commands ) gives access to the most common options:
More options are available by editing the configuration file which is easily done using the command:
$ pibooth --config
The default configuration can be restored with the command (strongly recommended when
$ pibooth --reset
See the default configuration file for further details.
The print button (see Commands) and print states are automatically activated/shown if:
- pycups is installed
- at least one printer is configured in
To avoid paper waste, set the option
[PRINTER][max_duplicates] to the maximum
of identical pictures that can be sent to the printer.
Set the option
[PRINTER][max_pages] to the number of paper sheets available on the
printer. When this number is reached, the print function will be disabled and an icon
indicates the printer failure. To reset the counter, open then close the settings
graphical interface (see Commands).
Here is the default configuration used for this project in CUPS, it may depend on the printer used:
|Media Size||10cm x 15cm|
|Media Type||Glossy Photo Paper|
|Shrink page ...||Shrink (print the whole page)|
Here is the diagram for hardware connections. Please refer to the default configuration file to know the default pins used.
Icons from the Noun Project
- Polaroid by icon 54
- Up hand drawn arrow by Kid A
- Cameraman and Friends Posing For Camera by Gan Khoon Lay