Skip to content
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.

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

docs: changed topic table to define suffixes… #197

Merged
merged 2 commits into from
Nov 26, 2021
Merged
Changes from all commits
Commits
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
18 changes: 10 additions & 8 deletions docs/tech_stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,16 @@ technology stack for compliant IoT devices.
* JSON encoding following the core schema definition, specifying the semantic structure of the data.
* Passes the [DAQ Validation Tool](validator.md) for all requirements.

# MQTT Topic Table

| Type | Category | subFolder | MQTT Topic | Schema File |
|----------|----------|-----------|----------------------------------------|---------------|
| state | state | _n/a_ | `/devices/{device_id}/state` | state.json |
| config | config | _n/a_ | `/devices/{device_id}/config` | config.json |
| pointset | event | pointset | `/devices/{device_id}/events/pointset` | pointset.json |
| system | event | system | `/devices/{device_id}/events/system` | system.json |
# MQTT Topic Suffix Table

| Type | Category | subFolder | MQTT Topic Suffix | Schema File |
| -------- | -------- | --------- | -------------------------------- | ------------- |
| state | state | _n/a_ | `{topic_prefix}/state` | state.json |
| config | config | _n/a_ | `{topic_prefix}/config` | config.json |
| pointset | event | pointset | `{topic_prefix}/events/pointset` | pointset.json |
| system | event | system | `{topic_prefix}/events/system` | system.json |

For GCP implementations the full topic would be `/devices/{device_id}/{suffix}`

# Backend Systems

Expand Down