Skip to content

Commit 209dcf0

Browse files
matiashl27matiashl27
committed
Merge branch 'docu-v2' of https://github.com/wenzel-lab/syringe-pumps-and-controller into docu-v2
2 parents 44f38cf + d431014 commit 209dcf0

File tree

112 files changed

+1054798
-653
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+1054798
-653
lines changed

‎1_printing.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ <h3 id="control-interface">Control Interface</h3>
143143
</ul>
144144
<h2 class="page-step" id="clean-up-of-printed-parts">Step 3: Clean-up of printed parts</h2>
145145
<div class="warning-block">
146-
<p><strong>Be careful when removing brim:</strong> To avoid injury, first remove the bulk of the brim without a knife. Remove the remaining brim with a peeling action as described below.</p>
146+
<p><strong>Be careful when removing the brim:</strong> To avoid injury, first remove the bulk of the brim without a knife. Remove the remaining brim with a peeling action as described below.</p>
147147
</div>
148148
<p>Carefully remove the printing brim from all parts. To remove brim:</p>
149149
<ol>

‎2_syringe-pump.html

+24-21
Large diffs are not rendered by default.

‎2_syringe-pump_BOM.csv

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
Name in documentation Category Qty Full Name Notes
2+
Back support - A printedparts 1
3+
Back support - B printedparts 1
4+
Carriage printedparts 1
5+
Front support printedparts 1
6+
Hand knob printedparts 2
7+
Heat insert mech 6 Heat inserts
8+
Lead screw mech 1 Threaded Rod
9+
Lead screw nut mech 1 Lead Screw Nut
10+
Linear bearing mech 2 Linear Bearing
11+
Linear motion rods mech 2 Linear Motion Rods
12+
M2.5 hex key tool 1
13+
M3 10mm screw mech 2 Screw
14+
M3 12mm screw mech 2 Screw
15+
M3 16mm screw mech 8 Screw
16+
M3 20mm screw mech 2 Screw
17+
M3 8mm screw mech 4 Screw
18+
M3 hex key tool 1
19+
M3 nut mech 9
20+
M4 10mm screw mech 4 Screw
21+
M4 hex key tool 1
22+
Motor coupling mech 1 Motor Coupling
23+
NEMA 17 motor elect 1 Stepper Motor Nema 17
24+
Planetary gearbox 100:1 mech 1 Planetary Gearbox
25+
Soldering iron tool 1
26+
Syringe holder printedparts 1

‎2_syringe-pump_BOM.html

+120
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Open-Source Syringe Pumps</title>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
<link rel="shortcut icon" href="./assets/favicon.ico" />
9+
10+
<link href="./static/style.css" rel="stylesheet">
11+
<link href="./assets/style.css" rel="stylesheet">
12+
<style>
13+
.nav-list a:hover:not(.active), .sub-nav-list a:hover:not(.active) {
14+
background-color: #555555 !important;
15+
}
16+
</style>
17+
18+
</head>
19+
<body>
20+
<header class="site-header">
21+
<div class="wrapper header-wrapper" >
22+
<div class=header-text>
23+
24+
<h1 class="site-title">Open-Source Syringe Pumps</h1>
25+
26+
<p class="author">by Pierre Padilla-Huamantinco, Tomás Astudillo Inostroza, Matías Hurtado Labarca, and Tobias Wenzel</p>
27+
<p class="affiliation">Latin American Hub for Bioimaging Through Open Hardware (LIBRE hub)</p>
28+
</div>
29+
</div>
30+
</header>
31+
<div class="page-content">
32+
<div>
33+
<nav class="sidebar">
34+
<a href="#" class="menu-icon">
35+
<svg viewBox="0 0 18 15">
36+
<path fill="#424242" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"/>
37+
<path fill="#424242" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484 h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"/>
38+
<path fill="#424242" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"/>
39+
</svg>
40+
</a>
41+
<ul class="nav-list">
42+
<li>
43+
<a class="navhome" href="./">
44+
Open-Source Syringe Pumps
45+
</a>
46+
</li>
47+
<li class="not-active">
48+
<a class="not-active" href="./1_printing.html">
49+
Print the plastic parts
50+
</a>
51+
</li>
52+
<li class="not-active">
53+
<a class="not-active" href="./2_syringe-pump.html">
54+
Build syringe pump
55+
</a>
56+
</li>
57+
<li class="not-active">
58+
<a class="not-active" href="./3_control-interface.html">
59+
Build control interface
60+
</a>
61+
</li>
62+
63+
</ul>
64+
</nav>
65+
</div>
66+
<div class="wrapper">
67+
<h1 id="bill-of-materials">Bill of Materials</h1>
68+
<p>Download this as a <a href="2_syringe-pump_BOM.csv">CSV file</a></p>
69+
<h3 id="tool">Tools</h3>
70+
<ul>
71+
<li>1 <a Class="bom" href="parts/tools/2mmBallEndAllenKey.html">M2.5 hex key</a> </li>
72+
<li>1 <a Class="bom" href="parts/tools/2.5mmBallEndAllenKey.html">M3 hex key</a> </li>
73+
<li>1 <a Class="bom" href="parts/tools/3mmBallEndAllenKey.html">M4 hex key</a> </li>
74+
<li>1 <a Class="bom" href="parts/tools/soldering-iron.html">Soldering iron</a> </li>
75+
</ul>
76+
<h3 id="elect">Electronic Components</h3>
77+
<ul>
78+
<li>1 <a Class="bom" href="parts/elect/NEMA-17-motor.html">NEMA 17 motor</a> </li>
79+
</ul>
80+
<h3 id="mech">Mechanical Components</h3>
81+
<ul>
82+
<li>6 <a Class="bom" href="parts/mech/heat-insert.html">Heat insert</a> </li>
83+
<li>1 <a Class="bom" href="parts/mech/lead-screw.html">Lead screw</a> </li>
84+
<li>1 <a Class="bom" href="parts/mech/lead-screw-nut.html">Lead screw nut</a> </li>
85+
<li>2 <a Class="bom" href="parts/mech/linear-bearing.html">Linear bearing</a> </li>
86+
<li>2 <a Class="bom" href="parts/mech/linear-motion-rods-200mm.html">Linear motion rods</a> </li>
87+
<li>2 <a Class="bom" href="parts/mech/M3-10.html">M3 10mm screw</a> </li>
88+
<li>2 <a Class="bom" href="parts/mech/M3-12.html">M3 12mm screw</a> </li>
89+
<li>8 <a Class="bom" href="parts/mech/M3-16.html">M3 16mm screw</a> </li>
90+
<li>2 <a Class="bom" href="parts/mech/M3-20.html">M3 20mm screw</a> </li>
91+
<li>4 <a Class="bom" href="parts/mech/M3-8.html">M3 8mm screw</a> </li>
92+
<li>9 <a Class="bom" href="parts/mech/nuts.html">M3 nut</a> </li>
93+
<li>4 <a Class="bom" href="parts/mech/M4-10.html">M4 10mm screw</a> </li>
94+
<li>1 <a Class="bom" href="parts/mech/motor-coupling.html">Motor coupling</a> </li>
95+
<li>1 <a Class="bom" href="parts/mech/planetary-gearbox-100-1.html">Planetary gearbox 100:1</a> </li>
96+
</ul>
97+
<h3 id="printedparts">Printed Parts</h3>
98+
<ul>
99+
<li>1 <a Class="bom" href="models/back-support-gearbox-A.html">Back support - A</a> </li>
100+
<li>1 <a Class="bom" href="models/back-support-gearbox-B.html">Back support - B</a> </li>
101+
<li>1 <a Class="bom" href="models/carriage.html">Carriage</a> </li>
102+
<li>1 <a Class="bom" href="models/front-support.html">Front support</a> </li>
103+
<li>2 <a Class="bom" href="models/hand-knob.html">Hand knob</a> </li>
104+
<li>1 <a Class="bom" href="models/syringe-holders.html">Syringe holder</a> </li>
105+
</ul>
106+
</div>
107+
</div>
108+
<footer class="site-footer">
109+
<div class="wrapper">
110+
<a target="_blank" rel="noopener noreferrer" href="https://gitbuilding.io">
111+
<img class="icon" src="./static/Logo/GitBuilding500x.png" alt="GitBuilding logo">
112+
<span class="info">Documentation powered by GitBuilding</span>
113+
</a>
114+
<p class="author">©2024 Pierre Padilla-Huamantinco, Tomás Astudillo Inostroza, Matías Hurtado Labarca, and Tobias Wenzel</p>
115+
<p class="email">Contact: <a href="mailto:librehub@uc.cl">librehub@uc.cl</a></p>
116+
<p class="license">Open-Source Syringe Pumps is released under <a href="license.html">CERN-OHL-1.2</a>.</p>
117+
118+
</div>
119+
</footer></body>
120+
</html>

‎3_control-interface.html

+11-6
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,11 @@ <h1 class="site-title">Open-Source Syringe Pumps</h1>
6060
</a>
6161
<ul class="sub-nav-list">
6262
<li>
63+
<a class="not-active" href="./3_control-interface_BOM.html">
64+
Bill of Materials
65+
</a>
66+
</li>
67+
<li>
6368
<a class="not-active" href="./ci_interaction_panel.html">
6469
Assemble the Front Panel
6570
</a>
@@ -88,7 +93,7 @@ <h1 class="site-title">Open-Source Syringe Pumps</h1>
8893
<div class="wrapper">
8994
<h1 id="control-interface">Control Interface</h1>
9095
<p><img alt="" src="images/control-interface/final.jpg" title="" /></p>
91-
<p>Before you start building the control interface, you will need to source all the components listed in our bill of materials:</p>
96+
<p>Before you start building the station, you will need to source all the components listed in our <a href="3_control-interface_BOM.html" title="HTML">bill of materials</a> (<a href="3_control-interface_BOM.html"><img alt="HTML" class="smallicon" src="static/Icons/html.png" title="HTML Bill of Materials" /></a>, <a href="3_control-interface_BOM.csv"><img alt="CSV" class="smallicon" src="static/Icons/csv.png" title="CSV Bill of Materials" /></a>), which is given on the next page.</p>
9297
<div class="pagebom">
9398
<h2 id="for-this-section-you-will-need">For this section you will need:</h2>
9499
<h3 id="elect">Electronic Components</h3>
@@ -106,10 +111,10 @@ <h3 id="elect">Electronic Components</h3>
106111
</ul>
107112
<h3 id="mech">Mechanical Components</h3>
108113
<ul>
109-
<li>8 <a Class="bom" href="parts/mech/M3-10mm-screw.html">M3 10mm screw</a> </li>
110-
<li>4 <a Class="bom" href="parts/mech/M3-15mm-screw.html">M3 15mm screw</a> </li>
111-
<li>1 <a Class="bom" href="parts/mech/M3-25mm-screw.html">M3 25mm screw</a> </li>
112-
<li>14 <a Class="bom" href="parts/mech/M3-nut.html">M3 nut</a> </li>
114+
<li>8 <a Class="bom" href="parts/mech/M3-10.html">M3 10mm screw</a> </li>
115+
<li>4 <a Class="bom" href="parts/mech/M3-16.html">M3 16mm screw</a> </li>
116+
<li>1 <a Class="bom" href="parts/mech/M3-25.html">M3 25mm screw</a> </li>
117+
<li>14 <a Class="bom" href="parts/mech/nuts.html">M3 nut</a> </li>
113118
</ul>
114119
<h3 id="printedparts">Printed Parts</h3>
115120
<ul>
@@ -130,7 +135,7 @@ <h2 id="instructions">Instructions</h2>
130135
<li><a href="ci_software.html" title="">Firmware Installation</a></li>
131136
</ol>
132137
<hr />
133-
<p><a href="ci_interaction_panel.html">Next page</a></p>
138+
<p><a href="3_control-interface_BOM.html">Next page</a></p>
134139
</div>
135140
</div>
136141
<footer class="site-footer">

‎3_control-interface_BOM.csv

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Name in documentation Category Qty Full Name Notes
2+
10 cm female-female jumper elect 7
3+
10 cm male-female jumper elect 8
4+
20 cm female-female jumper elect 12
5+
40 pin header elect 1
6+
5.5mm female jack connector elect 1
7+
Back cover printedparts 1
8+
Electronics holder printedparts 1
9+
Interface base printedparts 1
10+
Interface panel printedparts 1
11+
LCD adapter printedparts 1
12+
LCD screen elect 1 LCD Screen
13+
M3 10mm screw mech 8 Screw
14+
M3 16mm screw mech 4 Screw
15+
M3 25mm screw mech 1 Screw
16+
M3 nut mech 14
17+
Membrane 4x4 keypad elect 1
18+
Raspberry Pi Pico elect 1
19+
TMC2209 driver elect 2 Silent Driver + Heatsink
20+
Voltage regulator elect 1

‎3_control-interface_BOM.html

+140
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<title>Open-Source Syringe Pumps</title>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
7+
<meta name="viewport" content="width=device-width, initial-scale=1">
8+
<link rel="shortcut icon" href="./assets/favicon.ico" />
9+
10+
<link href="./static/style.css" rel="stylesheet">
11+
<link href="./assets/style.css" rel="stylesheet">
12+
<style>
13+
.nav-list a:hover:not(.active), .sub-nav-list a:hover:not(.active) {
14+
background-color: #555555 !important;
15+
}
16+
</style>
17+
18+
</head>
19+
<body>
20+
<header class="site-header">
21+
<div class="wrapper header-wrapper" >
22+
<div class=header-text>
23+
24+
<h1 class="site-title">Open-Source Syringe Pumps</h1>
25+
26+
<p class="author">by Pierre Padilla-Huamantinco, Tomás Astudillo Inostroza, Matías Hurtado Labarca, and Tobias Wenzel</p>
27+
<p class="affiliation">Latin American Hub for Bioimaging Through Open Hardware (LIBRE hub)</p>
28+
</div>
29+
</div>
30+
</header>
31+
<div class="page-content">
32+
<div>
33+
<nav class="sidebar">
34+
<a href="#" class="menu-icon">
35+
<svg viewBox="0 0 18 15">
36+
<path fill="#424242" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"/>
37+
<path fill="#424242" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484 h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"/>
38+
<path fill="#424242" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"/>
39+
</svg>
40+
</a>
41+
<ul class="nav-list">
42+
<li>
43+
<a class="navhome" href="./">
44+
Open-Source Syringe Pumps
45+
</a>
46+
</li>
47+
<li class="not-active">
48+
<a class="not-active" href="./1_printing.html">
49+
Print the plastic parts
50+
</a>
51+
</li>
52+
<li class="not-active">
53+
<a class="not-active" href="./2_syringe-pump.html">
54+
Build syringe pump
55+
</a>
56+
</li>
57+
<li class="active">
58+
<a class="active" href="./3_control-interface.html">
59+
Build control interface
60+
</a>
61+
<ul class="sub-nav-list">
62+
<li>
63+
<a class="active" href="./3_control-interface_BOM.html">
64+
Bill of Materials
65+
</a>
66+
</li>
67+
<li>
68+
<a class="not-active" href="./ci_interaction_panel.html">
69+
Assemble the Front Panel
70+
</a>
71+
</li>
72+
<li>
73+
<a class="not-active" href="./ci_electronics.html">
74+
Assemble the Main Electronics
75+
</a>
76+
</li>
77+
<li>
78+
<a class="not-active" href="./ci_close.html">
79+
Assemble everything together
80+
</a>
81+
</li>
82+
<li>
83+
<a class="not-active" href="./ci_software.html">
84+
Firmware Installation
85+
</a>
86+
</li>
87+
</ul>
88+
</li>
89+
90+
</ul>
91+
</nav>
92+
</div>
93+
<div class="wrapper">
94+
<h1 id="bill-of-materials">Bill of Materials</h1>
95+
<p>Download this as a <a href="3_control-interface_BOM.csv">CSV file</a></p>
96+
<h3 id="elect">Electronic Components</h3>
97+
<ul>
98+
<li>7 <a Class="bom" href="parts/elect/10cm-f-f-jumper.html">10 cm female-female jumper</a> </li>
99+
<li>8 <a Class="bom" href="parts/elect/10cm-m-f-jumper.html">10 cm male-female jumper</a> </li>
100+
<li>12 <a Class="bom" href="parts/elect/20cm-f-f-jumper.html">20 cm female-female jumper</a> </li>
101+
<li>1 <a Class="bom" href="parts/elect/40-pin-header.html">40 pin header</a> </li>
102+
<li>1 <a Class="bom" href="parts/elect/5.5mm-f-jack-connector.html">5.5mm female jack connector</a> </li>
103+
<li>1 <a Class="bom" href="parts/elect/lcd-screen.html">LCD screen</a> </li>
104+
<li>1 <a Class="bom" href="parts/elect/4x4-keypad.html">Membrane 4x4 keypad</a> </li>
105+
<li>1 <a Class="bom" href="parts/elect/rpi-pico.html">Raspberry Pi Pico</a> </li>
106+
<li>2 <a Class="bom" href="parts/elect/TMC2209-driver.html">TMC2209 driver</a> </li>
107+
<li>1 <a Class="bom" href="parts/elect/voltage-regulator.html">Voltage regulator</a> </li>
108+
</ul>
109+
<h3 id="mech">Mechanical Components</h3>
110+
<ul>
111+
<li>8 <a Class="bom" href="parts/mech/M3-10.html">M3 10mm screw</a> </li>
112+
<li>4 <a Class="bom" href="parts/mech/M3-16.html">M3 16mm screw</a> </li>
113+
<li>1 <a Class="bom" href="parts/mech/M3-25.html">M3 25mm screw</a> </li>
114+
<li>14 <a Class="bom" href="parts/mech/nuts.html">M3 nut</a> </li>
115+
</ul>
116+
<h3 id="printedparts">Printed Parts</h3>
117+
<ul>
118+
<li>1 <a Class="bom" href="models/interface-back-cover.html">Back cover</a> </li>
119+
<li>1 <a Class="bom" href="models/electronics-holder.html">Electronics holder</a> </li>
120+
<li>1 <a Class="bom" href="models/interface-base.html">Interface base</a> </li>
121+
<li>1 <a Class="bom" href="models/interface-panel.html">Interface panel</a> </li>
122+
<li>1 <a Class="bom" href="models/lcd-adapter.html">LCD adapter</a> </li>
123+
</ul>
124+
<hr />
125+
<p><a href="3_control-interface.html">Previous page</a> | <a href="ci_interaction_panel.html">Next page</a></p>
126+
</div>
127+
</div>
128+
<footer class="site-footer">
129+
<div class="wrapper">
130+
<a target="_blank" rel="noopener noreferrer" href="https://gitbuilding.io">
131+
<img class="icon" src="./static/Logo/GitBuilding500x.png" alt="GitBuilding logo">
132+
<span class="info">Documentation powered by GitBuilding</span>
133+
</a>
134+
<p class="author">©2024 Pierre Padilla-Huamantinco, Tomás Astudillo Inostroza, Matías Hurtado Labarca, and Tobias Wenzel</p>
135+
<p class="email">Contact: <a href="mailto:librehub@uc.cl">librehub@uc.cl</a></p>
136+
<p class="license">Open-Source Syringe Pumps is released under <a href="license.html">CERN-OHL-1.2</a>.</p>
137+
138+
</div>
139+
</footer></body>
140+
</html>

‎README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Our goal with this modification and enhancement is to make this open-source syri
1515
## Usage
1616

1717
### Instructions
18-
This Repository provides documentation on how to build the pumps and the controller. Just [follow the instructions here](https://librehub.github.io/syringe-pumps-and-controller/).
18+
This Repository provides documentation on how to build the pumps and the controller. Just [follow the instructions here](https://wenzel-lab.github.io/syringe-pumps-and-controller/)
1919

2020
This project is documented with GitBuilding - an Open Source project for documenting hardware projects. For more information on the GitBuilding project or how
2121
to install GitBuilding, please see the [GitBuilding website](http://gitbuilding.io)
@@ -26,7 +26,7 @@ to install GitBuilding, please see the [GitBuilding website](http://gitbuilding.
2626
* [Link to OnShape CAD files of printable syringe pump parts](https://cad.onshape.com/documents/20c077b452e92115525d4fed/w/71118f46b0924c1bb22b1150/e/9d30ca00efa721d242d78d3f?renderMode=0&uiState=64bd5f2a8bef574246b008b9)
2727
* [Link to OnShape CAD files of the printable controller enclosure](https://cad.onshape.com/documents/24a5022fafc4edd0c24874dd/w/35c6569cda7c2fa4439727d4/e/9dbcdcaba091e21e6a91c62c?renderMode=0&uiState=64bd5f3f0aa451311c1bb6ad)
2828
* Software source code
29-
* [Code to upload onto the Raspberry Pi Pico controller](https://github.com/LIBREhub/syringe-pumps-and-controller/blob/docu-v1/software/firmwareV1.ino)
29+
* [Code to upload onto the Raspberry Pi Pico controller](https://github.com/wenzel-lab/syringe-pumps-and-controller/blob/docu-v1/software/firmwareV1.ino)
3030

3131
### How do I edit the documentation?
3232

0 commit comments

Comments
 (0)