updated docs
This commit is contained in:
gocivici
parent
b417b26944
commit
667f487f36
@ -4,10 +4,10 @@
|
||||
[](https://opensource.org/licenses/MIT)
|
||||
[](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||
|
||||
This repository contains all the files and documentation for Trinteract, An open-source Arduino-compatible 3DOF Human Interface Device (HID). In other words a joystick that's capable of moving in all 3 Dimensions. [Visit the docs](https://gocivici.github.io/trinteract/) for more detailed information.
|
||||
This repository contains all the files and documentation for Trinteract, An open-source Arduino-compatible 3DOF Human Interface Device (HID). In other words a joystick that's capable of moving in all 3 Dimensions. Trinteract uses a 3D magnetometer and a Neodymium magnet to detect motion in 3D space. [Visit the docs](https://gocivici.github.io/trinteract/) for more detailed information.
|
||||
|
||||
File structure:
|
||||
+ `Software` contains the arduino code and necesserry drivers
|
||||
+ `Software` contains the arduino code and necessary drivers
|
||||
+ `PCB` contains the KiCAD PCB files and gerber files for manufacturing
|
||||
+ `docs` contains the source code for the documentation website build with [Sphinx](https://www.sphinx-doc.org/en/master/index.html)
|
||||
+ `CAD` contains all fusion360 CAD files and print ready .stl files
|
||||
|
||||
Binary file not shown.
Binary file not shown.
@ -11,7 +11,7 @@ Connecting to Arduino
|
||||
.. image:: ardu2.jpg
|
||||
:width: 45%
|
||||
|
||||
After you conect the board to arduino as shown in the picture, download the arduino code from `the repository <https://github.com/gocivici/trinteract>` and upload the code to the
|
||||
After you conect the board to arduino as shown in the picture, download the arduino code from `the repository <https://github.com/gocivici/trinteract>`_ and upload the code to the
|
||||
arduino with the following settings:
|
||||
|
||||
.. image:: ide.png
|
||||
|
||||
@ -226,7 +226,7 @@
|
||||
<h2>Connecting to Arduino<a class="headerlink" href="#connecting-to-arduino" title="Permalink to this heading">#</a></h2>
|
||||
<a class="reference internal image-reference" href="../_images/ardu.jpg"><img alt="../_images/ardu.jpg" src="../_images/ardu.jpg" style="width: 45%;" /></a>
|
||||
<a class="reference internal image-reference" href="../_images/ardu2.jpg"><img alt="../_images/ardu2.jpg" src="../_images/ardu2.jpg" style="width: 45%;" /></a>
|
||||
<p>After you conect the board to arduino as shown in the picture, download the arduino code from <cite>the repository <https://github.com/gocivici/trinteract></cite> and upload the code to the
|
||||
<p>After you conect the board to arduino as shown in the picture, download the arduino code from <a class="reference external" href="https://github.com/gocivici/trinteract">the repository</a> and upload the code to the
|
||||
arduino with the following settings:</p>
|
||||
<a class="reference internal image-reference" href="../_images/ide.png"><img alt="../_images/ide.png" class="align-center" src="../_images/ide.png" style="width: 60%;" /></a>
|
||||
</section>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -11,6 +11,7 @@
|
||||
<title>Hello, world!</title>
|
||||
</head>
|
||||
<body class="justify-content-center">
|
||||
<div class='pattern'></div>
|
||||
<header class="masthead d-flex align-items-center">
|
||||
<div class="container px-4 px-lg-5 text-center">
|
||||
<img src="logo.png" style="width:500px;">
|
||||
@ -30,6 +31,18 @@ body,
|
||||
html {
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
|
||||
}
|
||||
|
||||
.pattern {
|
||||
position: fixed;
|
||||
width: 100vw;
|
||||
height: 100vh;
|
||||
|
||||
background-color: #ffffff;
|
||||
opacity: 0.15;
|
||||
background-image: linear-gradient(#151ef5 1.8px, transparent 1.8px), linear-gradient(to right, #151ef5 1.8px, #ffffff 1.8px);
|
||||
background-size: 36px 36px;
|
||||
}
|
||||
.masthead {
|
||||
min-height: 30rem;
|
||||
@ -39,11 +52,9 @@ html {
|
||||
height: inherit;
|
||||
padding-top: 8rem;
|
||||
padding-bottom: 8rem;
|
||||
background: bllue;
|
||||
background-position: center center;
|
||||
background-repeat: no-repeat;
|
||||
background-size: cover;
|
||||
|
||||
}
|
||||
|
||||
.btn{
|
||||
margin:5px;
|
||||
}
|
||||
|
||||
@ -11,7 +11,7 @@ Connecting to Arduino
|
||||
.. image:: ardu2.jpg
|
||||
:width: 45%
|
||||
|
||||
After you conect the board to arduino as shown in the picture, download the arduino code from `the repository <https://github.com/gocivici/trinteract>` and upload the code to the
|
||||
After you conect the board to arduino as shown in the picture, download the arduino code from `the repository <https://github.com/gocivici/trinteract>`_ and upload the code to the
|
||||
arduino with the following settings:
|
||||
|
||||
.. image:: ide.png
|
||||
|
||||
@ -2,7 +2,7 @@ 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.
|
||||
Here are the parts that are required to build trinteract:
|
||||
|
||||
Parts
|
||||
-----
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
Interactive Tutorial
|
||||
====================
|
||||
This interactive guide will guide you throug the capabilities of the sensor. But first you have to use a plugin to let figma communicate with trinteract.
|
||||
download the zxyKit driver from here, unzip the folder and on Figma goto Plugins → Development → trinteract Driver.
|
||||
download the zxyKit driver from the repository, unzip the folder and on Figma goto Plugins → Development → trinteract Driver.
|
||||
|
||||
.. raw:: html
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user