Skip to content

Commit 381f143

Browse files
Amelia-bunDepactShineBrightMeow
authored
Update Glossary
* Expanded Glossary.md Added definitions for drift, breakout boards, and IMU. Redefined mounting reset as mounting calibration and feet mounting calibration as per the most recent server update. Fixed various items being in the wrong location. Clarified certain other points. * Update src/glossary.md Co-authored-by: Depact <[email protected]> * Edited glossary.md Clarified that Ibis reference was for the Ibis form factor, not the Ibis V2 tracker * docs: PR Clean-up --------- Co-authored-by: Depact <[email protected]> Co-authored-by: ShineBrightMeow <[email protected]>
1 parent 0d09271 commit 381f143

File tree

1 file changed

+59
-24
lines changed

1 file changed

+59
-24
lines changed

src/glossary.md

Lines changed: 59 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
11
# SlimeVR Terminology / Glossary
2+
```admonish warning
3+
Definitions provided in this page are relative to their use in this documentation and for SlimeVR. They may be inaccurate or lack information relative to other, non-SlimeVR projects.
4+
```
5+
## Table Of Contents
26

3-
- [SlimeVR Server](#slimevr-server)
4-
- [SlimeVR GUI](#slimevr-gui)
5-
- [SteamVR Driver](#steamvr-driver)
6-
- [Feeder App](#feeder-app)
7-
- [Session Calibration](#session-calibration)
8-
- [Full Reset](#full-reset)
9-
- [Yaw Reset](#yaw-reset)
10-
- [Mounting Reset](#mounting-reset)
11-
- [Mounting Orientation](#mounting-orientation)
12-
- [VR Headset](#vr-headset)
13-
- [Smol Slime](#smol-slime)
7+
- TOC
8+
{:toc}
149

1510
## SlimeVR Server
1611

@@ -63,36 +58,58 @@ It is a common misconception that the feeder app also forwards the [VR Headset](
6358

6459
- [SlimeVR Server](#slimevr-server)
6560

61+
## Drift
62+
Commonly used to describe the loss of tracking accuracy that an [IMU](#imu)-based tracker experiences due to the accumulation of error over time. A tracker with high drift experiences a noticeable loss of accuracy within 20 minutes. Drift is also commonly measured as degrees per hour—with 1-3 degrees per hour being an acceptable level of drift for modern SlimeVR trackers at the time of writing.
63+
64+
Note that drift refers to the *gradual* loss of tracking accuracy and is inherent to the tracker itself. Poor [Mounting Orientation](#mounting-orientation) [Session Calibration](#session-calibration) by the user will lead to a constant level of tracking inaccuracy.
65+
66+
### Synonyms {#drift-synonyms}
67+
- Tracking accuracy
68+
- IMU accuracy
69+
70+
### Related Terms {#drift-related}
71+
- Accelerometer
72+
- Gyroscope
73+
- Magnetometer
74+
- [IMU](#imu)
75+
- Stay Aligned
76+
6677
## Session Calibration
6778

6879
There are multiple different session calibrations within the SlimeVR Server; these are commonly referred to as "resets". These are forms of calibration that are generally not saved and need to be done during each session of SlimeVR. See the [Sub-Terms](#session-calibration-sub-terms) for the types of session calibrations.
6980

7081
### Synonyms {#session-calibration-synonyms}
7182

72-
- Resets (Full Reset; Mounting Reset; Feet Mounting Reset)
83+
- Full Reset
84+
- Mounting Calibration
85+
- Feet Mounting Calibration
7386
- Software Calibration
7487
- VRChat Calibration
7588

7689
### Sub-Terms {#session-calibration-sub}
7790

7891
- [Yaw Reset](#yaw-reset)
79-
- [Mounting Reset](#mounting-reset)
92+
- [Mounting Calibration](#mounting-calibration)
8093

8194
## Full Reset
8295

8396
A "full reset" is a [Session Calibration](#session-calibration) that re-orients trackers to have zero rotation in the pitch and roll axes and have the same yaw axis rotation as the head tracker (usually a [VR Headset](#vr-headset)), essentially "resetting" (or "zeroing") the "full" orientation. This is usually the first calibration used when starting a session with SlimeVR.
8497

85-
## Mounting Reset
98+
## Mounting Calibration
8699

87-
A "mounting reset" (or "reset mounting") is a [Session Calibration](#session-calibration) that corrects the base orientation of trackers in regards to how they are physically mounted to your body. This is usually the second calibration used when starting a session with SlimeVR if the user chooses to use automatic mounting. When mounting reset is used, the results of the calibration will override any manually set [Mounting Orientation](#mounting-orientation).
100+
Mounting Reset (or Mounting Calibration) is part of the [Session Calibration](#session-calibration) that allows the server to automatically measure the mounting orientation of trackers. This is usually the second calibration used when starting a session with SlimeVR if the user chooses to use automatic mounting. When mounting calibration is used, the results of the calibration will override any manually set [Mounting Orientation](#mounting-orientation).
88101

89-
### Synonyms {#mounting-reset-synonyms}
102+
Mounting Calibration is also commonly referred to in conjunction with Feet Mounting Calibration, which allows the server to correct the orientation of feet trackers.
90103

104+
### Synonyms {#mounting-calibration-synonyms}
91105
- Reset Mounting
92-
- Mounting Calibration
93106
- Automatic Mounting
94107
- Automatic Mounting Orientation
95108

109+
### Related Terms {#mounting-calibration-related}
110+
111+
- [Mounting Orientation](#mounting-orientation)
112+
96113
## Yaw Reset
97114

98115
A "yaw reset" is a [Session Calibration](#session-calibration) that re-orients trackers to have the same yaw axis rotation as the head tracker (usually a [VR Headset](#vr-headset)). Since this only calibrates the yaw axis, the user can be in any position where the trackers are all facing in their forward orientation with the head tracker. This is a calibration mainly used to correct for drift after a subjective amount of time since the last yaw reset or [Full Reset](#full-reset).
@@ -102,13 +119,9 @@ A "yaw reset" is a [Session Calibration](#session-calibration) that re-orients t
102119
- Fast Reset
103120
- Quick Reset
104121

105-
### Related Terms {#mounting-reset-related}
106-
107-
- [Mounting Orientation](#mounting-orientation)
108-
109122
## Mounting Orientation
110123

111-
Mounting orientation is a type of correction for SlimeVR trackers. Mounting orientation corrects the base orientation of trackers in regards to how they are physically mounted to your body.
124+
Mounting orientation is a type of correction for SlimeVR trackers. It defines the server's measurement of the rotation of trackers with respect to how they are physically mounted to your body. This can be automatically set by the server (preferred) or manually corrected by the user (not recommended due to inaccuracy).
112125

113126
### Synonyms {#mounting-orientation-synonyms}
114127

@@ -117,7 +130,7 @@ Mounting orientation is a type of correction for SlimeVR trackers. Mounting orie
117130

118131
### Related Terms {#mounting-orientation-related}
119132

120-
- [Mounting Reset](#mounting-reset)
133+
- [Mounting Calibration](#mounting-calibration)
121134

122135
## VR Headset
123136

@@ -132,12 +145,34 @@ A VR headset is a head mounted device that tracks its position and rotation, usu
132145

133146
## Smol Slime
134147
A type of SlimeVR tracker that uses an nRF wireless dongle instead of WiFi to connect to the server.
148+
135149
### Synonyms {#smol-slime-synonyms}
136150
- Smols
137151
- Smol Trackers
138152

139153
### Related Terms {#smol-slime-related}
140-
- Ibis (a specific type of smol slime)
141154
- Big/normal slime (wifi-based slime)
142155

156+
## Breakout Board
157+
A type of PCB designed to simplify integrating one or more integrated circuits into a larger device. Breakout boards are typically used for [IMUs](#imu), charging circuits, and microcontrollers, among other components.
158+
159+
### Synonyms {#breakout-synonyms}
160+
- Breakout
161+
- External PCB
162+
163+
### Related Terms {#breakout-related}
164+
- Microcontroller
165+
166+
## IMU
167+
An acronym for Inertial Measurement Unit. It is a type of integrated circuit that contains one or more devices used to measure movement. SlimeVR requires that an IMU integrates both an accelerometer and a gyroscope to allow for the measurement of acceleration and rotation relative to the last reset. As the IMU itself has no positional reference, it is susceptible to the unavoidable accumulation of error in its sensors over time, called [drift](#drift). A low-quality IMU accumulates error faster than a high quality IMU.
168+
169+
### Related Terms {#imu-related}
170+
- [Drift](#drift)
171+
- Accelerometer
172+
- Gyroscope
173+
- Magnetometer
174+
- [Full Reset](#full-reset)
175+
- [Mounting Calibration](#mounting-calibration)
176+
- [Yaw Reset](#yaw-reset)
177+
143178
*Updated and edited by Amebun.*

0 commit comments

Comments
 (0)