Skip to main content Link Search Menu Expand Document (external link)
SlimeVR Docs

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

img

Install

img

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.

img

3. Install device drivers

Please note: these drivers will be automatically installed if you download and run the SlimeVR server.

For CH340 (NodeMCU v3, Wemos D1 Mini and review units of SlimeVR)

Download the CH341SER.EXE file from here, run it and follow installation instructions.

img

For CP210X (NodeMCU v2)

  1. Download the zip archive with the drivers from silicon labs here.

    For any other OS, the drivers can be found here.

  2. Extract the files from the downloaded zip archive, then launch CP210xVCPInstaller_x64.exe (CP210xVCPInstaller_x86.exe if you are using 32-bit Windows) and follow installation instructions.

4. Install git client

For Windows, you can download and install Git for Windows. If you have other OS, visit https://git-scm.com/downloads.

Note: you will most likely have to click “Click here to download manually”. If that doesn’t work, you can try here.

img

5. 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. Click the Source Control button, click on Clone Repository and enter: https://github.com/SlimeVR/SlimeVR-Tracker-ESP.git. If you’re using experimental MPU+QMC5883L trackers, you would instead clone https://github.com/deiteris/SlimeVR-Tracker-ESP.git.

    If you installed git while Visual Studio Code was open you may have to close it and re-open it first.

    img

  2. Once you have chosen a download location click the Open button that appears at the bottom right.

    img

  3. Click Yes, I trust the authors.

    img

  4. (MPU+QMC5883L only) Click the Source Control button, click on main and choose either qmc-mag-new or hmc-mag from the dropdown depending on whether you’re using a QMC5883L or an HMC5883L.

    img

Next step - Configuring and building the firmware project