improve documentation for optional flags

[throni3git]

hello :)
i have been contributing in the past to this wonderful project, but i am still struggling to understand all of the options available as i find no full documentation on the options. so i want to ask directly for my scenario:

• a fixed set of two Lighthouses gen 2 with fixed positions
  • if the Lighthouse positions ever move i have the option to delete the config.json
• one Tracker paired with a Watchman dongle connected to a Linux based machine
• the Lighthouses are set up such that Tracker "sees" them in almost all of the play area

now i would like to get which of the options i should use to help libsurvive maintain a very consistent tracking. this means the following questions for me:

• should i use --force-calibrate? (i have seen that the calibration is done anyways during the run; also i see this is currently adressed in the issue Prevent libsurvive from continuously optimizing the calibration. #336 from Tantenfisch)
• should i change something on the GlobalSceneSolver? maybe deactivate them?
• should i set the Lighthouse-gen?

as you see a lot of these questions arise from not being able to fully understand the consequences of these options. for that i also would like to ask for sharp definitions in the readme file of this project - including if the options affect the system on startup or during a run.

that would help me a lot and hopefully others as well :)

[bl4ckb0ne]

I think --force-calibrate is probably what you want in this case, it should provide the most consistent tracking in case something moves on your desk. There's some doc about it in the readme but it's scarce.

I'm open to suggestions for improvement, I understand that this isnt the most user friendly tracking lib.

[throni3git]

a small improvement in the readme would be: "Calibration is the process which establishes where the lighthouses are set up in relation to the tracked objects. The first time you run libsurvive (when there is no config.json in XDG_CONFIG_HOME/libsurvive) , it can take up to ten seconds to communicate with the lighthouses and figure out where they are."

i suggest to put "Omnidirectional Optical Transmitter" right where the abbreviation "OOTX" is used in the readme. or even put together a abbreviation index for other abbreviations in the context of libsurvive. i found it in the LighthouseRedox repo [1]

what is the order of a "regular" startup without command line options (and without a config.json file)? and what is the --force-calibrate flag changing?

[1] https://github.com/nairol/LighthouseRedox/blob/master/docs/Light%20Emissions.md

[throni3git]

i understand from #206 that there is the (still?) experimental feature of a global scene solver (GSS) to reposition the lighthouses when a movement of one of the lighthouses was detected. i've read (in Discord and some of the issues in github) that switching it off might also help.

could you please give a sharp definition of what the GSS does and when?

[bl4ckb0ne]

I unfortunately cant, I'm not the original author. I took over maintainership a little while ago but I'm still not familiar with all the places of the codebase.

The best we can do at the moment is read the code, understand it, document it and iterate to improve.