Repository navigation
Docs: point liblsl topics to the liblsl docs; split devices, tools and bindings - #145
Merged
Merged
Conversation
Who needs what (apps, language bindings, liblsl), liblsl's distribution channels, and a warning that package-manager ports are maintained separately and often lag behind the release downloads and liblsl's own CMake integration. Adds a :liblsl: link role for liblsl's documentation.
Supported Devices now lists hardware only. A new Tools page covers recording (LabRecorder), viewers, XDF tools, real-time processing frameworks and stimulus presentation software (moved from the devices page).
Building, linking, configuring and the internals of liblsl are now documented with liblsl. lib_dev, build_android, cmake, full_tree and build_full_tree become short pointers (keeping their URLs and labels); lslapicfg keeps a summary and an example and links to the full reference. app_dev shows find_package/FetchContent instead of the old HINTS/PATH_SUFFIXES recipe. The index lists the liblsl topics.
- Ports are 16572-16603 (BasePort + PortRange 32), not ...-16604. - Fix the FF08 IPv6 multicast address typo. - KnownPeers adds unicast queries; it does not turn multicast off. - Resolvers use one socket per IP version for sending and replies, TCP discovery exists (ResolveOverTCP), and the unicast socket is queried for local streams and KnownPeers rather than being only a fallback. - RLS dejitter is built into liblsl (proc_dejitter, SmoothingHalftime 90 s). - Same-machine discovery section (from Chadwick's draft), noting that programs like socat bound to 16571 can take unicast queries. - Firewall and wireless sections link to the liblsl reference.
Official bindings and community bindings as tables with notes and the year of the last change, plus a separate list of protocol reimplementations that don't use liblsl. Every entry was checked on GitHub; superseded and abandoned projects are left out.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion to sccn/liblsl#324, which adds liblsl's own documentation (getting/using/building liblsl, the
lsl_api.cfgreference, and how liblsl works on the network). This site stays the LSL landing page and links there for anything liblsl-specific.New and restructured pages
Moved to the liblsl docs (pages kept as short pointers so their URLs and labels keep working):
lib_dev,build_android,cmake,full_tree,build_full_tree;lslapicfgkeeps a summary and an example.app_devnow showsfind_package/FetchContent.Fixes found while documenting liblsl against its code
KnownPeersadds unicast queries; it doesn't turn off multicast.ResolveOverTCP).proc_dejitter, default half-time 90 s), not "a future version".socatbound to 16571 can take unicast queries (cf. Linux network debugging documentation liblsl#177).Merge order: the
:liblsl:links point to pages added by sccn/liblsl#324; merge that first (it's meant to go live with liblsl 1.18).build_env.rstis untouched. No new Sphinx warnings (compared with a build ofmaster); a few old ones are gone.