docs

Pioreactor · Jun 10, 2024 · 7607a80 · 7607a80
1 parent a3fc1ad
commit 7607a80
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 25 deletions.
diff --git a/developer-guide/20-User interface/02-api.md b/developer-guide/20-User interface/02-api.md
@@ -9,18 +9,15 @@ slug: /web-ui-api
 ```
 Endpoint                                 Methods  Rule
 ---------------------------------------  -------  -------------------------------------------------------------------------
-able_to_install_plugins_from_ui          GET      /api/alllow_ui_installs
+able_to_install_plugins_from_ui          GET      /api/allow_ui_installs
 create_or_update_new_calibrations        PUT      /api/calibrations
 get_available_calibrations_type_by_unit  GET      /api/calibrations/<pioreactor_unit>
 get_available_calibrations_of_type       GET      /api/calibrations/<pioreactor_unit>/<calibration_type>
 get_calibration_by_name                  GET      /api/calibrations/<pioreactor_unit>/<calibration_type>/<calibration_name>
 patch_calibrations                       PATCH    /api/calibrations/<pioreactor_unit>/<calibration_type>/<calibration_name>
 get_current_calibrations_of_type         GET      /api/calibrations/<pioreactor_unit>/<calibration_type>/current
-get_custer_time                          GET      /api/cluster_time
-set_cluster_time                         POST     /api/cluster_time
 get_configs                              GET      /api/configs
 get_config                               GET      /api/configs/<filename>
-delete_config                            DELETE   /api/configs/<filename>
 update_config                            PATCH    /api/configs/<filename>
 get_automation_contrib                   GET      /api/contrib/automations/<automation_type>
 get_charts_contrib                       GET      /api/contrib/charts
@@ -31,35 +28,38 @@ delete_experiment_profile                DELETE   /api/contrib/experiment_profil
 get_job_contrib                          GET      /api/contrib/jobs
 get_experiments                          GET      /api/experiments
 create_experiment                        POST     /api/experiments
+delete_experiment                        DELETE   /api/experiments/<experiment>
 update_experiment                        PATCH    /api/experiments/<experiment>
 get_logs                                 GET      /api/experiments/<experiment>/logs
 get_media_rates                          GET      /api/experiments/<experiment>/media_rates
+get_fallback_time_series                 GET      /api/experiments/<experiment>/time_series/<data_source>/<column>
+get_growth_rates                         GET      /api/experiments/<experiment>/time_series/growth_rates
+get_od_readings                          GET      /api/experiments/<experiment>/time_series/od_readings
+get_od_readings_filtered                 GET      /api/experiments/<experiment>/time_series/od_readings_filtered
+get_temperature_readings                 GET      /api/experiments/<experiment>/time_series/temperature_readings
 get_unit_labels                          GET      /api/experiments/<experiment>/unit_labels
 upsert_unit_labels                       PUT      /api/experiments/<experiment>/unit_labels
-delete_experiment                        DELETE   /api/experiments/<experiment_id>
-get_list_of_workers_for_experiment       GET      /api/experiments/<experiment_id>/workers
-add_worker_to_experiment                 PUT      /api/experiments/<experiment_id>/workers
-remove_workers_from_experiment           DELETE   /api/experiments/<experiment_id>/workers
-remove_worker_from_experiment            DELETE   /api/experiments/<experiment_id>/workers/<pioreactor_unit>
-stop_all_in_experiment                   POST     /api/experiments/<experiment_id>/workers/stop
+get_logs_for_unit_and_experiment         GET      /api/experiments/<experiment>/units/<unit>/logs
+get_list_of_workers_for_experiment       GET      /api/experiments/<experiment>/workers
+add_worker_to_experiment                 PUT      /api/experiments/<experiment>/workers
+remove_workers_from_experiment           DELETE   /api/experiments/<experiment>/workers
+remove_worker_from_experiment            DELETE   /api/experiments/<experiment>/workers/<pioreactor_unit>
+stop_worker_in_experiment                POST     /api/experiments/<experiment>/workers/<worker>/stop
+stop_all_in_experiment                   POST     /api/experiments/<experiment>/workers/stop
+get_experiments_worker_assignments       GET      /api/experiments/assignment_count
 get_latest_experiment                    GET      /api/experiments/latest
 export_datasets                          POST     /api/export_datasets
 get_historical_config_for                GET      /api/historical_configs/<filename>
 get_historical_media_used                GET      /api/historical_media
 get_historical_organisms_used            GET      /api/historical_organisms
-install_plugin                           POST     /api/install_plugin
-get_installed_plugins                    GET      /api/installed_plugins
-get_plugin                               GET      /api/installed_plugins/<filename>
 is_local_access_point_active             GET      /api/is_local_access_point_active
-reboot_unit                              POST     /api/reboot/<unit>
+install_plugin                           POST     /api/plugins/install
+get_installed_plugins                    GET      /api/plugins/installed
+get_plugin                               GET      /api/plugins/installed/<filename>
+uninstall_plugin                         POST     /api/plugins/uninstall
 setup_worker_pioreactor                  POST     /api/setup_worker_pioreactor
-shutdown_unit                            POST     /api/shutdown/<unit>
-get_fallback_time_series                 GET      /api/time_series/<data_source>/<experiment>/<column>
-get_growth_rates                         GET      /api/time_series/growth_rates/<experiment>
-get_od_readings                          GET      /api/time_series/od_readings/<experiment>
-get_od_readings_filtered                 GET      /api/time_series/od_readings_filtered/<experiment>
-get_temperature_readings                 GET      /api/time_series/temperature_readings/<experiment>
-uninstall_plugin                         POST     /api/uninstall_plugin
+reboot_unit                              POST     /api/units/<unit>/reboot
+shutdown_unit                            POST     /api/units/<unit>/shutdown
 update_app                               POST     /api/update_app
 update_app_from_release_archive          POST     /api/update_app_from_release_archive
 update_app_to_develop                    POST     /api/update_app_to_develop
@@ -76,6 +76,7 @@ run_job_on_unit                          PATCH    /api/workers/<unit>/experiment
 stop_job_on_unit                         PATCH    /api/workers/<unit>/jobs/<job>/stop
 get_workers_and_experiment_assignments   GET      /api/workers/assignments
 static                                   GET      /static/<path:filename>
+
 ```
 
 From `python3 -m flask --debug --app main routes -s rule`
diff --git a/user-guide/01-getting-started/02-software-set-up.mdx b/user-guide/01-getting-started/02-software-set-up.mdx
@@ -54,7 +54,7 @@ What is an image file? It's a file that contains all the required software prein
 6. Click **Edit settings**:
     <img src="/img/user-guide/choose-edit-settings.png" width="525" alt="Click edit settings" style={{margin: "auto", display:"block"}} />
 
-    1. Check **Set hostname**. Input a unique name for this Pioreactor. Some names that we use for our first Pioreactor: `pioreactor1`, or `leader`, or `pio1`. _Don't_ use `pioreactor` or `raspberrypi`.
+    1. Check **Set hostname**. Input a unique name for this Pioreactor. Some names that we use for our first Pioreactor: `pioreactor01`, or `leader`, or `pio01`. _Don't_ use `pioreactor` or `raspberrypi`.
     3. Check **Set username and password**. Enter the following:
         -   **username**: `pioreactor`.
         -   **password**: `raspberry`.
@@ -115,7 +115,9 @@ Workers are additional Pioreactors that you can control from a single UI. Togeth
 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:
 
    :::note
-   Choose a hostname that isn't currently being used in your cluster, ex: `worker1`, `worker2`, etc. Re-using old names is fine, so long as that worker isn't present in your cluster.
+   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.
    :::
 
    Below is a screenshot of example settings, your settings might be slightly different.

diff --git a/user-guide/02-Experiment basics/11-running-self-test.md b/user-guide/02-Experiment basics/11-running-self-test.md
@@ -39,12 +39,19 @@ The self-test routine is optional. Even with test failures, the Pioreactor is st
 
 **Photodiodes are responsive to IR LED** checks to ensure that the IR photodiode(s) have a linear relationship with the IR LED's output. The linear relationship is important. Common reasons why this test fails include:
 
+- Not enough light is entering the PD position (see below for resolutions)
 - The IR LED connected to the the wrong LED output. Make sure that the IR LED is identified correctly in the config.ini
 - A loose (or absent) connection to the Pioreactor HAT, either in the photodiode(s) or the IR LED.
 
 The test will also report any valid IR LED & photodiode relationships in the dialog box. For example, `IR ⇝ REF` means that the REF photodiode has a linear relationship with the IR LED. Similarly, `IR ⇝ 45` means the the photodiode in the 45° pocket has a linear relationship with the IR LED. The absence of a relationship here can tell you about what might be wrong.
 
-Try running this test again if it fails. If it continues to fail, contact us.
+Tips:
+
+ - Try running this test again.
+ - Add a slight amount of turbid liquid (milk, culture, tea) to slightly increase the turbidity of the liquid inside. This increases the scatter of the liquid, and will help this test.
+
+
+If it continues to fail, contact us.
 
 **No ambient IR light detected** checks that the photodiodes are detecting a near-0 signal when the IR LED is completely off. This test may fail if a powerful IR signal is shining into or onto the Pioreactor's body (aka the Sun - don't put the Pioreactor in direct sunlight and avoid windows). Also make sure that the caps are on all the Pioreactor's LED pockets.
 

diff --git a/user-guide/03-Extending your Pioreactor/01-create-cluster.md b/user-guide/03-Extending your Pioreactor/01-create-cluster.md
@@ -61,3 +61,14 @@ You can also choose not to have the leader be a worker. This is useful if you ha
 ![leader not worker](/img/user-guide/leader_cluster.png)
 
 
+### Common questions
+
+
+#### Can I change the name of a _worker_?
+
+Yes, so long as that worker isn't the leader. Note: this doesn't change historical data.
+
+1. Remove the worker from your cluster using the Inventory page.
+2. SSH into the worker (it should still be on your network, even if not part of the cluster).
+3. Run `sudo hostnamectl set-hostname <new-worker-name> && sudo reboot`
+4. After a moment, the worker will turn back on with the new name. You can then use the Inventory page to add the worker again.
diff --git a/user-guide/99-common-questions.mdx b/user-guide/99-common-questions.mdx
@@ -43,7 +43,6 @@ sudo date --set "Thu Nov  2 09:46:50 EDT 2023"
 ```
 
 
-
 Optical density and LEDs
 ------------------------
Original file line number	Diff line number	Diff line change
Expand Up		@@ -43,7 +43,6 @@ sudo date --set "Thu Nov 2 09:46:50 EDT 2023"
		```



		Optical density and LEDs
		------------------------

Expand Down