path: root/README.md
diff options
authorCNLohr <charles@cnlohr.com>2017-04-29 18:03:50 -0400
committerGitHub <noreply@github.com>2017-04-29 18:03:50 -0400
commit2f7ebf7af36e324d8f1d8036800d34eeb2d9f46f (patch)
tree1fb7c080fb072b1b93f0fad5b85bccc04787c85a /README.md
parent1a6f5f8316b2dfa1baa923f5ef109b7a4890300f (diff)
Add a nomenclature section to the readme.
Diffstat (limited to 'README.md')
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3b26c5f..dc568f6 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,22 @@ Please see the issues for what help needs to be done now!
HackADay article and video with Dr. Yates on how they made the Vive a thing. http://hackaday.com/2016/12/21/alan-yates-why-valves-lighthouse-cant-work/
+## Nomenclature
+WRT = With Respect To
+PoV / POV = Point of View (typically WRT to a LH, sometimes (though rarely) a sensor)
+LH = Lighthouse = Base Station = A device that produces a 1.8 MHz modulated sync pulse in IR and then sweeps the scene with laser planes.
+Sync Pulse = A pulse of modulated IR data sent from a ligthhouse, typically by the floodlight aspect of a lighthouse.
+Sweep Pulse = The evenlope created by a laser sweeping over a light sensor.
+OOTX = Omnidirectional Optical Transmitter = Data encoded in the sync pulses of the LHs.
+HMD = Headset = Main sensor receiver with a visual display for a human.
+WM = Watchman = Controller = The HTC Vive controller.
+TR = Tracker = Official HTC Tracker.
+LightcapElement = A single pulse of light, including a timestamp, source sensor and length of pulse.
+Disambiguator = System that accepts lightcap elements and pulls out OOTX data and relative sweep times of sweep pulses.
+Poser = Device to convert series of angles from a LH's PoV
## Getting things working
There are two things you should consider doing to your system before running libsurvive.