Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 3.55 KB

README.md

File metadata and controls

45 lines (36 loc) · 3.55 KB
Raw

OSLTT - Open Source Latency Test Tool

An open source latency testing tool project - here you'll find the desktop software needed to use the tool, the firmware for the device, the circuit diagram and support.

Buy a kit

Get Started

  • Download the most recent release from the releases page.
  • Run the installer, which will install to C:\OSLTT
  • Launch the software
  • Allow it to install the drivers for the board
  • Allow it to update the device firmware (if prompted)
  • Select the test type you want to try - Monitor is the one I'd recommend trying first.
  • Hit "Start Test" - if you picked monitor your screen will go black, and FPS counter on the top left should read around 1000FPS.
  • Press the button on the tool to start capturing data. Let it complete then it'll close the test window.
  • Take a look at the results in the results view window.
  • Enjoy!

Features not currently implemented

  • Pre-testing system latency - this is a top priority for me. It will be done ASAP!
  • Add hotkeys to start and stop testing - this isn't all that difficult so I should have this added fairly quickly. This has been implemented - press F10 to start/stop the test.
  • A more live view style mode would be great. The baud rate is the biggest limiting factor there (115200 baud is ~1ms per byte, so you'd only get ~1000Hz which isn't all that useful)
  • More control over the triggers and sensors. Right now everything is quite fixed how I originally invisaged it, but I can already see methods that might be useful that the device doesn't currently support.
  • More on device processing for better compatability. In theory this can work with at least MacOS and Linux systems at a basic level so would be good to support them at least a little with more on device processing.

Reporting problems

If you encounter an errant bug in the software or firmware, please do let me know. The best way to do that is here on GitHub, through the issues tab. If you don't have a GitHub account, you can also email me here. Please include as much information as possible, and any screenshots relevant.

Feature suggestions

Much like the reporting problems section above, if you'd like to request a feature be added, please either submit an issue, or email me here.

Building from Source

  • Clone the repo
  • Launch the SLN in Visual Studio
  • Build the solution before opening Main.cs (as SettingsPane.cs is a user control that needs to be built before displaying Main.cs)
  • Copy the DirectX folder to bin/Debug
  • Get a copy of the arduino CLI here and place it in a new folder called "arduinoCLI" in bin/Debug
  • Run the program and enjoy!

Contributing

Supporting Directly

If you'd like to support the project but don't need a device, you can support by sharing the project with your favourite tech reviewers, or support directly through PayPal.

Code Contribution

If you'd like to contribute some code to the project - either bug fixes or new features - please submit a pull request with as much info as possible. I'll do my best to review and merge any changes in good time. If you have any questions about my (imperfect) code, please do submit an issue and tag it as a question.