aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBlaise Thompson <blaise@untzag.com>2021-04-27 11:42:43 -0500
committerGitHub <noreply@github.com>2021-04-27 11:42:43 -0500
commitdec84cfcdacc0dedac8b8effb15b774731fdaaba (patch)
tree2c6f4c3fb8d4af125ac85b48c83a231e47027249
parent5839fb18663b4c1043c1c0df56cef1b0d34cd759 (diff)
parentc77c9b4ba80fdb34184e741754418cf7e7f327f6 (diff)
Merge pull request #22 from plampkin/Guide
Updated all README files with spelling and grammar fixes
-rw-r--r--README.md18
-rw-r--r--analog-driver-board/README.md6
-rw-r--r--digital-controller/README.md10
-rw-r--r--digital-driver-board/README.md2
-rw-r--r--photon-source-leds/README.md16
-rw-r--r--photoreactor-base/README.md6
-rw-r--r--photoreactor-reaction-modules/README.md4
7 files changed, 31 insertions, 31 deletions
diff --git a/README.md b/README.md
index bc35514..83c12e1 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,15 @@
# Wisconsin Photoreactor Platform (WPP)
-An open source photoreactor platfrom. 3D printed enclosure, commercially avaliable components, and a little bit of custom circuitry.
+An open source photoreactor platform. 3D printed enclosure, commercially available components, and a little bit of custom circuitry.
-![WPP photo](./coverart.png)
-
-A WPP device consists of a base, reaction module and reactor driver. The base houses the photon source and cooling fan. The reaction module consists of a reaction chamber and vessel holder. A digital driver board, analog driver board or simple circuit integrating a commercial light emitting diode (LED) driver can be fitted to the base to drive the reactor. Each component is highly versatile, and apparatus is fully modular.
+![WPP photo](./coverart.jpg)
## Repository
-This is an open source hardware project licensed under the CERN Open Hardware Licence Version 2 - Permissive.
+This is an open source hardware project licensed under the CERN Open Hardware License Version 2 - Permissive.
Please see the LICENSE file for the complete license.
-This repository is being mirrored to several version control systems in an attempt to ensure maximum avaliability.
+This repository is being mirrored to several version control systems in an attempt to ensure maximum availability.
| name | url |
| ---------------- | --------------------------------------------------------------- |
@@ -21,13 +19,13 @@ This repository is being mirrored to several version control systems in an attem
## Safety
-The Wisconsin Photoreactor is for use by trained chemistry researchers and should be handled carefully.
+The Wisconsin Photoreactor is for use by trained chemists.
WPP apparatuses utilize high-intensity light emitting diodes (LED) that can cause eye damage if proper safety precautions are not observed.
Light-filtering safety glasses should be worn whenever a WPP apparatus photon source is powered.
Care must be taken to use safety glasses protective against the specific emission wavelengths of a photon source.
-## Frabication and Operation Instructions
+## Fabrication and Operation Instructions
This repository contains detailed instructions for fabrication, operation and documentation of WPP devices.
Please see [wpp-fabrication-operation.pdf](./fabrication-and-operation-instructions/wpp-fabrication-operation.tex)
@@ -37,9 +35,9 @@ Please see [wpp-fabrication-operation.pdf](./fabrication-and-operation-instructi
The WPP is designed around a mechanically robust 3D printed enclosure.
Every WPP device has the same base, see directory `photoreactor-base`.
WPP reaction modules are meant to be switched based on the reaction vessel used.
-See directory `photoreactor-tops` for our growing collection of reaction modules for common vessel types.
+See directory `photoreactor-reaction-modules` for our growing collection of reaction modules for common vessel types.
## Electronics
-The WPP incorporates small custom circuit boards providing control over light intensity and fan speed.
+The WPP incorporates small custom circuit boards providing control over reaction conditions.
Please see the fabrication instructions for more detailed information.
diff --git a/analog-driver-board/README.md b/analog-driver-board/README.md
index b3e077b..f415761 100644
--- a/analog-driver-board/README.md
+++ b/analog-driver-board/README.md
@@ -1,10 +1,10 @@
# Analog Driver Board
-A simple photoreactor driver board providing control of light intensity. This control is achieved through adjustment of the board-mounted potentiometer. No software is required, and multiple WPP reactors fitted with this board can be connected in series to a single power source.However, fan speed isn’t adjustable and is maintained at maximum.
+A simple photoreactor driver board providing control of light intensity. This control is achieved through adjustment of the board-mounted potentiometer. No software is required, and multiple WPP reactors fitted with this board can be connected in series to a single power source. However, fan speed isn’t adjustable and is maintained at maximum.
Relative light intensity can be determined using the analog driver board test points and a multimeter. See operation instructions for more information.
-The analog driver board is the recommended driver solution for a typical user.
+The analog driver board is the recommended driver solution for a typical user.
## PCB
@@ -34,7 +34,7 @@ PCB images generated with [tracespace](https://github.com/tracespace/tracespace)
| U2 | LED driver | Mean Well | LDD-1000L | $6.00 | [DigiKey](https://www.digikey.com/en/products/detail/mean-well-usa-inc/LDD-1000L/7704722) [Allied](https://www.alliedelec.com/product/mean-well/ldd-1000l/70345765/) |
All prices are extended estimates in USD.
-In general these are overestimates, so this should be an upper-estimate on cost.
+In general, these are overestimates, so this should be an upper-estimate on cost.
Many of these components can be substituted, so take the above as suggestions.
Boards themselves can be printed for approximately $5 each.
diff --git a/digital-controller/README.md b/digital-controller/README.md
index 796b347..6920c1c 100644
--- a/digital-controller/README.md
+++ b/digital-controller/README.md
@@ -1,10 +1,12 @@
# Digital Controller
The digital driver board can be controlled using a "digital control unit."
-Potential digital control units include Arduino microcontrollers or Rasberry Pi devices.
+Potential digital control units include Arduino or Rasberry Pi devices.
These control units can "supervise" the light intensity and fan speed of WPP devices fitted with digital driver boards.
-Custom control unit firmware is required to enable supervision of digital driver boards.
-Open-source firmware for controlling an digital driver board with an Ardunio microcontroller is provided.
+Custom control unit firmware is required to interface with digital driver boards.
+Open-source firmware for controlling a digital driver board with an Ardunio Uno is provided.
+See the firmware files for use instructions.
-Instructions on using this firmware with an Arduino microcontroller is provided in the fabrication and operation instructions.
+Instructions on connecting an Arduino Uno to a digital driver board are provided in the fabrication and operation instructions.
+Please see [wpp-fabrication-operation.pdf](./fabrication-and-operation-instructions/wpp-fabrication-operation.tex).
diff --git a/digital-driver-board/README.md b/digital-driver-board/README.md
index 39f192f..84a3fac 100644
--- a/digital-driver-board/README.md
+++ b/digital-driver-board/README.md
@@ -1,6 +1,6 @@
# digital-driver
-A photoreactor driver board designed to be controlled digitally over I2C.
+A photoreactor driver board designed to be controlled digitally over I2C. For fabrication instructions, please see [wpp-fabrication-operation.pdf](./fabrication-and-operation-instructions/wpp-fabrication-operation.tex).
## PCB
diff --git a/photon-source-leds/README.md b/photon-source-leds/README.md
index 15be9fa..9627bad 100644
--- a/photon-source-leds/README.md
+++ b/photon-source-leds/README.md
@@ -2,14 +2,14 @@
The WPP photon source consists of 3 high-power, single-color LEDs mounted onto an industry-standard 20 mm LED star package.
-WPP-comptabile LED stars emitting narrow wavelength ranges across the UV-Visible spectrum are available from multiple vendors. A few are detailed below.
+WPP-compatible LED stars emitting narrow wavelength ranges across the UV-Visible spectrum are available from multiple vendors. A few are detailed below.
-WPP-comptabible custom LED stars mounted with 3.5 mm surface mount LEDs of any wavelength can be fabricated using a reflow oven. See the fabrication instructions for more information.
+WPP-compatible custom LED stars mounted with 3.5 mm surface mount LEDs of any wavelength can be fabricated using a reflow oven. Please see [wpp-fabrication-operation.pdf](./fabrication-and-operation-instructions/wpp-fabrication-operation.tex) for fabrication instructions for more information.
-## List of compatible commerical LED stars
+## List of compatible commercial LED stars
-| color | max emission | manufacturer | manufacturer part number | LEDsupply LED star part number | LEDsupply price | Other vendors |
-| :------------- | :----------- | :----------- | :------------------------ | :----------------------------- | :-------------- |:------------- |
+| color | max emission | manufacturer | manufacturer part number | LEDsupply LED star part number | LEDsupply price | Other vendors |
+| :------------- | :----------- | :----------- | :----------------------- | :----------------------------- | :-------------- |:------------- |
| UVA | 365 nm | Inolux | IN-C39CTOU2 | N/A (mounted by user) | N/A | [DigiKey](https://www.digikey.com/en/products/detail/inolux/IN-C39CTOU2/9681227) [Mouser](https://www.mouser.com/ProductDetail/Inolux/IN-C39CTOU2/?qs=qSfuJ%252Bfl%2Fd4759YPTEyoag%3D%3D) |
| Violet | 400 nm | Inolux | IN-C39CTOU5 | N/A (mounted by user) | N/A | [DigiKey](https://www.digikey.com/en/products/detail/inolux/IN-C39CTOU5/9681233) [Mouser](https://www.mouser.com/ProductDetail/Inolux/IN-C39CTOU5/?qs=qSfuJ%252Bfl%2Fd6BLbca08ZG2g%3D%3D) |
| Blue | 450 nm | Cree, Inc. | XTEARY-00-0000-000000N09 | CREEXTE-ROY-3 | $10.10 | [DigiKey](https://www.digikey.com/en/products/detail/cree-inc/XTEARY-00-0000-000000N09/3744336) [Mouser](https://www.mouser.com/ProductDetail/Cree-Inc/XTEARY-00-0000-000000N09?qs=ygRr%2Ftkhtevu4HqMzfGc3w%3D%3D) |
@@ -21,9 +21,9 @@ WPP-comptabible custom LED stars mounted with 3.5 mm surface mount LEDs of any w
| NIR | 730 nm | Cree, Inc. | XPEFAR-L1-0000-00601 | CREEXPE-FRD-3 | $12.00 | [DigiKey](https://www.digikey.com/en/products/detail/cree-inc/XPEFAR-L1-0000-00601/5303643) [Mouser](https://www.mouser.com/ProductDetail/Cree-Inc/XPEFAR-L1-0000-00601?qs=k72kBymvut%252B0JKg4b6%252BzNg%3D%3D) |
All prices are in USD.
-In general, prices are overestimates, thereby providing an upper-estimate on cost.
+In general, prices are overestimates, thereby providing an upper estimate on cost.
-## Commerical LED emission spectra
+## Commercial LED emission spectra
LED emission spectra below were measured using an Ocean Insight USB2000 Spectrometer loaned by the [Goldsmith Group](https://goldsmith.chem.wisc.edu).
@@ -47,6 +47,6 @@ LED emission spectra below were measured using an Ocean Insight USB2000 Spectrom
## Ordering Blank LED stars
-The WPP lightsource is designed to fit an industry-standard, 20 mm [Indus Star A008 high power LED modules](https://leddynamics.com/indus-star-a007-a008).
+The WPP base is designed to fit an industry-standard, 20 mm [Indus Star A008 high power LED modules](https://leddynamics.com/indus-star-a007-a008).
To order blank Indus Star A008 LED stars for custom LED star creation, contact [LEDsupply](https://www.ledsupply.com/contact-us), [LEDdynamics](https://leddynamics.com/contact-us) or other vendors.
diff --git a/photoreactor-base/README.md b/photoreactor-base/README.md
index 311cf03..4b69cf4 100644
--- a/photoreactor-base/README.md
+++ b/photoreactor-base/README.md
@@ -2,10 +2,10 @@
![WPP base](./base.jpg)
-The core structure of the Wisconsin Photoreactor Platform. Each reactor shares this component. It has a 140 mm by 140 mm footprint and is compatible with typical laboratory stir plates.
+The core structure of the Wisconsin Photoreactor Platform. Each reactor shares this component. It has a 130 mm by 130 mm footprint and is compatible with typical laboratory stir plates.
Through variation of the LED star integrated into a base, the user can control the wavelengths of light delivered by the photon source to a reaction vessel.
-See fabrication instructions for LED star installation instructions. See `photon-source-leds` directory for list of LED stars confirmed compatible with the WPP architecture.
+Please see [wpp-fabrication-operation.pdf](./fabrication-and-operation-instructions/wpp-fabrication-operation.tex) for fabrication instructions and LED star installation instructions. See `photon-source-leds` directory for list of LED stars confirmed compatible with the WPP architecture.
### Bill of Materials
@@ -20,4 +20,4 @@ See fabrication instructions for LED star installation instructions. See `photon
| 3/4" screws | Fastenal | 72490 | |
All prices are extended estimates in USD.
-In general these are overestimates, so this should be an upper-estimate on cost.
+In general, these are overestimates, so this should be an upper estimate on cost.
diff --git a/photoreactor-reaction-modules/README.md b/photoreactor-reaction-modules/README.md
index e9ed3ac..694a7a3 100644
--- a/photoreactor-reaction-modules/README.md
+++ b/photoreactor-reaction-modules/README.md
@@ -7,7 +7,7 @@ A WPP reaction module consists of a reflective reaction chamber and rigid vessel
By modifying chamber height and adjusting holder geometry, one can produce modules compatible with reaction vessels of various types and sizes.
Template reaction chamber and vessel holder CAD designs are provided in the `template` directory.
-CAD designs and 3D-printable models for modules compatible with various common reaction vessl are provided in this directory. A table of compatible vessels is offered below.
+CAD designs and 3D-printable models for modules compatible with various common reaction vessel are provided in this directory. A table listing vessels with already created reaction modules is offered below.
## Reaction vessels with compatible modules
@@ -21,7 +21,7 @@ CAD designs and 3D-printable models for modules compatible with various common r
## Bill of Materials
-The interior of WPP reaciton chambers should be covered with reflective material. One option is offered below.
+The interior of WPP reaction chambers should be covered with reflective material. One option is offered below.
| reference | manufacturer | part number | price | vendors |
| :---------------- | :----------- | :---------------- | :----- | :------ |