Documentation

From The Relativty Wiki

Other languages:

Welcome


Welcome to the Relativty documentation! On this page, you will find the complete documentation to build, and setup your own VR headset!


PLEASE NOTE; We highly recommend that you use the STM32 tracker because it has proved to be more stable than the Due based one. The Due code has recently been reported to throw compiler errors, and the Due trackers have exhibited stability issues. Because of this, we will be phasing out support for the Arduino DUE code in the next couple of months. (NOTE added on Apr 17, 2019)



before we start

Recommended computer specs

Recommended computer specs
Processor Intel Core i5 2500 or AMD Ryzen 5 2600, equilevant or better
Graphics NVIDIA GeForce GTX960 or AMD RX470, equivalent or better
Memory 4GB RAM or more
Video output 1x HDMI 1.4 port
USB 2x USB port

Needed Hardware

Before you can start building your own Relativty VR headset, you will need the following parts;

Needed hardware
Arduino DUE
MPU6050
5.5 inch 2K screen
3D printed parts

Needed Software

To get data output for our VR headset, and to make it compitable with SteamVR, we will need some software. Here are the links to the sites where you can download the needed software.

Arduino IDE
Redirects you to the Arduino website, where you can download the IDE.
Download Relativty Github
This downloads the Arduino code and the 3D models.
Download OSVR
Redirects you to the website, where you can download OSVR.
Downlaod OSVR plugin github
This downloads the files to make OSVR compitable with Relativ.

Documentation

Connecting the hardware (part 1)

The Schematics to connect your VR headset.

We will start with conecting all the components of our VR headset. The first thing we will do is connecting our MPU6050 to our Arduino DUE, following this schematic;

Schematic
VCC 5V
GND GND
SCL 21 (SCL)
SDA 20 (SDA)
INT 2

Now, we have connected our MPU6050 to our Arduino DUE, we can connect our Arduino to our computer, using the programming port. For uploading the sketch, we dont make use of the native USB port!

We dont have to connect our screen yet, we first need to upload our program to our Arduino DUE, and make sure it is working.


Uploading the sketch

The first step is importing our downloaded Arduino libraries. We need to move the downloaded libraries from \Relativ-master\src\libraries to Documents\Arduino\libraries\.

After uploading our libraries, we can open the main.ino file, wich we can find in \Relativ-master\src\main.
This should automatically open the Arduino IDE.

Before we can upload our sketch to our Arduino board, we need to make sure we have installed, and selected the rigth board in our Arduino software. To do this, we have to go to Tools - Boards manager. Search here for Arduino DUE, and install the package.

How a succesfull upload should look like

Now, we can go to Tools - Boards, and select the Arduino DUE (programming port). When you have done this, you can go to Tools - Port, and select your connected Arduino board.

When you have done all above steps, you should be able to upload the sketch to your arduino board! You can do this by pressing the button with the right arrow in it.

If your sketch is uploaded succesfully, you should see this in the console of the Arduino IDE (see image on the right);

After uploading your code, you will need to disconnect your Arduino, and reconnect it on the Native USB port!

Testing

Before we continue with building, and setting up our VR headset, we will frist test our MPU6050, to make sure that it is connected correctly, and everything is working.

We can check this, by opening the Serial Monitor. (Make sure your Arduino Due is connected on the Native USB port!)

We can open our Serial monitor in the following ways; Tools - Serial Monitor Ctrl+Shift+M Before the Serial monitor will display something / the correct data, we will need to set it to 250.000 baud.

If everything is connected good, and you had uploaded your sketch without a error, we should see a lot of numbers in the serial monitor.

Setting up SteamVR

Before we start setting up OSVR, we will setup SteamVR. This is a easy, and simple step. We will have to copy all the files from
relativ-osvr-plugin/SteamVR
and paste them in the drivers folder of your Steam directory
(PATH_TO_STEAM/Steam/steamapps/common/SteamVR/drivers)

Setting up OSVR

Before you continue, we assume you have downloaded OSVR, and the OSVR drivers, as mentioned in the "Needed Software".

We will start with setting up the config files. To do this, copy the files from relativ-osvr-plugin/OSVR/Configs, and paste them in the 'displays' folder in the OSVR directory (PATH_TO_OSVR/OSVR/Runtime/bin/displays).

Now, we have have completed the Configs, we will do the Displays. We need to copy the files from relativ-osvr-plugin/OSVR/Displays, to the 'displays' folder in our OSVR directory. (PATH_TO_OSVR/OSVR/Runtime/bin/displays)

Last, but not least, we will do the plugins. We will have to copy the plugin files from relativ-osvr-plugin/OSVR/Displays, to the 'displays' folder in your OSVR directory. (PATH_TO_OSVR/OSVR/Runtime/bin/osvr-plugin-0)

Changing the COM port

To get movement on your VR headset, OSVR will need to get the input from your Arduino board. To get this input, OSVR needs to know on wich COM port your Arduino is connected.

How to check your COM port;
Arduino IDE
Tools > Ports Here you can find your connected Arduino board(s), and its COM port.
Device Manager
1. Open Device Manager:
Click; Start > Control Panel > Hardware and Sound > Device Manager (under "Devices and Printers")
2. In the Device Manager list, look in ports, and find your Arduino board.

You can find the COM port of your OSVR in the config file. (osvr_server_config.json) make sure it matches the COM port of your Arduino board, because OSVR wont work otherwise!

Screen Configuration

Please make sure you have only two screens connected! (your main screen, and the screen of your VR headset.) Your VR headset screen must be at the right of main screen, and must be aligned with the top border of the main screen.

The Schematics to connect your VR headset.

Connecting the hardware (part 2)

Well done, you have setup your Arduino DUE, and MPU6050! Now, we will connect our screen to our PC, using a HDMI, and USB cable.

Your screen should automatically turn on when you connect it to the power (the USB cable).

Relativ and OSVR

Well, it is time to startup your Relativ headset for the first time!

To do this, we need to start 'osvr_server.exe'. You can find this in FOLDER_TO_OSVR/OSVR/bin/osvr_server.exe

This window should appear: (see image 1)

Now, we can start SteamVR. A little SteamVR windows should appear: (see image 2)

Have fun playing SteamVR games with your headset!