diff --git a/docs/_data/navigation.json b/docs/_data/navigation.json index d12b2fc8..0e46dc7e 100644 --- a/docs/_data/navigation.json +++ b/docs/_data/navigation.json @@ -71,7 +71,52 @@ "name": "Development Documentation", "path": "/software/repo/", "file": "dev.html", - "type": "page" + "type": "page", + "content": + [ + { + "name": "Requirements Analysis", + "path": "/software/repo/", + "file": "requirements.html", + "type": "page" + }, + { + "name": "Sensor Abstraction Layer", + "path": "/software/repo/", + "file": "abstraction-layer.html", + "type": "page" + }, + { + "name": "Interaction Observer", + "path": "/software/repo/", + "file": "interaction-observer.html", + "type": "page" + }, + { + "name": "Configuration File", + "path": "/software/repo/", + "file": "configuration.html", + "type": "page" + }, + { + "name": "REST API", + "path": "/software/apps/server/", + "file": "rest-api.html", + "type": "page" + }, + { + "name": "SignalR", + "path": "/software/apps/server/", + "file": "signalr.html", + "type": "page" + }, + { + "name": "TUIO", + "path": "/software/repo/", + "file": "tuio.html", + "type": "page" + } + ] }, { "name": "Version History", @@ -93,6 +138,12 @@ "type": "page", "content": [ + { + "name": "Overview", + "path": "/software/apps/server/", + "file": "server-overview.html", + "type": "page" + }, { "name": "Tracking view", "path": "/software/apps/server/", @@ -128,12 +179,6 @@ "path": "/software/apps/server/", "file": "video-tutorial.html", "type": "page" - }, - { - "name": "REST API", - "path": "/software/apps/server/", - "file": "rest-api.html", - "type": "page" } ] }, diff --git a/docs/software/apps/server/rest-api.md b/docs/software/apps/server/rest-api.md index fabe102d..de1f266d 100644 --- a/docs/software/apps/server/rest-api.md +++ b/docs/software/apps/server/rest-api.md @@ -1,4 +1,4 @@ -# ReFlex TrackingServer REST API +# ReFlex.TrackingServer: REST API ## Table of contents diff --git a/docs/software/apps/server/server-overview.md b/docs/software/apps/server/server-overview.md new file mode 100644 index 00000000..240ec608 --- /dev/null +++ b/docs/software/apps/server/server-overview.md @@ -0,0 +1,18 @@ +# ReFlex.TrackingServer Overview + + +## Table of contents + +1. [Introduction](#introduction) + +## Introduction + +The diagram illustrates the requirements and functionalities of the server application, organised by sections of the configuration interface. + +Blue boxes represent functional requirements, green boxes represent non-functional requirements, and orange boxes represent development tools. + +The grey boxes represent the individual features of the user interface, which can be loaded via the configuration file (dark blue border) or set via the REST API (magenta border). + +Light blue borders indicate parts of the [data format] in which interactions are transmitted to client applications. + +__[⬆ back to top](#table-of-contents)__ diff --git a/docs/software/apps/server/signal-r.md b/docs/software/apps/server/signal-r.md new file mode 100644 index 00000000..886de12b --- /dev/null +++ b/docs/software/apps/server/signal-r.md @@ -0,0 +1,32 @@ +# ReFlex.TrackingServer: SignalR + + +## Table of contents + +1. [Introduction](#introduction) +2. [List of SignalR-Hubs](#list-of-signalr-hubs) + +## Introduction + +Various types of data can be received via the SignalR protocol. These include, on the one hand, notifications regarding status changes in subsystems and, on the other hand, complex data such as the interaction history, the point cloud and the vector field, as well as performance data. The interface is organised into hubs, each of which encapsulates different types of information. Within each hub, various methods are defined through which the client can subscribe to the relevant information. + +__[⬆ back to top](#table-of-contents)__ + +## List of SignalR-Hubs + +| Address | Method | Description | Type | +| ---------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------ | --------- | +| `/calibhub` | `startCalibrationSubscription` | Current calibration status | Status | +| `/nethub` | `startState` | Current status of the transmission | Status | +| `/perfhub` | `startCollectingData` | Enabling/Disabling Performance Monitoring - Streaming Performance Data | Diagnosis | +| `/pointcloudhub` | `startPointCloud` | Streaming the point cloud | Data | +| | `startVectorField` | Streaming the [vector field]({{ site.baseurl }}/software/repo/pipeline.html#vector-field-computation) | Data | +| `/prochub` | `startState` | Current processing status | Status | +| | `startInteractions` | Streaming [interaction data]({{ site.baseurl }}/software/repo/interactions.html) | Data | +| | `startInteractionFrames` | Streaming [InteractionFrames]({{ site.baseurl }}/software/repo/pipeline.html#identification-of-touch) | Data | +| | `startInteractionHistory` | Streaming [InteractionHistory]({{ site.baseurl }}/software/repo/pipeline.html#identification-of-touch) | Data | +| `/trkhub` | `startRecordingState` | Current sensor state | Status | +| `/tuiohub` | `startState` | Current [TUIO]({{ site.baseurl }}/software/repo/tuio.html) broadcast state | Status | +| | `startPackageDetails` | Streaming [TUIO]({{ site.baseurl }}/software/repo/tuio.html) packages | Data | + +__[⬆ back to top](#table-of-contents)__ diff --git a/docs/software/repo/abstraction-layer.md b/docs/software/repo/abstraction-layer.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/software/repo/config-file.md b/docs/software/repo/config-file.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/software/repo/interaction-observer.md b/docs/software/repo/interaction-observer.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/software/repo/requirements.md b/docs/software/repo/requirements.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/software/repo/tuio.md b/docs/software/repo/tuio.md new file mode 100644 index 00000000..e69de29b