|
|
|
---
|
|
|
|
title: 'MQTT Topic: qaqc_settings_update'
|
|
|
|
---
|
|
|
|
|
|
|
|
# `qaqc_settings_update`
|
|
|
|
|
|
|
|
#### version 2
|
| ... | ... | @@ -26,9 +27,9 @@ title: 'MQTT Topic: qaqc_settings_update' |
|
|
|
# If all three are not null, temporary_name is ignored.
|
|
|
|
<DStream> = {
|
|
|
|
"arg_name": <string> # The argument name in the quality function.
|
|
|
|
"alias": <string> # A string alias (aka. speaking name) for this stream [2]
|
|
|
|
"sta_thing_id": <number> | null # ID of the Thing in the sensor things api (STA).
|
|
|
|
"sta_stream_id": <number> | null # ID of the Datatream in the sensor things api (STA).
|
|
|
|
"alias": <string> # A string alias (aka. speaking name) for this stream [2][3]
|
|
|
|
"sta_thing_id": <number> | null # ID of the Thing in the sensor things api (STA). [3]
|
|
|
|
"sta_stream_id": <number> | null # ID of the Datatream in the sensor things api (STA). [3]
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
| ... | ... | @@ -44,3 +45,11 @@ title: 'MQTT Topic: qaqc_settings_update' |
|
|
|
[1]: The `context_window` must be either a stringified number (e.g. `"5"`) or a datetime-range string (e.g. `"5d12h10ns"`). For allowed units see the `unit` argument in the docs of [pandas.Timedelta](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Timedelta.html#pandas-timedelta).
|
|
|
|
|
|
|
|
[2]: The alias string is `"T<sta_thing_id>S<sta_stream_id>"` if both are present (neither is `null`), otherwise this is a user-given name.
|
|
|
|
|
|
|
|
[3] For `alias`, `sta_thing_id` (TID) and `sta_stream_id` (SID) we have following cases
|
|
|
|
|
|
|
|
| `sta_thing_id` | `sta_stream_id` | `alias` | example | Description |
|
|
|
|
| ------ | ------ | ------- | ------- | -------- |
|
|
|
|
| `null` | - (ignored) | any user given string | `null,null,"myStream"` | A temporary stream, used for example for intermediate calculation results; after QC run the stream/data is discarded. |
|
|
|
|
| ID | `null` | auto-generated string with user part | `23,null,"T23SmyResult"` | A new data product stream; the stream is created and the data will be uploaded to the new stream. The new stream belongs to the _thing_ with ID from column 1 (`23` in the example); the name of the stream will be the user given part of the `alias` ( `"myResult"` in the example).
|
|
|
|
| ID | ID | auto-generated string | `23,42,"T23S42"` | A default data stream. | |
|
|
\ No newline at end of file |
