2023-05-08 11:02:13 -05:00
<!DOCTYPE html>
2023-05-09 08:39:06 -05:00
< html lang = "en" data-theme = "light" >
2023-05-08 11:02:13 -05:00
< head >
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / > < meta name = "generator" content = "Docutils 0.19: https://docutils.sourceforge.io/" / >
< title > Quick Start — zxyKit 0.1 documentation< / title >
< script data-cfasync = "false" >
2023-05-09 08:39:06 -05:00
document.documentElement.dataset.mode = localStorage.getItem("mode") || "light";
2023-05-08 11:02:13 -05:00
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
< / script >
<!-- Loaded before other Sphinx assets -->
< link href = "../_static/styles/theme.css?digest=e353d410970836974a52" rel = "stylesheet" / >
< link href = "../_static/styles/bootstrap.css?digest=e353d410970836974a52" rel = "stylesheet" / >
< link href = "../_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel = "stylesheet" / >
< link href = "../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel = "stylesheet" / >
< link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" / >
< link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" / >
< link rel = "preload" as = "font" type = "font/woff2" crossorigin href = "../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/pygments.css" / >
< link rel = "stylesheet" href = "../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type = "text/css" / >
2023-04-29 04:24:18 -05:00
< link rel = "stylesheet" type = "text/css" href = "../_static/copybutton.css" / >
< link rel = "stylesheet" type = "text/css" href = "../_static/css/custom.css" / >
2023-05-08 11:02:13 -05:00
<!-- Pre - loaded scripts that we'll load fully later -->
< link rel = "preload" as = "script" href = "../_static/scripts/bootstrap.js?digest=e353d410970836974a52" / >
< link rel = "preload" as = "script" href = "../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" / >
< script data-url_root = "../" id = "documentation_options" src = "../_static/documentation_options.js" > < / script >
< script src = "../_static/doctools.js" > < / script >
< script src = "../_static/sphinx_highlight.js" > < / script >
< script src = "../_static/clipboard.min.js" > < / script >
< script src = "../_static/copybutton.js" > < / script >
< script src = "../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824" > < / script >
< script > DOCUMENTATION _OPTIONS . pagename = 'getting_started/Quick Start' ; < / script >
< link rel = "index" title = "Index" href = "../genindex.html" / >
< link rel = "search" title = "Search" href = "../search.html" / >
< link rel = "next" title = "Interactive Tutorial" href = "Installation.html" / >
< link rel = "prev" title = "Welcome to zxyKit’ href = "../index.html" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
< meta name = "docsearch:language" content = "en" / >
< / head >
2023-05-09 08:39:06 -05:00
< body data-bs-spy = "scroll" data-bs-target = ".bd-toc-nav" data-offset = "180" data-bs-root-margin = "0px 0px -60%" data-default-mode = "light" >
2023-04-29 04:24:18 -05:00
2023-05-08 11:02:13 -05:00
< a class = "skip-link" href = "#main-content" > Skip to main content< / a >
< input type = "checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
< label class = "overlay overlay-primary" for = "__primary" > < / label >
< input type = "checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
< label class = "overlay overlay-secondary" for = "__secondary" > < / label >
< div class = "search-button__wrapper" >
< div class = "search-button__overlay" > < / div >
< div class = "search-button__search-container" >
< form class = "bd-search d-flex align-items-center"
action="../search.html"
method="get">
< i class = "fa-solid fa-magnifying-glass" > < / i >
< input type = "search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
< span class = "search-button__kbd-shortcut" > < kbd class = "kbd-shortcut__modifier" > Ctrl< / kbd > +< kbd > K< / kbd > < / span >
< / form > < / div >
< / div >
< nav class = "bd-header navbar navbar-expand-lg bd-navbar" >
< / nav >
< div class = "bd-container" >
< div class = "bd-container__inner bd-page-width" >
< div class = "bd-sidebar-primary bd-sidebar" >
2023-04-29 04:24:18 -05:00
2023-05-08 11:02:13 -05:00
< div class = "sidebar-header-items sidebar-primary__section" >
2023-04-29 04:24:18 -05:00
2023-05-08 11:02:13 -05:00
< / div >
< div class = "sidebar-primary-items__start sidebar-primary__section" >
< div class = "sidebar-primary-item" >
2023-04-29 04:24:18 -05:00
2023-05-08 11:02:13 -05:00
< a class = "navbar-brand logo" href = "../index.html" >
2023-04-29 04:24:18 -05:00
2023-05-08 11:02:13 -05:00
< img src = "../_static/logo.png" class = "logo__image only-light" alt = "Logo image" / >
< script > document . write ( ` <img src="../_static/logo.png" class="logo__image only-dark" alt="Logo image"/> ` ) ; < / script >
< / a > < / div >
< div class = "sidebar-primary-item" > < nav class = "bd-links" id = "bd-docs-nav" aria-label = "Main" >
< div class = "bd-toc-item navbar-nav active" >
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > ✨ Getting Started< / span > < / p >
< ul class = "current nav bd-sidenav" >
< li class = "toctree-l1 current active" > < a class = "current reference internal" href = "#" > Quick Start< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Installation.html" > Interactive Tutorial< / a > < / li >
2023-04-29 04:24:18 -05:00
< li class = "toctree-l1" > < a class = "reference internal" href = "Configuration.html" > Configuration< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "Examples.html" > Examples< / a > < / li >
< / ul >
2023-05-08 11:02:13 -05:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > 🎨 Customization< / span > < / p >
< ul class = "nav bd-sidenav" >
2023-04-29 04:24:18 -05:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../customization/Pinout.html" > Pinout< / a > < / li >
< / ul >
2023-05-08 11:02:13 -05:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > 🛠️ Build Your Own< / span > < / p >
< ul class = "nav bd-sidenav" >
2023-04-29 04:24:18 -05:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../build_your_own/overview.html" > Overview< / a > < / li >
2023-05-08 11:02:13 -05:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../build_your_own/3D%20Printing.html" > 3D Printing< / a > < / li >
2023-04-29 04:24:18 -05:00
< / ul >
2023-05-08 11:02:13 -05:00
< p aria-level = "2" class = "caption" role = "heading" > < span class = "caption-text" > 📖 Development< / span > < / p >
< ul class = "nav bd-sidenav" >
2023-04-29 04:24:18 -05:00
< li class = "toctree-l1" > < a class = "reference internal" href = "../development/About.html" > About< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../development/Contributing.html" > Contributing< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "../development/Changelog.html" > hangelog< / a > < / li >
< / ul >
2023-05-08 11:02:13 -05:00
< / div >
< / nav > < / div >
< / div >
< div class = "sidebar-primary-items__end sidebar-primary__section" >
< / div >
< div id = "rtd-footer-container" > < / div >
2023-04-29 04:24:18 -05:00
< / div >
2023-05-08 11:02:13 -05:00
< main id = "main-content" class = "bd-main" >
< div class = "sbt-scroll-pixel-helper" > < / div >
< div class = "bd-content" >
< div class = "bd-article-container" >
< div class = "bd-header-article" >
< div class = "header-article-items header-article__inner" >
< div class = "header-article-items__start" >
< div class = "header-article-item" > < label class = "sidebar-toggle primary-toggle btn btn-sm" for = "__primary" title = "Toggle primary sidebar" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< span class = "fa-solid fa-bars" > < / span >
< / label > < / div >
2023-04-29 04:24:18 -05:00
< / div >
2023-05-08 11:02:13 -05:00
< div class = "header-article-items__end" >
< div class = "header-article-item" >
< div class = "article-header-buttons" >
2023-05-09 08:39:06 -05:00
< div class = "dropdown dropdown-source-buttons" >
< button class = "btn dropdown-toggle" type = "button" data-bs-toggle = "dropdown" aria-expanded = "false" aria-label = "Source repositories" >
< i class = "fab fa-github" > < / i >
< / button >
< ul class = "dropdown-menu" >
< li > < a href = "https://github.com/gocivici/trinteract" target = "_blank"
class="btn btn-sm btn-source-repository-button dropdown-item"
title="Source repository"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fab fa-github" > < / i >
< / span >
< span class = "btn__text-container" > Repository< / span >
< / a >
< / li >
< li > < a href = "https://github.com/gocivici/trinteract/edit/master/docs/source/getting_started/Quick Start.rst" target = "_blank"
class="btn btn-sm btn-source-edit-button dropdown-item"
title="Suggest edit"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-pencil-alt" > < / i >
< / span >
< span class = "btn__text-container" > Suggest edit< / span >
< / a >
< / li >
< li > < a href = "https://github.com/gocivici/trinteract/issues/new?title=Issue%20on%20page%20%2Fgetting_started/Quick Start.html&body=Your%20issue%20content%20here." target = "_blank"
class="btn btn-sm btn-source-issues-button dropdown-item"
title="Open an issue"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-lightbulb" > < / i >
< / span >
< span class = "btn__text-container" > Open issue< / span >
< / a >
< / li >
< / ul >
< / div >
2023-05-08 11:02:13 -05:00
< div class = "dropdown dropdown-download-buttons" >
< button class = "btn dropdown-toggle" type = "button" data-bs-toggle = "dropdown" aria-expanded = "false" aria-label = "Download this page" >
< i class = "fas fa-download" > < / i >
< / button >
< ul class = "dropdown-menu" >
< li > < a href = "../_sources/getting_started/Quick Start.rst" target = "_blank"
class="btn btn-sm btn-download-source-button dropdown-item"
title="Download source file"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-file" > < / i >
< / span >
< span class = "btn__text-container" > .rst< / span >
< / a >
< / li >
< li >
< button onclick = "window.print()"
class="btn btn-sm btn-download-pdf-button dropdown-item"
title="Print to PDF"
data-bs-placement="left" data-bs-toggle="tooltip"
>
< span class = "btn__icon-container" >
< i class = "fas fa-file-pdf" > < / i >
< / span >
< span class = "btn__text-container" > .pdf< / span >
< / button >
< / li >
< / ul >
< / div >
< script >
document.write(`
< button class = "theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title = "light/dark" aria-label = "light/dark" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< span class = "theme-switch" data-mode = "light" > < i class = "fa-solid fa-sun" > < / i > < / span >
< span class = "theme-switch" data-mode = "dark" > < i class = "fa-solid fa-moon" > < / i > < / span >
< span class = "theme-switch" data-mode = "auto" > < i class = "fa-solid fa-circle-half-stroke" > < / i > < / span >
< / button >
`);
< / script >
< script >
document.write(`
< button class = "btn btn-sm navbar-btn search-button search-button__button" title = "Search" aria-label = "Search" data-bs-placement = "bottom" data-bs-toggle = "tooltip" >
< i class = "fa-solid fa-magnifying-glass" > < / i >
< / button >
`);
< / script >
< / div > < / div >
< / div >
< / div >
< / div >
< div id = "jb-print-docs-body" class = "onlyprint" >
< h1 > Quick Start< / h1 >
<!-- Table of contents -->
< div id = "print-main-content" >
< div id = "jb-print-toc" >
2023-04-29 04:24:18 -05:00
< / div >
2023-05-08 11:02:13 -05:00
< / div >
2023-04-29 04:24:18 -05:00
< / div >
2023-05-08 11:02:13 -05:00
< div id = "searchbox" > < / div >
< article class = "bd-article" role = "main" >
< section id = "quick-start" >
< h1 > Quick Start< a class = "headerlink" href = "#quick-start" title = "Permalink to this heading" > #< / a > < / h1 >
< p > To get started with < strong > trinteract< / strong > , connect an < strong > 3.3v< / strong > arduino pro micro to the board as shown in the picture along with the 3D printed top. If you’ < a class = "reference internal" href = "../build_your_own/overview.html" > < span class = "doc" > 🛠️ Build Your Own< / span > < / a > section.< / p >
2023-04-29 04:24:18 -05:00
< div class = "attention admonition" >
< p class = "admonition-title" > Important< / p >
2023-05-08 11:02:13 -05:00
< p > trinteract is only compatible with 3.3 volts, any higher voltage could fry the sensor< / p >
< / div >
< img alt = "../_images/Figure1.png" class = "align-center" src = "../_images/Figure1.png" / >
< p > On Windows, Your computer will recognize trinteract as a game controller. To check if it’
< code class = "docutils literal notranslate" > < span class = "pre" > Control< / span > < span class = "pre" > Panel< / span > < / code > → < code class = "docutils literal notranslate" > < span class = "pre" > Devices< / span > < span class = "pre" > and< / span > < span class = "pre" > Printers< / span > < / code > → < code class = "docutils literal notranslate" > < span class = "pre" > Set< / span > < span class = "pre" > up< / span > < span class = "pre" > USB< / span > < span class = "pre" > game< / span > < span class = "pre" > controllers< / span > < / code > and click < code class = "docutils literal notranslate" > < span class = "pre" > Properties< / span > < / code > < / p >
< a class = "reference internal image-reference" href = "../_images/Figure2.png" > < img alt = "../_images/Figure2.png" src = "../_images/Figure2.png" style = "width: 45%;" / > < / a >
< a class = "reference internal image-reference" href = "../_images/Figure3.gif" > < img alt = "../_images/Figure3.gif" src = "../_images/Figure3.gif" style = "width: 45%;" / > < / a >
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
< p > If trinteract isn’ < / p >
2023-04-29 04:24:18 -05:00
< / div >
< / section >
2023-05-08 11:02:13 -05:00
< / article >
< footer class = "bd-footer-article" >
< div class = "footer-article-items footer-article__inner" >
< div class = "footer-article-item" > <!-- Previous / next buttons -->
< div class = "prev-next-area" >
< a class = "left-prev"
href="../index.html"
title="previous page">
< i class = "fa-solid fa-angle-left" > < / i >
< div class = "prev-next-info" >
< p class = "prev-next-subtitle" > previous< / p >
< p class = "prev-next-title" > Welcome to zxyKit’ < / p >
2023-04-29 04:24:18 -05:00
< / div >
2023-05-08 11:02:13 -05:00
< / a >
< a class = "right-next"
href="Installation.html"
title="next page">
< div class = "prev-next-info" >
< p class = "prev-next-subtitle" > next< / p >
< p class = "prev-next-title" > Interactive Tutorial< / p >
< / div >
< i class = "fa-solid fa-angle-right" > < / i >
< / a >
< / div > < / div >
< / div >
< / footer >
2023-04-29 04:24:18 -05:00
< / div >
2023-05-08 11:02:13 -05:00
2023-04-29 04:24:18 -05:00
< / div >
2023-05-08 11:02:13 -05:00
< footer class = "bd-footer-content" >
< div class = "bd-footer-content__inner container" >
< div class = "footer-item" >
< p class = "component-author" >
By Görkem
< / p >
< / div >
< div class = "footer-item" >
< p class = "copyright" >
© Copyright 2023, Görkem.
< br / >
< / p >
< / div >
< div class = "footer-item" >
< / div >
< div class = "footer-item" >
< / div >
< / div >
< / footer >
2023-04-29 04:24:18 -05:00
2023-05-08 11:02:13 -05:00
< / main >
2023-04-29 04:24:18 -05:00
< / div >
< / div >
2023-05-08 11:02:13 -05:00
<!-- Scripts loaded after <body> so the DOM is not blocked -->
< script src = "../_static/scripts/bootstrap.js?digest=e353d410970836974a52" > < / script >
< script src = "../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" > < / script >
< footer class = "bd-footer" >
< / footer >
< / body >
2023-04-29 04:24:18 -05:00
< / html >
