Gorkem/trinteract
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updated docs

Browse Source
This commit is contained in:
gocivici 2023-05-11 19:03:33 +03:00
parent e44585f14d
commit 03a436114a
56 changed files with 328 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/.doctrees/build_your_own/3D Printing.doctree
View File

Binary file not shown.

BIN
docs/.doctrees/build_your_own/Fabrication.doctree
View File

Binary file not shown.

BIN
docs/.doctrees/build_your_own/Soldering.doctree
View File

Binary file not shown.

BIN
docs/.doctrees/build_your_own/Testing.doctree
View File

Binary file not shown.

BIN
docs/.doctrees/build_your_own/overview.doctree
View File

Binary file not shown.

BIN
docs/.doctrees/environment.pickle
View File

Binary file not shown.

BIN
docs/.doctrees/index.doctree
View File

Binary file not shown.

BIN
docs/_images/3D.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 635 KiB

BIN
docs/_images/3D2.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 479 KiB

BIN
docs/_images/cura.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 599 KiB

BIN
docs/_images/hole.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 363 KiB

BIN
docs/_images/pcb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 154 KiB

BIN
docs/_images/schema.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 104 KiB

BIN
docs/_images/solder.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 871 KiB

BIN
docs/_images/solder2.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 903 KiB

23
docs/_sources/build_your_own/3D Printing.rst.txt
View File

@ -1,2 +1,23 @@
3D Printing
===========
===========
.. image:: cura.png
:width: 80%
:align: center
The latest CAD files can downloaded from `this link. <https://github.com/gocivici/trinteract/archive/refs/heads/master.zip>`_ The CAD files can be edited in Fusion360. You can also use the .stl files directly for the 3D printing.
The 3D prints were done on a fdm printer with a eSun PLA+ filament. The following settings were used for the print:
* Layer Height: 0.25mm
* Wall thickness: 1.2mm
* infill: 50%
* Generate support, Overhang Angle:60
.. image:: 3D.jpg
:width: 45%
.. image:: 3D2.jpg
:width: 45%

12
docs/_sources/build_your_own/Fabrication.rst.txt
View File

@ -1,2 +1,12 @@
PCB Fabrication
===============
===============
Schematic and PCB
-----------------
.. image:: pcb.png
The latest PCB files can downloaded from `this link <https://github.com/gocivici/trinteract/archive/refs/heads/master.zip>`_
There are two subfolders under the PCB folder. One contains the KiCAD files that can be edited and customized. The other folder titled "Gerbers" contains the manufacture ready files
that can be directly sent to a PCB manufacturer like JLCPCB.

32
docs/_sources/build_your_own/Soldering.rst.txt
View File

@ -1,2 +1,32 @@
Soldering
=========
=========
SMD Components
--------------
.. image:: solder.jpg
:width: 45%
.. image:: solder2.jpg
:width: 45%
.. note::
The PCB in these pictures are from the previous version, I'll update them once I receive the new batch. The only difference in the new version is the button placement. The newer version has the button on the back.
The components can be soldered on to the PCB by hand, but you could also use solder paste and a reflow oven to make the process easier. I followed this tutorial
for the hand soldering:
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/embed/4zXP0TtORWo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
Through-Hole Components
-----------------------
The only Through-Hole components in this build are te header pins. You can also solder additional expansion pins if you plan to prototype with the board.
.. image:: hole.jpg
:width: 60%
:align: center

4
docs/_sources/build_your_own/Testing.rst.txt
View File

@ -1,2 +1,2 @@
Testing
=======
Assembly and Testing
====================

22
docs/_sources/build_your_own/overview.rst.txt
View File

@ -1,2 +1,22 @@
Overview
========
========
Here are the parts that are required to biuld trinteract. You can also prototype it first before fabricating a pcb following the wiring diagram below.
Parts
-----
* :doc:`Trinteract pcb </build_your_own/Fabrication>`
* `Infenion TLV493DA Low Power 3D Magnetic Sensor <https://eu.mouser.com/ProductDetail/Infineon-Technologies/TLV493DA1B6HTSA2?qs=0DP5yvOrqYnbdRXsuslLCg%3D%3D&countryCode=DE&currencyCode=EUR>`_
* '2 x 2.2k Ω SMD Resistor 0805 - R1 & R3
* '680 Ω SMD Resistor 0805 - R2
* '4.7k Ω SMD Resistor 0805 - R4
* '100n SMD Capacitor 0805 - C1
* 'Tactile Switch 5 X 5mm, 2 mm Actuator Height
* 4x4mm neodymium cube magnet
': *These parts can be bought from any major electronics supplier, like Digikey or Mouser*

1
docs/_sources/index.rst.txt
View File

@ -16,7 +16,6 @@ Contents
:caption: 🛠️ Build Your Own
build_your_own/overview
build_your_own/Bill of materials
build_your_own/Fabrication
build_your_own/Soldering
build_your_own/3D Printing

10
docs/_static/css/custom.css vendored
View File

@ -21,7 +21,17 @@ h1, h2 {
.theme-toggle-container{
display: none;
}
.content-icon-container svg{
height: 2rem !important;
width: 2rem !important;
}
.content-icon-container{
border-style: solid;
border-style: dashed;
border-width: 1px;
border-radius: 5px;
}
body{
--color-problematic: #b30000 !important;
--color-foreground-primary: #000 !important;

18
docs/build_your_own/3D Printing.html
View File

@ -3,7 +3,7 @@
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Testing" href="Testing.html" /><link rel="prev" title="Soldering" href="Soldering.html" />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Assembly and Testing" href="Testing.html" /><link rel="prev" title="Soldering" href="Soldering.html" />
<!-- Generated with Sphinx 6.1.3 and Furo 2023.03.27 -->
<title>3D Printing - trinteract v1.2 documentation</title>
@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="Soldering.html">Soldering</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>
@ -223,6 +222,17 @@
<article role="main">
<section id="d-printing">
<h1>3D Printing<a class="headerlink" href="#d-printing" title="Permalink to this heading">#</a></h1>
<a class="reference internal image-reference" href="../_images/cura.png"><img alt="../_images/cura.png" class="align-center" src="../_images/cura.png" style="width: 80%;" /></a>
<p>The latest CAD files can downloaded from <a class="reference external" href="https://github.com/gocivici/trinteract/archive/refs/heads/master.zip">this link.</a> The CAD files can be edited in Fusion360. You can also use the .stl files directly for the 3D printing.</p>
<p>The 3D prints were done on a fdm printer with a eSun PLA+ filament. The following settings were used for the print:</p>
<ul class="simple">
<li><p>Layer Height: 0.25mm</p></li>
<li><p>Wall thickness: 1.2mm</p></li>
<li><p>infill: 50%</p></li>
<li><p>Generate support, Overhang Angle:60</p></li>
</ul>
<a class="reference internal image-reference" href="../_images/3D.jpg"><img alt="../_images/3D.jpg" src="../_images/3D.jpg" style="width: 45%;" /></a>
<a class="reference internal image-reference" href="../_images/3D2.jpg"><img alt="../_images/3D2.jpg" src="../_images/3D2.jpg" style="width: 45%;" /></a>
</section>
</article>
@ -235,7 +245,7 @@
<div class="context">
<span>Next</span>
</div>
<div class="title">Testing</div>
<div class="title">Assembly and Testing</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>

41
docs/build_your_own/Fabrication.html
View File

@ -3,7 +3,7 @@
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Soldering" href="Soldering.html" /><link rel="prev" title="Bill of materials(BOM)" href="Bill%20of%20materials.html" />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Soldering" href="Soldering.html" /><link rel="prev" title="Overview" href="overview.html" />
<!-- Generated with Sphinx 6.1.3 and Furo 2023.03.27 -->
<title>PCB Fabrication - trinteract v1.2 documentation</title>
@ -136,7 +136,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>
@ -215,7 +214,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
@ -223,6 +222,13 @@
<article role="main">
<section id="pcb-fabrication">
<h1>PCB Fabrication<a class="headerlink" href="#pcb-fabrication" title="Permalink to this heading">#</a></h1>
<section id="schematic-and-pcb">
<h2>Schematic and PCB<a class="headerlink" href="#schematic-and-pcb" title="Permalink to this heading">#</a></h2>
<img alt="../_images/pcb.png" src="../_images/pcb.png" />
<p>The latest PCB files can downloaded from <a class="reference external" href="https://github.com/gocivici/trinteract/archive/refs/heads/master.zip">this link</a></p>
<p>There are two subfolders under the PCB folder. One contains the KiCAD files that can be edited and customized. The other folder titled “Gerbers” contains the manufacture ready files
that can be directly sent to a PCB manufacturer like JLCPCB.</p>
</section>
</section>
</article>
@ -239,14 +245,14 @@
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="Bill%20of%20materials.html">
<a class="prev-page" href="overview.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Bill of materials(BOM)</div>
<div class="title">Overview</div>
</div>
</a>
@ -268,9 +274,28 @@
</footer>
</div>
<aside class="toc-drawer no-toc">
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">PCB Fabrication</a><ul>
<li><a class="reference internal" href="#schematic-and-pcb">Schematic and PCB</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>

45
docs/build_your_own/Soldering.html
View File

@ -136,7 +136,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>
@ -215,7 +214,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
@ -223,6 +222,22 @@
<article role="main">
<section id="soldering">
<h1>Soldering<a class="headerlink" href="#soldering" title="Permalink to this heading">#</a></h1>
<section id="smd-components">
<h2>SMD Components<a class="headerlink" href="#smd-components" title="Permalink to this heading">#</a></h2>
<a class="reference internal image-reference" href="../_images/solder.jpg"><img alt="../_images/solder.jpg" src="../_images/solder.jpg" style="width: 45%;" /></a>
<a class="reference internal image-reference" href="../_images/solder2.jpg"><img alt="../_images/solder2.jpg" src="../_images/solder2.jpg" style="width: 45%;" /></a>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The PCB in these pictures are from the previous version, I’ll update them once I receive the new batch. The only difference in the new version is the button placement. The newer version has the button on the back.</p>
</div>
<p>The components can be soldered on to the PCB by hand, but you could also use solder paste and a reflow oven to make the process easier. I followed this tutorial
for the hand soldering:</p>
<iframe width="560" height="315" src="https://www.youtube.com/embed/4zXP0TtORWo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></section>
<section id="through-hole-components">
<h2>Through-Hole Components<a class="headerlink" href="#through-hole-components" title="Permalink to this heading">#</a></h2>
<p>The only Through-Hole components in this build are te header pins. You can also solder additional expansion pins if you plan to prototype with the board.</p>
<a class="reference internal image-reference" href="../_images/hole.jpg"><img alt="../_images/hole.jpg" class="align-center" src="../_images/hole.jpg" style="width: 60%;" /></a>
</section>
</section>
</article>
@ -268,9 +283,29 @@
</footer>
</div>
<aside class="toc-drawer no-toc">
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Soldering</a><ul>
<li><a class="reference internal" href="#smd-components">SMD Components</a></li>
<li><a class="reference internal" href="#through-hole-components">Through-Hole Components</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>

9
docs/build_your_own/Testing.html
View File

@ -6,7 +6,7 @@
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="About" href="../development/About.html" /><link rel="prev" title="3D Printing" href="3D%20Printing.html" />
<!-- Generated with Sphinx 6.1.3 and Furo 2023.03.27 -->
<title>Testing - trinteract v1.2 documentation</title>
<title>Assembly and Testing - trinteract v1.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=fad236701ea90a88636c2a8c73b44ae642ed2a53" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Testing</a></li>
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>
@ -221,8 +220,8 @@
</label>
</div>
<article role="main">
<section id="testing">
<h1>Testing<a class="headerlink" href="#testing" title="Permalink to this heading">#</a></h1>
<section id="assembly-and-testing">
<h1>Assembly and Testing<a class="headerlink" href="#assembly-and-testing" title="Permalink to this heading">#</a></h1>
</section>
</article>

49
docs/build_your_own/overview.html
View File

@ -3,7 +3,7 @@
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Bill of materials(BOM)" href="Bill%20of%20materials.html" /><link rel="prev" title="Examples" href="../getting_started/Examples.html" />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="PCB Fabrication" href="Fabrication.html" /><link rel="prev" title="Examples" href="../getting_started/Examples.html" />
<!-- Generated with Sphinx 6.1.3 and Furo 2023.03.27 -->
<title>Overview - trinteract v1.2 documentation</title>
@ -136,7 +136,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul class="current">
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>
@ -215,7 +214,7 @@
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
@ -223,6 +222,21 @@
<article role="main">
<section id="overview">
<h1>Overview<a class="headerlink" href="#overview" title="Permalink to this heading">#</a></h1>
<p>Here are the parts that are required to biuld trinteract. You can also prototype it first before fabricating a pcb following the wiring diagram below.</p>
<section id="parts">
<h2>Parts<a class="headerlink" href="#parts" title="Permalink to this heading">#</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="Fabrication.html"><span class="doc">Trinteract pcb</span></a></p></li>
<li><p><a class="reference external" href="https://eu.mouser.com/ProductDetail/Infineon-Technologies/TLV493DA1B6HTSA2?qs=0DP5yvOrqYnbdRXsuslLCg%3D%3D&amp;countryCode=DE&amp;currencyCode=EUR">Infenion TLV493DA Low Power 3D Magnetic Sensor</a></p></li>
<li><p>‘2 x 2.2k Ω SMD Resistor 0805 - R1 &amp; R3</p></li>
<li><p>‘680 Ω SMD Resistor 0805 - R2</p></li>
<li><p>‘4.7k Ω SMD Resistor 0805 - R4</p></li>
<li><p>‘100n SMD Capacitor 0805 - C1</p></li>
<li><p>‘Tactile Switch 5 X 5mm, 2 mm Actuator Height</p></li>
<li><p>4x4mm neodymium cube magnet</p></li>
</ul>
<p>‘: <em>These parts can be bought from any major electronics supplier, like Digikey or Mouser</em></p>
</section>
</section>
</article>
@ -230,12 +244,12 @@
<footer>
<div class="related-pages">
<a class="next-page" href="Bill%20of%20materials.html">
<a class="next-page" href="Fabrication.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Bill of materials(BOM)</div>
<div class="title">PCB Fabrication</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
@ -268,9 +282,28 @@
</footer>
</div>
<aside class="toc-drawer no-toc">
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Overview</a><ul>
<li><a class="reference internal" href="#parts">Parts</a></li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>

7
docs/development/About.html
View File

@ -3,7 +3,7 @@
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Contributing" href="Contributing.html" /><link rel="prev" title="Testing" href="../build_your_own/Testing.html" />
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Contributing" href="Contributing.html" /><link rel="prev" title="Assembly and Testing" href="../build_your_own/Testing.html" />
<!-- Generated with Sphinx 6.1.3 and Furo 2023.03.27 -->
<title>About - trinteract v1.2 documentation</title>
@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul class="current">
@ -247,7 +246,7 @@
<span>Previous</span>
</div>
<div class="title">Testing</div>
<div class="title">Assembly and Testing</div>
</div>
</a>

3
docs/development/Changelog.html
View File

@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul class="current">

3
docs/development/Contributing.html
View File

@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul class="current">

3
docs/genindex.html
View File

@ -166,11 +166,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>

3
docs/getting_started/Configuration.html
View File

@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>

3
docs/getting_started/Examples.html
View File

@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>

3
docs/getting_started/Installation.html
View File

@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>

3
docs/getting_started/Quick Start.html
View File

@ -168,11 +168,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../build_your_own/Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>

BIN
docs/objects.inv
View File

Binary file not shown.

3
docs/search.html
View File

@ -165,11 +165,10 @@
<p class="caption" role="heading"><span class="caption-text">🛠️ Build Your Own</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Bill%20of%20materials.html">Bill of materials(BOM)</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Fabrication.html">PCB Fabrication</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Soldering.html">Soldering</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/3D%20Printing.html">3D Printing</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Testing.html">Testing</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_your_own/Testing.html">Assembly and Testing</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">📖 Development</span></p>
<ul>

2
docs/searchindex.js
View File

File diff suppressed because one or more lines are too long

BIN
docs/source/build_your_own/20230404_153134.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 408 KiB

BIN
docs/source/build_your_own/20230404_153202.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 425 KiB

BIN
docs/source/build_your_own/20230416_154522.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 1.6 MiB

23
docs/source/build_your_own/3D Printing.rst
View File

@ -1,2 +1,23 @@
3D Printing
===========
===========
.. image:: cura.png
:width: 80%
:align: center
The latest CAD files can downloaded from `this link. <https://github.com/gocivici/trinteract/archive/refs/heads/master.zip>`_ The CAD files can be edited in Fusion360. You can also use the .stl files directly for the 3D printing.
The 3D prints were done on a fdm printer with a eSun PLA+ filament. The following settings were used for the print:
* Layer Height: 0.25mm
* Wall thickness: 1.2mm
* infill: 50%
* Generate support, Overhang Angle:60
.. image:: 3D.jpg
:width: 45%
.. image:: 3D2.jpg
:width: 45%

BIN
docs/source/build_your_own/3D.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 635 KiB

BIN
docs/source/build_your_own/3D2.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 479 KiB

2
docs/source/build_your_own/Bill of materials.rst
View File

@ -1,2 +0,0 @@
Bill of materials(BOM)
======================

12
docs/source/build_your_own/Fabrication.rst
View File

@ -1,2 +1,12 @@
PCB Fabrication
===============
===============
Schematic and PCB
-----------------
.. image:: pcb.png
The latest PCB files can downloaded from `this link <https://github.com/gocivici/trinteract/archive/refs/heads/master.zip>`_
There are two subfolders under the PCB folder. One contains the KiCAD files that can be edited and customized. The other folder titled "Gerbers" contains the manufacture ready files
that can be directly sent to a PCB manufacturer like JLCPCB.

32
docs/source/build_your_own/Soldering.rst
View File

@ -1,2 +1,32 @@
Soldering
=========
=========
SMD Components
--------------
.. image:: solder.jpg
:width: 45%
.. image:: solder2.jpg
:width: 45%
.. note::
The PCB in these pictures are from the previous version, I'll update them once I receive the new batch. The only difference in the new version is the button placement. The newer version has the button on the back.
The components can be soldered on to the PCB by hand, but you could also use solder paste and a reflow oven to make the process easier. I followed this tutorial
for the hand soldering:
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/embed/4zXP0TtORWo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
Through-Hole Components
-----------------------
The only Through-Hole components in this build are te header pins. You can also solder additional expansion pins if you plan to prototype with the board.
.. image:: hole.jpg
:width: 60%
:align: center

4
docs/source/build_your_own/Testing.rst
View File

@ -1,2 +1,2 @@
Testing
=======
Assembly and Testing
====================

BIN
docs/source/build_your_own/cura.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 599 KiB

BIN
docs/source/build_your_own/hole.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 363 KiB

22
docs/source/build_your_own/overview.rst
View File

@ -1,2 +1,22 @@
Overview
========
========
Here are the parts that are required to biuld trinteract. You can also prototype it first before fabricating a pcb following the wiring diagram below.
Parts
-----
* :doc:`Trinteract pcb </build_your_own/Fabrication>`
* `Infenion TLV493DA Low Power 3D Magnetic Sensor <https://eu.mouser.com/ProductDetail/Infineon-Technologies/TLV493DA1B6HTSA2?qs=0DP5yvOrqYnbdRXsuslLCg%3D%3D&countryCode=DE&currencyCode=EUR>`_
* '2 x 2.2k Ω SMD Resistor 0805 - R1 & R3
* '680 Ω SMD Resistor 0805 - R2
* '4.7k Ω SMD Resistor 0805 - R4
* '100n SMD Capacitor 0805 - C1
* 'Tactile Switch 5 X 5mm, 2 mm Actuator Height
* 4x4mm neodymium cube magnet
': *These parts can be bought from any major electronics supplier, like Digikey or Mouser*

BIN
docs/source/build_your_own/pcb.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 154 KiB

BIN
docs/source/build_your_own/schema.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 104 KiB

BIN
docs/source/build_your_own/solder.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 871 KiB

BIN
docs/source/build_your_own/solder2.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 903 KiB

1
docs/source/index.rst
View File

@ -16,7 +16,6 @@ Contents
:caption: 🛠️ Build Your Own
build_your_own/overview
build_your_own/Bill of materials
build_your_own/Fabrication
build_your_own/Soldering
build_your_own/3D Printing