From 22c737037336eababbb92c8d0f70300991201b0d Mon Sep 17 00:00:00 2001 From: CamDavidsonPilon Date: Wed, 21 Aug 2024 21:36:54 -0400 Subject: [PATCH] new networking dir; notes on internet sharing --- .../01-getting-started/02-software-set-up.mdx | 4 +- .../05-calibrate-od600.md | 2 +- .../09-external-power.md | 2 +- .../20-updating-software.md | 4 +- .../30-Advanced/00-accessing-raspberry-pi.md | 2 +- .../02-networking/01-internet-sharing.md | 37 +++++++++++++++++++ .../06-local-access-point.md | 0 .../10-networking.md} | 2 +- .../30-Advanced/02-networking/_category_.yaml | 3 ++ .../Stirring troubleshooting.md | 2 +- 10 files changed, 48 insertions(+), 10 deletions(-) create mode 100644 user-guide/30-Advanced/02-networking/01-internet-sharing.md rename user-guide/30-Advanced/{ => 02-networking}/06-local-access-point.md (100%) rename user-guide/30-Advanced/{02-networking.md => 02-networking/10-networking.md} (99%) create mode 100644 user-guide/30-Advanced/02-networking/_category_.yaml 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 88881a019..7c71d0777 100644 --- a/user-guide/01-getting-started/02-software-set-up.mdx +++ b/user-guide/01-getting-started/02-software-set-up.mdx @@ -61,9 +61,7 @@ What is an image file? It's a file that contains all the required software prein - Note: You can change the username and password later. 4. Check **Configure wireless LAN** and enter your network name into SSID network name, WiFi password, and country. Or leave blank if using ethernet. :::tip - If you are having difficulty connecting to a network, like at a university that may not easily allow Raspberry Pi's, [there's a built-in solution for creating a local access point](/user-guide/local-access-point)). - - Note that any tutorials that mention `wpa_supplicant.conf` are **out of date**. This has been deprecated by Raspberry Pis for a while. We have some further documentation on [networking available here](/user-guide/networking). + If you are having difficulty connecting to a network, like at a university that may not easily incorporate Raspberry Pi's, [there's a built-in solution for creating a local access point](/user-guide/local-access-point)) and a [solution for internet-sharing from a PC via ethernet](/user-guide/internet-sharing). ::: 5. Change timezone to your local timezone. diff --git a/user-guide/03-Extending your Pioreactor/05-calibrate-od600.md b/user-guide/03-Extending your Pioreactor/05-calibrate-od600.md index 93056296e..f4d3a4f67 100644 --- a/user-guide/03-Extending your Pioreactor/05-calibrate-od600.md +++ b/user-guide/03-Extending your Pioreactor/05-calibrate-od600.md @@ -53,7 +53,7 @@ By default, we fit the calibration curve with a polynomial. You can choose the d Calibrations are applied automatically. That is, after performing a calibration, your future experiments that use optical density readings will use the post-calibration values and be displayed in the UI and saved to the database. -If you wish to stop using calibrations, you can switch if off in the config.ini by setting adding `use_calibations=0` under the `[od_config]` section. +If you wish to stop using calibrations, you can switch if off in the config.ini by setting adding `use_calibations=0` under the `[od_reading.config]` section. ## Viewing your previous calibrations diff --git a/user-guide/03-Extending your Pioreactor/09-external-power.md b/user-guide/03-Extending your Pioreactor/09-external-power.md index e718f6a34..57544e0c8 100644 --- a/user-guide/03-Extending your Pioreactor/09-external-power.md +++ b/user-guide/03-Extending your Pioreactor/09-external-power.md @@ -16,7 +16,7 @@ Finally, to enable the PWM channels to use the new auxiliary power supply, **you :::note -When changing the default power supply, any stirring calibration and pump calibrations will need to be updated. Also, the `initial_duty_cycle` under `stirring` in the configuration may need to change. +When changing the default power supply, any stirring calibration and pump calibrations will need to be updated. Also, the `initial_duty_cycle` under `stirring.config` in the configuration may need to change. ::: :::caution diff --git a/user-guide/03-Extending your Pioreactor/20-updating-software.md b/user-guide/03-Extending your Pioreactor/20-updating-software.md index af76b8bf9..b3e6fab32 100644 --- a/user-guide/03-Extending your Pioreactor/20-updating-software.md +++ b/user-guide/03-Extending your Pioreactor/20-updating-software.md @@ -50,7 +50,7 @@ Similarly, from the [command line](https://docs.pioreactor.com/user-guide/access Each time we release a new Pioreactor version, we create a bundle of the required files as a zip file. This zip file can be uploaded to your Pioreactor cluster via the UI. -1. On the [Releases page](https://github.com/Pioreactor/pioreactor/releases), download the `release_xx.xx.xx.zip` file for the version you want onto a computer with access to the Pioreactor web UI. +1. On the [Releases page](https://github.com/Pioreactor/pioreactor/releases?q=prerelease%3Afalse&expanded=true), download the `release_xx.xx.xx.zip` file for the version you want onto a computer with access to the Pioreactor web UI. 2. In the web UI, visit _Updates_. In the drop down in the top right, select "Update from zip file". @@ -69,7 +69,7 @@ Each time we release a new Pioreactor version, we create a bundle of the require ### Method 3: Update using a zip file over scp or sftp -1. On the [Releases page](https://github.com/Pioreactor/pioreactor/releases), download the `release_xx.xx.xx.zip` file for the version you want. +1. On the [Releases page](https://github.com/Pioreactor/pioreactor/releases?q=prerelease%3Afalse&expanded=true), download the `release_xx.xx.xx.zip` file for the version you want. 2. We need a software tool up upload this release to the Pioreactor. 1. You can use `scp` on the command line: diff --git a/user-guide/30-Advanced/00-accessing-raspberry-pi.md b/user-guide/30-Advanced/00-accessing-raspberry-pi.md index 1b682fafa..ae5797273 100644 --- a/user-guide/30-Advanced/00-accessing-raspberry-pi.md +++ b/user-guide/30-Advanced/00-accessing-raspberry-pi.md @@ -16,7 +16,7 @@ There are two simple ways to access the Raspberry Pi from a Windows desktop. 2. Type `ssh pioreactor@.local`. For example, to access on our Pioreactor named _worker3_, we typed `ssh pioreactor@worker3.local`. The default password is `raspberry` (see "info" below). If asked "The authenticity of host...", enter "yes". :::info -When typing in the password, characters may not show up as you type - that's normal. This is a security feature. +When typing in the password, characters may not appear up as you type - that's expected. This is a security feature. ::: diff --git a/user-guide/30-Advanced/02-networking/01-internet-sharing.md b/user-guide/30-Advanced/02-networking/01-internet-sharing.md new file mode 100644 index 000000000..f633e5b56 --- /dev/null +++ b/user-guide/30-Advanced/02-networking/01-internet-sharing.md @@ -0,0 +1,37 @@ +--- +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. A simple way to set up a cluster of Pioreactor is to use internet sharing between your PC and the leader Pioreactor, and use a [local access point](/user-guide/local-access-point) between the leader Pioreactor and the worker Pioreactors. + +#### Requirements + +1. The Pioreactor requires an ethernet port. Any Raspberry Pi B models have this, but also you can purchase inexpensive (micro)USB-to-ethernet dongles. +2. You can use a freshly installed Pioreactor, or an existing Pioreactor. +2. An ethernet cable +3. A PC with an available ethernet connector (again, you can purchase dongles to connect ethernet to PC's that don't have an available ethernet port). + +#### Steps + +1. Power off the Pioreactor. +2. Connect the ethernet cable to the Pi. +3. Connect the other end of the ethernet cable to the PC. +4. If using a **mac / OSX**: turn on internet sharing with the following: + 1. Go to System Preferences -> Internet sharing. + 2. In "Share your connection from", choose the source of your internet. Ex: if connected over Wi-Fi, choose that. + 3. "To devices using": select the USB10/100/1000 LAN. + 4. Set "Internet Sharing" to "On". + 5. Click "Done" + +5. If using a **Windows**, turn on internet sharing with the following: + 1. Open search bar and search for "View Network Connections" + 2. Find the interface that has your Internet connection on (green symbol), right click and select 'Properties' + 3. Select the sharing tab and in 'Home networking connection' select the interface the Pi is connected to (something like "Ethernet"). + 4. Tick the box 'Allow other network users to connect through this computer's Internet connection' and click on 'OK' +6. Power up the Pioreactor. After a few minutes, you should be able to `ping your-leaders-hostname.local` and get back an address like `192.168.xx.xx`. +7. Try http://pioreactor.local in your browser. The UI should come up. Or try http://your-leaders-hostname.local. +9. Save the new config. + + +And you're done! Your Pioreactor should be able to be both accessed by the local PC, and be able to ping the internet (for updates, plugins, etc). You can also disconnect the ethernet cable as well, and your Pioreactor will still function (albeit it will lose internet connectivity). \ No newline at end of file diff --git a/user-guide/30-Advanced/06-local-access-point.md b/user-guide/30-Advanced/02-networking/06-local-access-point.md similarity index 100% rename from user-guide/30-Advanced/06-local-access-point.md rename to user-guide/30-Advanced/02-networking/06-local-access-point.md diff --git a/user-guide/30-Advanced/02-networking.md b/user-guide/30-Advanced/02-networking/10-networking.md similarity index 99% rename from user-guide/30-Advanced/02-networking.md rename to user-guide/30-Advanced/02-networking/10-networking.md index 2e3f68ad9..68ab2c17d 100644 --- a/user-guide/30-Advanced/02-networking.md +++ b/user-guide/30-Advanced/02-networking/10-networking.md @@ -1,5 +1,5 @@ --- -title: Networking +title: Networking tools slug: /networking --- diff --git a/user-guide/30-Advanced/02-networking/_category_.yaml b/user-guide/30-Advanced/02-networking/_category_.yaml new file mode 100644 index 000000000..18239b1e5 --- /dev/null +++ b/user-guide/30-Advanced/02-networking/_category_.yaml @@ -0,0 +1,3 @@ +collapsed: true +collapsible: true +label: "Networking" diff --git a/user-guide/50-Troubleshooting/Stirring troubleshooting.md b/user-guide/50-Troubleshooting/Stirring troubleshooting.md index 6d95a049a..a3ea421fb 100644 --- a/user-guide/50-Troubleshooting/Stirring troubleshooting.md +++ b/user-guide/50-Troubleshooting/Stirring troubleshooting.md @@ -31,7 +31,7 @@ First, with the stirring activity running, carefully examine if the fan below is - Try lowering the `initial_duty_cycle` in the config.ini to a value like ~20. - Are the two magnets still present on the fan? Visually inspect from the side, or unscrew the top faceplate from the vial holder to see better. - The heater PCB may be damaged. Contact us at support@pioreactor.com. - - You can turn off the feedback loop by setting `use_rpm=0` in the `[stirring]` section of your configuration. Set the `initial_duty_cycle` to some appropriate value (20 to 40), as well. + - You can turn off the feedback loop by setting `use_rpm=0` in the `[stirring.config]` section of your configuration. Set the `initial_duty_cycle` to some appropriate value (20 to 40), as well.