Liblsl.dart

This is the monorepo for the dart native liblsl package.

Subpackages:

• liblsl: The main package for liblsl.

  • JOSS paper: markdown version of the JOSS paper

• liblsl_test: An integration test so you can try out liblsl with flutter on any supported target platform.

• liblsl_timing: App based multi-device latency, sync and interactive timing tests with automatic device coordination via LSL

• liblsl_analysis: Analysis of results from the timing tests in liblsl_timing

Getting Started

You're most likely interested in the liblsl package, which is the main package for liblsl.dart. You can find installation instructions and usage examples in the README of that package. API documentation, and the Dart package are available on pub.dev: https://pub.dev/packages/liblsl.

Working with the monorepo

This is a monorepo managed with melos and fvm. To get started, clone this repository including submodules:

git clone --recurse-submodules

Install fvm, then run:

cd liblsl.dart
fvm dart pub get

There are some helpful melos commands for working with the monorepo:

• fvm exec melos run <script>: run a script defined in the melos scripts section of the root pubspec.yaml across all packages. For example, melos run format runs dart format . in all packages.
• fvm exec melos run lint:all: run dart analyze and dart format for all packages, and fail if there are any warnings or formatting issues.
• fvm exec melos run test: run dart test for all packages.

The lint and test scripts at the very least should be run before pushing any changes. For more scripts available, see the pubspec.yaml file.

Contributing

See the CONTRIBUTING.md file for guidelines on how to contribute to this project.

Code of Conduct

This project and everyone participating in it must uphold Code of Conduct. By participating, you are expected to uphold this code.

Support

Please see the SUPPORT.md file for information on how to get support for liblsl.dart and where to ask questions or discuss potential features.

Security

Please see the SECURITY.md file for information on how to report security vulnerabilities for liblsl.dart.

License

This project is licensed under the MIT License - see the LICENSE file for details.