OpenRiverCam OS

OpenRiverCam OS web dashboard for use on personal computer or Raspberry Pi device, operating in the field.

What is OpenRiverCam OS
Installation

Tip

Rainbow Sensing is the company behind this entirely Open-Source software framework. We provide ready-to-use images with one year of support for a fixed fee. After the first year you may continue using the software on your own devices indefinitely. Contact info@rainbowsensing.com for more information.

We also provide training packages for field installation, field survey, image-based processing and principles, LiveOpenRiverCam server deployment and maintenance (central API for storage and further use of data). You may also contact us for training packages.

What is OpenRiverCam OS?

OpenRiverCam OS is an entirely open-source dashboard to organize automated measurements of water levels and river flows using camera videos. It is optimized for use on Raspberry Pi 5 devices and can utilize connected Raspberry Pi cameras. What can you do with OpenRiverCam OS?

Set up fully automated processing of videos into water levels and discharges, leveraging the power of PyOpenRiverCam
Set up your own automated water level feeds from external (e.g. web-reporting) or connected devices
Download your data, directly from the device via the web interface.
Sync your data Live(!) to a LiveORC server setup for operational real-time use of data in Decision Support Systems or forecast systems.
Monitor currently ongoing tasks and logs.
Investigate your time series and results with powerful figures and graphs
Secure access to your device via a hashed password.
Stay up-to-date with the latest developments of OpenRiverCam OS through Over-The-Air updates.

Note

This README is only meant to instruct how to install OpenRiverCam OS on a device. For more information on how to use OpenRiverCam OS, please refer to the [documentation] which is forthcoming. We here do not provide any advice on how to build or water proof a device, or how to perform surveys. If you are interested in these topics, please contact us for a dedicated training package.

Two approaches to installation are provided.

Installation of ready-to-use images for Raspberry Pi 5 devices (can be acquired from Rainbow Sensing).
Installation of back end and front end on your own selected device. We provide examples for Debian-based systems only.

Installation on Raspberry Pi

If you have acquired a ready-to-use .img file from Rainbow Sensing for use on Raspberry Pi, please follow these instructions.

Prerequisites

A Raspberry Pi 4 or 5 (recommended) device with 8GB of memory. We DO NOT support lower Raspberry Pi devices as these are not powerful enough and do not work with arm64 images. Please do not contact us for support on Raspberry Pi 3 or lower devices.
A suitable power supply. For Raspberry Pi 4, we recommend a 5V 2A power supply. For Raspberry Pi 5, we recommend a 5V 5A power supply. For connections in the field to a 12V battery (e.g. combined with solar panels), you will require a buck step down converter (check your favorite electronics store or web store). Ensure that you find one with 12V input (up to 24V if your battery has a higher voltage) that delivers 5V at minimum 3A (2A for Raspberry Pi 4), and ideally 5V 5A for a more stable and reliable power. supply.

See: https://www.raspberrypi.com/products/raspberry-pi-5/?variant=raspberry-pi-5-8gb
An SD card (micro) of good quality (really...try to not underspend on cheap SD cards) of at least 32GB in size; OR (better) a Raspberry Pi 5 Compute Module with a carrier board, with at least 32GB eMMC flash storage. For SD-cards, ensure you have a microSD card reader slot on your device, or ensure you get a SD card adapter to fit it in a large SD card reader.

See: https://www.raspberrypi.com/products/compute-module-5/?variant=cm5-104032
A laptop or desktop computer with the "Raspberry Pi Imager" installed.

See: https://www.raspberrypi.com/software/
A UTP Cable and a free network port on your router or network switch (check the NOTE below if you only have WiFi).

If you want to collect videos with the same device, we also recommend to connect a Raspberry Pi (v3) camera to the device. The OS will have Raspberry Pi camera libraries pre-installed. Alternatively you may use a suitable IP Camera that can deliver video files via FTP or SFTP.

See: https://www.raspberrypi.com/products/camera-module-3/

For installation instructions of the Raspberry Pi Imager, please go to https://www.raspberrypi.com/software/

Getting the image on the SD card

If you have a Raspberry Pi Compute Module, please go to the next section. If you have an SD card, continue here.

At this stage you will not need your Raspberry Pi yet. Just leave it in the box and start the laptop or desktop computer that has Raspberry Pi Imager installed

Put your SD card in a free SD-card reader slot on your laptop or desktop computer that has the Raspberry Pi imager installed
Download our image from the provided link to a location on your machine that you can find back easily, e.g. C:\User\myuser\Downloads. The file has the extension img.gz. Do not unpack this file. This is not necessary.
Start the Raspberry Pi imager application.
In the field "Raspberry Pi Device", click on "CHOOSE DEVICE" and select your Raspberry Pi device in the list. This can only be Raspberry Pi 4 or 5!
In the field "Operating System", click on "CHOOSE OS", scroll all the way down and select "Use custom". Now navigate to the folder in which you stored the img.gz file and double-click it to select it.
In the field "Storage", click on "CHOOSE STORAGE". Select the SD card, typically called something like "Internal SD card reader."
Click on "NEXT"
When the application asks "Would you like to apply OS customisation settings?", click on NO.

Tip

If you do not have a UTP cable or free UTP slot conveniently nearby but instead want to rely on WiFi, then select "EDIT SETTINGS" and follow the instruction below.

In the "GENERAL" tab, activate "Configure wireless LAN"
type in the exact capital sensitive (!) name of your WiFi SSID in the SSID field.
type the exact capital sensitive password in the password field.
Choose your 2-letter country code in the Wireless LAN country dropdown menu.
Click on "SAVE"
Click on "YES".

When the application asks "All existing data on '-your selected SD card-' will be erased. Are you sure you want to continue?", click on YES.
When Raspberry OS Imager asks for your computer's root/super user password, please provide this.

The SD card will now be prepared and verified. This will only take a few minutes. Time for a 🍵 or ☕.

Are you back after your 🍵 or ☕? You should now see a box with title "Write Successful". If you do not see this, but instead get an error, then likely there is something wrong with your SD card. Please check the following:

Is the SD card read only? SD card casings (the larger ones) have a physical read only switch. If this is set to read only, please move the physical switch on the SD card to write.
Is the SD card large enough?
Is the SD card still ok? SD cards are known to deteriorate in time. This can result in SD cards still being readible but not anymore capable of writing. If the SD card is indicated to be read only, even with the physical switch in the right place, you probably have a broken SD card.

Getting the image on the Compute Module

The process is almost the same as for the SD card. The only difference is that you need to ensure the Compute Module device is connected to your computer in USB-mode, and select this device in the Raspberry Pi Imager.

Elaborate instructions how to get an image onto your compute module are provided on https://www.raspberrypi.com/documentation/computers/compute-module.html#flash-compute-module-emmc

Test your installation

In case you use an SD card, take it out of the reader and put it into your Raspberry Pi. With a Compute Module, switch back to normal operations.
Connect the Raspberry Pi's power adapter or other power source (e.g. 12V - 5V connection) and connect the UTP cable to your router or network switch. This should bring the device onto the same network as your computer.
Open a browser and navigate to http://orcos.local. This should bring up the following page. If this page cannot be found, then try http://orcos.home or http://orcos

You now have to select your password. Please ensure you remember this password. If you forget it, you will not be able to login anymore and since the service runs locally on the device, you will not be able to perform any recovery.

You should now reach the home page of the device. From here onwards, please follow our documentation pages (forthcoming).

Installation via Docker on a server or your own computer

We have a fully working Docker composition that can be used to run OpenRiverCam OS on a server. This allows you to run ORC-OS on your own computer via Docker, for instance to reprocess videos in a non-operational context. Basically this gives you Desktop functionality without the need to install anything on your device.

Install as follows: first make sure Docker and Docker Compose are installed on your computer. On Windows you must install Docker Desktop. On Linux you can use the linux package manager such as apt. On macOS you can use homebrew.

In windows make sure you use Windows System for Linux (WSL) or Git Bash as these have the same command interface as linux.

Create a local data directory
```
mkdir -p $HOME/.ORC-OS
```

Copy the .env.example file to .env and generate a secret key and set a data path. Replace $HOME/.ORC-OS with the desired folder (see step 1) and make sure it exists:

cp .env.example .env
# Generate a secure secret key and update it in .env
sed -i "s/^ORC_SECRET_KEY=.*/ORC_SECRET_KEY=$(openssl rand -hex 32)/" .env
sed -i "s|^ORC_DATA_PATH=.*|ORC_DATA_PATH=$HOME/.ORC-OS|" .env

Build and start all services (replace $HOME/.ORC-OS for the desired folder:
```
docker-compose up --build -d
```
You should now be able to reach the web interface at http://localhost:3000
View logs
```
docker-compose logs -f
```
Stop services
```
docker-compose down
```

Installation on your own device

For installation on your own device, we provide examples for Debian-based systems only. As each device or OS may be different in structure, naming of packages and exact approaches to establish services, we cannot provide a generic installation guide. Also, you may have specific requirements, such as a specific version of Python or a specific reverse proxy requirement. Hence the instructions below are provided as an example only. You need to understand the following concepts to be able to install OpenRiverCam OS on your own device:

Reverse proxy services (e.g. through nginx apache or other reverse proxy services)
Python virtual environments (e.g. through venv or conda)
Python Package management (e.g. through pip)
Systemd services (and how to manage, start, stop and enable/disable them)

Caution

Rainbow Sensing does not provide free support for installation on your own device. We cannot guarantee that the provided instructions will work for you. If you encounter any problems during installation, and you want us to assist or make a special recipe for your device please contact us for support at info@rainbowsensing.com

Prerequisites

At minimum your device should have:

A linux-based operating system (Debian adviced, but others may work as well)
A network connection to the internet during installation
Sufficient storage. We recommend at least 32GB of storage.
Sufficient memory. We recommend at least 8GB of RAM.
Adinistrator (sudo) rights on the device.
Power supply, connectivity and wiring and boxing for deployment in the field (not in scope for these instructions)
Python version 3.9, 3.10, 3.11 or 3.12 installed on your device. Earlier versions will NOT work. Later versions do not yet work. We recommend to use Python 3.12.

Of course, you will need a camera feed as well. Camera data should lead to files on your device with a recognizable time stamp with date and time. For instance, video_20250121T131523.mp4. The exact format and naming convention can be configured.

Installation of components

The following components must be installed on your device.

A FastAPI back-end. This component is used by the front end to communicate with the device. It is a Python package that can be installed via pip.
A web front-end. This component has a is used by the user to interact with the device. It is a Python package that can be installed via pip.
A reverse proxy to serve the web server to the user. This component is used to serve the web server to the user. It is a Python package that can be installed via pip.

We will go over each component in detail below. The commands are all based on Debian-based systems. If you use a different system, you will need to adapt the commands accordingly.

Installation of dependencies

First update your repositories and install the necessary linux libraries.

# update all installed packages
sudo apt update
sudo apt upgrade
# update the required dependencies
sudo apt install -y ffmpeg git libsm6 libxext6 libgl1 nginx python3-dev python3-venv libgdal-dev vim jq

FastAPI back-end

FastAPI is a python-based API library. We highly recommend setting up a virtual Python environment for the FastAPI backend. This ensures that the each component. This will ensure that you do not mix up dependencies between components. We here assume you will run things from a user's home directory. The following commands will:

create a virtual environment in the user's home directory
activate the virtual environment
install the latest version of the ORC-API
make a fresh database
deactivate the virtual environment

# set up the virtual environment
python3 -m venv $HOME/venv/orc-api
# activate the virtual environment
source $HOME/venv/orc-api/bin/activate
# get latest version name
ORC_VERSION=$(curl -s https://api.github.com/repos/localdevices/ORC-OS/releases/latest | jq -r .tag_name)
echo "Installing ORC-API $VERSION"
# install the latest ORC-OS API
pip install git+https://github.com/localdevices/ORC-OS.git@$ORC_VERSION
# ensure a fresh database it created
cd $HOME/venv/orc-api/lib/python3.12/site-packages/orc-api
alembic upgrade head
# deactivate the virtual environment
deactivate

To test if the installation was successful, you can run the following command:

# activate the virtual environment
source $HOME/venv/orc-api/bin/activate
# start the API interactively, wait up to a few minutes for the first start
$HOME/venv/orc-os/bin/uvicorn main:app --host 0.0.0.0 --port 5000 --workers 1

This should start the API interactively. Note that a number of functions must be compiled and loaded into memory. This may take a few seconds to a few minutes to complete. This is only required once. The second time the API is started, it will start much faster. If this runs without errors, press Ctrl+C to stop the API.

It is wise to now check if all required files seem present.

By default, ORC OS stores all its data on the user's home folder under $HOME/.ORC-OS. The database should already be there in a file $HOME/.ORC-OS/orc-os.db You can check if this file is present:

ls ~/.ORC-OS -l

This should return the file and file details. If you have already started the API interactively, you will also see a folder for incoming and uploads. In incoming you should eveentually place videos that you wish to automatically process. In uploads you will find the processed videos, once you start running videos. A user will usually never look at these files and folders directly. They are only used internally by the API.

Run the ORC-API as a service

Naturally you do not want to manually start the API every time you want to use it. Hence, we recommend to set up a systemd service that starts the API automatically on boot, and restarts it if for some reason it stops or crashes. Crashes could happen e.g. when the service runs out of memory. Normal closes happen when the OTA updates are performed or when the user selects a restart of the API from the front end by clicking on the restart button.

We also strongly recommend to set a ORC_SECRET_KEY environment variable. This ensures that the API is protected against unauthorized access. You can generate a random key with the following command:

SECRET_KEY=$(head -c 16 /dev/urandom | base64)
echo $SECRET_KEY

An example of a systemd service file is provided below. You need to adapt the paths to your system. Also you must replace YOUR_SECRET_KEY_GOES_HERE by the actual secret key you generated for the device.

Place this file in etc/systemd/system/orc-api.service.

[Unit]
Description=FastAPI for ORC-OS
Before=nginx.service
After=network.target

[Service]
User=user
WorkingDirectory=/home/user/venv/orc-os/lib/python3.12/site-packages/orc_api
Environment="PATH=/home/user/venv/orc-os/bin:/usr/bin"
Environment="ORC_INCOMING_DIRECTORY=/home/user/.ORC-OS/incoming"
Environment="ORC_HOME=/home/user/.ORC-OS"
Environment="ORC_SECRET_KEY=YOUR_SECRET_KEY_GOES_HERE"
ExecStart=/home/user/venv/orc-os/bin/uvicorn main:app --host 0.0.0.0 --port 5000 --workers 1
Restart=always
RestartSec=10

[Install]
WantedBy=multi-user.target

After creating this file, you can enable (for each boot) and immediately start the service.

# refresh systemd services
sudo systemctl daemon-reload
# enable for starting automatically on boot
sudo systemctl enable orc-api.service
# start the service
sudo systemctl start orc-api.service

To check what is going on in the back end, you can check the journal whilst filtering out messages related to this service as follows:

sudo journalctl -u orc-api.service

or for live updating messages type:

sudo journalctl -u orc-api.service -f

Web front-end

To ensure that the web front end is served out and can be updated by the Over-The-Air update process, you must ensure that the web files are unpacked in $HOME/.ORC-OS/www and that a symbolic link to the typical location of web-files is made. Also, your $USER must be able to write to this folder and have www access rights to serve out the files on a web server. This is done as follows:

# make sure the www folder exists
sudo mkdir /var/www/orc-os
# change group ownership to www-data
sudo chown -R $USER:www-data /var/www/orc-os
# set permissions to 775
sudo chmod -R 775 /var/www/orc-os
# change group permissions with inheritance
sudo chmod g+s /var/www/orc-os
# add $USER to www-data group
sudo usermod -aG www-data $USER
# make symbolic link to accessible place for OTA updates
sudo ln -sf /var/www/orc-os $HOME/.ORC-OS/www
sudo chown -R $USER:$USER $HOME/.ORC-OS/www

You can now upload the last version of the web front end to the web server. First download it from the releases page https://github.com/localdevices/ORC-OS/releases

Go to the last release and download the asset frontend-build.zip. Unzip this file in the folder $HOME/.ORC-OS/www.

Reverse proxy setup

Finally, the web front end should be served. We use nginx here but any other reverse proxy will work as well.

Make a configuration in /etc/nginx/sites-available/orc-os as follows

server {
        listen 80 default_server;
        listen [::]:80 default_server;
        client_max_body_size 100m;

        root /var/www/orc-os;

        index index.html;

        server_name orc-os;
        disable_symlinks off;
        location / {
                # First attempt to serve request as file, then
                # as directory, then index.html, then fall back to displaying a 404.
                try_files $uri $uri/ /index.html =404;
        }
        location /api/ {
                # Proxy pass to the FastAPI server
                proxy_pass http://127.0.0.1:5000;

                # Proxy settings for correct header handling
                proxy_set_header Host $host;
                proxy_set_header X-Real-IP $remote_addr;
                proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
                proxy_set_header X-Forwarded-Proto $scheme;
                proxy_set_header Upgrade $http_upgrade;
                proxy_set_header Connection "Upgrade";
                proxy_cache_bypass $http_upgrade;

                proxy_connect_timeout       10s;
                proxy_send_timeout          30s;
                proxy_read_timeout          30s;
                send_timeout                30s;

                proxy_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;
                proxy_next_upstream_tries 3;

        }


}

The root directive must point to the folder where the web front end is stored. To enable the nginx configuration, first remove any symlink enabled site, such as the default site /etc/nginx/sites-enabled/default, then create the symlink for the orc-os front end, finally restart nginx.

sudo rm /etc/nginx/sites-enabled/default
sudo ln -s /etc/nginx/sites-available/orc-os /etc/nginx/sites-enabled/orc-os
sudo systemctl restart nginx

Open your favorite browser and navigate to http://orc-os. You should see the ORC OS home page from where you can set a password and start using the device.

For developers

Clone the repository with ssh and move into the cloned folder.

git clone git@github.com:localdevices/ORC-OS.git
cd ORC-OS

Setup a virtual developers environment and install the package with symbolic links as follows:

python -m venv $HOME/venv/orc-os
source $HOME/venv/orc-os/bin/activate
pip install -e .

Make sure you install pre-commit hooks so that code is properly linted before pushing.

pip install pre-commit
pre-commit install

Name		Name	Last commit message	Last commit date
Latest commit History 131 Commits
.github		.github
dashboard		dashboard
orc_api		orc_api
tests		tests
.env.example		.env.example
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
CHANGELOG.md		CHANGELOG.md
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
docker-compose.yml		docker-compose.yml
entrypoint.sh		entrypoint.sh
pyproject.toml		pyproject.toml
requirements.txt		requirements.txt
sonar-project.properties		sonar-project.properties

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

OpenRiverCam OS

What is OpenRiverCam OS?

Installation on Raspberry Pi

Prerequisites

Getting the image on the SD card

Getting the image on the Compute Module

Test your installation

Installation via Docker on a server or your own computer

Installation on your own device

Prerequisites

Installation of components

Installation of dependencies

FastAPI back-end

Run the ORC-API as a service

Web front-end

Reverse proxy setup

For developers

About

Uh oh!

Releases 12

Packages

Uh oh!

Languages

License

localdevices/ORC-OS

Folders and files

Latest commit

History

Repository files navigation

OpenRiverCam OS

What is OpenRiverCam OS?

Installation on Raspberry Pi

Prerequisites

Getting the image on the SD card

Getting the image on the Compute Module

Test your installation

Installation via Docker on a server or your own computer

Installation on your own device

Prerequisites

Installation of components

Installation of dependencies

FastAPI back-end

Run the ORC-API as a service

Web front-end

Reverse proxy setup

For developers

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 12

Packages 0

Uh oh!

Languages

Packages