dweOS

Web interface driver for DWE.ai cameras.

Installation

To install for any supported Linux system, run the following command:

curl -s https://raw.githubusercontent.com/DeepwaterExploration/DWE_OS_2/main/install.sh | sudo bash -s

Raspberry Pi Hardware PWM

In order to enable hardware PWM on your Raspberry Pi, you need to edit /boot/firmware/config.txt. See Raspberry Pi documentation for more information.

Add the following lines to the end of the file, and reboot.

[all]
dtoverlay=pwm-2chan

Building for development

1. Clone the repository

git clone https://github.com/DeepwaterExploration/DWE_OS_2.git
cd DWE_OS_2

3. Build the project

cd frontend
npm install
cd ..
sudo chmod -R 777 ./
./create_release.sh

Building the RPi Image

git clone https://github.com/DeepwaterExploration/pi-gen
cd pi-gen
sudo ./build.sh -c config

The image will be found in the deploy folder. The latest release from github will be used for building the image.

Creating a Release

Releases are versioned from frontend/package.json and use conventional commits to generate CHANGELOG.md. You need git-cliff, npm, and the GitHub CLI (gh).

1. Run ./bump_version.sh X.Y.Z from a clean working tree. The script:

   • creates release/vX.Y.Z from the latest origin/main
   • sets the version in frontend/package.json and package-lock.json
   • regenerates CHANGELOG.md with git-cliff, which adds the new release
   • commits chore(release): vX.Y.Z, then pushes the branch and opens a PR after you confirm

   Use --no-push to stop after the local commit, or -y to skip the confirmation.

2. Wait for Backend CI and Frontend CI to pass on the PR, then merge it.

3. The Tag Release workflow tags the merge commit as vX.Y.Z and starts Build Release. That workflow creates a draft GitHub release.

4. Publish the draft release in the GitHub UI.

The changelog starts at v0.7.4. Commits up to and including v0.7.3 predate conventional commits, so v0.7.3 is the baseline. To regenerate the changelog by hand, start from that tag:

git cliff v0.7.3..HEAD -o CHANGELOG.md

A plain git cliff without the range also picks up older commits whose messages happen to look like word: text, such as TODO: fix wifi.