Installation
Installation Guide for pi-OCEAN
Prerequisites
- **Raspberry Pi 5**: This project has been tested and optimized specifically for the Raspberry Pi 5. Compatibility with other Raspberry Pi models is not guaranteed.
- **Raspberry Pi OS Lite**: A fresh installation is recommended for optimal performance and stability.
- **Basic Linux Command Line Knowledge**: Familiarity with SSH and basic Linux commands.
- **Internet Connection**: Required for initial setup and package downloads.
Recommended Installation (Automated Script)
This method is recommended for most users. It automates the setup of necessary dependencies and the pi-OCEAN software.
-
1. Prepare your Raspberry Pi 5:
- Download and install Raspberry Pi OS Lite (64-bit recommended).
- Enable SSH by creating an empty file named `ssh` in the boot partition of your SD card/NVMe.
- Connect your Raspberry Pi to your network (Ethernet recommended for initial setup).
2. Connect to your Raspberry Pi via SSH:
Find your Raspberry Pi's IP address (e.g., from your router or by connecting a monitor and running `hostname -I`). Then, from your computer's terminal:
ssh pi@
Default username is `pi`, password is `raspberry`. You will be prompted to change it.
-
3. Run the pi-OCEAN installation script:
Once connected via SSH, execute the following command:
curl -s https://get.piocean.org | sudo bash
The script will guide you through the installation process. Follow the on-screen instructions.
-
4. Access the pi-OCEAN Web UI:
After the installation completes, you can access the pi-OCEAN dashboard from any web browser on your local network:
http://piocean.local:5000
If `piocean.local` does not resolve, try using your Raspberry Pi's IP address directly.
Manual Installation (Advanced Users)
For developers or users who prefer more control, you can manually clone the repository and run the installation script.
-
1. Clone the pi-OCEAN repository:
git clone https://github.com/your-username/piocean.git cd piocean
-
2. Run the manual installation script:
sudo ./install/install.sh
This script will install all necessary dependencies and set up the pi-OCEAN services.
Post-Installation Configuration
After the initial installation, you will need to configure pi-OCEAN through its web interface:
- **Configure Sensors**: Enter the details for each sensor (type, GPIO pin, calibration values) in the settings.
- **Set Up MQTT**: Enter the connection details for your MQTT broker and subscribe to relevant topics (e.g., for tank level from Victron Cerbo GX).
- **Create Rules**: Define automation rules using the visual rule builder to customize your watermaker's operation.
Configuration
After installing pi-OCEAN, you'll need to configure your sensors and hardware.
Go to Configuration