Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 1 addition & 11 deletions .github/workflows/build-os-bookworm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,6 @@ concurrency:
jobs:
build:
name: build
strategy:
fail-fast: false
matrix:
variant:
- adafruithat
- planktoscopehat
- fairscope-latest
base_variant_name:
- lite
permissions:
contents: read
packages: write
Expand All @@ -49,8 +40,7 @@ jobs:
with:
name: planktoscope
base_release_name: bookworm
base_image_variant: ${{ matrix.base_variant_name }}
base_image_variant: lite
base_release_date: 2025-05-13
base_file_release_date: 2025-05-13
arch: arm64
variant: ${{ matrix.variant }}
18 changes: 9 additions & 9 deletions .github/workflows/build-os.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ on:
description: 'The CPU architecture of the OS (armhf, arm64)'
required: true
type: string
variant:
description: 'The name of the RPi OS base image variant (none, segmenter-only, adafruithat, planktoscopehat)'
required: true
type: string

jobs:
build-os-image:
Expand Down Expand Up @@ -153,7 +149,7 @@ jobs:
ACTUAL_SHA="$(printf "%.7s" "${{ env.ACTUAL_SHA }}")"
/run/os-setup/os/ci-record-version.sh \
"github.com/${{ env.REPO }}" "$ACTUAL_SHA" "hash" \
"${{ inputs.variant }}" "/run/os-setup"
"/run/os-setup"
echo "installer-config.yml:"
cat /usr/share/planktoscope/installer-config.yml
echo "installer-versioning.yml:"
Expand Down Expand Up @@ -276,7 +272,7 @@ jobs:
run: |
echo "Running setup scripts..."
export DEBIAN_FRONTEND=noninteractive
/run/os-setup/os/setup.sh ${{ inputs.variant }}
/run/os-setup/os/setup.sh
echo "Done!"

- name: Prepare for a headless first boot on bare metal
Expand Down Expand Up @@ -330,9 +326,10 @@ jobs:
else
version="$(printf "%.7s" "${{ github.sha }}")"
fi
variant="${{ inputs.variant }}"

variant=""
if [[ "${{ inputs.base_release_name }}" != "bookworm" ]]; then
variant="$variant.${{ inputs.base_release_name }}"
variant="${{ inputs.base_release_name }}"
fi
if [[ "${{ inputs.arch }}" != "arm64" ]]; then
variant="$variant.${{ inputs.arch }}"
Expand All @@ -342,7 +339,10 @@ jobs:
fi

# Assemble the image name
output_name="${{ inputs.name }}-$version+$variant"
output_name="${{ inputs.name }}-$version"
if [[ $variant != "" ]]; then
output_name="$output_name.$variant"
fi
echo "OUTPUT_IMAGE_NAME=$output_name" >> $GITHUB_ENV

- name: Shrink the OS image
Expand Down
4 changes: 0 additions & 4 deletions documentation/docs/setup/software/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ Currently, all post-installation configuration is performed in the PlanktoScope

## Hardware Version

!!! info

This step is only required if you are using a `planktoscopehat` SD card image; it is not needed on the `adafruithat` and `fairscope-latest` SD card images.

The first time you start the PlanktoScope, you will need to select the hardware version of your PlanktoScope for the PlanktoScope software to match the actual configuration of your PlanktoScope hardware. To do this, open the Node-RED dashboard. You should see a homepage with a drop-down menu to select your PlanktoScope hardware version. You should select the correct version for your PlanktoScope. After you select a hardware version, the PlanktoScope will show the Node-RED dashboard's normal homepage navigation buttons; you should also wait several seconds for the PlanktoScope software to restart and load the updated hardware settings.

## Next steps
Expand Down
16 changes: 0 additions & 16 deletions documentation/docs/setup/software/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ If you are building your own PlanktoScope from your own hardware kit, you will n

In order to install the PlanktoScope software, you will first need to choose an SD card image file to use for installation, and then you will install that SD card image and perform some configuration of the software.

## Choosing an SD card image

PlanktoScope SD card image files are identified with a version number as well as a hardware configuration tag - for example, the SD card image file named `planktoscope-v2024.0.0+planktoscopehat.img.xz` is for v2020.0.0 of the PlanktoScope OS, configured to work with versions of the PlanktoScope hardware based on the custom PlanktoScope HAT (rather than the Adafruit Stepper Motor HAT). Thus, you will need to choose both a version number (e.g. v2023.9.0) and a hardware configuration (e.g. `planktoscopehat`).

### PlanktoScope OS versions

Because the PlanktoScope project aims to release occasional updates to the PlanktoScope OS in order to fix various software problems and make various improvements to the software, multiple versions of the PlanktoScope OS exist, and new versions will be released in the future. In general, each version of the PlanktoScope OS will be compatible with all previous officially-released versions of the PlanktoScope hardware (which are all versions listed in the [hardware changelog](../../reference/hardware/changelog.md) without the description of a "prototype"). The PlanktoScope documentation describes the latest stable release of the PlanktoScope OS, and you should always use the latest stable release on your PlanktoScopes.
Expand All @@ -26,18 +22,6 @@ PlanktoScope OS versions are independent of hardware versions, and (starting in

- v2024.1.0: this version will be the second release of the PlanktoScope OS in 2024.

### Hardware configurations

Currently, each version of the PlanktoScope OS is provided as three SD card images which support the two different types of hardware configurations supported by the PlanktoScope software:

- `adafruithat`: this configuration of the PlanktoScope OS is compatible with v2.1 of the PlanktoScope hardware, which uses the [Adafruit Stepper Motor HAT](https://learn.adafruit.com/adafruit-dc-and-stepper-motor-hat-for-raspberry-pi/overview).

- `planktoscopehat`: this configuration of the PlanktoScope OS is compatible with all versions of the PlanktoScope hardware starting with hardware v2.3; those hardware versions use the [PlanktoScope HAT](../../reference/hardware/hat.md) instead of the Adafruit Stepper Motor HAT. This configuration requires you to select the hardware version of your PlanktoScope in the [post-installation configuration](config.md) process.

- `fairscope-latest`: this configuration of the PlanktoScope OS is identical to the `planktoscopehat` configuration, except that this one sets the default settings to be for hardware version v2.6 so that you won't need to select the hardware version of your PlanktoScope in the post-installation configuration process.

If you have a PlanktoScope from FairScope, you should probably use the `fairscope-latest` SD card image; otherwise, if you have a non-FairScope PlanktoScope with hardware version v2.3 or later, you should probably use the `planktoscopehat` SD card image; otherwise, if you have a v2.1 PlanktoScope, you should probably use an `adafruithat` SD card image.

## Installation

After you have chosen a PlanktoScope OS SD card image for the desired OS version and hardware configuration, you should follow our [standard installation](standard-install.md) guide in order to install that SD card image into your PlanktoScope.
Expand Down
1 change: 0 additions & 1 deletion node-red/nodes/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

29 changes: 28 additions & 1 deletion node-red/projects/adafruithat/flows.json
Original file line number Diff line number Diff line change
Expand Up @@ -6924,7 +6924,9 @@
"x": 800,
"y": 420,
"wires": [
[],
[
"154753a6a39b04b8"
],
[],
[]
]
Expand Down Expand Up @@ -7158,6 +7160,26 @@
"y": 460,
"wires": []
},
{
"id": "154753a6a39b04b8",
"type": "exec",
"z": "9daf9e2b.019fc",
"command": "sudo systemctl restart nodered.service",
"addpay": false,
"append": "",
"useSpawn": "false",
"timer": "",
"winHide": false,
"oldrc": false,
"name": "Restart Node Red",
"x": 1070,
"y": 420,
"wires": [
[],
[],
[]
]
},
{
"id": "ddcbbfa5.cd158",
"type": "exec",
Expand Down Expand Up @@ -8455,6 +8477,11 @@
"label": "",
"value": "PlanktoScope v2.6",
"type": "str"
},
{
"label": "",
"value": "PlanktoScope v3.0",
"type": "str"
}
],
"payload": "",
Expand Down
Loading