From 667f487f366495a87772ea7f3219b07d99c55df1 Mon Sep 17 00:00:00 2001 From: gocivici Date: Wed, 17 May 2023 10:17:50 +0300 Subject: [PATCH] updated docs --- README.md | 4 ++-- docs/.doctrees/build_your_own/Testing.doctree | Bin 3939 -> 4146 bytes docs/.doctrees/environment.pickle | Bin 89049 -> 89280 bytes docs/_sources/build_your_own/Testing.rst.txt | 2 +- docs/build_your_own/Testing.html | 2 +- docs/searchindex.js | 2 +- docs/source/_templates/newIndex.html | 19 ++++++++++++++---- docs/source/build_your_own/Testing.rst | 2 +- docs/source/build_your_own/overview.rst | 2 +- docs/source/getting_started/Installation.rst | 2 +- 10 files changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index caedfd3..ef3a355 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ [![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. [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 diff --git a/docs/.doctrees/build_your_own/Testing.doctree b/docs/.doctrees/build_your_own/Testing.doctree index 51a707f7abf2b88ce62e92d5f5d488b9f253f404..1d30531e6f420dcb96902b49e201d50f1e97cc3a 100644 GIT binary patch delta 344 zcmaDXw@HDufpx07z(&@U%#1fDPh^Ro%*SHM7(dya<%l?EQEFOhQEFat>XgY-G#jVX zPSMCkcgj>!5%v$L#&6dBqLR!D77HJII|?bsB-c`RwLyemb}E=)G6q4Q+n8d zCYBauPU%sbEYG5*Jf$>4J0mMYIwPqxDTA|ztt7E1J+%bcGR?`dESiZByW~OkE5<^M z)kRo2B{4%8=oD3`43cAjGU`AXO`r_S=8Rg9opn82aKEKY@n+n7gVlnOartIJ_D@WV zcQ&(dJ!Cf9ma#cwUB>E+&WyIw9!`*lN-7Idi@~9=tutd?XGUj7X@(-mQJXV(fC_ap N+AXgY-G#jVX zPSMCJ1GDF diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle index 1b681a47b5fd5563e9e0443c5f4c594a6299fd85..c99212af036db0f8fc17d6869bf972eb6702f120 100644 GIT binary patch delta 3505 zcmZu!dr(y873W-7K^J6q0eL8}AOeEC7PAXRmw@6o z=X~dT-0xl+)cxuM-N4a2SzJxQod!sjJSlSV`kC<_qto?GS4&&_PFHJpQDtMByIYaZ z?KR82`Du~5=2oX`mm+WNPnVPOXUTufOOuc0rN{@brO0PHlDwn&mm*^NrLeGNmDdt$ zjTOVs%IAx>$cszTHeM`LboU{7cKs@IKKmXIK)w*`+z*5F^)E6Q!7NdH8gqcaQbe7*lk3SeU3M z@sc7M7)N`Ps^8xwJ(T43u|#<29XkDm(KJDs#IL6Xy(YYOFC`R%QHDoJl2PT8Ess8t z-hKAxM)2yV#xm6h)5F4K?wT6WZh|swoejx*7ty;I=Eb*?(RD_f7~NpxWOS2J2cypz?O}9_(LqMH8NJEq z?~INyy2FTT6C;ecDs?M~3ygR-3a-QLiNGmYa73Cg;1wGz#eZZ$mNagV9an5PZzY`o z_ci>3Ibf7VH2nQF5QG1k15d*k7H7k1X|_=d{wfEIIAno1Fk?p^lvF*U^v#Ple|S zHJuIb&ZW`3=*zh}53=Be(45^*7I`=rV8rRUkO6OmM#-8YSVy0x2v*u1T4{&s0m=B) zJX(Ni7p-_Q4Q5JLeEIg%xudo6QfR*OTxGdG>IAh_8VyF7a8418?S5#~h^7cuc^fYm zK|0Zl7C{Zf;ki;+hLpA#40vw-W0M!7DJI9Ntq+dyeCP;&?;qiROZ+3WVPQHXz$(tP zSsUAOl{h-MOqQ6?UI?j^*9iy?*bUo5t8#``<4Pl`ARfRl*z+{)ESfrc zHsaR{;gn>E!z)FQ<{xE@9n94CLOZziQE~o#xdF%QG}o~K#d=m$MHoo&-Omc;LpLI^ zr2?i!jGF=qx&8Vy=>gYb!|@6_-Fyq!oB^p)UmR9sKrs$J0}J4F{IrUWIX+0>H5{vk zGM}&P9!-wYPKJSCKn~_tK{lM=C|k66Cs5RT8qdWlFw#*<)>TB8znBWY81OluMokqT zk%qSao#6JTGs=dk)sUbYAzPPR*;s(bmOu`7cB+1z&fkmM_;xj{gPW5J#pjkloNikD zq_|2cG9HgqgEdBkkzN}`gr<@YZq-Ym;b`%7fchp5EQKl<<_tE>Tc$RRR*MZ&G9gJ< zrSgy23-InTSRhrz%k9rtv3@zt^FqdzQaL|t_|N6Rb~mqpL}BI~hePbK8S_^`vVKpXUJnP9>0b#bdQ}GbKcAYU{qc`2oa0fD9;uDet8opi zhRjJ^1EE|eG{sK?m+Bq$F?rLx^*=UmR_&8{k8E8?pUeWZ zu7w%21}1b! zsu5dBRU;a3$_AKkcBn6ns$8g=pC{ZaoFwV`wGFpyfY(g?$*x!2ZjU6o)cau*KHNYj zOcT!B2o4*Yd)>lIk5%+lm)du0PQ*c%URitit>K+r-98TQM#v$Kzifn5IF4UzgaUXM zb2fp^aDrmQ`z%hf7{Jy|kiGXOgmcB?Hc#}LHmAGAWnQ8F2z1j0HpD}mqOb$Xex>n% z;+fLra&$i5q=+-5Y_f^}OR4{c>SSK)*zQt-jQU_fXEALvtS>&!#j$9z?N`Jv_-)Yt z#tD2`$o5-)`w)+8hSl&8?{B6NPoTaIHqdRxQ3s_){!O4?4fV#<=ZP$>#-Tb$#M5=u zlvo_8qpw6i#%zI^ruEO?Kwz!$|b54GX#RQ8l tS^SyBCoJx;xX0oui*Xh=SPZdvK%%eF6X|T(*4*OiQUv^Quzw3!;D6-z-k1OY delta 3353 zcmZu!eNa@_72oq%ScC<3mqkEe`4B;&GRuc79|lq9i_+_jpoxck|nN7z5)0_zwBVx{utd3j;X3T< zcP$l*IrC-I>meHl8)32f&rvGX__H%*ti(1!UY{x)Pfl=3J|hDJV{-3w2Py7KLyfoRtJgUa#KFwS=eiUB5X>B_~&xy zU7Y4KSIW_Cj;c7C;i!qDI~=uh^chDz9Np#U5J#VLG{Dh6IXc17J&s=I=wBRhrPBHn zFL1<{tjKjZoNAm+hcm)m9ed}OW;~M*3-RM6kS@&VSld+##+O38@Tr8^H@Eb{P1$`V z1FGOQrj~#O>oOrmFzS{3-(*5M=y5s+inQPIa?)Ce)MIi1Smdlie6au)3Hkn6`V%W4 zl^V!1!<}}F;MP#Go&?+Je4LH3FEItb?UkdT4{EVwy zA&9rJVIzGJ$5S9xVBWF|agBv~JQ!H_#lX79{7COAq*X*ZR74%W=tKH_5t05Oko0UI z>Dzv!pZoN41Kh*z64(P&sRSBehWE}i-cSk)Aq1lNT4awWR^wlvf_VI3C7ca#UZwdS zDuZNCxBpWHDZ=__zIis|?s7=dJ~Vhf*|pJZ_>M)ZB35}FuHp`>0MWRe7JGPOglAv| zw^cwTOyO_^?DJ4>v_cXb#@$xfrGAz;*!0&qv>k__u9Cj#gVBCl%c)AzG|Yor(69yKbQ0K%ywiSr3%*(diSRR?VZ-PR z5U1@idgiiU$}Nl#f8uo=km;nuWS`M*Pl>OECGZ9(I^e@G{3OSa>@tY2dTI9&;uAGp z4SD$UI*8WT6i;r1Pvj;!d4c#BDS!@W_ijs{Zi_H!#MydS3!^wv4RIJ&58=Xu5qlfJ zqMi1hW!I%Pc+axS^{`m@)|*+-042i1Cz9r65B4_Fqu#xs8%ex0e9b*P z)(FqQ==hSS;SC|ZI)?gsmLJ_UgqUlYa?`34HULt4QKTC8e?e2Bn9tq>1Uc%l_b=pet^3TcVF)q~E^wmlsV z>CXVA#?Z9Up9NZ;QJW#5Lypkw?6AAJ9enUQuY8%CE8JY;=HJ}hq<2mb?mG1LG6 diff --git a/docs/_sources/build_your_own/Testing.rst.txt b/docs/_sources/build_your_own/Testing.rst.txt index 3e14725..7ede72e 100644 --- a/docs/_sources/build_your_own/Testing.rst.txt +++ b/docs/_sources/build_your_own/Testing.rst.txt @@ -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 ` 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 `_ and upload the code to the arduino with the following settings: .. image:: ide.png diff --git a/docs/build_your_own/Testing.html b/docs/build_your_own/Testing.html index 40a68bc..e9b78af 100644 --- a/docs/build_your_own/Testing.html +++ b/docs/build_your_own/Testing.html @@ -226,7 +226,7 @@

Connecting to Arduino#

../_images/ardu.jpg ../_images/ardu2.jpg -

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 and upload the code to the arduino with the following settings:

../_images/ide.png diff --git a/docs/searchindex.js b/docs/searchindex.js index 5b7e793..ccd1d31 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["build_your_own/3D Printing", "build_your_own/Fabrication", "build_your_own/Soldering", "build_your_own/Testing", "build_your_own/overview", "development/About", "development/Changelog", "development/Contributing", "getting_started/Configuration", "getting_started/Examples", "getting_started/Installation", "getting_started/Quick Start", "index"], "filenames": ["build_your_own\\3D Printing.rst", "build_your_own\\Fabrication.rst", "build_your_own\\Soldering.rst", "build_your_own\\Testing.rst", "build_your_own\\overview.rst", "development\\About.rst", "development\\Changelog.rst", "development\\Contributing.rst", "getting_started\\Configuration.rst", "getting_started\\Examples.rst", "getting_started\\Installation.rst", "getting_started\\Quick Start.rst", "index.rst"], "titles": ["3D Printing", "PCB Fabrication", "Soldering", "Assembly and Testing", "Overview", "About", "hangelog", "Contributing", "Configuration", "Examples", "Interactive Tutorial", "Quick Start", "Contents"], "terms": {"testii": 5, "i": [2, 6, 7, 8, 9, 11], "m": [6, 7, 9], "test": [6, 7, 9, 12], "thissss": [6, 7, 9], "To": 11, "get": 11, "trinteract": [3, 4, 8, 10, 11], "connect": [11, 12], "an": 11, "3": 11, "3v": 11, "arduino": [8, 11, 12], "pro": 11, "micro": 11, "board": [2, 3, 11], "shown": [3, 11], "pictur": [2, 3, 11], "along": 11, "3d": [4, 11, 12], "print": [8, 11, 12], "top": 11, "onli": [2, 11], "compat": 11, "volt": 11, "ani": [4, 11], "higher": 11, "voltag": 11, "could": [2, 11], "fry": 11, "sensor": [4, 10, 11], "next": 8, "launch": 8, "interact": 12, "tutori": [2, 12], "figma": 10, "follow": [0, 2, 3, 4, 8], "link": [0, 1, 8], "below": 4, "thi": [0, 1, 2, 10], "project": [], "under": 1, "activ": [], "developmenttttttgggggg": [], "quick": 12, "instal": 12, "configur": 12, "exampl": 12, "pinout": [], "overview": 12, "about": 12, "contribut": 12, "hangelog": 12, "index": 12, "modul": 12, "search": 12, "page": 12, "If": [8, 11], "you": [0, 2, 3, 4, 8, 10, 11], "re": 11, "build": [2, 11], "your": 11, "own": 11, "kit": 11, "head": [8, 11], "over": 11, "section": 11, "On": 11, "window": 11, "comput": 11, "recogn": 11, "game": 11, "control": [8, 11], "check": 11, "": 11, "go": 11, "panel": 11, "hardwar": [], "sound": [], "panelhardwar": [], "sounddevic": [], "printer": [0, 11], "devic": 11, "set": [0, 3, 8, 11], "up": [8, 11], "usb": 11, "click": [8, 11], "properti": 11, "isn": 11, "t": 11, "can": [0, 1, 2, 4, 8, 11], "visit": 11, "troubleshoot": 11, "guid": [10, 11], "here": [4, 10, 11], "joystick": [], "setxaxisrang": [], "64": 8, "setyaxisrang": [], "setzaxisrang": [], "bill": [], "materi": 8, "bom": [], "pcb": [2, 4, 12], "fabric": [4, 12], "solder": 12, "The": [0, 1, 2, 12], "code": [3, 8], "found": 8, "softwar": 8, "folder": [1, 8, 10], "github": [3, 8], "repositori": [3, 8], "download": [0, 1, 3, 8, 10], "latest": [0, 1, 8], "version": [2, 8], "gocivici": [3, 8], "throug": 10, "capabl": 10, "But": 10, "first": [4, 8, 10], "have": [8, 10], "us": [0, 2, 8, 10], "plugin": 10, "let": 10, "commun": 10, "zxykit": 10, "driver": 10, "from": [0, 1, 2, 3, 4, 10], "unzip": 10, "goto": 10, "develop": 10, "raw": [], "html": [], "ifram": [], "style": [], "border": [], "1px": [], "solid": [], "rgba": [], "0": 0, "1": 0, "width": [], "800": [], "height": [0, 4], "450": [], "src": [], "http": [3, 8], "www": [], "com": [3, 8], "emb": [], "embed_host": [], "share": [], "url": [], "3a": [], "2f": [], "2fwww": [], "2ffile": [], "2fufxi3bclrxhgj0qwtabtzl": [], "2ftutori": [], "3ftype": [], "3dwhiteboard": [], "26node": [], "id": [], "3d2": [], "253a265": [], "26t": [], "3droktvzkpylv7qnq": [], "allowfullscreen": [], "calibr": 8, "howev": 8, "also": [0, 2, 4, 8], "implement": 8, "boot": 8, "so": 8, "someth": 8, "els": 8, "decid": 8, "do": 8, "comment": 8, "line": 8, "want": 8, "digitalread": 8, "calbutton": 8, "calibrationst": 8, "true": 8, "These": 4, "valu": 8, "determin": 8, "rang": 8, "side": [], "button": [2, 12], "come": 8, "base": 8, "4x4mm": [4, 8], "neodymium": [4, 8], "like": [1, 4, 8], "textil": 8, "etc": 8, "field": 8, "uncom": 8, "open": 8, "serial": 8, "port": 8, "upload": [3, 8], "monitor": 8, "see": 8, "new": [2, 8], "now": 8, "move": 8, "maximum": 8, "minimum": 8, "end": 8, "add": [], "int": 8, "y": 8, "map": 8, "calx": 8, "tlv493dmagnetic3dsensor": 8, "getx": 8, "ymax": 8, "ymin": 8, "x": [4, 8], "cali": 8, "geti": 8, "xmax": 8, "xmin": 8, "z": 8, "calz": 8, "getz": 8, "zmin": 8, "zmax": 8, "differ": [2, 12], "magnet": [4, 12], "debug": 8, "begin": 8, "9600": 8, "println": 8, "archiv": 8, "ref": 8, "master": 8, "zip": 8, "replac": 8, "doc": [], "build_your_own": [], "infenion": 4, "tlv493da": 4, "low": 4, "power": 4, "eu": [], "mouser": 4, "productdetail": [], "infineon": [], "technologi": [], "tlv493da1b6htsa2": [], "q": [], "0dp5yvorqynbdrxsusllcg": [], "countrycod": [], "de": [], "currencycod": [], "eur": [], "2": 4, "2k": 4, "\u03c9": 4, "smd": [4, 12], "resistor": 4, "0805": 4, "r1": 4, "r3": 4, "680": 4, "r2": 4, "4": 4, "7k": 4, "r4": 4, "100n": 4, "capacitor": 4, "c1": 4, "tactil": 4, "switch": 4, "5": 4, "5mm": 4, "mm": 4, "actuat": 4, "bought": 4, "major": 4, "electron": 4, "supplier": 4, "part": 12, "ar": [1, 2, 4], "requir": 4, "biuld": 4, "prototyp": [2, 4], "befor": 4, "wire": 4, "diagram": 4, "digikei": 4, "imag": [], "figure2": [], "png": [], "schemat": 12, "file": [0, 1], "There": 1, "two": 1, "subfold": 1, "One": 1, "contain": 1, "kicad": 1, "edit": [0, 1], "custom": 1, "other": 1, "titl": 1, "gerber": 1, "manufactur": 1, "readi": 1, "directli": [0, 1], "sent": 1, "jlcpcb": 1, "compon": 12, "hand": 2, "place": [], "reflow": 2, "oven": 2, "make": 2, "process": 2, "easier": 2, "past": 2, "previou": 2, "ll": 2, "updat": 2, "them": 2, "when": [], "receiv": 2, "th": [], "batch": 2, "placement": 2, "onc": 2, "newer": 2, "ha": 2, "back": 2, "cube": 4, "were": 0, "done": 0, "fdm": 0, "esun": 0, "pla": 0, "filament": 0, "layer": 0, "25mm": 0, "wall": 0, "thick": 0, "2mm": 0, "infil": 0, "50": 0, "gener": 0, "support": 0, "overhang": 0, "angl": 0, "60": 0, "cad": 0, "fusion360": 0, "stl": 0, "assembli": 12, "te": 2, "header": 2, "pin": 2, "addit": 2, "expans": 2, "plan": 2, "through": 12, "hole": 12, "after": 3, "conect": 3}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"3d": 0, "print": 0, "overview": 4, "pinout": [], "about": 5, "hangelog": 6, "instal": [6, 7, 9], "contribut": 7, "configur": 8, "exampl": 9, "quick": 11, "start": [11, 12], "import": 11, "welcom": [], "zxykit": [], "": [], "document": [], "content": 12, "get": 12, "custom": [], "build": 12, "your": 12, "own": 12, "develop": 12, "indic": 12, "tabl": 12, "interact": 10, "tutori": 10, "bill": [], "materi": [], "bom": [], "pcb": 1, "fabric": 1, "solder": 2, "test": 3, "The": 8, "button": 8, "differ": 8, "magnet": 8, "part": 4, "schemat": 1, "assembli": 3, "smd": 2, "compon": 2, "through": 2, "hole": 2, "connect": 3, "arduino": 3}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"About": [[5, "about"]], "hangelog": [[6, "hangelog"]], "Installation": [[6, "installation"], [7, "installation"], [9, "installation"]], "Contributing": [[7, "contributing"]], "Configuration": [[8, "configuration"]], "Different Magnet": [[8, "different-magnet"]], "The Button": [[8, "the-button"]], "Examples": [[9, "examples"]], "Interactive Tutorial": [[10, "interactive-tutorial"]], "Quick Start": [[11, "quick-start"]], "Important": [[11, null]], "Contents": [[12, "contents"]], "\u2728 Getting Started": [[12, null]], "\ud83d\udee0\ufe0f Build Your Own": [[12, null]], "\ud83d\udcd6 Development": [[12, null]], "Indices and tables": [[12, "indices-and-tables"]], "PCB Fabrication": [[1, "pcb-fabrication"]], "Schematic and PCB": [[1, "schematic-and-pcb"]], "Overview": [[4, "overview"]], "Parts": [[4, "parts"]], "3D Printing": [[0, "d-printing"]], "Soldering": [[2, "soldering"]], "SMD Components": [[2, "smd-components"]], "Through-Hole Components": [[2, "through-hole-components"]], "Assembly and Testing": [[3, "assembly-and-testing"]], "Connecting to Arduino": [[3, "connecting-to-arduino"]]}, "indexentries": {}}) \ No newline at end of file +Search.setIndex({"docnames": ["build_your_own/3D Printing", "build_your_own/Fabrication", "build_your_own/Soldering", "build_your_own/Testing", "build_your_own/overview", "development/About", "development/Changelog", "development/Contributing", "getting_started/Configuration", "getting_started/Examples", "getting_started/Installation", "getting_started/Quick Start", "index"], "filenames": ["build_your_own\\3D Printing.rst", "build_your_own\\Fabrication.rst", "build_your_own\\Soldering.rst", "build_your_own\\Testing.rst", "build_your_own\\overview.rst", "development\\About.rst", "development\\Changelog.rst", "development\\Contributing.rst", "getting_started\\Configuration.rst", "getting_started\\Examples.rst", "getting_started\\Installation.rst", "getting_started\\Quick Start.rst", "index.rst"], "titles": ["3D Printing", "PCB Fabrication", "Soldering", "Assembly and Testing", "Overview", "About", "hangelog", "Contributing", "Configuration", "Examples", "Interactive Tutorial", "Quick Start", "Contents"], "terms": {"testii": 5, "i": [2, 6, 7, 8, 9, 11], "m": [6, 7, 9], "test": [6, 7, 9, 12], "thissss": [6, 7, 9], "To": 11, "get": 11, "trinteract": [4, 8, 10, 11], "connect": [11, 12], "an": 11, "3": 11, "3v": 11, "arduino": [8, 11, 12], "pro": 11, "micro": 11, "board": [2, 3, 11], "shown": [3, 11], "pictur": [2, 3, 11], "along": 11, "3d": [4, 11, 12], "print": [8, 11, 12], "top": 11, "onli": [2, 11], "compat": 11, "volt": 11, "ani": [4, 11], "higher": 11, "voltag": 11, "could": [2, 11], "fry": 11, "sensor": [4, 10, 11], "next": 8, "launch": 8, "interact": 12, "tutori": [2, 12], "figma": 10, "follow": [0, 2, 3, 4, 8], "link": [0, 1, 8], "below": 4, "thi": [0, 1, 2, 10], "project": [], "under": 1, "activ": [], "developmenttttttgggggg": [], "quick": 12, "instal": 12, "configur": 12, "exampl": 12, "pinout": [], "overview": 12, "about": 12, "contribut": 12, "hangelog": 12, "index": 12, "modul": 12, "search": 12, "page": 12, "If": [8, 11], "you": [0, 2, 3, 4, 8, 10, 11], "re": 11, "build": [2, 11], "your": 11, "own": 11, "kit": 11, "head": [8, 11], "over": 11, "section": 11, "On": 11, "window": 11, "comput": 11, "recogn": 11, "game": 11, "control": [8, 11], "check": 11, "": 11, "go": 11, "panel": 11, "hardwar": [], "sound": [], "panelhardwar": [], "sounddevic": [], "printer": [0, 11], "devic": 11, "set": [0, 3, 8, 11], "up": [8, 11], "usb": 11, "click": [8, 11], "properti": 11, "isn": 11, "t": 11, "can": [0, 1, 2, 4, 8, 11], "visit": 11, "troubleshoot": 11, "guid": [10, 11], "here": [4, 10, 11], "joystick": [], "setxaxisrang": [], "64": 8, "setyaxisrang": [], "setzaxisrang": [], "bill": [], "materi": 8, "bom": [], "pcb": [2, 4, 12], "fabric": [4, 12], "solder": 12, "The": [0, 1, 2, 12], "code": [3, 8], "found": 8, "softwar": 8, "folder": [1, 8, 10], "github": 8, "repositori": [3, 8], "download": [0, 1, 3, 8, 10], "latest": [0, 1, 8], "version": [2, 8], "gocivici": 8, "throug": 10, "capabl": 10, "But": 10, "first": [4, 8, 10], "have": [8, 10], "us": [0, 2, 8, 10], "plugin": 10, "let": 10, "commun": 10, "zxykit": 10, "driver": 10, "from": [0, 1, 2, 3, 4, 10], "unzip": 10, "goto": 10, "develop": 10, "raw": [], "html": [], "ifram": [], "style": [], "border": [], "1px": [], "solid": [], "rgba": [], "0": 0, "1": 0, "width": [], "800": [], "height": [0, 4], "450": [], "src": [], "http": 8, "www": [], "com": 8, "emb": [], "embed_host": [], "share": [], "url": [], "3a": [], "2f": [], "2fwww": [], "2ffile": [], "2fufxi3bclrxhgj0qwtabtzl": [], "2ftutori": [], "3ftype": [], "3dwhiteboard": [], "26node": [], "id": [], "3d2": [], "253a265": [], "26t": [], "3droktvzkpylv7qnq": [], "allowfullscreen": [], "calibr": 8, "howev": 8, "also": [0, 2, 4, 8], "implement": 8, "boot": 8, "so": 8, "someth": 8, "els": 8, "decid": 8, "do": 8, "comment": 8, "line": 8, "want": 8, "digitalread": 8, "calbutton": 8, "calibrationst": 8, "true": 8, "These": 4, "valu": 8, "determin": 8, "rang": 8, "side": [], "button": [2, 12], "come": 8, "base": 8, "4x4mm": [4, 8], "neodymium": [4, 8], "like": [1, 4, 8], "textil": 8, "etc": 8, "field": 8, "uncom": 8, "open": 8, "serial": 8, "port": 8, "upload": [3, 8], "monitor": 8, "see": 8, "new": [2, 8], "now": 8, "move": 8, "maximum": 8, "minimum": 8, "end": 8, "add": [], "int": 8, "y": 8, "map": 8, "calx": 8, "tlv493dmagnetic3dsensor": 8, "getx": 8, "ymax": 8, "ymin": 8, "x": [4, 8], "cali": 8, "geti": 8, "xmax": 8, "xmin": 8, "z": 8, "calz": 8, "getz": 8, "zmin": 8, "zmax": 8, "differ": [2, 12], "magnet": [4, 12], "debug": 8, "begin": 8, "9600": 8, "println": 8, "archiv": 8, "ref": 8, "master": 8, "zip": 8, "replac": 8, "doc": [], "build_your_own": [], "infenion": 4, "tlv493da": 4, "low": 4, "power": 4, "eu": [], "mouser": 4, "productdetail": [], "infineon": [], "technologi": [], "tlv493da1b6htsa2": [], "q": [], "0dp5yvorqynbdrxsusllcg": [], "countrycod": [], "de": [], "currencycod": [], "eur": [], "2": 4, "2k": 4, "\u03c9": 4, "smd": [4, 12], "resistor": 4, "0805": 4, "r1": 4, "r3": 4, "680": 4, "r2": 4, "4": 4, "7k": 4, "r4": 4, "100n": 4, "capacitor": 4, "c1": 4, "tactil": 4, "switch": 4, "5": 4, "5mm": 4, "mm": 4, "actuat": 4, "bought": 4, "major": 4, "electron": 4, "supplier": 4, "part": 12, "ar": [1, 2, 4], "requir": 4, "biuld": 4, "prototyp": [2, 4], "befor": 4, "wire": 4, "diagram": 4, "digikei": 4, "imag": [], "figure2": [], "png": [], "schemat": 12, "file": [0, 1], "There": 1, "two": 1, "subfold": 1, "One": 1, "contain": 1, "kicad": 1, "edit": [0, 1], "custom": 1, "other": 1, "titl": 1, "gerber": 1, "manufactur": 1, "readi": 1, "directli": [0, 1], "sent": 1, "jlcpcb": 1, "compon": 12, "hand": 2, "place": [], "reflow": 2, "oven": 2, "make": 2, "process": 2, "easier": 2, "past": 2, "previou": 2, "ll": 2, "updat": 2, "them": 2, "when": [], "receiv": 2, "th": [], "batch": 2, "placement": 2, "onc": 2, "newer": 2, "ha": 2, "back": 2, "cube": 4, "were": 0, "done": 0, "fdm": 0, "esun": 0, "pla": 0, "filament": 0, "layer": 0, "25mm": 0, "wall": 0, "thick": 0, "2mm": 0, "infil": 0, "50": 0, "gener": 0, "support": 0, "overhang": 0, "angl": 0, "60": 0, "cad": 0, "fusion360": 0, "stl": 0, "assembli": 12, "te": 2, "header": 2, "pin": 2, "addit": 2, "expans": 2, "plan": 2, "through": 12, "hole": 12, "after": 3, "conect": 3}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"3d": 0, "print": 0, "overview": 4, "pinout": [], "about": 5, "hangelog": 6, "instal": [6, 7, 9], "contribut": 7, "configur": 8, "exampl": 9, "quick": 11, "start": [11, 12], "import": 11, "welcom": [], "zxykit": [], "": [], "document": [], "content": 12, "get": 12, "custom": [], "build": 12, "your": 12, "own": 12, "develop": 12, "indic": 12, "tabl": 12, "interact": 10, "tutori": 10, "bill": [], "materi": [], "bom": [], "pcb": 1, "fabric": 1, "solder": 2, "test": 3, "The": 8, "button": 8, "differ": 8, "magnet": 8, "part": 4, "schemat": 1, "assembli": 3, "smd": 2, "compon": 2, "through": 2, "hole": 2, "connect": 3, "arduino": 3}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"About": [[5, "about"]], "hangelog": [[6, "hangelog"]], "Installation": [[6, "installation"], [7, "installation"], [9, "installation"]], "Contributing": [[7, "contributing"]], "Configuration": [[8, "configuration"]], "Different Magnet": [[8, "different-magnet"]], "The Button": [[8, "the-button"]], "Examples": [[9, "examples"]], "Interactive Tutorial": [[10, "interactive-tutorial"]], "Quick Start": [[11, "quick-start"]], "Important": [[11, null]], "Contents": [[12, "contents"]], "\u2728 Getting Started": [[12, null]], "\ud83d\udee0\ufe0f Build Your Own": [[12, null]], "\ud83d\udcd6 Development": [[12, null]], "Indices and tables": [[12, "indices-and-tables"]], "PCB Fabrication": [[1, "pcb-fabrication"]], "Schematic and PCB": [[1, "schematic-and-pcb"]], "Overview": [[4, "overview"]], "Parts": [[4, "parts"]], "3D Printing": [[0, "d-printing"]], "Soldering": [[2, "soldering"]], "SMD Components": [[2, "smd-components"]], "Through-Hole Components": [[2, "through-hole-components"]], "Assembly and Testing": [[3, "assembly-and-testing"]], "Connecting to Arduino": [[3, "connecting-to-arduino"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/docs/source/_templates/newIndex.html b/docs/source/_templates/newIndex.html index 88f5ada..c0da9ec 100644 --- a/docs/source/_templates/newIndex.html +++ b/docs/source/_templates/newIndex.html @@ -11,6 +11,7 @@ Hello, world! +
@@ -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; } diff --git a/docs/source/build_your_own/Testing.rst b/docs/source/build_your_own/Testing.rst index 3e14725..7ede72e 100644 --- a/docs/source/build_your_own/Testing.rst +++ b/docs/source/build_your_own/Testing.rst @@ -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 ` 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 `_ and upload the code to the arduino with the following settings: .. image:: ide.png diff --git a/docs/source/build_your_own/overview.rst b/docs/source/build_your_own/overview.rst index 60c159f..c1af1ce 100644 --- a/docs/source/build_your_own/overview.rst +++ b/docs/source/build_your_own/overview.rst @@ -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 ----- diff --git a/docs/source/getting_started/Installation.rst b/docs/source/getting_started/Installation.rst index a8fb1de..e2c326e 100644 --- a/docs/source/getting_started/Installation.rst +++ b/docs/source/getting_started/Installation.rst @@ -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