EyeTrackVR-Docs/development/docs/standards/index.html
RedHawk989 80b3309ebf Merge pull request #3 from lorow/feature/updating-firmware
Fix typos, add recommended antennas, add info about updating the firmware
2023-03-10 13:53:45 +00:00

31 lines
39 KiB
HTML

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Standards Guide | EyeTrackVR Docs</title>
<meta name="description" content="Official documentation for EyeTrackVR. Fully opensource and affordable VR eye tracking platform.">
<link rel="preload stylesheet" href="/assets/style.5bf60f53.css" as="style">
<link rel="modulepreload" href="/assets/chunks/virtual_search-data.f5f281ff.js">
<link rel="modulepreload" href="/assets/app.ffc675f3.js">
<link rel="modulepreload" href="/assets/development_docs_standards.md.4c4a8f40.lean.js">
<script id="check-dark-light">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-5aaf92e7><!--[--><!--]--><!--[--><span tabindex="-1" data-v-8ab7c6af></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-8ab7c6af> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5aaf92e7 data-v-264fabfc><div class="VPNavBar has-sidebar" data-v-264fabfc data-v-26cab421><div class="container" data-v-26cab421><div class="VPNavBarTitle has-sidebar" data-v-26cab421 data-v-092de34b><a class="title" href="/" data-v-092de34b><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/logo.svg" alt="EyeTrackVR Logo" data-v-74766fef><!--]--><!--[--><img class="VPImage light logo" src="/logo_light.png" alt="EyeTrackVR Logo" data-v-74766fef><!--]--><!--]--><!--]--><!--[-->EyeTrackVR Docs<!--]--><!--[--><!--]--></a></div><div class="content" data-v-26cab421><!--[--><!--]--><div class="VPNavBarSearch search" data-v-26cab421><!----><div id="docsearch"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><span class="DocSearch-Button-Key">Meta</span><span class="DocSearch-Button-Key">K</span></span></button></div></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-26cab421 data-v-408d05b6><span id="main-nav-aria-label" class="visually-hidden" data-v-408d05b6>Main Navigation</span><!--[--><!--[--><div class="VPFlyout VPNavBarMenuGroup" data-v-408d05b6 data-v-01da497a><button type="button" class="button" aria-haspopup="true" aria-expanded="false" data-v-01da497a><span class="text" data-v-01da497a><!----> About <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="text-icon" data-v-01da497a><path d="M12,16c-0.3,0-0.5-0.1-0.7-0.3l-6-6c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l5.3,5.3l5.3-5.3c0.4-0.4,1-0.4,1.4,0s0.4,1,0,1.4l-6,6C12.5,15.9,12.3,16,12,16z"></path></svg></span></button><div class="menu" data-v-01da497a><div class="VPMenu" data-v-01da497a data-v-1e25c4ce><div class="items" data-v-1e25c4ce><!--[--><!--[--><div class="VPMenuLink" data-v-1e25c4ce data-v-48adf3ca><a class="VPLink link" href="/about" data-v-48adf3ca data-v-cd683231><!--[-->About Us<!--]--><!----></a></div><!--]--><!--[--><div class="VPMenuLink" data-v-1e25c4ce data-v-48adf3ca><a class="VPLink link" href="/dev_roadmap" data-v-48adf3ca data-v-cd683231><!--[-->Development Road Map<!--]--><!----></a></div><!--]--><!--]--></div><!--[--><!--]--></div></div></div><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/contact" data-v-408d05b6 data-v-45557806 data-v-cd683231><!--[-->Contact<!--]--><!----></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-26cab421 data-v-24251c90><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" aria-label="toggle dark mode" aria-checked="false" data-v-24251c90 data-v-16a7f83e data-v-8be94668><span class="check" data-v-8be94668><span class="icon" data-v-8be94668><!--[--><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="sun" data-v-16a7f83e><path d="M12,18c-3.3,0-6-2.7-6-6s2.7-6,6-6s6,2.7,6,6S15.3,18,12,18zM12,8c-2.2,0-4,1.8-4,4c0,2.2,1.8,4,4,4c2.2,0,4-1.8,4-4C16,9.8,14.2,8,12,8z"></path><path d="M12,4c-0.6,0-1-0.4-1-1V1c0-0.6,0.4-1,1-1s1,0.4,1,1v2C13,3.6,12.6,4,12,4z"></path><path d="M12,24c-0.6,0-1-0.4-1-1v-2c0-0.6,0.4-1,1-1s1,0.4,1,1v2C13,23.6,12.6,24,12,24z"></path><path d="M5.6,6.6c-0.3,0-0.5-0.1-0.7-0.3L3.5,4.9c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l1.4,1.4c0.4,0.4,0.4,1,0,1.4C6.2,6.5,5.9,6.6,5.6,6.6z"></path><path d="M19.8,20.8c-0.3,0-0.5-0.1-0.7-0.3l-1.4-1.4c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l1.4,1.4c0.4,0.4,0.4,1,0,1.4C20.3,20.7,20,20.8,19.8,20.8z"></path><path d="M3,13H1c-0.6,0-1-0.4-1-1s0.4-1,1-1h2c0.6,0,1,0.4,1,1S3.6,13,3,13z"></path><path d="M23,13h-2c-0.6,0-1-0.4-1-1s0.4-1,1-1h2c0.6,0,1,0.4,1,1S23.6,13,23,13z"></path><path d="M4.2,20.8c-0.3,0-0.5-0.1-0.7-0.3c-0.4-0.4-0.4-1,0-1.4l1.4-1.4c0.4-0.4,1-0.4,1.4,0s0.4,1,0,1.4l-1.4,1.4C4.7,20.7,4.5,20.8,4.2,20.8z"></path><path d="M18.4,6.6c-0.3,0-0.5-0.1-0.7-0.3c-0.4-0.4-0.4-1,0-1.4l1.4-1.4c0.4-0.4,1-0.4,1.4,0s0.4,1,0,1.4l-1.4,1.4C18.9,6.5,18.6,6.6,18.4,6.6z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="moon" data-v-16a7f83e><path d="M12.1,22c-0.3,0-0.6,0-0.9,0c-5.5-0.5-9.5-5.4-9-10.9c0.4-4.8,4.2-8.6,9-9c0.4,0,0.8,0.2,1,0.5c0.2,0.3,0.2,0.8-0.1,1.1c-2,2.7-1.4,6.4,1.3,8.4c2.1,1.6,5,1.6,7.1,0c0.3-0.2,0.7-0.3,1.1-0.1c0.3,0.2,0.5,0.6,0.5,1c-0.2,2.7-1.5,5.1-3.6,6.8C16.6,21.2,14.4,22,12.1,22zM9.3,4.4c-2.9,1-5,3.6-5.2,6.8c-0.4,4.4,2.8,8.3,7.2,8.7c2.1,0.2,4.2-0.4,5.8-1.8c1.1-0.9,1.9-2.1,2.4-3.4c-2.5,0.9-5.3,0.5-7.5-1.1C9.2,11.4,8.1,7.7,9.3,4.4z"></path></svg><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-26cab421 data-v-be888c46 data-v-de2bf516><!--[--><a class="VPSocialLink" href="https://github.com/RedHawk989/EyeTrackVR" target="_blank" rel="noopener" data-v-de2bf516 data-v-af939139><svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>GitHub</title><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg></a><a class="VPSocialLink" href="https://discord.gg/kkXYbVykZX" target="_blank" rel="noopener" data-v-de2bf516 data-v-af939139><svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Discord</title><path d="M20.317 4.3698a19.7913 19.7913 0 00-4.8851-1.5152.0741.0741 0 00-.0785.0371c-.211.3753-.4447.8648-.6083 1.2495-1.8447-.2762-3.68-.2762-5.4868 0-.1636-.3933-.4058-.8742-.6177-1.2495a.077.077 0 00-.0785-.037 19.7363 19.7363 0 00-4.8852 1.515.0699.0699 0 00-.0321.0277C.5334 9.0458-.319 13.5799.0992 18.0578a.0824.0824 0 00.0312.0561c2.0528 1.5076 4.0413 2.4228 5.9929 3.0294a.0777.0777 0 00.0842-.0276c.4616-.6304.8731-1.2952 1.226-1.9942a.076.076 0 00-.0416-.1057c-.6528-.2476-1.2743-.5495-1.8722-.8923a.077.077 0 01-.0076-.1277c.1258-.0943.2517-.1923.3718-.2914a.0743.0743 0 01.0776-.0105c3.9278 1.7933 8.18 1.7933 12.0614 0a.0739.0739 0 01.0785.0095c.1202.099.246.1981.3728.2924a.077.077 0 01-.0066.1276 12.2986 12.2986 0 01-1.873.8914.0766.0766 0 00-.0407.1067c.3604.698.7719 1.3628 1.225 1.9932a.076.076 0 00.0842.0286c1.961-.6067 3.9495-1.5219 6.0023-3.0294a.077.077 0 00.0313-.0552c.5004-5.177-.8382-9.6739-3.5485-13.6604a.061.061 0 00-.0312-.0286zM8.02 15.3312c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9555-2.4189 2.157-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.9555 2.4189-2.1569 2.4189zm7.9748 0c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9554-2.4189 2.1569-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.946 2.4189-2.1568 2.4189Z"/></svg></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-26cab421 data-v-7af1585b data-v-01da497a><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-01da497a><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="icon" data-v-01da497a><circle cx="12" cy="12" r="2"></circle><circle cx="19" cy="12" r="2"></circle><circle cx="5" cy="12" r="2"></circle></svg></button><div class="menu" data-v-01da497a><div class="VPMenu" data-v-01da497a data-v-1e25c4ce><!----><!--[--><!--[--><!----><div class="group" data-v-7af1585b><div class="item appearance" data-v-7af1585b><p class="label" data-v-7af1585b>Appearance</p><div class="appearance-action" data-v-7af1585b><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" aria-label="toggle dark mode" aria-checked="false" data-v-7af1585b data-v-16a7f83e data-v-8be94668><span class="check" data-v-8be94668><span class="icon" data-v-8be94668><!--[--><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="sun" data-v-16a7f83e><path d="M12,18c-3.3,0-6-2.7-6-6s2.7-6,6-6s6,2.7,6,6S15.3,18,12,18zM12,8c-2.2,0-4,1.8-4,4c0,2.2,1.8,4,4,4c2.2,0,4-1.8,4-4C16,9.8,14.2,8,12,8z"></path><path d="M12,4c-0.6,0-1-0.4-1-1V1c0-0.6,0.4-1,1-1s1,0.4,1,1v2C13,3.6,12.6,4,12,4z"></path><path d="M12,24c-0.6,0-1-0.4-1-1v-2c0-0.6,0.4-1,1-1s1,0.4,1,1v2C13,23.6,12.6,24,12,24z"></path><path d="M5.6,6.6c-0.3,0-0.5-0.1-0.7-0.3L3.5,4.9c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l1.4,1.4c0.4,0.4,0.4,1,0,1.4C6.2,6.5,5.9,6.6,5.6,6.6z"></path><path d="M19.8,20.8c-0.3,0-0.5-0.1-0.7-0.3l-1.4-1.4c-0.4-0.4-0.4-1,0-1.4s1-0.4,1.4,0l1.4,1.4c0.4,0.4,0.4,1,0,1.4C20.3,20.7,20,20.8,19.8,20.8z"></path><path d="M3,13H1c-0.6,0-1-0.4-1-1s0.4-1,1-1h2c0.6,0,1,0.4,1,1S3.6,13,3,13z"></path><path d="M23,13h-2c-0.6,0-1-0.4-1-1s0.4-1,1-1h2c0.6,0,1,0.4,1,1S23.6,13,23,13z"></path><path d="M4.2,20.8c-0.3,0-0.5-0.1-0.7-0.3c-0.4-0.4-0.4-1,0-1.4l1.4-1.4c0.4-0.4,1-0.4,1.4,0s0.4,1,0,1.4l-1.4,1.4C4.7,20.7,4.5,20.8,4.2,20.8z"></path><path d="M18.4,6.6c-0.3,0-0.5-0.1-0.7-0.3c-0.4-0.4-0.4-1,0-1.4l1.4-1.4c0.4-0.4,1-0.4,1.4,0s0.4,1,0,1.4l-1.4,1.4C18.9,6.5,18.6,6.6,18.4,6.6z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="moon" data-v-16a7f83e><path d="M12.1,22c-0.3,0-0.6,0-0.9,0c-5.5-0.5-9.5-5.4-9-10.9c0.4-4.8,4.2-8.6,9-9c0.4,0,0.8,0.2,1,0.5c0.2,0.3,0.2,0.8-0.1,1.1c-2,2.7-1.4,6.4,1.3,8.4c2.1,1.6,5,1.6,7.1,0c0.3-0.2,0.7-0.3,1.1-0.1c0.3,0.2,0.5,0.6,0.5,1c-0.2,2.7-1.5,5.1-3.6,6.8C16.6,21.2,14.4,22,12.1,22zM9.3,4.4c-2.9,1-5,3.6-5.2,6.8c-0.4,4.4,2.8,8.3,7.2,8.7c2.1,0.2,4.2-0.4,5.8-1.8c1.1-0.9,1.9-2.1,2.4-3.4c-2.5,0.9-5.3,0.5-7.5-1.1C9.2,11.4,8.1,7.7,9.3,4.4z"></path></svg><!--]--></span></span></button></div></div></div><div class="group" data-v-7af1585b><div class="item social-links" data-v-7af1585b><div class="VPSocialLinks social-links-list" data-v-7af1585b data-v-de2bf516><!--[--><a class="VPSocialLink" href="https://github.com/RedHawk989/EyeTrackVR" target="_blank" rel="noopener" data-v-de2bf516 data-v-af939139><svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>GitHub</title><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg></a><a class="VPSocialLink" href="https://discord.gg/kkXYbVykZX" target="_blank" rel="noopener" data-v-de2bf516 data-v-af939139><svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Discord</title><path d="M20.317 4.3698a19.7913 19.7913 0 00-4.8851-1.5152.0741.0741 0 00-.0785.0371c-.211.3753-.4447.8648-.6083 1.2495-1.8447-.2762-3.68-.2762-5.4868 0-.1636-.3933-.4058-.8742-.6177-1.2495a.077.077 0 00-.0785-.037 19.7363 19.7363 0 00-4.8852 1.515.0699.0699 0 00-.0321.0277C.5334 9.0458-.319 13.5799.0992 18.0578a.0824.0824 0 00.0312.0561c2.0528 1.5076 4.0413 2.4228 5.9929 3.0294a.0777.0777 0 00.0842-.0276c.4616-.6304.8731-1.2952 1.226-1.9942a.076.076 0 00-.0416-.1057c-.6528-.2476-1.2743-.5495-1.8722-.8923a.077.077 0 01-.0076-.1277c.1258-.0943.2517-.1923.3718-.2914a.0743.0743 0 01.0776-.0105c3.9278 1.7933 8.18 1.7933 12.0614 0a.0739.0739 0 01.0785.0095c.1202.099.246.1981.3728.2924a.077.077 0 01-.0066.1276 12.2986 12.2986 0 01-1.873.8914.0766.0766 0 00-.0407.1067c.3604.698.7719 1.3628 1.225 1.9932a.076.076 0 00.0842.0286c1.961-.6067 3.9495-1.5219 6.0023-3.0294a.077.077 0 00.0313-.0552c.5004-5.177-.8382-9.6739-3.5485-13.6604a.061.061 0 00-.0312-.0286zM8.02 15.3312c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9555-2.4189 2.157-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.9555 2.4189-2.1569 2.4189zm7.9748 0c-1.1825 0-2.1569-1.0857-2.1569-2.419 0-1.3332.9554-2.4189 2.1569-2.4189 1.2108 0 2.1757 1.0952 2.1568 2.419 0 1.3332-.946 2.4189-2.1568 2.4189Z"/></svg></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-26cab421 data-v-670493dd><span class="container" data-v-670493dd><span class="top" data-v-670493dd></span><span class="middle" data-v-670493dd></span><span class="bottom" data-v-670493dd></span></span></button></div></div></div><!----></header><div class="VPLocalNav" data-v-5aaf92e7 data-v-232414b9><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-232414b9><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" viewbox="0 0 24 24" class="menu-icon" data-v-232414b9><path d="M17,11H3c-0.6,0-1-0.4-1-1s0.4-1,1-1h14c0.6,0,1,0.4,1,1S17.6,11,17,11z"></path><path d="M21,7H3C2.4,7,2,6.6,2,6s0.4-1,1-1h18c0.6,0,1,0.4,1,1S21.6,7,21,7z"></path><path d="M21,15H3c-0.6,0-1-0.4-1-1s0.4-1,1-1h18c0.6,0,1,0.4,1,1S21.6,15,21,15z"></path><path d="M17,19H3c-0.6,0-1-0.4-1-1s0.4-1,1-1h14c0.6,0,1,0.4,1,1S17.6,19,17,19z"></path></svg><span class="menu-text" data-v-232414b9>Menu</span></button><a class="top-link" href="#" data-v-232414b9> Return to top </a></div><aside class="VPSidebar" data-v-5aaf92e7 data-v-21951dfa><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-21951dfa><span class="visually-hidden" id="sidebar-aria-label" data-v-21951dfa> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="group" data-v-21951dfa><section class="VPSidebarGroup collapsible" data-v-21951dfa data-v-6a6002da><div class="title" role="button" data-v-6a6002da><h2 class="title-text" data-v-6a6002da>Getting Started</h2><div class="action" data-v-6a6002da><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewbox="0 0 24 24" class="icon minus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2zM20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h8c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg><svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon plus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2z M20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11h-3V8c0-0.6-0.4-1-1-1s-1,0.4-1,1v3H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h3v3c0,0.6,0.4,1,1,1s1-0.4,1-1v-3h3c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg></div></div><div class="items" data-v-6a6002da><!--[--><!--[--><a class="VPLink link link" href="/getting_started/intro" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Introduction</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/getting_started/things_to_know" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Things to know before you start</span><!--]--><!----></a><!----><!--]--><!--]--></div></section></div><div class="group" data-v-21951dfa><section class="VPSidebarGroup collapsible" data-v-21951dfa data-v-6a6002da><div class="title" role="button" data-v-6a6002da><h2 class="title-text" data-v-6a6002da>How to Build</h2><div class="action" data-v-6a6002da><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewbox="0 0 24 24" class="icon minus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2zM20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h8c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg><svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon plus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2z M20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11h-3V8c0-0.6-0.4-1-1-1s-1,0.4-1,1v3H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h3v3c0,0.6,0.4,1,1,1s1-0.4,1-1v-3h3c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg></div></div><div class="items" data-v-6a6002da><!--[--><!--[--><a class="VPLink link link" href="/how_to_build/full_build" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Full Build Guide</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/how_to_build/parts_list" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Part List</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/how_to_build/creating_your_own_mount" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>How to Create your own Camera Mount</span><!--]--><!----></a><!----><!--]--><!--]--></div></section></div><div class="group" data-v-21951dfa><section class="VPSidebarGroup collapsible" data-v-21951dfa data-v-6a6002da><div class="title" role="button" data-v-6a6002da><h2 class="title-text" data-v-6a6002da>Firmware Guide</h2><div class="action" data-v-6a6002da><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewbox="0 0 24 24" class="icon minus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2zM20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h8c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg><svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon plus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2z M20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11h-3V8c0-0.6-0.4-1-1-1s-1,0.4-1,1v3H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h3v3c0,0.6,0.4,1,1,1s1-0.4,1-1v-3h3c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg></div></div><div class="items" data-v-6a6002da><!--[--><!--[--><a class="VPLink link link" href="/firmware_guide/firmware" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Introduction</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/firmware_guide/setup_vscode" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Setup Visual Studio Code environment</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/firmware_guide/configure_firmware" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Configuring Firmware</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/firmware_guide/upload_and_update_firmware" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Uploading and Updating the Firmware</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/firmware_guide/update_platformio" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Updating PlatformIO</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/firmware_guide/environments" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Firmware Environments</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/firmware_guide/mdns" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>MDNS</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/firmware_guide/rest_api" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>REST API</span><!--]--><!----></a><!----><!--]--><!--]--></div></section></div><div class="group" data-v-21951dfa><section class="VPSidebarGroup collapsible" data-v-21951dfa data-v-6a6002da><div class="title" role="button" data-v-6a6002da><h2 class="title-text" data-v-6a6002da>Software Guide</h2><div class="action" data-v-6a6002da><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewbox="0 0 24 24" class="icon minus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2zM20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h8c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg><svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon plus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2z M20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11h-3V8c0-0.6-0.4-1-1-1s-1,0.4-1,1v3H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h3v3c0,0.6,0.4,1,1,1s1-0.4,1-1v-3h3c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg></div></div><div class="items" data-v-6a6002da><!--[--><!--[--><a class="VPLink link link" href="/software_guide/eyetrackvr_app_guide" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Installing and setting up the ETVR App</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/software_guide/build_software" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Building the app from source</span><!--]--><!----></a><!----><!--]--><!--]--></div></section></div><div class="group" data-v-21951dfa><section class="VPSidebarGroup collapsible" data-v-21951dfa data-v-6a6002da><div class="title" role="button" data-v-6a6002da><h2 class="title-text" data-v-6a6002da>Miscellaneous</h2><div class="action" data-v-6a6002da><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewbox="0 0 24 24" class="icon minus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2zM20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h8c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg><svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon plus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2z M20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11h-3V8c0-0.6-0.4-1-1-1s-1,0.4-1,1v3H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h3v3c0,0.6,0.4,1,1,1s1-0.4,1-1v-3h3c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg></div></div><div class="items" data-v-6a6002da><!--[--><!--[--><a class="VPLink link link" href="/misc/vrc_avatar_setup" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>VR Chat Avatar Setup</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/misc/faq" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>FAQ</span><!--]--><!----></a><!----><!--]--><!--]--></div></section></div><div class="group" data-v-21951dfa><section class="VPSidebarGroup collapsible" data-v-21951dfa data-v-6a6002da><div class="title" role="button" data-v-6a6002da><h2 class="title-text" data-v-6a6002da>Development</h2><div class="action" data-v-6a6002da><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewbox="0 0 24 24" class="icon minus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2zM20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h8c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg><svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon plus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2z M20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11h-3V8c0-0.6-0.4-1-1-1s-1,0.4-1,1v3H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h3v3c0,0.6,0.4,1,1,1s1-0.4,1-1v-3h3c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg></div></div><div class="items" data-v-6a6002da><!--[--><!--[--><a class="VPLink link link" href="/development/docs/dev_docs" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Docs</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link" href="/development/docs/pages" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Edit Docs</span><!--]--><!----></a><!----><!--]--><!--[--><a class="VPLink link link active" href="/development/docs/standards" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Standards</span><!--]--><!----></a><!----><!--]--><!--]--></div></section></div><div class="group" data-v-21951dfa><section class="VPSidebarGroup collapsible" data-v-21951dfa data-v-6a6002da><div class="title" role="button" data-v-6a6002da><h2 class="title-text" data-v-6a6002da>Archive</h2><div class="action" data-v-6a6002da><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewbox="0 0 24 24" class="icon minus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2zM20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h8c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg><svg version="1.1" xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon plus" data-v-6a6002da><path d="M19,2H5C3.3,2,2,3.3,2,5v14c0,1.7,1.3,3,3,3h14c1.7,0,3-1.3,3-3V5C22,3.3,20.7,2,19,2z M20,19c0,0.6-0.4,1-1,1H5c-0.6,0-1-0.4-1-1V5c0-0.6,0.4-1,1-1h14c0.6,0,1,0.4,1,1V19z"></path><path d="M16,11h-3V8c0-0.6-0.4-1-1-1s-1,0.4-1,1v3H8c-0.6,0-1,0.4-1,1s0.4,1,1,1h3v3c0,0.6,0.4,1,1,1s1-0.4,1-1v-3h3c0.6,0,1-0.4,1-1S16.6,11,16,11z"></path></svg></div></div><div class="items" data-v-6a6002da><!--[--><!--[--><a class="VPLink link link" href="/archive/fox_ir_v2_build_instructions" style="padding-left:0px;" tabindex="-1" data-v-9ac6cb77 data-v-cd683231><!--[--><span class="link-text" data-v-9ac6cb77>Prepare to solder IR LED PCB V2's</span><!--]--><!----></a><!----><!--]--><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-5aaf92e7 data-v-ac201f45><div class="VPDoc has-sidebar has-aside" data-v-ac201f45 data-v-317b0207><div class="container" data-v-317b0207><div class="aside" data-v-317b0207><div class="aside-curtain" data-v-317b0207></div><div class="aside-container" data-v-317b0207><div class="aside-content" data-v-317b0207><div class="VPDocAside" data-v-317b0207 data-v-39cd9708><!--[--><!--]--><!--[--><!--]--><div class="VPDocAsideOutline" data-v-39cd9708 data-v-586090b2><div class="content" data-v-586090b2><div class="outline-marker" data-v-586090b2></div><div class="outline-title" data-v-586090b2>On this page</div><nav aria-labelledby="doc-outline-aria-label" data-v-586090b2><span class="visually-hidden" id="doc-outline-aria-label" data-v-586090b2> Table of Contents for current page </span><ul class="root" data-v-586090b2 data-v-0eba5460><!--[--><!--]--></ul></nav></div></div><!--[--><!--]--><div class="spacer" data-v-39cd9708></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-317b0207><div class="content-container" data-v-317b0207><!--[--><!--]--><main class="main" data-v-317b0207><div style="position:relative;" class="vp-doc _development_docs_standards" data-v-317b0207><div><h1 id="standards-guide" tabindex="-1">Standards Guide <a class="header-anchor" href="#standards-guide" aria-hidden="true">#</a></h1><p>Listed here are the standards that are used for the EyeTrackVR project. These standards are used to ensure that the project is consistent and easy to understand.</p><h2 id="code-standards" tabindex="-1">Code Standards <a class="header-anchor" href="#code-standards" aria-hidden="true">#</a></h2><h3 id="general" tabindex="-1">General <a class="header-anchor" href="#general" aria-hidden="true">#</a></h3><p>It is by design that we use a static-site framework for the documentation site. This is to ensure that the documentation is easy to maintain and extend. This is also to ensure that the documentation is easy to understand.</p><p>We have only a few rules for the documentation site:</p><ul><li>All code should be written in English.</li><li>All code should be written in a way that is easy to understand.</li><li>All code should be written in a way that is easy to maintain.</li><li>All code should be written in a way that is easy to extend.</li><li>Our git commit style is to be followed, in english only.</li></ul><h3 id="git-commit-style" tabindex="-1">Git Commit Style <a class="header-anchor" href="#git-commit-style" aria-hidden="true">#</a></h3><p>We use the <a href="https://www.conventionalcommits.org/en/v1.0.0/" target="_blank" rel="noreferrer">Conventional Commits</a> standard for our git commit style. This is to ensure that our git commits are easy to understand and easy to maintain. This is also to ensure that our git commits are easy to extend.</p><p>Git commits are used to with the <a href="https://semantic-release.gitbook.io/semantic-release/" target="_blank" rel="noreferrer">Semantic Release</a> tool to automatically generate the changelog and versioning for the project. As such, it is important that we follow the Conventional Commits standard, with our own rule customizations.</p><p>The following is a list of the customizations that we have made to the Conventional Commits standard:</p><ul><li>We use the <code>BREAKING CHANGE(S)</code> or <code>BREAKING</code> text to indicate a breaking change.</li></ul><p>Our git commit style is as follows:</p><div class="language-bash line-numbers-mode"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-palenight"><code><span class="line"><span style="color:#89DDFF;">&lt;</span><span style="color:#A6ACCD;">type</span><span style="color:#89DDFF;">&gt;[</span><span style="color:#A6ACCD;">optional scope</span><span style="color:#89DDFF;">]</span><span style="color:#A6ACCD;">: </span><span style="color:#89DDFF;">&lt;</span><span style="color:#A6ACCD;">description</span><span style="color:#89DDFF;">&gt;</span></span>
<span class="line"></span>
<span class="line"><span style="color:#89DDFF;">[</span><span style="color:#A6ACCD;">optional body</span><span style="color:#89DDFF;">]</span></span>
<span class="line"></span>
<span class="line"><span style="color:#89DDFF;">[</span><span style="color:#A6ACCD;">optional footer(s)</span><span style="color:#89DDFF;">]</span></span>
<span class="line"></span></code></pre><div class="line-numbers-wrapper" aria-hidden="true"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br></div></div><p>The following is a list of the types that we use:</p><ul><li><code>feat</code>: A new feature.</li><li><code>fix</code>: A bug fix.</li><li><code>docs</code>: Documentation only changes.</li><li><code>style</code>: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).</li><li><code>refactor</code>: A code change that neither fixes a bug nor adds a feature.</li><li><code>perf</code>: A code change that improves performance.</li><li><code>test</code>: Adding missing or correcting existing tests.</li><li><code>build</code>: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm, yarn, actions).</li><li><code>ci</code>: Changes to our CI configuration files and scripts (example scopes: GH-Actions, yml, YAML).</li><li><code>chore</code>: Other changes that don&#39;t modify src or test files.</li><li><code>revert</code>: Reverts a previous commit.</li><li><code>BREAKING CHANGE</code>: Indicate a breaking change.</li><li><code>no-release</code>: This commit will not trigger a release.</li></ul><p>An example of our git commit style is as follows:</p><div class="language-bash line-numbers-mode"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki material-palenight"><code><span class="line"><span style="color:#FFCB6B;">feat:</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">add</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">a</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">new</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">feature</span><span style="color:#A6ACCD;"> </span><span style="color:#676E95;font-style:italic;"># this is the commit title</span></span>
<span class="line"></span>
<span class="line"><span style="color:#FFCB6B;">-</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">added</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">new</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">thing</span><span style="color:#A6ACCD;"> </span><span style="color:#676E95;font-style:italic;"># some detail about the new thing</span></span>
<span class="line"></span>
<span class="line"><span style="color:#FFCB6B;">BREAKING</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">CHANGE:</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">this</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">is</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">a</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">breaking</span><span style="color:#A6ACCD;"> </span><span style="color:#C3E88D;">change</span><span style="color:#A6ACCD;"> </span><span style="color:#676E95;font-style:italic;">#this line is optionaland only used if needed</span></span>
<span class="line"></span></code></pre><div class="line-numbers-wrapper" aria-hidden="true"><span class="line-number">1</span><br><span class="line-number">2</span><br><span class="line-number">3</span><br><span class="line-number">4</span><br><span class="line-number">5</span><br></div></div></div></div></main><!--[--><!--]--><footer class="VPDocFooter" data-v-317b0207 data-v-cbbeb5ab><div class="edit-info" data-v-cbbeb5ab><!----><div class="last-updated" data-v-cbbeb5ab><p class="VPLastUpdated" data-v-cbbeb5ab data-v-cc1176cb>Last updated: <time datetime="2023-03-03T18:30:00.000Z" data-v-cc1176cb></time></p></div></div><div class="prev-next" data-v-cbbeb5ab><div class="pager" data-v-cbbeb5ab><a class="pager-link prev" href="/development/docs/pages" data-v-cbbeb5ab><span class="desc" data-v-cbbeb5ab>Previous page</span><span class="title" data-v-cbbeb5ab>Edit Docs</span></a></div><div class="has-prev pager" data-v-cbbeb5ab><a class="pager-link next" href="/archive/fox_ir_v2_build_instructions" data-v-cbbeb5ab><span class="desc" data-v-cbbeb5ab>Next page</span><span class="title" data-v-cbbeb5ab>Prepare to solder IR LED PCB V2's</span></a></div></div></footer><!--[--><!--]--></div></div></div></div></div><footer class="VPFooter has-sidebar" data-v-5aaf92e7 data-v-1a0cce0c><div class="container" data-v-1a0cce0c><p class="message" data-v-1a0cce0c>Released under the MIT License.</p><p class="copyright" data-v-1a0cce0c>Copyright © 2022-present ETVR</p></div></footer><!--[--><!--]--></div></div>
<script>__VP_HASH_MAP__ = JSON.parse("{\"firmware_guide_environments.md\":\"36d19564\",\"about.md\":\"3352f48a\",\"archive_fox_ir_v2_build_instructions.md\":\"f4e1b25e\",\"contact.md\":\"c7df13d0\",\"development_docs_dev_docs.md\":\"c984c92b\",\"development_docs_pages.md\":\"08f3671d\",\"firmware_guide_configure_firmware.md\":\"3641ea6f\",\"firmware_guide_firmware.md\":\"5b8407e9\",\"how_to_build_full_build.md\":\"d126a594\",\"getting_started_things_to_know.md\":\"24580896\",\"dev_roadmap.md\":\"ff471091\",\"firmware_guide_upload_and_update_firmware.md\":\"b720563f\",\"development_docs_standards.md\":\"4c4a8f40\",\"how_to_build_creating_your_own_mount.md\":\"a523561e\",\"firmware_guide_setup_vscode.md\":\"a022729d\",\"firmware_guide_update_platformio.md\":\"4052d476\",\"firmware_guide_mdns.md\":\"089ec198\",\"firmware_guide_rest_api.md\":\"cdbe96a3\",\"getting_started_intro.md\":\"6d59da76\",\"misc_faq.md\":\"648fb0ec\",\"software_guide_build_software.md\":\"a50bc6e6\",\"index.md\":\"da681b8b\",\"how_to_build_parts_list.md\":\"6275b3c3\",\"misc_vrc_avatar_setup.md\":\"12b4199c\",\"software_guide_eyetrackvr_app_guide.md\":\"00e33ae4\"}")</script>
<script type="module" async src="/assets/app.ffc675f3.js"></script>
</body>
</html>