Skip to content

Commit 4ad8de7

Browse files
committed
fix a couple of typos that were causing errors
1 parent c10c256 commit 4ad8de7

File tree

6 files changed

+80
-4
lines changed

6 files changed

+80
-4
lines changed

docs/3dphardware_dev/glossary.rst

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
Glossary
2+
========
3+
4+
1. `Breakaway End <#Breakaway-End>`_
5+
2. `BusKill Cable <#BusKill-Cable>`_
6+
3. `BusKill Software <#BusKill-Software>`_
7+
4. `Jig <#Jig>`_
8+
5. `Magnetic Coupler <#Magnetic-Coupler>`_
9+
6. `Magnetic Release Cord <#Magnetic-Release-Cord>`_
10+
7. `Pogo Contacts <#Pogo-Contacts>`_
11+
8. `Pogo Pin <#Pogo-Pin>`_
12+
9. `Pogo Contact <#Pogo-Contact>`_
13+
10. `Release End <#Release-End>`_
14+
11. `USB A <#USB-A>`_
15+
12. `USB Ejection Event <#USB-Ejection-Event>`_
16+
13. `USB Insertion Event <#USB-Insertion-Event>`_
17+
18+
Breakaway End
19+
-------------
20+
The Magnetic Coupler has two parts. The Breakaway end is the part of the coupler that would separate from the laptop, it terminates the cord that is attached to the user.
21+
22+
BusKill Cable
23+
-------------
24+
Used to refer to the assembly of a USB, USB Extender Cord, and Magnetic Coupler with a laptop installed and running BusKill software.
25+
26+
BusKill Software
27+
----------------
28+
A program that you can install on Linux, MacOS, or Windows that allows you to set up a trigger that occurs with a USB Ejection Event. The trigger could be locking the screen, shutting down the computer, etc.
29+
30+
Jig
31+
---
32+
A printed piece that is used to stabilize something during assembly.
33+
34+
Magnetic Coupler
35+
----------------
36+
The Magnetic Coupler has two parts, the Breakaway End and the Release End. These two parts contain magnets and contacts. The coupler is designed so that when the magnets are in place, the Pogo Pins and Pogo Receptors make contact and transfer data and power.
37+
38+
Magnetic Release Cord
39+
---------------------
40+
*AKA Magnetic Breakaway Cord*
41+
42+
All of these terms are used to refer to the assembly of a USB A, USB A Extender Cord, and Magnetic Coupler.
43+
44+
Pogo Contact
45+
------------
46+
Contacts refer to either the Pogo Pins or the Pogo Receptors. For the Magnetic Coupler to work, the contacts move the data and power from one end of the magnetic coupler to the other so that the USB device functions as expected.
47+
48+
Pogo Pin
49+
--------
50+
The Pogo Pin is a spring loaded pogo pin. It is soldered to a pin of a USB A port and housed in the Release End of the Magnetic Coupler. When it is in contact with a Pogo Receptor on the end of a USB Extender Cord, it completes the circuit.
51+
52+
Pogo Receptor
53+
-------------
54+
The Pogo Receptor is a conductive contact. It is soldered to the wires of a USB Extender Cord and housed in the Breakaway End of the Magnetic Coupler.
55+
56+
Release End
57+
-----------
58+
The Magnetic Coupler has two parts. The Release end is the part of the coupler that would remain connected to the laptop, it terminates the cord that ends with the USB that is inside the computer.
59+
60+
USB A
61+
-----
62+
USB A is a type of USB connection. It's the type of connection USB drives use.
63+
64+
USB Ejection Event
65+
------------------
66+
What happens when you remove a USB drive from a computer's USB port (or otherwise interrupt the connection, such as with a magnetic coupler) and the computer begins the process of recognizing the disconnection.
67+
68+
USB Extender Cord
69+
-----------------
70+
*AKA USB Extension Cable*
71+
72+
The USB Extender Cord is a cord that has a USB female port on one end and a USB male port at the other end. In the BusKill project, this must necessarily be a Data cord, because the project requires a USB data connection.
73+
74+
USB Insertion Event
75+
-------------------
76+
What happens when you insert a USB drive into a computer's USB port and the computer begins a process of recognizing the device and establishing a connection.

docs/3dphardware_dev/magnets.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Add the magnets
2-
=========================================================
2+
================
33

44
Before you start
55
------------

docs/3dphardware_dev/preppogos.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Steps
1212

1313
1. Strip 8 x 10mm 22 awg wire
1414
2. Solder 4 of the wires to pogo pins
15-
.. image:: /images/3dassembly/pogopinwires.jpg
16-
:width: 400
17-
:alt: photograph of wires soldered to pogo pins
15+
.. image:: /images/3dassembly/pogopinwires.jpg
16+
:width: 400
17+
:alt: photograph of wires soldered to pogo pins
1818
3. Glue the wires into the jig
1919
4. Solder 4 of the wires to pogo contacts
2020
5. Glue the wires onto the jig
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)