1 Fork 0

Files

T

Updated docs and updated API to fetch signal descriptors in all modes

API and Protocol docs have been updated (GPT 5.6)

The API methods for fetching a sepcific signal descriptor and fetching
all signal descriptors now work in offline mode, the core_tui.py example
has been updated to fit the new tri mode architecture and loading
recording offload -> processing and then processing -> playback engine
all works

2026-09-21 13:33:55 +02:00

Internal

Initial documentation, partial Protocol documentation

2026-08-06 18:17:57 +01:00

API.md

Updated docs and updated API to fetch signal descriptors in all modes

2026-09-21 13:33:55 +02:00

Protocol.md

Updated docs and updated API to fetch signal descriptors in all modes

2026-09-21 13:33:55 +02:00

README.md

Fixed copy paste errors in documentation

2026-08-14 21:18:22 +01:00

README.md

DynaLab Core Documentation

Warning

Documentation is currently being written. It may contain incomplete or incorrect information. While DynaLab Core is in it's alpha stage it is the users responsibility to cross check the information provided in documentation with the codebase.

This documentation is ordered in the following sections

API
Protocol
Internal

API - Documents the user side API of the Core class, this goes through setting up a new core, and how to interact with it

Protocol - Documents the data ingress protocol, this is useful for developing connectors to pipe data into the DynaLab Core

Internal - Documents the inner working of DynaLab Core including data flow, internal API's, custom file types and much more