/cinepi-sdk

Collection of software components for development of open source cinema camera using raspberry pi hardware and software.

CinePI SDK Banner

Version

Collection of software components for development of open source cinema camera using raspberry pi hardware and software.

Raspberry Pi Debian Redis C C++ Python Shell Script OpenGL

Overview

The purpose of this repository is to host pre-built images that include all necessary software and drivers to facilitate quick-and-easy development of cinepi software components.

Based on the latest Debian release for Raspberry Pi ( Bookworm ). Head to the releases page to download the latest pre-zipped .img file and flash to your micro-sd card to get started!

Supported Hardware

CinePI cameras are based around Raspberry Pi hardware / software.

1st party camera modules from Raspberry Pi are supported out of the box, 3rd party sensor modules designs from Will Whang and Soho-enterprise are also supported.

Mainboards

  • Raspberry Pi 4B / Compute Module 4 (Unsupported)
  • Raspberry Pi 5 ( 4/8 GB )

Image Sensor Modules

CinePI SDK Banner HQ Camera Module, StarlightEye, OneInchEye, SE-SB8M-IMX585

Getting started

Setup

  1. Install the latest image from releases , unzip or use software like Belena Etcher to flash the .zip directly to a micro-sd card.
  • ⚠️SSH Access⚠️

    hostname: cinepi.local user: pi password: 1

    Example for accessing via a terminal: ssh pi@cinepi.local

  1. Depending on which camera module you have decided to use, you will need to modify the config.txt found in the boot partition. Enable the correct sensor overlay by uncommenting the appropriate lines for your given sensor module. By default the image comes with camera_auto_detect enabled, so 1st party camera modules from Raspberry Pi should automatically be detected. Connect camera modules to camera port 1.
# Automatically load overlays for detected cameras
camera_auto_detect=1

# OneInchEye Module ( default camera port 1 )
#camera_auto_detect=0
#dtoverlay=imx283

# StarlightEye Module ( default camera port 1 )
#camera_auto_detect=0
#dtoverlay=imx585
  1. Insert the micro-sd card into the Raspberry Pi and power on. Connect the Pi to a display via HDMI ( During first boot you may experience a sudden reboot, this is normal as the Pi expands the filesystem. )

  2. Upon successful installation, you will presented with the familiar desktop environment for Raspberry Pi.

Testing

Testing can be done after installation by running 2 scripts found within the home directory.

  1. run-raw.sh : this script is responsible for starting the cinepi-raw instance that starts and controls the camera.

  2. run-gui.sh : this script is responsible for starting the cinepi-gui instance that displays the live camera preview, overlays and controls.

Demo video

In addition when running the run-raw.sh script, you can also preview a live MJPEG stream via a browser on port 8000 on the route /stream. For example on another computer sharing the same network as the pi; go to: cinepi.local:8000/stream

mjpeg stream demo

Development

This SDK has been provided as a means to promote development of CinePI software components in a structured and collaborative environment.

Architecture / Design

Below is high level overview of the hardware and software components of a CinePI based camera.

diagram

For detailed breakdowns of the individual software components such as cinepi-raw or cinepi-gui, please visit their respective repositories for more details.

Discussion

discord github

Donate