Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "BaSyx / Documentation / Components / DataBridge / Features / AAS Endpoint"
(→Working Example) |
(→AAS) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | = AAS = | + | = AAS Data Sink = |
The AAS Server can be integrated with DataBridge. The AAS component can be configured as a Data Sink in the DataBridge. | The AAS Server can be integrated with DataBridge. The AAS component can be configured as a Data Sink in the DataBridge. | ||
== Configuration == | == Configuration == | ||
| − | To configure AAS Server in DataBridge you need to provide the '''unique id''', '''endpoint of the Submodel''' | + | To configure AAS Server in DataBridge you need to provide the '''unique id''', '''endpoint of the Submodel''', '''idShort path''' and the '''api''' type. |
| + | The AAS endpoint supports both the Dot AAS V1 '''(BaSyx)''' as well as Dot AAS V3 '''(DotAAS-V3)''' specifications api. | ||
| − | === Sample Configuration === | + | === Sample Configuration Dot AAS V1 === |
<pre class="mw-code mw-code-json"> | <pre class="mw-code mw-code-json"> | ||
[ | [ | ||
| Line 11: | Line 12: | ||
"uniqueId": "ConnectedSubmodel/ConnectedPropertyA", | "uniqueId": "ConnectedSubmodel/ConnectedPropertyA", | ||
"submodelEndpoint": "http://localhost:4001/shells/TestUpdatedDeviceAAS/aas/submodels/ConnectedSubmodel/submodel", | "submodelEndpoint": "http://localhost:4001/shells/TestUpdatedDeviceAAS/aas/submodels/ConnectedSubmodel/submodel", | ||
| − | "idShortPath": "ConnectedPropertyA" | + | "idShortPath": "ConnectedPropertyA", |
| + | "api": "BaSyx" | ||
} | } | ||
] | ] | ||
</pre> | </pre> | ||
| + | |||
| + | === Sample Configuration Dot AAS V3 === | ||
| + | <pre class="mw-code mw-code-json"> | ||
| + | [ | ||
| + | { | ||
| + | "uniqueId": "ConnectedTestSubmodel/DotAASV3ConformantApiSMC/DotAASV3ConformantApiProperty", | ||
| + | "submodelEndpoint": "http://localhost:4001/submodels/c3VibW9kZWxJZA==", | ||
| + | "idShortPath": "DotAASV3ConformantApiSMC.DotAASV3ConformantApiProperty", | ||
| + | "api": "DotAAS-V3" | ||
| + | } | ||
| + | ] | ||
| + | </pre> | ||
| + | |||
| + | In the '''submodelEndpoint''', the '''c3VibW9kZWxJZA==''' is the Base64 encoded identifier of the Submodel. As per the DotAAS-V3 specification the '''idShortPath''' should be dot-separated as shown in the configuration above. | ||
| + | |||
| + | '''Note:''' The default api type is Dot AAS V1 '''(BaSyx)'''. | ||
Similarly, you can configure multiple AAS sinks inside the configuration file. | Similarly, you can configure multiple AAS sinks inside the configuration file. | ||
Latest revision as of 11:57, 13 December 2023
Contents
AAS Data Sink
The AAS Server can be integrated with DataBridge. The AAS component can be configured as a Data Sink in the DataBridge.
Configuration
To configure AAS Server in DataBridge you need to provide the unique id, endpoint of the Submodel, idShort path and the api type. The AAS endpoint supports both the Dot AAS V1 (BaSyx) as well as Dot AAS V3 (DotAAS-V3) specifications api.
Sample Configuration Dot AAS V1
[
{
"uniqueId": "ConnectedSubmodel/ConnectedPropertyA",
"submodelEndpoint": "http://localhost:4001/shells/TestUpdatedDeviceAAS/aas/submodels/ConnectedSubmodel/submodel",
"idShortPath": "ConnectedPropertyA",
"api": "BaSyx"
}
]
Sample Configuration Dot AAS V3
[
{
"uniqueId": "ConnectedTestSubmodel/DotAASV3ConformantApiSMC/DotAASV3ConformantApiProperty",
"submodelEndpoint": "http://localhost:4001/submodels/c3VibW9kZWxJZA==",
"idShortPath": "DotAASV3ConformantApiSMC.DotAASV3ConformantApiProperty",
"api": "DotAAS-V3"
}
]
In the submodelEndpoint, the c3VibW9kZWxJZA== is the Base64 encoded identifier of the Submodel. As per the DotAAS-V3 specification the idShortPath should be dot-separated as shown in the configuration above.
Note: The default api type is Dot AAS V1 (BaSyx).
Similarly, you can configure multiple AAS sinks inside the configuration file.
Naming Convention
The name of the AAS configuration file should be aasserver.json.
Working Example
The integration example with MQTT as a data source, JSONata as a transformer, and AAS as a data sink is on GitHub DataBridge Example.