Skip to content

dev documentation (first part) #3474

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
reworc merged 1 commit into from
Sep 22, 2026
Merged

dev documentation (first part) #3474

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 52 additions & 7 deletions docs/_data/navigation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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/",
Expand Down Expand Up @@ -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"
}
]
},
Expand Down
2 changes: 1 addition & 1 deletion docs/software/apps/server/rest-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ReFlex TrackingServer REST API
# ReFlex.TrackingServer: REST API

<!-- omit in toc -->
## Table of contents
Expand Down
18 changes: 18 additions & 0 deletions docs/software/apps/server/server-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ReFlex.TrackingServer Overview

<!-- omit in toc -->
## 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)__
32 changes: 32 additions & 0 deletions docs/software/apps/server/signal-r.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# ReFlex.TrackingServer: SignalR

<!-- omit in toc -->
## 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)__
Empty file added docs/software/repo/abstraction-layer.md
View file
Open in desktop
Empty file.
Empty file added docs/software/repo/config-file.md
View file
Open in desktop
Empty file.
Empty file added docs/software/repo/interaction-observer.md
View file
Open in desktop
Empty file.
Empty file added docs/software/repo/requirements.md
View file
Open in desktop
Empty file.
Empty file added docs/software/repo/tuio.md
View file
Open in desktop
Empty file.
Loading