EyeTrackVR-Docs/docs/_pages/Setup_Visual_Studio.md
2022-12-29 12:22:03 -08:00

2.8 KiB

layout title nav_order permalink parent
page Setup Visual Studio Code environment 1 /setting-up-firmware-enviroment/ Firmware Guide

Setting up the environment

This procedure will show how to prepare your system for uploading the firmware to your tracker.

1. Install Visual Studio Code

Download the latest Visual Studio Code and install it.

Download

{% include custom/images/image_2.html url="https://i.imgur.com/jXPXIFz.gif" max-width="500" caption="" alt="" %}

Install

{% include custom/images/image_2.html url="https://i.imgur.com/hAm3Zu0.gif" max-width="500" caption="" alt="" %}

2. Install PlatformIO IDE

Once Visual Studio Code is installed, open it and install PlatformIO IDE for VSCode, an extension that will allow you to connect to the tracker, build and upload the firmware.

{% include custom/images/image_2.html url="https://i.imgur.com/ebV0IgT.gif" max-width="500" caption="" alt="" %}

3. Clone the firmware project

Make sure you close any current projects you have open or open a new window before moving forward with these steps.

  1. Go to https://github.com/lorow/OpenIris and clone the latest version from the main branch.

    1. If you do not have git installed please install it from here.

    2. Open Git Bash. {% include custom/images/image_2.html url="https://i.imgur.com/DWO5vkE.png" max-width="500" caption="" alt="" %}

    3. Change the directory to the directory that you want the firmware to be cloned. Ex: cd C:\ {% include custom/images/image_2.html url="https://i.imgur.com/mWAVxtF.png" max-width="500" caption="" alt="" %}

    4. Clone the repository by entering the command: git clone https://github.com/lorow/OpenIris.git {% include custom/images/image_2.html url="https://i.imgur.com/YbXpX7t.png" max-width="500" caption="" alt="" %}

    For more info about cloning please refer to this documentation

    Do not download as a zip - 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.

  2. Open the firmware in VSCode by going to PlatformIO, selecting open, then navigating to OpenIris/ESP folder and opening it.

{% include custom/images/image_2.html url="https://i.imgur.com/c61Cpaz.gif" max-width="500" caption="" alt="" %}

This is an adaptation from SlimeVR. Credit goes to the SlimeVR team adapted from here