DWE OS#

Note

exploreHD settings can only be adjusted on the lower bandwidth / configurable firmware. Learn how to upgrade here

Getting Started#

Connecting#

To connect to the pi, we recommend using SSH. You can read our documentation on that on How to SSH into a Raspberry Pi.

Option 1: Installing Image for Raspberry Pi 4 (Recommended)

Download the latest image here: https://github.com/DeepwaterExploration/DWE_OS/releases/

You can use BalenaEtcher for flashing the image to an SD card.

Option 2: Installing with Installation Script

To install for the Raspberry Pi, you can use the installation script by executing the following command:

sudo apt update

sudo apt upgrade

curl -fsSL https://raw.githubusercontent.com/DeepwaterExploration/DWE_OS/main/scripts/install.sh | sudo -E bash -

Once installed, the script should exit with the following message: Installation of DWE OS was successful.

You can now jump to Interface to access the functionality.

Option 3: Installing Manually (Expert Only)

You can install manually (for raspberry pi or other systems) with the following commands:

First, install nodejs with:

sudo apt update
sudo apt upgrade
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt install nodejs
curl -L https://npmjs.org/install.sh | sudo sh

Next, install the required dependencies:

sudo apt install libudev-dev libgstreamer-plugins-base1.0-dev libgstreamer1.0-dev gstreamer1.0-plugins-good gstreamer1.0-plugins-bad

Finally, install the dwe-os-1 application from npmjs with:

sudo npm install -g @dwe.ai/dwe-os-1

Auto Launch

To enable auto-launch (recommended for raspberry pi):

  • Install pm2: sudo npm install -g pm2

  • Start dwe-os-1 from pm2: pm2 start dwe-os-1

  • Save the process list: pm2 save

  • Enable startup for pm2: sudo pm2 startup systemd -u <your username> --hp /home/<your username>

    • Raspberry Pi: sudo pm2 startup systemd -u pi --hp /home/pi

Running Manually (Optional) To run the application temporarily (this is only if you do not want to install with auto-launch):

  • Run: dwe-os-1 start

Interface#

To use the interface, navigate to http://192.168.2.2:5000 (or http://companion.local:5000 if running the ArduSub companion software).

dweos-light