Skip to content

Feature/update documentation #3496

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 9 commits into from
Oct 23, 2026
Merged

Feature/update documentation #3496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
1e0247d
fix: typo
reworc Oct 23, 2026
c6d3002
requirements-analysis, pt. 1
reworc Oct 23, 2026
2875bc9
update requirements analysis
reworc Oct 23, 2026
3a9fb78
finalized requirement analysis
reworc Oct 23, 2026
b29a7ed
shorten heading
reworc Oct 23, 2026
f36f4cc
added short description for rest controllers
reworc Oct 23, 2026
df2283c
documentation of tuio interface
reworc Oct 23, 2026
3f1bf4e
documentation of config file
reworc Oct 23, 2026
d33ba90
restructuring / cleanup
reworc Oct 23, 2026
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
93 changes: 36 additions & 57 deletions docs/_data/navigation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"content":
[
{
"name": "Repository",
"name": "Developer Documentation",
"type": "subcategory",
"content": [
{
Expand All @@ -26,15 +26,21 @@
"type": "page"
},
{
"name": "Architecture",
"name": "ReFlex Library (.NET)",
"path": "/software/repo/",
"file": "architecture.html",
"file": "library.html",
"type": "page"
},
{
"name": "ReFlex Library (.NET)",
"name": "Requirements Analysis",
"path": "/software/repo/",
"file": "library.html",
"file": "requirements.html",
"type": "page"
},
{
"name": "Architecture",
"path": "/software/repo/",
"file": "architecture.html",
"type": "page"
},
{
Expand All @@ -49,74 +55,47 @@
"file": "touch-detection.html",
"type": "page"
},
{
"name": "Supported Sensors",
"path": "/software/repo/",
"file": "sensors.html",
"type": "page"
},
{
"name": "Interactions Format",
"path": "/software/repo/",
"file": "interactions.html",
"type": "page"
},
{
"name": "Supported Sensors",
"name": "Server Configuration",
"path": "/software/repo/",
"file": "sensors.html",
"file": "config-file.html",
"type": "page"
},
{
"name": "github CI",
"name": "REST API",
"path": "/software/apps/server/",
"file": "rest-api.html",
"type": "page"
},
{
"name": "SignalR",
"path": "/software/apps/server/",
"file": "signal-r.html",
"type": "page"
},
{
"name": "TUIO",
"path": "/software/repo/",
"file": "ci.html",
"file": "tuio.html",
"type": "page"
},
{
"name": "Development Documentation",
"name": "github CI",
"path": "/software/repo/",
"file": "dev.html",
"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": "config-file.html",
"type": "page"
},
{
"name": "REST API",
"path": "/software/apps/server/",
"file": "rest-api.html",
"type": "page"
},
{
"name": "SignalR",
"path": "/software/apps/server/",
"file": "signal-r.html",
"type": "page"
},
{
"name": "TUIO",
"path": "/software/repo/",
"file": "tuio.html",
"type": "page"
}
]
"file": "ci.html",
"type": "page"
},
{
"name": "Version History",
Expand Down
Binary file added docs/assets/img/overview/requirement_analysis.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 30 additions & 0 deletions docs/software/apps/server/rest-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,11 @@ __[⬆ back to top](#table-of-contents)__

## Calibration

- Retrieval of current calibration data
- Specification of parameters
- Updating of calibration points
- Explicit transformation from world to image coordinates

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/Calibration/FrameSize` | - | `FrameSizeDefinition` | Returns the current calibration window/frame size. |
Expand All @@ -164,6 +169,9 @@ __[⬆ back to top](#table-of-contents)__

## Tracking

- Start/stop the sensor (including emulator/recorder)
- Specifying parameters (sensor, resolution)

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/Tracking` | - | `IDepthCamera[]` | Returns all available cameras. |
Expand Down Expand Up @@ -191,6 +199,9 @@ __[⬆ back to top](#table-of-contents)__

## Settings

- Access to the central settings of the filter pipeline
- Loading/saving the configuration

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/Settings` | - | `TrackingServerAppSettings` | Returns the complete current server configuration. |
Expand Down Expand Up @@ -225,6 +236,9 @@ __[⬆ back to top](#table-of-contents)__

## Processing

- Start/stop the processing component
- Specifying parameters (type of processing, update rate)

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/Processing/GetInterval` | - | `int` | Returns the current update interval in milliseconds. |
Expand All @@ -241,6 +255,9 @@ __[⬆ back to top](#table-of-contents)__

## Network

- Start/stop the transmission component
- Specify parameters (address, protocol, update rate)

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/Network/Status` | - | `NetworkAttributes` | Returns a summarized networking status including address, port, endpoint, and interfaces. |
Expand All @@ -262,6 +279,9 @@ __[⬆ back to top](#table-of-contents)__

## Tuio

- Start/stop TUIO transmission
- Specifying parameters (version, encoding, protocol)

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/Tuio/IsBroadcasting` | - | `JsonSimpleValue<bool>` | Returns whether TUIO broadcasting is active. Name: `IsBroadcasting`. |
Expand All @@ -281,6 +301,9 @@ __[⬆ back to top](#table-of-contents)__

## DepthImage

- Retrieving the point cloud
- Retrieving the vector field

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/DepthImage/PointCloud` | - | `Point3[]` | Returns the current point cloud or an empty array. |
Expand All @@ -290,6 +313,9 @@ __[⬆ back to top](#table-of-contents)__

## Log

- Retrieving the log (in full / in sections)
- Sending errors for inclusion in the server log

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/Log` | - | `LogMessageDetail[]` | Returns the currently buffered log messages. |
Expand All @@ -302,6 +328,8 @@ __[⬆ back to top](#table-of-contents)__

## VersionInfo

- provide server version and current dependencies

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/VersionInfo` | - | `AppVersionInfo[]` | Returns the known version information for the application. |
Expand All @@ -310,6 +338,8 @@ __[⬆ back to top](#table-of-contents)__

## RecordRawDepth

- Saving the point cloud to a JSON file (surveying)

| Method | Route | Request | Response | Description |
|---|---|---|---|---|
| `GET` | `/api/RecordRawDepth/IsCapturing` | - | `bool` | Returns whether raw data is currently being captured. |
Expand Down
Loading
Loading