docs: Merge pull request #11 from lorow/feature/cleanup-parts-page

Clean-up the parts page, add missing information, upkeep repo links, spelling
This commit is contained in:
RedHawk989 2023-07-17 14:38:56 +00:00
parent ac0bcdea43
commit cb4901ad76
46 changed files with 210 additions and 213 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1 +1 @@
import{V as i,a as s,b as l,c as r}from"./chunks/theme.d1f43b14.js";import{o as u,c,G as n,B as a,b as o,a as e,z as t}from"./chunks/framework.7384f92b.js";const h=[{name:"Prohurtz",avatar:"https://avatars.githubusercontent.com/u/48768484?v=4",title:"Creator / Lead Software Developer / Documentor / Hardware Developer",links:[{icon:"github",link:"https://github.com/RedHawk989"}]},{name:"Summer",avatar:"https://avatars.githubusercontent.com/u/115666235?v=4",title:"Machine Learning Engineer / Data Scientist / App Developer",links:[{icon:"github",link:"https://github.com/Summer404NotFound"}]},{name:"lorow",avatar:"https://avatars.githubusercontent.com/u/14099558?v=4",title:"Lead Firmware Developer / App Developer",links:[{icon:"github",link:"https://github.com/lorow"}]},{name:"DaOfficialWizard",avatar:"https://avatars.githubusercontent.com/u/45744329?v=4",title:"Firmware Developer / Documentation Manager / App Developer",links:[{icon:"github",link:"https://github.com/ZanzyTHEbar"}]}],m=[{name:"qdot",avatar:"https://avatars.githubusercontent.com/u/34539?v=4",links:[{icon:"github",link:"https://github.com/qdot"}]},{name:"dfgHiatus",avatar:"https://avatars.githubusercontent.com/u/51272212?v=4",links:[{icon:"github",link:"https://github.com/dfgHiatus"}]},{name:"PallasNeko",avatar:"https://avatars.githubusercontent.com/u/124042774?v=4",links:[{icon:"github",link:"https://github.com/PallasNeko"}]}],d=t("div",{class:"text-[#ab5ac7]"}," Our Team ",-1),p=t("br",null,null,-1),b=t("br",null,null,-1),_=t("br",null,null,-1),g=t("a",{class:"custom-links",href:"/intro",target:"_blank"},"guides",-1),v=t("br",null,null,-1),k=t("br",null,null,-1),f=t("br",null,null,-1),w=t("br",null,null,-1),T=t("a",{class:"custom-links",href:"https://en.wikipedia.org/wiki/Open-source_model",target:"_blank"},"Open Source model",-1),y=t("br",null,null,-1),P=t("br",null,null,-1),O=JSON.parse('{"title":"","description":"","frontmatter":{"layout":"page"},"headers":[],"relativePath":"about.md","filePath":"about.md","lastUpdated":1673640425000}'),D={name:"about.md"},x=Object.assign(D,{setup(V){return(S,N)=>(u(),c("div",null,[n(o(r),null,{default:a(()=>[n(o(i),null,{title:a(()=>[d]),lead:a(()=>[e(" The development of EyeTrackVR is guided by an international team, some of whom have chosen to be featured below."),p,b,e(" EyeTrackVR developers are a group of people who are passionate about the field of augmented and virtual reality. ")]),_:1}),n(o(s),{size:"medium",members:o(h)},null,8,["members"]),n(o(l),null,{title:a(()=>[e("Contributors")]),lead:a(()=>[e("Those who have actively contributed to development."),_,e(" Community Support")]),members:a(()=>[n(o(s),{size:"small",members:o(m)},null,8,["members"])]),_:1}),n(o(l),null,{title:a(()=>[e("Philosophy")]),lead:a(()=>[e(" The "),g,e(" on this website include some of our teams own notes (not all of them are polished) that we disclose for other people to use."),v,k,e(" Here, we hope you may find something useful to you."),f,w,e(" We advocate the "),T,e("."),y,P,e(" This is why we strive to make our work open to other people for consultation, replication and reuse. ")]),_:1})]),_:1})]))}});export{O as __pageData,x as default};
import{V as i,a as s,b as l,c as r}from"./chunks/theme.02c6747e.js";import{o as u,c,G as n,B as a,b as o,a as e,z as t}from"./chunks/framework.7384f92b.js";const h=[{name:"Prohurtz",avatar:"https://avatars.githubusercontent.com/u/48768484?v=4",title:"Creator / Lead Software Developer / Documentor / Hardware Developer",links:[{icon:"github",link:"https://github.com/RedHawk989"}]},{name:"Summer",avatar:"https://avatars.githubusercontent.com/u/115666235?v=4",title:"Machine Learning Engineer / Data Scientist / App Developer",links:[{icon:"github",link:"https://github.com/Summer404NotFound"}]},{name:"lorow",avatar:"https://avatars.githubusercontent.com/u/14099558?v=4",title:"Lead Firmware Developer / App Developer",links:[{icon:"github",link:"https://github.com/lorow"}]},{name:"DaOfficialWizard",avatar:"https://avatars.githubusercontent.com/u/45744329?v=4",title:"Firmware Developer / Documentation Manager / App Developer",links:[{icon:"github",link:"https://github.com/ZanzyTHEbar"}]}],m=[{name:"qdot",avatar:"https://avatars.githubusercontent.com/u/34539?v=4",links:[{icon:"github",link:"https://github.com/qdot"}]},{name:"dfgHiatus",avatar:"https://avatars.githubusercontent.com/u/51272212?v=4",links:[{icon:"github",link:"https://github.com/dfgHiatus"}]},{name:"PallasNeko",avatar:"https://avatars.githubusercontent.com/u/124042774?v=4",links:[{icon:"github",link:"https://github.com/PallasNeko"}]}],d=t("div",{class:"text-[#ab5ac7]"}," Our Team ",-1),p=t("br",null,null,-1),b=t("br",null,null,-1),_=t("br",null,null,-1),g=t("a",{class:"custom-links",href:"/intro",target:"_blank"},"guides",-1),v=t("br",null,null,-1),k=t("br",null,null,-1),f=t("br",null,null,-1),w=t("br",null,null,-1),T=t("a",{class:"custom-links",href:"https://en.wikipedia.org/wiki/Open-source_model",target:"_blank"},"Open Source model",-1),y=t("br",null,null,-1),P=t("br",null,null,-1),O=JSON.parse('{"title":"","description":"","frontmatter":{"layout":"page"},"headers":[],"relativePath":"about.md","filePath":"about.md","lastUpdated":1673640425000}'),D={name:"about.md"},x=Object.assign(D,{setup(V){return(S,N)=>(u(),c("div",null,[n(o(r),null,{default:a(()=>[n(o(i),null,{title:a(()=>[d]),lead:a(()=>[e(" The development of EyeTrackVR is guided by an international team, some of whom have chosen to be featured below."),p,b,e(" EyeTrackVR developers are a group of people who are passionate about the field of augmented and virtual reality. ")]),_:1}),n(o(s),{size:"medium",members:o(h)},null,8,["members"]),n(o(l),null,{title:a(()=>[e("Contributors")]),lead:a(()=>[e("Those who have actively contributed to development."),_,e(" Community Support")]),members:a(()=>[n(o(s),{size:"small",members:o(m)},null,8,["members"])]),_:1}),n(o(l),null,{title:a(()=>[e("Philosophy")]),lead:a(()=>[e(" The "),g,e(" on this website include some of our teams own notes (not all of them are polished) that we disclose for other people to use."),v,k,e(" Here, we hope you may find something useful to you."),f,w,e(" We advocate the "),T,e("."),y,P,e(" This is why we strive to make our work open to other people for consultation, replication and reuse. ")]),_:1})]),_:1})]))}});export{O as __pageData,x as default};

View File

@ -1 +1 @@
import{V as i,a as s,b as l,c as r}from"./chunks/theme.d1f43b14.js";import{o as u,c,G as n,B as a,b as o,a as e,z as t}from"./chunks/framework.7384f92b.js";const h=[{name:"Prohurtz",avatar:"https://avatars.githubusercontent.com/u/48768484?v=4",title:"Creator / Lead Software Developer / Documentor / Hardware Developer",links:[{icon:"github",link:"https://github.com/RedHawk989"}]},{name:"Summer",avatar:"https://avatars.githubusercontent.com/u/115666235?v=4",title:"Machine Learning Engineer / Data Scientist / App Developer",links:[{icon:"github",link:"https://github.com/Summer404NotFound"}]},{name:"lorow",avatar:"https://avatars.githubusercontent.com/u/14099558?v=4",title:"Lead Firmware Developer / App Developer",links:[{icon:"github",link:"https://github.com/lorow"}]},{name:"DaOfficialWizard",avatar:"https://avatars.githubusercontent.com/u/45744329?v=4",title:"Firmware Developer / Documentation Manager / App Developer",links:[{icon:"github",link:"https://github.com/ZanzyTHEbar"}]}],m=[{name:"qdot",avatar:"https://avatars.githubusercontent.com/u/34539?v=4",links:[{icon:"github",link:"https://github.com/qdot"}]},{name:"dfgHiatus",avatar:"https://avatars.githubusercontent.com/u/51272212?v=4",links:[{icon:"github",link:"https://github.com/dfgHiatus"}]},{name:"PallasNeko",avatar:"https://avatars.githubusercontent.com/u/124042774?v=4",links:[{icon:"github",link:"https://github.com/PallasNeko"}]}],d=t("div",{class:"text-[#ab5ac7]"}," Our Team ",-1),p=t("br",null,null,-1),b=t("br",null,null,-1),_=t("br",null,null,-1),g=t("a",{class:"custom-links",href:"/intro",target:"_blank"},"guides",-1),v=t("br",null,null,-1),k=t("br",null,null,-1),f=t("br",null,null,-1),w=t("br",null,null,-1),T=t("a",{class:"custom-links",href:"https://en.wikipedia.org/wiki/Open-source_model",target:"_blank"},"Open Source model",-1),y=t("br",null,null,-1),P=t("br",null,null,-1),O=JSON.parse('{"title":"","description":"","frontmatter":{"layout":"page"},"headers":[],"relativePath":"about.md","filePath":"about.md","lastUpdated":1673640425000}'),D={name:"about.md"},x=Object.assign(D,{setup(V){return(S,N)=>(u(),c("div",null,[n(o(r),null,{default:a(()=>[n(o(i),null,{title:a(()=>[d]),lead:a(()=>[e(" The development of EyeTrackVR is guided by an international team, some of whom have chosen to be featured below."),p,b,e(" EyeTrackVR developers are a group of people who are passionate about the field of augmented and virtual reality. ")]),_:1}),n(o(s),{size:"medium",members:o(h)},null,8,["members"]),n(o(l),null,{title:a(()=>[e("Contributors")]),lead:a(()=>[e("Those who have actively contributed to development."),_,e(" Community Support")]),members:a(()=>[n(o(s),{size:"small",members:o(m)},null,8,["members"])]),_:1}),n(o(l),null,{title:a(()=>[e("Philosophy")]),lead:a(()=>[e(" The "),g,e(" on this website include some of our teams own notes (not all of them are polished) that we disclose for other people to use."),v,k,e(" Here, we hope you may find something useful to you."),f,w,e(" We advocate the "),T,e("."),y,P,e(" This is why we strive to make our work open to other people for consultation, replication and reuse. ")]),_:1})]),_:1})]))}});export{O as __pageData,x as default};
import{V as i,a as s,b as l,c as r}from"./chunks/theme.02c6747e.js";import{o as u,c,G as n,B as a,b as o,a as e,z as t}from"./chunks/framework.7384f92b.js";const h=[{name:"Prohurtz",avatar:"https://avatars.githubusercontent.com/u/48768484?v=4",title:"Creator / Lead Software Developer / Documentor / Hardware Developer",links:[{icon:"github",link:"https://github.com/RedHawk989"}]},{name:"Summer",avatar:"https://avatars.githubusercontent.com/u/115666235?v=4",title:"Machine Learning Engineer / Data Scientist / App Developer",links:[{icon:"github",link:"https://github.com/Summer404NotFound"}]},{name:"lorow",avatar:"https://avatars.githubusercontent.com/u/14099558?v=4",title:"Lead Firmware Developer / App Developer",links:[{icon:"github",link:"https://github.com/lorow"}]},{name:"DaOfficialWizard",avatar:"https://avatars.githubusercontent.com/u/45744329?v=4",title:"Firmware Developer / Documentation Manager / App Developer",links:[{icon:"github",link:"https://github.com/ZanzyTHEbar"}]}],m=[{name:"qdot",avatar:"https://avatars.githubusercontent.com/u/34539?v=4",links:[{icon:"github",link:"https://github.com/qdot"}]},{name:"dfgHiatus",avatar:"https://avatars.githubusercontent.com/u/51272212?v=4",links:[{icon:"github",link:"https://github.com/dfgHiatus"}]},{name:"PallasNeko",avatar:"https://avatars.githubusercontent.com/u/124042774?v=4",links:[{icon:"github",link:"https://github.com/PallasNeko"}]}],d=t("div",{class:"text-[#ab5ac7]"}," Our Team ",-1),p=t("br",null,null,-1),b=t("br",null,null,-1),_=t("br",null,null,-1),g=t("a",{class:"custom-links",href:"/intro",target:"_blank"},"guides",-1),v=t("br",null,null,-1),k=t("br",null,null,-1),f=t("br",null,null,-1),w=t("br",null,null,-1),T=t("a",{class:"custom-links",href:"https://en.wikipedia.org/wiki/Open-source_model",target:"_blank"},"Open Source model",-1),y=t("br",null,null,-1),P=t("br",null,null,-1),O=JSON.parse('{"title":"","description":"","frontmatter":{"layout":"page"},"headers":[],"relativePath":"about.md","filePath":"about.md","lastUpdated":1673640425000}'),D={name:"about.md"},x=Object.assign(D,{setup(V){return(S,N)=>(u(),c("div",null,[n(o(r),null,{default:a(()=>[n(o(i),null,{title:a(()=>[d]),lead:a(()=>[e(" The development of EyeTrackVR is guided by an international team, some of whom have chosen to be featured below."),p,b,e(" EyeTrackVR developers are a group of people who are passionate about the field of augmented and virtual reality. ")]),_:1}),n(o(s),{size:"medium",members:o(h)},null,8,["members"]),n(o(l),null,{title:a(()=>[e("Contributors")]),lead:a(()=>[e("Those who have actively contributed to development."),_,e(" Community Support")]),members:a(()=>[n(o(s),{size:"small",members:o(m)},null,8,["members"])]),_:1}),n(o(l),null,{title:a(()=>[e("Philosophy")]),lead:a(()=>[e(" The "),g,e(" on this website include some of our teams own notes (not all of them are polished) that we disclose for other people to use."),v,k,e(" Here, we hope you may find something useful to you."),f,w,e(" We advocate the "),T,e("."),y,P,e(" This is why we strive to make our work open to other people for consultation, replication and reuse. ")]),_:1})]),_:1})]))}});export{O as __pageData,x as default};

View File

@ -1 +1 @@
import{u as r,k as p,R as s,a7 as u,a8 as c,a9 as l,aa as f,ab as d,ac as m,ad as h,ae as g,af as A,ag as v,H as C,d as P,p as y,ah as _,ai as w,aj as R,ak as T}from"./chunks/framework.7384f92b.js";import{t as b}from"./chunks/theme.d1f43b14.js";const E={};const D={...b,setup(){const{lang:e}=r();p(()=>{s&&(document.cookie=`nf_lang=${e.value}; expires=Mon, 1 Jan 2024 00:00:00 UTC; path=/`)})},...E};function i(e){if(e.extends){const t=i(e.extends);return{...t,...e,async enhanceApp(a){t.enhanceApp&&await t.enhanceApp(a),e.enhanceApp&&await e.enhanceApp(a)}}}return e}const n=i(D),S=P({name:"VitePressApp",setup(){const{site:e}=r();return y(()=>{p(()=>{document.documentElement.lang=e.value.lang,document.documentElement.dir=e.value.dir})}),_(),w(),R(),n.setup&&n.setup(),()=>T(n.Layout)}});async function j(){const e=O(),t=x();t.provide(c,e);const a=l(e.route);return t.provide(f,a),t.component("Content",d),t.component("ClientOnly",m),Object.defineProperties(t.config.globalProperties,{$frontmatter:{get(){return a.frontmatter.value}},$params:{get(){return a.page.value.params}}}),n.enhanceApp&&await n.enhanceApp({app:t,router:e,siteData:h}),{app:t,router:e,data:a}}function x(){return g(S)}function O(){let e=s,t;return A(a=>{let o=v(a);return e&&(t=o),(e||t===o)&&(o=o.replace(/\.js$/,".lean.js")),s&&(e=!1),C(()=>import(o),[])},n.NotFound)}s&&j().then(({app:e,router:t,data:a})=>{t.go().then(()=>{u(t.route,a.site),e.mount("#app")})});export{j as createApp};
import{u as r,k as p,R as s,a7 as u,a8 as c,a9 as l,aa as f,ab as d,ac as m,ad as h,ae as g,af as A,ag as v,H as C,d as P,p as y,ah as _,ai as w,aj as R,ak as T}from"./chunks/framework.7384f92b.js";import{t as b}from"./chunks/theme.02c6747e.js";const E={};const D={...b,setup(){const{lang:e}=r();p(()=>{s&&(document.cookie=`nf_lang=${e.value}; expires=Mon, 1 Jan 2024 00:00:00 UTC; path=/`)})},...E};function i(e){if(e.extends){const t=i(e.extends);return{...t,...e,async enhanceApp(a){t.enhanceApp&&await t.enhanceApp(a),e.enhanceApp&&await e.enhanceApp(a)}}}return e}const n=i(D),S=P({name:"VitePressApp",setup(){const{site:e}=r();return y(()=>{p(()=>{document.documentElement.lang=e.value.lang,document.documentElement.dir=e.value.dir})}),_(),w(),R(),n.setup&&n.setup(),()=>T(n.Layout)}});async function j(){const e=O(),t=x();t.provide(c,e);const a=l(e.route);return t.provide(f,a),t.component("Content",d),t.component("ClientOnly",m),Object.defineProperties(t.config.globalProperties,{$frontmatter:{get(){return a.frontmatter.value}},$params:{get(){return a.page.value.params}}}),n.enhanceApp&&await n.enhanceApp({app:t,router:e,siteData:h}),{app:t,router:e,data:a}}function x(){return g(S)}function O(){let e=s,t;return A(a=>{let o=v(a);return e&&(t=o),(e||t===o)&&(o=o.replace(/\.js$/,".lean.js")),s&&(e=!1),C(()=>import(o),[])},n.NotFound)}s&&j().then(({app:e,router:t,data:a})=>{t.go().then(()=>{u(t.route,a.site),e.mount("#app")})});export{j as createApp};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1 @@
import{_ as o,i as a}from"./chunks/index.9f7265df.js";import{o as i,c as s,G as n,b as r,V as l,z as e,a as t}from"./chunks/framework.7384f92b.js";const d=l("",6),h=e("h3",{id:"install",tabindex:"-1"},[t("Install "),e("a",{class:"header-anchor",href:"#install","aria-label":'Permalink to "Install"'},"")],-1),c=e("br",null,null,-1),_=l("",5),p=l("",3),u=e("ol",null,[e("li",null,[t("Change the directory to the directory that you want the firmware to be cloned. Ex: "),e("code",null,"cd C:/")])],-1),m=e("ol",null,[e("li",null,[t("Clone the repository by entering the command: "),e("code",null,"git clone https://github.com/EyeTrackVR/OpenIris.git")])],-1),f=e("p",null,[t("For more info about cloning please refer to "),e("a",{href:"https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository",target:"_blank",rel:"noreferrer"},"this documentation")],-1),g=e("p",null,[e("em",null,[e("strong",null,"Do not download as a zip")]),t(" - please only properly clone the project, take note of the path you run the clone command in, this is where the files will be downloaded. When we open it in PlatformIO later, this path will be needed.")],-1),w=e("ol",null,[e("li",null,[t("Open the firmware in VSCode by going to PlatformIO, selecting open, then navigating to "),e("code",null,"OpenIris/ESP"),t(" folder and opening it.")])],-1),v=e("p",null,[e("em",null,[t("This is an adaptation from SlimeVR. Some Credit goes to the SlimeVR team "),e("a",{href:"https://docs.slimevr.dev/firmware/setup-and-install.html",target:"_blank",rel:"noreferrer"},"adapted from here")])],-1),V=JSON.parse('{"title":"Setting up the environment","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/setup_vscode.md","filePath":"firmware_guide/setup_vscode.md","lastUpdated":1689532703000}'),b={name:"firmware_guide/setup_vscode.md"},P=Object.assign(b,{setup(I){return(k,S)=>(i(),s("div",null,[d,n(o,{options:r(a).setup_vscode_image_one},null,8,["options"]),h,c,n(o,{options:r(a).setup_vscode_image_two},null,8,["options"]),_,n(o,{options:r(a).setup_vscode_image_three},null,8,["options"]),p,n(o,{options:r(a).setup_vscode_image_four},null,8,["options"]),u,n(o,{options:r(a).setup_vscode_image_five},null,8,["options"]),m,n(o,{options:r(a).setup_vscode_image_six},null,8,["options"]),f,g,w,n(o,{options:r(a).setup_vscode_image_seven},null,8,["options"]),v]))}});export{V as __pageData,P as default};

View File

@ -1 +0,0 @@
import{_ as o,i as a}from"./chunks/index.9f7265df.js";import{o as r,c as s,G as n,b as l,V as i,z as e,a as t}from"./chunks/framework.7384f92b.js";const d=i('<h1 class="text-[var(--font-accent)]" id="setting-up-the-environment" tabindex="-1">Setting up the environment <a class="header-anchor" href="#setting-up-the-environment" aria-label="Permalink to &quot;Setting up the environment {.text-[var(--font-accent)]}&quot;"></a></h1><p>This procedure will show how to prepare your system for uploading the firmware to your tracker.</p><h2 id="_1-install-visual-studio-code" tabindex="-1">1. Install Visual Studio Code <a class="header-anchor" href="#_1-install-visual-studio-code" aria-label="Permalink to &quot;1. Install Visual Studio Code&quot;"></a></h2><p>Download the <a href="https://code.visualstudio.com/download" target="_blank" rel="noreferrer">latest Visual Studio Code</a> and install it.</p><h3 id="download" tabindex="-1">Download <a class="header-anchor" href="#download" aria-label="Permalink to &quot;Download&quot;"></a></h3><br>',6),c=e("h3",{id:"install",tabindex:"-1"},[t("Install "),e("a",{class:"header-anchor",href:"#install","aria-label":'Permalink to "Install"'},"")],-1),h=e("br",null,null,-1),p=e("h2",{id:"_2-install-platformio-ide",tabindex:"-1"},[t("2. Install PlatformIO IDE "),e("a",{class:"header-anchor",href:"#_2-install-platformio-ide","aria-label":'Permalink to "2. Install PlatformIO IDE"'},"")],-1),_=e("p",null,[t("Once Visual Studio Code is installed, open it and install "),e("a",{href:"https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide",target:"_blank",rel:"noreferrer"},"PlatformIO IDE for VSCode"),t(", an extension that will allow you to connect to the tracker, build and upload the firmware.")],-1),u=i('<h2 id="_3-clone-the-firmware-project" tabindex="-1">3. Clone the firmware project <a class="header-anchor" href="#_3-clone-the-firmware-project" aria-label="Permalink to &quot;3. Clone the firmware project&quot;"></a></h2><p>Make sure you close any current projects you have open or open a new window before moving forward with these steps.</p><ol><li>Go to <a href="https://github.com/lorow/OpenIris" target="_blank" rel="noreferrer">https://github.com/lorow/OpenIris</a> and <code>clone</code> the latest version from the <code>main</code> branch. <ol><li><p>If you do not have <code>git</code> installed please install it from <a href="https://git-scm.com/download/win" target="_blank" rel="noreferrer">here</a>.</p></li><li><p>Open Git Bash.</p></li></ol></li></ol>',3),m=e("ol",null,[e("li",null,[t("Change the directory to the directory that you want the firmware to be cloned. Ex: "),e("code",null,"cd C:/")])],-1),f=e("ol",null,[e("li",null,[t("Clone the repository by entering the command: "),e("code",null,"git clone https://github.com/lorow/OpenIris.git")])],-1),g=e("p",null,[t("For more info about cloning please refer to "),e("a",{href:"https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository",target:"_blank",rel:"noreferrer"},"this documentation")],-1),w=e("p",null,[e("em",null,[e("strong",null,"Do not download as a zip")]),t(" - please only properly clone the project, take note of the path you run the clone command in, this is where the files will be downloaded. When we open it in PlatformIO later, this path will be needed.")],-1),b=e("ol",null,[e("li",null,[t("Open the firmware in VSCode by going to PlatformIO, selecting open, then navigating to "),e("code",null,"OpenIris/ESP"),t(" folder and opening it.")])],-1),v=e("p",null,[e("em",null,[t("This is an adaptation from SlimeVR. Some Credit goes to the SlimeVR team "),e("a",{href:"https://docs.slimevr.dev/firmware/setup-and-install.html",target:"_blank",rel:"noreferrer"},"adapted from here")])],-1),C=JSON.parse('{"title":"Setting up the environment","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/setup_vscode.md","filePath":"firmware_guide/setup_vscode.md","lastUpdated":1681507268000}'),I={name:"firmware_guide/setup_vscode.md"},T=Object.assign(I,{setup(S){return(k,y)=>(r(),s("div",null,[d,n(o,{options:l(a).setup_vscode_image_one},null,8,["options"]),c,h,n(o,{options:l(a).setup_vscode_image_two},null,8,["options"]),p,_,n(o,{options:l(a).setup_vscode_image_three},null,8,["options"]),u,n(o,{options:l(a).setup_vscode_image_four},null,8,["options"]),m,n(o,{options:l(a).setup_vscode_image_five},null,8,["options"]),f,n(o,{options:l(a).setup_vscode_image_six},null,8,["options"]),g,w,b,n(o,{options:l(a).setup_vscode_image_seven},null,8,["options"]),v]))}});export{C as __pageData,T as default};

View File

@ -1 +0,0 @@
import{_ as o,i as a}from"./chunks/index.9f7265df.js";import{o as r,c as s,G as n,b as l,V as i,z as e,a as t}from"./chunks/framework.7384f92b.js";const d=i("",6),c=e("h3",{id:"install",tabindex:"-1"},[t("Install "),e("a",{class:"header-anchor",href:"#install","aria-label":'Permalink to "Install"'},"")],-1),h=e("br",null,null,-1),p=e("h2",{id:"_2-install-platformio-ide",tabindex:"-1"},[t("2. Install PlatformIO IDE "),e("a",{class:"header-anchor",href:"#_2-install-platformio-ide","aria-label":'Permalink to "2. Install PlatformIO IDE"'},"")],-1),_=e("p",null,[t("Once Visual Studio Code is installed, open it and install "),e("a",{href:"https://marketplace.visualstudio.com/items?itemName=platformio.platformio-ide",target:"_blank",rel:"noreferrer"},"PlatformIO IDE for VSCode"),t(", an extension that will allow you to connect to the tracker, build and upload the firmware.")],-1),u=i("",3),m=e("ol",null,[e("li",null,[t("Change the directory to the directory that you want the firmware to be cloned. Ex: "),e("code",null,"cd C:/")])],-1),f=e("ol",null,[e("li",null,[t("Clone the repository by entering the command: "),e("code",null,"git clone https://github.com/lorow/OpenIris.git")])],-1),g=e("p",null,[t("For more info about cloning please refer to "),e("a",{href:"https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository",target:"_blank",rel:"noreferrer"},"this documentation")],-1),w=e("p",null,[e("em",null,[e("strong",null,"Do not download as a zip")]),t(" - please only properly clone the project, take note of the path you run the clone command in, this is where the files will be downloaded. When we open it in PlatformIO later, this path will be needed.")],-1),b=e("ol",null,[e("li",null,[t("Open the firmware in VSCode by going to PlatformIO, selecting open, then navigating to "),e("code",null,"OpenIris/ESP"),t(" folder and opening it.")])],-1),v=e("p",null,[e("em",null,[t("This is an adaptation from SlimeVR. Some Credit goes to the SlimeVR team "),e("a",{href:"https://docs.slimevr.dev/firmware/setup-and-install.html",target:"_blank",rel:"noreferrer"},"adapted from here")])],-1),C=JSON.parse('{"title":"Setting up the environment","description":"","frontmatter":{},"headers":[],"relativePath":"firmware_guide/setup_vscode.md","filePath":"firmware_guide/setup_vscode.md","lastUpdated":1681507268000}'),I={name:"firmware_guide/setup_vscode.md"},T=Object.assign(I,{setup(S){return(k,y)=>(r(),s("div",null,[d,n(o,{options:l(a).setup_vscode_image_one},null,8,["options"]),c,h,n(o,{options:l(a).setup_vscode_image_two},null,8,["options"]),p,_,n(o,{options:l(a).setup_vscode_image_three},null,8,["options"]),u,n(o,{options:l(a).setup_vscode_image_four},null,8,["options"]),m,n(o,{options:l(a).setup_vscode_image_five},null,8,["options"]),f,n(o,{options:l(a).setup_vscode_image_six},null,8,["options"]),g,w,b,n(o,{options:l(a).setup_vscode_image_seven},null,8,["options"]),v]))}});export{C as __pageData,T as default};

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1 @@
import{_ as s,a as i}from"./chunks/index.3b745ef0.js";import{_ as l,i as d}from"./chunks/index.9f7265df.js";import{o as c,c as h,G as a,B as n,b as r,V as t,z as e,a as o}from"./chunks/framework.7384f92b.js";const u=t("",4),_=e("p",null," This project is in active development. However, it is working for most users. ",-1),p=t("",5),m=e("p",null,[o(" Make sure you are using "),e("ins",{class:"text-red-400 dark:text-red-500"},"non-focused"),o(" emitters and no more than "),e("ins",{class:"font-bold"},"5 mW/sr"),o(" total power. ")],-1),f=t("",9),b=t("",3),R=JSON.parse('{"title":"EyeTrackVR","description":"","frontmatter":{},"headers":[],"relativePath":"getting_started/intro.md","filePath":"getting_started/intro.md","lastUpdated":1689604501000}'),y={name:"getting_started/intro.md"},V=Object.assign(y,{setup(g){return(k,w)=>(c(),h("div",null,[u,a(s,{options:r(i).user_warning},{content:n(()=>[_]),_:1},8,["options"]),p,a(s,{options:r(i).led_power_warning},{content:n(()=>[m]),_:1},8,["options"]),f,a(l,{options:r(d).discord_content},null,8,["options"]),b]))}});export{R as __pageData,V as default};

File diff suppressed because one or more lines are too long

View File

@ -1 +0,0 @@
import{_ as s,a as i}from"./chunks/index.3b745ef0.js";import{_ as l,i as d}from"./chunks/index.9f7265df.js";import{o as c,c as h,G as a,B as n,b as r,V as t,z as e,a as o}from"./chunks/framework.7384f92b.js";const u=t("",4),_=e("p",null," This project is in active development. However, it is working for most users. ",-1),p=t("",5),m=e("p",null,[o(" Make sure you are using "),e("ins",{class:"text-red-400 dark:text-red-500"},"non-focused"),o(" emitters and at around "),e("ins",{class:"font-bold"},"5ma"),o(" total power. ")],-1),f=t("",9),b=t("",3),R=JSON.parse('{"title":"EyeTrackVR","description":"","frontmatter":{},"headers":[],"relativePath":"getting_started/intro.md","filePath":"getting_started/intro.md","lastUpdated":1689147044000}'),y={name:"getting_started/intro.md"},V=Object.assign(y,{setup(g){return(k,w)=>(c(),h("div",null,[u,a(s,{options:r(i).user_warning},{content:n(()=>[_]),_:1},8,["options"]),p,a(s,{options:r(i).led_power_warning},{content:n(()=>[m]),_:1},8,["options"]),f,a(l,{options:r(d).discord_content},null,8,["options"]),b]))}});export{R as __pageData,V as default};

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -6,10 +6,10 @@
<title>Pages | EyeTrackVR Docs</title>
<meta name="description" content="Official documentation for EyeTrackVR. Fully open-source and affordable VR eye tracking platform.">
<link rel="preload stylesheet" href="/assets/style.224ec70d.css" as="style">
<script type="module" src="/assets/app.926ec588.js"></script>
<script type="module" src="/assets/app.8c348910.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.2ed14f66.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.7384f92b.js">
<link rel="modulepreload" href="/assets/chunks/theme.d1f43b14.js">
<link rel="modulepreload" href="/assets/chunks/theme.02c6747e.js">
<link rel="modulepreload" href="/assets/development_docs_pages.md.a16f2e91.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>
@ -23,7 +23,7 @@
<span class="line"><span style="color:#F07178;"> </span><span style="color:#89DDFF;">{</span><span style="color:#F07178;"> text</span><span style="color:#89DDFF;">:</span><span style="color:#F07178;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">My Page</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">,</span><span style="color:#F07178;"> link</span><span style="color:#89DDFF;">:</span><span style="color:#F07178;"> </span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">/my_folder/my_page</span><span style="color:#89DDFF;">&quot;</span><span style="color:#F07178;"> </span><span style="color:#89DDFF;">},</span><span style="color:#F07178;"> </span><span style="color:#676E95;font-style:italic;">// Add this line - subdir then file</span></span>
<span class="line"><span style="color:#F07178;"> ]</span><span style="color:#89DDFF;">,</span></span>
<span class="line"><span style="color:#89DDFF;">},</span></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><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br></div></div><div class="info custom-block"><p class="custom-block-title">Note</p><p>The <code>link</code> property does not require a file extension. Please do not add it.</p></div><h3 class="text-[var(--font-accent)]" id="title-style" tabindex="-1">Title Style <a class="header-anchor" href="#title-style" aria-label="Permalink to &quot;Title Style {.text-[var(--font-accent)]}&quot;"></a></h3><p>The title style is the style of the title that appears at the top of the page.</p><p>We like to keep this cohesive, so please use the following style:</p><div class="language-md line-numbers-mode"><button title="Copy Code" class="copy"></button><span class="lang">md</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;"># </span><span style="color:#FFCB6B;">My Page {.text-</span><span style="color:#89DDFF;">[</span><span style="color:#C3E88D;">var(--font-accent)</span><span style="color:#89DDFF;">]</span><span style="color:#FFCB6B;">}</span></span></code></pre><div class="line-numbers-wrapper" aria-hidden="true"><span class="line-number">1</span><br></div></div><p>This will give the title a nice orange colour.</p><p>The <code>{}</code> are required, and the <code>.text-[#e67e22]</code> is the colour using <code>TailWindCSS</code> classes. You can also use our built in CSS variables <code>{.text-[var(--font-accent)]}</code>. You will find these in the <code>src/styles/theme.css</code> file. You can change this to any colour you like, but please keep it consistent with the rest of the site.</p><div class="tip custom-block"><p class="custom-block-title">Tip</p><p>This entire site supports <code>TailWindCSS</code> classes. You can find the documentation <a href="https://tailwindcss.com/docs" target="_blank" rel="noreferrer">here</a>.</p><p>All classes you wish to add, must be prefaced with a <code>.</code> when inside of the <code>{}</code>.</p><p>When using classes on <code>HTML</code> elements, you can use the <code>class</code> attribute. For example:</p><div class="language-html line-numbers-mode"><button title="Copy Code" class="copy"></button><span class="lang">html</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#89DDFF;">&lt;</span><span style="color:#F07178;">h1</span><span style="color:#89DDFF;"> </span><span style="color:#C792EA;">class</span><span style="color:#89DDFF;">=</span><span style="color:#89DDFF;">&quot;</span><span style="color:#C3E88D;">text-[#e67e22]</span><span style="color:#89DDFF;">&quot;</span><span style="color:#89DDFF;">&gt;</span><span style="color:#A6ACCD;">My Page</span><span style="color:#89DDFF;">&lt;/</span><span style="color:#F07178;">h1</span><span style="color:#89DDFF;">&gt;</span></span></code></pre><div class="line-numbers-wrapper" aria-hidden="true"><span class="line-number">1</span><br></div></div></div><h2 id="editing-a-page" tabindex="-1">Editing a Page <a class="header-anchor" href="#editing-a-page" aria-label="Permalink to &quot;Editing a Page&quot;"></a></h2><p>To edit a page, you will need to edit the Markdown file in the <code>vitepress/docs/src/pages</code> folder.</p></div></div></main><footer class="VPDocFooter" data-v-5aafa2ac data-v-31cb5067><!--[--><!--]--><div class="edit-info" data-v-31cb5067><!----><div class="last-updated" data-v-31cb5067><p class="VPLastUpdated" data-v-31cb5067 data-v-f00606ba>Last updated: <time datetime="2023-03-03T18:30:00.000Z" data-v-f00606ba></time></p></div></div><div class="prev-next" data-v-31cb5067><div class="pager" data-v-31cb5067><a class="pager-link prev" href="/development/docs/dev_docs" data-v-31cb5067><span class="desc" data-v-31cb5067>Previous page</span><span class="title" data-v-31cb5067>Docs</span></a></div><div class="has-prev pager" data-v-31cb5067><a class="pager-link next" href="/development/docs/standards" data-v-31cb5067><span class="desc" data-v-31cb5067>Next page</span><span class="title" data-v-31cb5067>Standards</span></a></div></div></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-bd8710d4 data-v-2425ede7><div class="container" data-v-2425ede7><p class="message" data-v-2425ede7>Released under the MIT License.</p><p class="copyright" data-v-2425ede7>Copyright © 2022-present ETVR</p></div></footer><!--[--><!--]--></div></div>
<script>__VP_HASH_MAP__ = JSON.parse("{\"development_docs_dev_docs.md\":\"129593e0\",\"firmware_guide_configure_firmware.md\":\"1156a298\",\"firmware_guide_mdns.md\":\"6911a871\",\"dev_roadmap.md\":\"1d67b1f2\",\"archive_fox_ir_v2_build_instructions.md\":\"4968d89f\",\"about.md\":\"9337080f\",\"index.md\":\"8a593e29\",\"how_to_build_parts_list.md\":\"79a4093c\",\"misc_faq.md\":\"bc5df512\",\"software_guide_build_software.md\":\"4d2a7ef2\",\"misc_vrc_avatar_setup.md\":\"fb8562d6\",\"development_docs_standards.md\":\"34f5cc0e\",\"firmware_guide_firmware.md\":\"2acb6454\",\"firmware_guide_upload_and_update_firmware.md\":\"72da2ad7\",\"getting_started_intro.md\":\"a1fa8a01\",\"how_to_build_creating_your_own_mount.md\":\"a0eff1b7\",\"how_to_build_full_build.md\":\"f2c25978\",\"firmware_guide_update_platformio.md\":\"9f4a42e7\",\"development_docs_pages.md\":\"a16f2e91\",\"firmware_guide_rest_api.md\":\"ab0c274d\",\"getting_started_things_to_know.md\":\"dd5287e8\",\"firmware_guide_environments.md\":\"a939c975\",\"contact.md\":\"8b34e956\",\"software_guide_eyetrackvr_app_guide.md\":\"dfcbc709\",\"firmware_guide_setup_vscode.md\":\"fbe684df\",\"software_guide_osc_setup.md\":\"a5e43cc8\"}")
<script>__VP_HASH_MAP__ = JSON.parse("{\"archive_fox_ir_v2_build_instructions.md\":\"4968d89f\",\"development_docs_standards.md\":\"34f5cc0e\",\"about.md\":\"21b61c72\",\"development_docs_pages.md\":\"a16f2e91\",\"dev_roadmap.md\":\"1d67b1f2\",\"contact.md\":\"8b34e956\",\"development_docs_dev_docs.md\":\"129593e0\",\"firmware_guide_mdns.md\":\"6911a871\",\"index.md\":\"8a593e29\",\"firmware_guide_environments.md\":\"a939c975\",\"firmware_guide_configure_firmware.md\":\"1156a298\",\"firmware_guide_firmware.md\":\"2acb6454\",\"firmware_guide_rest_api.md\":\"ab0c274d\",\"firmware_guide_setup_vscode.md\":\"5916e117\",\"software_guide_build_software.md\":\"4d2a7ef2\",\"getting_started_things_to_know.md\":\"dd5287e8\",\"software_guide_osc_setup.md\":\"a5e43cc8\",\"software_guide_eyetrackvr_app_guide.md\":\"dfcbc709\",\"firmware_guide_update_platformio.md\":\"9f4a42e7\",\"how_to_build_full_build.md\":\"f2c25978\",\"getting_started_intro.md\":\"413f3c40\",\"how_to_build_creating_your_own_mount.md\":\"a0eff1b7\",\"how_to_build_parts_list.md\":\"954cc6fc\",\"misc_faq.md\":\"bc5df512\",\"misc_vrc_avatar_setup.md\":\"fb8562d6\",\"firmware_guide_upload_and_update_firmware.md\":\"72da2ad7\"}")
__VP_SITE_DATA__ = JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"EyeTrackVR Docs\",\"description\":\"Official documentation for EyeTrackVR. Fully open-source and affordable VR eye tracking platform.\",\"base\":\"/\",\"head\":[],\"appearance\":true,\"themeConfig\":{\"logo\":{\"light\":\"/logo_light.png\",\"dark\":\"/logo.svg\",\"alt\":\"EyeTrackVR Logo\"},\"siteTitle\":\"EyeTrackVR Docs\",\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2022-present ETVR\"},\"nav\":[{\"text\":\"About\",\"items\":[{\"text\":\"About Us\",\"link\":\"/about\"},{\"text\":\"Development Road Map\",\"link\":\"/dev_roadmap\"}]},{\"text\":\"Contact\",\"link\":\"/contact\"}],\"sidebar\":[{\"text\":\"Getting Started\",\"collapsible\":true,\"items\":[{\"text\":\"Introduction\",\"link\":\"/getting_started/intro\"},{\"text\":\"Things to know before you start\",\"link\":\"/getting_started/things_to_know\"}]},{\"text\":\"How to Build\",\"collapsible\":true,\"items\":[{\"text\":\"Full Build Guide\",\"link\":\"/how_to_build/full_build\"},{\"text\":\"Part List\",\"link\":\"/how_to_build/parts_list\"},{\"text\":\"How to Create your own Camera Mount\",\"link\":\"/how_to_build/creating_your_own_mount\"}]},{\"text\":\"Firmware Guide\",\"collapsible\":true,\"items\":[{\"text\":\"Introduction\",\"link\":\"/firmware_guide/firmware\"},{\"text\":\"Setup Visual Studio Code environment\",\"link\":\"/firmware_guide/setup_vscode\"},{\"text\":\"Configuring Firmware\",\"link\":\"/firmware_guide/configure_firmware\"},{\"text\":\"Uploading and Updating the Firmware\",\"link\":\"/firmware_guide/upload_and_update_firmware\"},{\"text\":\"Updating PlatformIO\",\"link\":\"/firmware_guide/update_platformio\"},{\"text\":\"Firmware Environments\",\"link\":\"/firmware_guide/environments\"},{\"text\":\"MDNS\",\"link\":\"/firmware_guide/mdns\"},{\"text\":\"REST API\",\"link\":\"/firmware_guide/rest_api\"}]},{\"text\":\"Software Guide\",\"collapsible\":true,\"items\":[{\"text\":\"Installing and setting up the ETVR App\",\"link\":\"/software_guide/eyetrackvr_app_guide\"},{\"text\":\"Building the app from source\",\"link\":\"/software_guide/build_software\"},{\"text\":\"Setting up OSC recenter/recalibrate\",\"link\":\"/software_guide/osc_setup\"}]},{\"text\":\"Miscellaneous\",\"collapsible\":true,\"items\":[{\"text\":\"VR Chat Avatar Setup\",\"link\":\"/misc/vrc_avatar_setup\"},{\"text\":\"FAQ\",\"link\":\"/misc/faq\"}]},{\"text\":\"Development\",\"collapsible\":true,\"items\":[{\"text\":\"Docs\",\"link\":\"/development/docs/dev_docs\"},{\"text\":\"Edit Docs\",\"link\":\"/development/docs/pages\"},{\"text\":\"Standards\",\"link\":\"/development/docs/standards\"}]},{\"text\":\"Archive\",\"collapsible\":true,\"items\":[{\"text\":\"Prepare to solder IR LED PCB V2's\",\"link\":\"/archive/fox_ir_v2_build_instructions\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/EyeTrackVR/EyeTrackVR\"},{\"icon\":\"discord\",\"link\":\"https://discord.gg/kkXYbVykZX\"}]},\"locales\":{},\"scrollOffset\":90,\"cleanUrls\":true}")</script>
</body>

View File

@ -6,10 +6,10 @@
<title>Standards Guide | EyeTrackVR Docs</title>
<meta name="description" content="Official documentation for EyeTrackVR. Fully open-source and affordable VR eye tracking platform.">
<link rel="preload stylesheet" href="/assets/style.224ec70d.css" as="style">
<script type="module" src="/assets/app.926ec588.js"></script>
<script type="module" src="/assets/app.8c348910.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.2ed14f66.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.7384f92b.js">
<link rel="modulepreload" href="/assets/chunks/theme.d1f43b14.js">
<link rel="modulepreload" href="/assets/chunks/theme.02c6747e.js">
<link rel="modulepreload" href="/assets/development_docs_standards.md.34f5cc0e.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>
@ -23,7 +23,7 @@
<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></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-5aafa2ac data-v-31cb5067><!--[--><!--]--><div class="edit-info" data-v-31cb5067><!----><div class="last-updated" data-v-31cb5067><p class="VPLastUpdated" data-v-31cb5067 data-v-f00606ba>Last updated: <time datetime="2023-03-03T18:30:00.000Z" data-v-f00606ba></time></p></div></div><div class="prev-next" data-v-31cb5067><div class="pager" data-v-31cb5067><a class="pager-link prev" href="/development/docs/pages" data-v-31cb5067><span class="desc" data-v-31cb5067>Previous page</span><span class="title" data-v-31cb5067>Edit Docs</span></a></div><div class="has-prev pager" data-v-31cb5067><a class="pager-link next" href="/archive/fox_ir_v2_build_instructions" data-v-31cb5067><span class="desc" data-v-31cb5067>Next page</span><span class="title" data-v-31cb5067>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-bd8710d4 data-v-2425ede7><div class="container" data-v-2425ede7><p class="message" data-v-2425ede7>Released under the MIT License.</p><p class="copyright" data-v-2425ede7>Copyright © 2022-present ETVR</p></div></footer><!--[--><!--]--></div></div>
<script>__VP_HASH_MAP__ = JSON.parse("{\"development_docs_dev_docs.md\":\"129593e0\",\"firmware_guide_configure_firmware.md\":\"1156a298\",\"firmware_guide_mdns.md\":\"6911a871\",\"dev_roadmap.md\":\"1d67b1f2\",\"archive_fox_ir_v2_build_instructions.md\":\"4968d89f\",\"about.md\":\"9337080f\",\"index.md\":\"8a593e29\",\"how_to_build_parts_list.md\":\"79a4093c\",\"misc_faq.md\":\"bc5df512\",\"software_guide_build_software.md\":\"4d2a7ef2\",\"misc_vrc_avatar_setup.md\":\"fb8562d6\",\"development_docs_standards.md\":\"34f5cc0e\",\"firmware_guide_firmware.md\":\"2acb6454\",\"firmware_guide_upload_and_update_firmware.md\":\"72da2ad7\",\"getting_started_intro.md\":\"a1fa8a01\",\"how_to_build_creating_your_own_mount.md\":\"a0eff1b7\",\"how_to_build_full_build.md\":\"f2c25978\",\"firmware_guide_update_platformio.md\":\"9f4a42e7\",\"development_docs_pages.md\":\"a16f2e91\",\"firmware_guide_rest_api.md\":\"ab0c274d\",\"getting_started_things_to_know.md\":\"dd5287e8\",\"firmware_guide_environments.md\":\"a939c975\",\"contact.md\":\"8b34e956\",\"software_guide_eyetrackvr_app_guide.md\":\"dfcbc709\",\"firmware_guide_setup_vscode.md\":\"fbe684df\",\"software_guide_osc_setup.md\":\"a5e43cc8\"}")
<script>__VP_HASH_MAP__ = JSON.parse("{\"archive_fox_ir_v2_build_instructions.md\":\"4968d89f\",\"development_docs_standards.md\":\"34f5cc0e\",\"about.md\":\"21b61c72\",\"development_docs_pages.md\":\"a16f2e91\",\"dev_roadmap.md\":\"1d67b1f2\",\"contact.md\":\"8b34e956\",\"development_docs_dev_docs.md\":\"129593e0\",\"firmware_guide_mdns.md\":\"6911a871\",\"index.md\":\"8a593e29\",\"firmware_guide_environments.md\":\"a939c975\",\"firmware_guide_configure_firmware.md\":\"1156a298\",\"firmware_guide_firmware.md\":\"2acb6454\",\"firmware_guide_rest_api.md\":\"ab0c274d\",\"firmware_guide_setup_vscode.md\":\"5916e117\",\"software_guide_build_software.md\":\"4d2a7ef2\",\"getting_started_things_to_know.md\":\"dd5287e8\",\"software_guide_osc_setup.md\":\"a5e43cc8\",\"software_guide_eyetrackvr_app_guide.md\":\"dfcbc709\",\"firmware_guide_update_platformio.md\":\"9f4a42e7\",\"how_to_build_full_build.md\":\"f2c25978\",\"getting_started_intro.md\":\"413f3c40\",\"how_to_build_creating_your_own_mount.md\":\"a0eff1b7\",\"how_to_build_parts_list.md\":\"954cc6fc\",\"misc_faq.md\":\"bc5df512\",\"misc_vrc_avatar_setup.md\":\"fb8562d6\",\"firmware_guide_upload_and_update_firmware.md\":\"72da2ad7\"}")
__VP_SITE_DATA__ = JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"EyeTrackVR Docs\",\"description\":\"Official documentation for EyeTrackVR. Fully open-source and affordable VR eye tracking platform.\",\"base\":\"/\",\"head\":[],\"appearance\":true,\"themeConfig\":{\"logo\":{\"light\":\"/logo_light.png\",\"dark\":\"/logo.svg\",\"alt\":\"EyeTrackVR Logo\"},\"siteTitle\":\"EyeTrackVR Docs\",\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2022-present ETVR\"},\"nav\":[{\"text\":\"About\",\"items\":[{\"text\":\"About Us\",\"link\":\"/about\"},{\"text\":\"Development Road Map\",\"link\":\"/dev_roadmap\"}]},{\"text\":\"Contact\",\"link\":\"/contact\"}],\"sidebar\":[{\"text\":\"Getting Started\",\"collapsible\":true,\"items\":[{\"text\":\"Introduction\",\"link\":\"/getting_started/intro\"},{\"text\":\"Things to know before you start\",\"link\":\"/getting_started/things_to_know\"}]},{\"text\":\"How to Build\",\"collapsible\":true,\"items\":[{\"text\":\"Full Build Guide\",\"link\":\"/how_to_build/full_build\"},{\"text\":\"Part List\",\"link\":\"/how_to_build/parts_list\"},{\"text\":\"How to Create your own Camera Mount\",\"link\":\"/how_to_build/creating_your_own_mount\"}]},{\"text\":\"Firmware Guide\",\"collapsible\":true,\"items\":[{\"text\":\"Introduction\",\"link\":\"/firmware_guide/firmware\"},{\"text\":\"Setup Visual Studio Code environment\",\"link\":\"/firmware_guide/setup_vscode\"},{\"text\":\"Configuring Firmware\",\"link\":\"/firmware_guide/configure_firmware\"},{\"text\":\"Uploading and Updating the Firmware\",\"link\":\"/firmware_guide/upload_and_update_firmware\"},{\"text\":\"Updating PlatformIO\",\"link\":\"/firmware_guide/update_platformio\"},{\"text\":\"Firmware Environments\",\"link\":\"/firmware_guide/environments\"},{\"text\":\"MDNS\",\"link\":\"/firmware_guide/mdns\"},{\"text\":\"REST API\",\"link\":\"/firmware_guide/rest_api\"}]},{\"text\":\"Software Guide\",\"collapsible\":true,\"items\":[{\"text\":\"Installing and setting up the ETVR App\",\"link\":\"/software_guide/eyetrackvr_app_guide\"},{\"text\":\"Building the app from source\",\"link\":\"/software_guide/build_software\"},{\"text\":\"Setting up OSC recenter/recalibrate\",\"link\":\"/software_guide/osc_setup\"}]},{\"text\":\"Miscellaneous\",\"collapsible\":true,\"items\":[{\"text\":\"VR Chat Avatar Setup\",\"link\":\"/misc/vrc_avatar_setup\"},{\"text\":\"FAQ\",\"link\":\"/misc/faq\"}]},{\"text\":\"Development\",\"collapsible\":true,\"items\":[{\"text\":\"Docs\",\"link\":\"/development/docs/dev_docs\"},{\"text\":\"Edit Docs\",\"link\":\"/development/docs/pages\"},{\"text\":\"Standards\",\"link\":\"/development/docs/standards\"}]},{\"text\":\"Archive\",\"collapsible\":true,\"items\":[{\"text\":\"Prepare to solder IR LED PCB V2's\",\"link\":\"/archive/fox_ir_v2_build_instructions\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/EyeTrackVR/EyeTrackVR\"},{\"icon\":\"discord\",\"link\":\"https://discord.gg/kkXYbVykZX\"}]},\"locales\":{},\"scrollOffset\":90,\"cleanUrls\":true}")</script>
</body>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -6,10 +6,10 @@
<title>REST API | EyeTrackVR Docs</title>
<meta name="description" content="Official documentation for EyeTrackVR. Fully open-source and affordable VR eye tracking platform.">
<link rel="preload stylesheet" href="/assets/style.224ec70d.css" as="style">
<script type="module" src="/assets/app.926ec588.js"></script>
<script type="module" src="/assets/app.8c348910.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.2ed14f66.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.7384f92b.js">
<link rel="modulepreload" href="/assets/chunks/theme.d1f43b14.js">
<link rel="modulepreload" href="/assets/chunks/theme.02c6747e.js">
<link rel="modulepreload" href="/assets/firmware_guide_rest_api.md.ab0c274d.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>
@ -41,7 +41,7 @@
<span class="line"><span style="color:#F07178;"> </span><span style="color:#A6ACCD;">WIFI_POWER_2dBm</span><span style="color:#F07178;"> </span><span style="color:#89DDFF;">=</span><span style="color:#F07178;"> </span><span style="color:#F78C6C;">8</span><span style="color:#89DDFF;">,</span><span style="color:#676E95;font-style:italic;">// 2dBm</span></span>
<span class="line"><span style="color:#F07178;"> </span><span style="color:#A6ACCD;">WIFI_POWER_MINUS_1dBm</span><span style="color:#F07178;"> </span><span style="color:#89DDFF;">=</span><span style="color:#F07178;"> </span><span style="color:#89DDFF;">-</span><span style="color:#F78C6C;">4</span><span style="color:#676E95;font-style:italic;">// -1dBm</span></span>
<span class="line"><span style="color:#89DDFF;">}</span><span style="color:#F07178;"> </span><span style="color:#FFCB6B;">wifi_power_t</span><span style="color:#89DDFF;">;</span></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><span class="line-number">6</span><br><span class="line-number">7</span><br><span class="line-number">8</span><br><span class="line-number">9</span><br><span class="line-number">10</span><br><span class="line-number">11</span><br><span class="line-number">12</span><br><span class="line-number">13</span><br><span class="line-number">14</span><br></div></div></div><table><thead><tr><th style="text-align:center;">Param</th><th style="text-align:center;">Description</th></tr></thead><tbody><tr><td style="text-align:center;"><code>txPower</code></td><td style="text-align:center;">The power level to set.</td></tr></tbody></table><h3 id="camera-params" tabindex="-1">Camera Params <a class="header-anchor" href="#camera-params" aria-label="Permalink to &quot;Camera Params&quot;"></a></h3><div class="tip custom-block"><p class="custom-block-title">Coming Soon</p><p>We are currently working on this section of documentation.</p></div></div></div></main><footer class="VPDocFooter" data-v-5aafa2ac data-v-31cb5067><!--[--><!--]--><div class="edit-info" data-v-31cb5067><!----><div class="last-updated" data-v-31cb5067><p class="VPLastUpdated" data-v-31cb5067 data-v-f00606ba>Last updated: <time datetime="2023-02-12T17:42:09.000Z" data-v-f00606ba></time></p></div></div><div class="prev-next" data-v-31cb5067><div class="pager" data-v-31cb5067><a class="pager-link prev" href="/firmware_guide/mdns" data-v-31cb5067><span class="desc" data-v-31cb5067>Previous page</span><span class="title" data-v-31cb5067>MDNS</span></a></div><div class="has-prev pager" data-v-31cb5067><a class="pager-link next" href="/software_guide/eyetrackvr_app_guide" data-v-31cb5067><span class="desc" data-v-31cb5067>Next page</span><span class="title" data-v-31cb5067>Installing and setting up the ETVR App</span></a></div></div></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-bd8710d4 data-v-2425ede7><div class="container" data-v-2425ede7><p class="message" data-v-2425ede7>Released under the MIT License.</p><p class="copyright" data-v-2425ede7>Copyright © 2022-present ETVR</p></div></footer><!--[--><!--]--></div></div>
<script>__VP_HASH_MAP__ = JSON.parse("{\"development_docs_dev_docs.md\":\"129593e0\",\"firmware_guide_configure_firmware.md\":\"1156a298\",\"firmware_guide_mdns.md\":\"6911a871\",\"dev_roadmap.md\":\"1d67b1f2\",\"archive_fox_ir_v2_build_instructions.md\":\"4968d89f\",\"about.md\":\"9337080f\",\"index.md\":\"8a593e29\",\"how_to_build_parts_list.md\":\"79a4093c\",\"misc_faq.md\":\"bc5df512\",\"software_guide_build_software.md\":\"4d2a7ef2\",\"misc_vrc_avatar_setup.md\":\"fb8562d6\",\"development_docs_standards.md\":\"34f5cc0e\",\"firmware_guide_firmware.md\":\"2acb6454\",\"firmware_guide_upload_and_update_firmware.md\":\"72da2ad7\",\"getting_started_intro.md\":\"a1fa8a01\",\"how_to_build_creating_your_own_mount.md\":\"a0eff1b7\",\"how_to_build_full_build.md\":\"f2c25978\",\"firmware_guide_update_platformio.md\":\"9f4a42e7\",\"development_docs_pages.md\":\"a16f2e91\",\"firmware_guide_rest_api.md\":\"ab0c274d\",\"getting_started_things_to_know.md\":\"dd5287e8\",\"firmware_guide_environments.md\":\"a939c975\",\"contact.md\":\"8b34e956\",\"software_guide_eyetrackvr_app_guide.md\":\"dfcbc709\",\"firmware_guide_setup_vscode.md\":\"fbe684df\",\"software_guide_osc_setup.md\":\"a5e43cc8\"}")
<script>__VP_HASH_MAP__ = JSON.parse("{\"archive_fox_ir_v2_build_instructions.md\":\"4968d89f\",\"development_docs_standards.md\":\"34f5cc0e\",\"about.md\":\"21b61c72\",\"development_docs_pages.md\":\"a16f2e91\",\"dev_roadmap.md\":\"1d67b1f2\",\"contact.md\":\"8b34e956\",\"development_docs_dev_docs.md\":\"129593e0\",\"firmware_guide_mdns.md\":\"6911a871\",\"index.md\":\"8a593e29\",\"firmware_guide_environments.md\":\"a939c975\",\"firmware_guide_configure_firmware.md\":\"1156a298\",\"firmware_guide_firmware.md\":\"2acb6454\",\"firmware_guide_rest_api.md\":\"ab0c274d\",\"firmware_guide_setup_vscode.md\":\"5916e117\",\"software_guide_build_software.md\":\"4d2a7ef2\",\"getting_started_things_to_know.md\":\"dd5287e8\",\"software_guide_osc_setup.md\":\"a5e43cc8\",\"software_guide_eyetrackvr_app_guide.md\":\"dfcbc709\",\"firmware_guide_update_platformio.md\":\"9f4a42e7\",\"how_to_build_full_build.md\":\"f2c25978\",\"getting_started_intro.md\":\"413f3c40\",\"how_to_build_creating_your_own_mount.md\":\"a0eff1b7\",\"how_to_build_parts_list.md\":\"954cc6fc\",\"misc_faq.md\":\"bc5df512\",\"misc_vrc_avatar_setup.md\":\"fb8562d6\",\"firmware_guide_upload_and_update_firmware.md\":\"72da2ad7\"}")
__VP_SITE_DATA__ = JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"EyeTrackVR Docs\",\"description\":\"Official documentation for EyeTrackVR. Fully open-source and affordable VR eye tracking platform.\",\"base\":\"/\",\"head\":[],\"appearance\":true,\"themeConfig\":{\"logo\":{\"light\":\"/logo_light.png\",\"dark\":\"/logo.svg\",\"alt\":\"EyeTrackVR Logo\"},\"siteTitle\":\"EyeTrackVR Docs\",\"footer\":{\"message\":\"Released under the MIT License.\",\"copyright\":\"Copyright © 2022-present ETVR\"},\"nav\":[{\"text\":\"About\",\"items\":[{\"text\":\"About Us\",\"link\":\"/about\"},{\"text\":\"Development Road Map\",\"link\":\"/dev_roadmap\"}]},{\"text\":\"Contact\",\"link\":\"/contact\"}],\"sidebar\":[{\"text\":\"Getting Started\",\"collapsible\":true,\"items\":[{\"text\":\"Introduction\",\"link\":\"/getting_started/intro\"},{\"text\":\"Things to know before you start\",\"link\":\"/getting_started/things_to_know\"}]},{\"text\":\"How to Build\",\"collapsible\":true,\"items\":[{\"text\":\"Full Build Guide\",\"link\":\"/how_to_build/full_build\"},{\"text\":\"Part List\",\"link\":\"/how_to_build/parts_list\"},{\"text\":\"How to Create your own Camera Mount\",\"link\":\"/how_to_build/creating_your_own_mount\"}]},{\"text\":\"Firmware Guide\",\"collapsible\":true,\"items\":[{\"text\":\"Introduction\",\"link\":\"/firmware_guide/firmware\"},{\"text\":\"Setup Visual Studio Code environment\",\"link\":\"/firmware_guide/setup_vscode\"},{\"text\":\"Configuring Firmware\",\"link\":\"/firmware_guide/configure_firmware\"},{\"text\":\"Uploading and Updating the Firmware\",\"link\":\"/firmware_guide/upload_and_update_firmware\"},{\"text\":\"Updating PlatformIO\",\"link\":\"/firmware_guide/update_platformio\"},{\"text\":\"Firmware Environments\",\"link\":\"/firmware_guide/environments\"},{\"text\":\"MDNS\",\"link\":\"/firmware_guide/mdns\"},{\"text\":\"REST API\",\"link\":\"/firmware_guide/rest_api\"}]},{\"text\":\"Software Guide\",\"collapsible\":true,\"items\":[{\"text\":\"Installing and setting up the ETVR App\",\"link\":\"/software_guide/eyetrackvr_app_guide\"},{\"text\":\"Building the app from source\",\"link\":\"/software_guide/build_software\"},{\"text\":\"Setting up OSC recenter/recalibrate\",\"link\":\"/software_guide/osc_setup\"}]},{\"text\":\"Miscellaneous\",\"collapsible\":true,\"items\":[{\"text\":\"VR Chat Avatar Setup\",\"link\":\"/misc/vrc_avatar_setup\"},{\"text\":\"FAQ\",\"link\":\"/misc/faq\"}]},{\"text\":\"Development\",\"collapsible\":true,\"items\":[{\"text\":\"Docs\",\"link\":\"/development/docs/dev_docs\"},{\"text\":\"Edit Docs\",\"link\":\"/development/docs/pages\"},{\"text\":\"Standards\",\"link\":\"/development/docs/standards\"}]},{\"text\":\"Archive\",\"collapsible\":true,\"items\":[{\"text\":\"Prepare to solder IR LED PCB V2's\",\"link\":\"/archive/fox_ir_v2_build_instructions\"}]}],\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/EyeTrackVR/EyeTrackVR\"},{\"icon\":\"discord\",\"link\":\"https://discord.gg/kkXYbVykZX\"}]},\"locales\":{},\"scrollOffset\":90,\"cleanUrls\":true}")</script>
</body>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -1 +1 @@
{"development_docs_dev_docs.md":"129593e0","firmware_guide_configure_firmware.md":"1156a298","firmware_guide_mdns.md":"6911a871","dev_roadmap.md":"1d67b1f2","archive_fox_ir_v2_build_instructions.md":"4968d89f","about.md":"9337080f","index.md":"8a593e29","how_to_build_parts_list.md":"79a4093c","misc_faq.md":"bc5df512","software_guide_build_software.md":"4d2a7ef2","misc_vrc_avatar_setup.md":"fb8562d6","development_docs_standards.md":"34f5cc0e","firmware_guide_firmware.md":"2acb6454","firmware_guide_upload_and_update_firmware.md":"72da2ad7","getting_started_intro.md":"a1fa8a01","how_to_build_creating_your_own_mount.md":"a0eff1b7","how_to_build_full_build.md":"f2c25978","firmware_guide_update_platformio.md":"9f4a42e7","development_docs_pages.md":"a16f2e91","firmware_guide_rest_api.md":"ab0c274d","getting_started_things_to_know.md":"dd5287e8","firmware_guide_environments.md":"a939c975","contact.md":"8b34e956","software_guide_eyetrackvr_app_guide.md":"dfcbc709","firmware_guide_setup_vscode.md":"fbe684df","software_guide_osc_setup.md":"a5e43cc8"}
{"archive_fox_ir_v2_build_instructions.md":"4968d89f","development_docs_standards.md":"34f5cc0e","about.md":"21b61c72","development_docs_pages.md":"a16f2e91","dev_roadmap.md":"1d67b1f2","contact.md":"8b34e956","development_docs_dev_docs.md":"129593e0","firmware_guide_mdns.md":"6911a871","index.md":"8a593e29","firmware_guide_environments.md":"a939c975","firmware_guide_configure_firmware.md":"1156a298","firmware_guide_firmware.md":"2acb6454","firmware_guide_rest_api.md":"ab0c274d","firmware_guide_setup_vscode.md":"5916e117","software_guide_build_software.md":"4d2a7ef2","getting_started_things_to_know.md":"dd5287e8","software_guide_osc_setup.md":"a5e43cc8","software_guide_eyetrackvr_app_guide.md":"dfcbc709","firmware_guide_update_platformio.md":"9f4a42e7","how_to_build_full_build.md":"f2c25978","getting_started_intro.md":"413f3c40","how_to_build_creating_your_own_mount.md":"a0eff1b7","how_to_build_parts_list.md":"954cc6fc","misc_faq.md":"bc5df512","misc_vrc_avatar_setup.md":"fb8562d6","firmware_guide_upload_and_update_firmware.md":"72da2ad7"}

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long