-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
101 changed files
with
3,778 additions
and
1,076 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "javascript.preferences.quoteStyle": "double", | ||
| "exportall.config.quote": "\"", | ||
| "exportall.config.relExclusion": [ | ||
| "/lib/modules/shared/exports.ts", | ||
| "/lib/modules/shared/types/exports.ts" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| code: true | ||
| type: page | ||
| title: ingestMeasure | ||
| description: Kuzzle IoT Platform - Device Manager - Assets Controller | ||
| --- | ||
|
|
||
| # ingestMeasure | ||
|
|
||
| Ingest a single measure into an asset. | ||
|
|
||
| --- | ||
|
|
||
| ## Query Syntax | ||
|
|
||
| ### HTTP | ||
|
|
||
| ```http | ||
| URL: http://kuzzle:7512/_/device-manager/:engineId/assets/:assetId/measures/:slotName | ||
| Method: POST | ||
| ``` | ||
|
|
||
| ### Other protocols | ||
|
|
||
| ```js | ||
| { | ||
| "controller": "device-manager/assets", | ||
| "action": "measureIngest", | ||
| "assetId": "<assetId>", | ||
| "engineId": "<engineId>", | ||
| "slotName": "<slotName>" | ||
| "body": { | ||
| "dataSource": { | ||
| "id": "<id>", | ||
| // optional: | ||
| "metadata": { | ||
| // ... | ||
| } | ||
| }, | ||
| "measuredAt": "<measuredAt>" | ||
| "values": { | ||
| "<valueName>": "<value>", | ||
| // ... | ||
| } | ||
| }, | ||
|
|
||
| // optional: | ||
| "engineGroup": "<engine group>" | ||
| } | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Arguments | ||
|
|
||
| - `engineId`: target engine id | ||
| - `assetId`: target asset id | ||
| - `slotName`: target measure slot name | ||
| - `engineGroup` (optional): target engine group | ||
|
|
||
| ## Body properties | ||
| - `dataSource`: the measure source | ||
| - `measuredAt`: the timestamp of when the measure was collected | ||
| - `values`: the measure values | ||
|
|
||
| # Datasource properties | ||
|
|
||
| - `id`: the measure source unique identifier | ||
| - `metadata`: (optional) additional metadata for the source | ||
|
|
||
| --- | ||
|
|
||
| ## Response | ||
|
|
||
| ```js | ||
| { | ||
| "status": 200, | ||
| "error": null, | ||
| "controller": "device-manager/assets", | ||
| "action": "measureIngest", | ||
| "requestId": "<unique request identifier>", | ||
| "result": null, | ||
| } | ||
| ``` | ||
|
|
||
| ## Errors | ||
|
|
||
| Ingesting a measure with incorrect values will throw a [ MeasureValidationError ](../../../errors/measure-validation/index.md) with the HTTP code **400**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| --- | ||
| code: true | ||
| type: page | ||
| title: ingestMeasures | ||
| description: Kuzzle IoT Platform - Device Manager - Assets Controller | ||
| --- | ||
|
|
||
| # ingestMeasures | ||
|
|
||
| Ingest measures from a data source into an asset. | ||
|
|
||
| --- | ||
|
|
||
| ## Query Syntax | ||
|
|
||
| ### HTTP | ||
|
|
||
| ```http | ||
| URL: http://kuzzle:7512/_/device-manager/:engineId/assets/:assetId/_mMeasureIngest | ||
| Method: POST | ||
| ``` | ||
|
|
||
| ### Other protocols | ||
|
|
||
| ```js | ||
| { | ||
| "controller": "device-manager/assets", | ||
| "action": "_mMeasureIngest", | ||
| "assetId": "<assetId>", | ||
| "engineId": "<engineId>", | ||
| "body": { | ||
| "dataSource": { | ||
| "id": "<id>", | ||
| // optional: | ||
| "metadata": { | ||
| // ... | ||
| } | ||
| }, | ||
| "measurements": [ | ||
| { | ||
| "slotName": "<measureName>", | ||
| "measuredAt": "<measuredAt>", | ||
| "values": { | ||
| "<valueName>": "<value>", | ||
| // ... | ||
| } | ||
| } | ||
| // ... | ||
| ] | ||
| }, | ||
|
|
||
| // optional: | ||
| "engineGroup": "<engine group>" | ||
| } | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Arguments | ||
|
|
||
| - `engineId`: target engine id | ||
| - `assetId`: target asset id | ||
| - `engineGroup`: (optional): target engine group | ||
|
|
||
| ## Body properties | ||
|
|
||
| - `dataSource`: the measures source | ||
| - `measurements`: the list of measurements to ingest | ||
|
|
||
| # Datasource properties | ||
|
|
||
| - `id`: the measure source unique identifier | ||
| - `metadata`: (optional) additional metadata for the source | ||
|
|
||
| # Measurement properties | ||
|
|
||
| - `slotName`: target measure slot name | ||
| - `measuredAt`: the timestamp of when the measure was collected | ||
| - `values`: the measure values | ||
|
|
||
| --- | ||
|
|
||
| ## Response | ||
|
|
||
| ```js | ||
| { | ||
| "status": 200, | ||
| "error": null, | ||
| "controller": "device-manager/assets", | ||
| "action": "mMeasureIngest", | ||
| "requestId": "<unique request identifier>", | ||
| "result": null, | ||
| } | ||
| ``` | ||
|
|
||
| ## Errors | ||
|
|
||
| Ingesting measures with incorrect values will throw a [ MeasureValidationError ](../../../errors/measure-validation/index.md) with the HTTP code **400**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.