trinteract/README.md
2023-05-19 13:03:37 +03:00

26 lines
1.4 KiB
Markdown

# Trinteract
[![License: CERN-OHL-S](https://img.shields.io/badge/Hardware%20License-CERN--OHL--S%20v2-blueviolet)](https://ohwr.org/cern_ohl_s_v2.pdf)
[![License: MIT](https://img.shields.io/badge/Software%20License-MIT-yellow)](https://opensource.org/licenses/MIT)
[![License: CC BY-SA 4.0](https://img.shields.io/badge/Documentation%20License-CC_BY--SA_4.0-lightgrey)](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. 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.
[Watch the Demo here](https://youtu.be/fPkMXDzb_GY)
File structure:
+ `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
![](media/attached.jpg)
![](media/trinteractbase.gif)
Before Assembly | Assembled
:-------------------------:|:-------------------------:
![](media/notassembled.jpg) | ![](media/assembled.jpg)