diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index df1eb18f3..2b5877377 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -12,7 +12,7 @@ jobs: name: Deploy to GitHub Pages runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4 - uses: actions/setup-node@v3 with: node-version: 20.x diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml index 2490b687f..dc3896845 100644 --- a/.github/workflows/test-deploy.yml +++ b/.github/workflows/test-deploy.yml @@ -12,7 +12,7 @@ jobs: name: Test deployment runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - uses: actions/setup-node@v3 with: node-version: 16.x diff --git a/src/components/ButtonDownloadVersionedImage.js b/src/components/ButtonDownloadVersionedImage.js new file mode 100644 index 000000000..323f8ad73 --- /dev/null +++ b/src/components/ButtonDownloadVersionedImage.js @@ -0,0 +1,52 @@ +import React from 'react'; + + +export default function ButtonDownloadVersionedImage({type}){ + const [selectedVersion, setSelectedVersion] = React.useState(""); + const [versions, setVersions] = React.useState([]); + + React.useEffect(() => { + const fetchReleases = async () => { + try { + const response = await fetch("https://api.github.com/repos/pioreactor/custopizer/releases"); + if (!response.ok) { + throw new Error("Failed to fetch releases"); + } + + const data = await response.json(); + // Filter out prereleases and drafts + const filteredVersions = data + .filter(release => !release.prerelease && !release.draft) + .map(release => ({ version: release.tag_name })); + + setVersions(filteredVersions); + } catch (error) { + console.error("Error fetching releases:", error); + } + }; + + fetchReleases(); + }, []); + + const handleDownload = () => { + if (selectedVersion) { + const downloadUrl = `https://github.com/Pioreactor/CustoPiZer/releases/download/${selectedVersion}/pioreactor_${type}.zip`; + window.open(downloadUrl, '_blank'); + } + }; + + return ( +
+ Select software version: + + +
+ ); +} diff --git a/user-guide/01-getting-started/02-software-set-up.mdx b/user-guide/01-getting-started/02-software-set-up.mdx index 9180dc257..6928a0663 100644 --- a/user-guide/01-getting-started/02-software-set-up.mdx +++ b/user-guide/01-getting-started/02-software-set-up.mdx @@ -6,6 +6,7 @@ slug: /software-set-up --- import TOCInline from '@theme/TOCInline'; +import ButtonDownloadVersionedImage from '@site/src/components/ButtonDownloadVersionedImage'; ### Before you begin @@ -29,7 +30,7 @@ Before you get started, you'll need to have the following: We'll start your blank microSD card. -1. Download the [Pioreactor leader & worker image file](https://github.com/pioreactor/custopizer/releases/latest/download/pioreactor_leader_worker.zip). +1. Download the [Pioreactor leader and worker image file](https://github.com/pioreactor/custopizer/releases/latest/download/pioreactor_leader_worker.zip). :::info What is an image file? It's a file that contains all the required software preinstalled on it, including an operating system and our custom Pioreactor software. The image will be installed on the microSD card. @@ -110,9 +111,17 @@ Workers are additional Pioreactors that you can control from a single UI. Togeth #### Step 1. Install the worker software -1. Follow the same instructions above, but use a [Pioreactor Worker image](https://github.com/pioreactor/custopizer/releases/latest/download/pioreactor_worker.zip) instead. All the settings are the same, including *username* and *password*, **but choose a new hostname**. See note below: +1. Download a *Pioreactor worker image*: - :::note + :::tip + Check the software version of your leader first (you can find that on the Updates page, or the Inventory Page, or use `pio version` on the command line). It's recommended to download the associated worker image for that same version. + ::: + + + +2. Follow the same instructions above to write the image to an SD card. All the settings are the same, including *username* and *password*, **but choose a new hostname**. See note below: + + :::tip Choose a hostname that isn't currently being used in your cluster, ex: `worker01`, `worker02`, etc. Re-using old names is fine, so long as that worker isn't present in your cluster. **Tip**: if you plan to have many Pioreactors, use a leading zero in any numbers, like `pio01`, or `worker01`, etc. @@ -185,3 +194,14 @@ Easiest solution is to start over. You can edit the name in the RPi Imager, and #### Can I plug a monitor into the Raspberry Pi's HDMI port? Our current software turns off all external displays (for power and compute reasons), so any external monitor attached to the Pi won't work. + +#### I want a different leader-worker software version. + + + + +#### I'd like to have the leader _not be a worker_, and only a standalone leader. Can I do that? + +Sure, we have a custom image that only has the leader software on it. See below: + + diff --git a/user-guide/03-Extending your Pioreactor/06a-using-community-plugins.mdx b/user-guide/03-Extending your Pioreactor/06a-using-community-plugins.mdx index 235aefcf9..51ccb66fe 100644 --- a/user-guide/03-Extending your Pioreactor/06a-using-community-plugins.mdx +++ b/user-guide/03-Extending your Pioreactor/06a-using-community-plugins.mdx @@ -42,6 +42,19 @@ Managing on/off and settings are done just like any other job, in the Manage dia You can uninstall plugins from the same page, too. These will remove the action on the Pioreactor's card, but won't delete the section in your config.ini. Also, if a SQL table was installed with the plugin, the table will not be deleted. +## I don't have internet access - how can I install the plugin? + + 1. First, get the latest .whl file [here](https://pypi.org/) onto any computer that can SSH into the Pioreactor. + 2. To get this .whl file onto a Pioreactor, use either `scp`, WinSCP, or FileZilla. Note: if you upload the .whl file to your leader Pioreactor first, you can distribute the .whl file to all your workers with `pios cp ` + 3. Once the .whl file is on the Pioreactor, use the following to install the plugin: + ``` + pio plugin install --source + ``` + For example: + ``` + pio plugins install pioreactor-air-bubbler --source ~/pioreactor_air_bubbler-0.3.1-py3-none-any.whl + ``` + ## Alternative: putting Python files in the the `plugins` folder An alternative way to install a plugin is to place a Python file in the `/home/pioreactor/.pioreactor/plugins` directory on the Raspberry Pi. This is good for one-off scripts or plugins you are demoing or testing. See more [about writing and distributing plugins](/developer-guide/intro-plugins). \ No newline at end of file diff --git a/user-guide/30-Advanced/01-cli.md b/user-guide/30-Advanced/01-cli.md index f5635395f..3d595e4db 100644 --- a/user-guide/30-Advanced/01-cli.md +++ b/user-guide/30-Advanced/01-cli.md @@ -21,8 +21,8 @@ Interacting with the Pioreactor on the command line are through the `pio` tool. * `pio plugins list` will list the currently installed plugins * `pio blink` will blink the Pioreactor's onboard LED. * `pio log -m ` will log a message -* `pio view-cache ` will print out the contents of the specified cache. -* `pio clear-cache ` will remove `` from cache ``. +* `pio cache view ` will print out the contents of the specified cache. +* `pio cache clear ` will remove `` from cache ``. ### Leader-only commands diff --git a/user-guide/30-Advanced/02-networking/01-internet-sharing.md b/user-guide/30-Advanced/02-networking/01-internet-sharing.md index 1a1c41f55..30dcf73f7 100644 --- a/user-guide/30-Advanced/02-networking/01-internet-sharing.md +++ b/user-guide/30-Advanced/02-networking/01-internet-sharing.md @@ -3,10 +3,10 @@ title: Internet sharing between a PC and a Pioreactor slug: /internet-sharing --- -Below is a way to physically connect your PC to your Pioreactor and be able to control the Pioreactor from your PC, without needing any wifi or external router. This is called _internet sharing_. Note that this method _does_ scale to larger clusters, but below is only how to connect a single Pioreactor. +Below is a way to physically connect your PC to your Pioreactor and be able to control the Pioreactor from your PC, without needing any wifi or external router. This is called _internet sharing_. Note that this method _does_ scale to larger clusters (see below). -Below is a simple diagram of how this might look (these are faked IPs). +Below is a simple diagram of how this might look (these are random IPs, yours may be different). ``` +---------------------+