Skip to content

Commit c7e2225

Browse files
fixes
1 parent 4c9675a commit c7e2225

4 files changed

Lines changed: 20 additions & 14 deletions

File tree

developer-guide/07-Plugins/02-adding-plugins-to-ui.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ You should have already added your plugin's Python code to your Pioreactor by so
2121

2222

2323
The list of activities, among other things, is sourced from either of two directories:
24-
- `/var/www/pioreactorui/contrib/jobs/`, is the source of the "default" jobs
25-
- `/home/pioreactor/.pioreactor/plugins/ui/contrib/jobs`, is a directory to put custom yaml files for jobs.
24+
- `~/pioreactor/.pioreactor/ui/jobs`, is the source of the "default" jobs
25+
- `~/pioreactor/.pioreactor/plugins/ui/jobs`, is a directory to put custom yaml files for plugins.
2626

2727
Placing a new yaml file in either of these folders will populate the page with your new job. Here's an example `example.yaml` file:
2828

@@ -63,8 +63,8 @@ Saving it to either directory above, and refreshing the page:
6363
6464
Placing a new yaml file in either of the following folders will populate the UI with your new job.
6565
66-
- `/var/www/pioreactorui/contrib/jobs/`, is the source of the "default" jobs
67-
- `/home/pioreactor/.pioreactor/plugins/ui/contrib/jobs/`, is a directory to put custom plugins.
66+
- `~/pioreactor/.pioreactor/ui/jobs`, is the source of the "default" jobs
67+
- `~/pioreactor/.pioreactor/plugins/ui/jobs`, is a directory to put custom yaml files for plugins.
6868

6969
```yaml
7070
---
@@ -87,8 +87,11 @@ Suppose we wish to add our new automation, either installed from a package or vi
8787
![](/img/developer-guide/07-plugins/02-adding-plugins-to-ui/dropdown_automations.png)
8888

8989
This list is sourced from yaml files located on the leader's Raspberry Pi, in either of two directories:
90-
- `/var/www/pioreactorui/contrib/automations/`, is the source of the our built-in automations
91-
- `/home/pioreactor/.pioreactor/plugins/ui/contrib/automations/{led,dosing,temperature}`, is a directory to put yaml files for custom automations.
90+
91+
- `~/pioreactor/.pioreactor/ui/automations`, is the source of the "default" automations
92+
- `~/pioreactor/.pioreactor/plugins/ui/automations`, is a directory to put custom yaml files for plugins.
93+
94+
9295

9396
Placing your yaml file in either folder above will populate the dropdown list in the UI with your new automation. Here's an example `example.yaml` file:
9497

developer-guide/07-Plugins/03-plugin-as-python-package.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ function decorated with `@run.command` at the bottom of the file. See example [h
149149

150150
#### 3. Optional: A configuration file, named `additional_config.ini`
151151

152-
This configuration file will contain additional configs that we want to add to our list of existing Configurations on the Pioreactor web interface. This file will be merged with the existing `config.ini` when the plugin is installed.
152+
This configuration file will contain additional configs that we want to add to our list of existing Configurations on the Pioreactor web interface. This file will be merged with the existing `unit_config.ini` when the plugin is installed.
153153

154154
![](/img/developer-guide/07-plugins/03-plugin-as-python-package/python-package-new-config.png)
155155

user-guide/01-getting-started/00-gettingstarted.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,21 @@ import Card from '@site/src/components/Card';
2626
<Card imageUrl="user-guide/hardware-assembly/pioreactor_20ml_v1.0_splash.png" headerText="Pioreactor 20ml v1.0" linkUrl="/user-guide/hardware-setup-intro"/>
2727
</div>
2828

29-
<h3> Upgrade kits and accessories</h3>
29+
<h3> Upgrade kits</h3>
3030

3131
<div className="cardGrid">
32-
<Card imageUrl="user-guide/hardware-assembly/upgrade_kits/40ml1.0to-1.5.webp" headerText="Pioreactor 40ml v1.0 → v1.5 upgrade kit" linkUrl="/user-guide/40ml-v10-upgrade-v15-upgrade-disassembly"/>
33-
<Card imageUrl="user-guide/hardware-assembly/upgrade_kits/20ml_1.1to-1.5_1.webp" headerText="Pioreactor 20ml v1.1 → v1.5 upgrade kit" linkUrl="/user-guide/20ml-v11-upgrade-v15-upgrade-disassembly" />
3432
<Card imageUrl="user-guide/hardware-assembly/upgrade_XR/40ml-xr.png" headerText="Pioreactor 40ml v1.5 → XR upgrade kit" linkUrl="/user-guide/40ml-v15-to-XR-upgrade-disassembly" isNew={true} />
3533
<Card imageUrl="user-guide/hardware-assembly/upgrade_XR/20ml-xr.png" headerText="Pioreactor 20ml v1.5 → XR upgrade kit" linkUrl="/user-guide/20ml-v15-to-XR-upgrade-disassembly" isNew={true} />
34+
<Card imageUrl="user-guide/hardware-assembly/upgrade_kits/40ml1.0to-1.5.webp" headerText="Pioreactor 40ml v1.0 → v1.5 upgrade kit" linkUrl="/user-guide/40ml-v10-upgrade-v15-upgrade-disassembly"/>
35+
<Card imageUrl="user-guide/hardware-assembly/upgrade_kits/20ml_1.1to-1.5_1.webp" headerText="Pioreactor 20ml v1.1 → v1.5 upgrade kit" linkUrl="/user-guide/20ml-v11-upgrade-v15-upgrade-disassembly" />
3636
<Card imageUrl="user-guide/hardware-assembly/upgrade-version-splash.png" headerText="Pioreactor 20ml v1.0 → v1.1 upgrade kit" linkUrl="/user-guide/v11-upgrade-hardware-setup"/>
3737
<Card imageUrl="user-guide/add-teh/14_teh_finished.jpeg" headerText="Temperature Expansion Kit" linkUrl="/user-guide/temperature-expansion-kit" />
38+
</div>
39+
40+
<h3> Accessories</h3>
41+
3842
<Card imageUrl="user-guide/hardware-assembly/pioreactor_dosing_splash.webp" headerText="Adding peristaltic pumps" linkUrl="/user-guide/using-pumps" />
3943
<Card imageUrl="user-guide/01-getting-started/00-gettingstarted/leds_splash.webp" headerText="Adding more LEDs" linkUrl="/user-guide/using-leds" />
40-
</div>
4144

4245
<h3> Software guides</h3>
4346

user-guide/29-Automations/02-dosing-automations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ sidebar_class_name: sidebar-item--updated
88

99
When pairing the Pioreactor with dosing pumps, there are new capabilities and experiments you can run. The Pioreactor is pre-programmed with the following dosing automations. In the below automations, values highlighted `like so` are configurable.
1010

11-
Before starting a dosing automation from the UI, review the `Current volume` and `Max working volume` fields in the automation dialog. `Current volume` should match the liquid currently in the vial, and `Max working volume` should match the volume set by the height of your waste / efflux tube.
11+
Before starting a dosing automation from the UI, review the `Current volume` and `Efflux tube level` fields in the automation dialog. `Current volume` should match the liquid currently in the vial, and `Efflux tube level` should match the volume set by the height of your waste / efflux tube.
1212

1313
## Available dosing automations
1414

@@ -155,12 +155,12 @@ To further avoid overflow, we limit how much liquid is added in a single pump cy
155155

156156

157157
- **Current volume**: this is how much liquid is currently in the vial when you start the automation.
158-
- **Max working volume**: the efflux tube's position determines the maximum volume your liquid volume will reach.
158+
- **Efflux tube level**: the efflux tube's position determines the maximum volume your liquid volume will reach.
159159

160160

161161
### Configuration parameters
162162

163-
You can edit these parameters in your config.ini files. For dosing runs started from the UI, `Current volume` and `Max working volume` can also be adjusted directly in the automation dialog before starting.
163+
You can edit these parameters in your config.ini files. For dosing runs started from the UI, `Current volume` and `Efflux tube level` can also be adjusted directly in the automation dialog before starting.
164164

165165

166166
#### Section `[dosing_automation.config]`

0 commit comments

Comments
 (0)