Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "BaSyx / Documentation / Components / DataBridge / Features / AAS Polling Consumer"

(Created page with "= AAS Polling Consumer = The AAS Server as a polling consumer can be integrated with the DataBridge. The AAS Polling consumer component can be configured as a Data Source in t...")
 
(Sample Configuration for Consuming SubmodelElement)
Line 34: Line 34:
 
In the api type DotAAS-V3 configuration for '''submodelEndpoint''' attribute, the '''dGVsZW1ldHJ5RGF0YVN0cnVjdHVyZVRlc3Q=''' is the Base64 encoded identifier of the Submodel.  
 
In the api type DotAAS-V3 configuration for '''submodelEndpoint''' attribute, the '''dGVsZW1ldHJ5RGF0YVN0cnVjdHVyZVRlc3Q=''' is the Base64 encoded identifier of the Submodel.  
  
'''Note:''' The default api type is Dot AAS V1 '''(BaSyx)'''.
+
'''Note:'''  
 +
 
 +
* The default api type is Dot AAS V1 '''(BaSyx)'''.
 +
* The attribute '''uniqueId''' is an arbitrary unique identifier.
 +
 
  
 
Similarly, you can configure multiple AAS polling consumers inside the configuration file.
 
Similarly, you can configure multiple AAS polling consumers inside the configuration file.

Revision as of 04:57, 5 January 2024

AAS Polling Consumer

The AAS Server as a polling consumer can be integrated with the DataBridge. The AAS Polling consumer component can be configured as a Data Source in the DataBridge.

Configuration

To configure AAS Server as a polling consumer in the 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. It is possible to consume a single SubmodelElement and also the whole Submodel.

If the configuration contains the idShortPath attribute as empty, then the whole Submodel is consumed; otherwise, the SubmodelElement whose idShort path is provided. Please refer to the sample configurations for better understanding.

Sample Configuration for Consuming Submodel

[
	{
		"uniqueId": "exampleAAS1",
		"submodelEndpoint": "http://localhost:4001/submodels/dGVsZW1ldHJ5RGF0YVN0cnVjdHVyZVRlc3Q=",
		"idShortPath": "",
                "api": "DotAAS-V3"
	}
]

Sample Configuration for Consuming SubmodelElement

[
	{
		"uniqueId": "exampleAAS3",
		"submodelEndpoint": "http://localhost:4001/shells/TestUpdatedDeviceAAS/aas/submodels/telemetryDataStructureTest/submodel",
		"idShortPath": "pressure",
                "api": "BaSyx"
	}
]

In the api type DotAAS-V3 configuration for submodelEndpoint attribute, the dGVsZW1ldHJ5RGF0YVN0cnVjdHVyZVRlc3Q= is the Base64 encoded identifier of the Submodel.

Note:

  • The default api type is Dot AAS V1 (BaSyx).
  • The attribute uniqueId is an arbitrary unique identifier.


Similarly, you can configure multiple AAS polling consumers inside the configuration file.

Naming Convention

The name of the AAS polling consumer configuration file should be aaspollingconsumer.json.

Working Example

The integration example with AAS as a data source, JSONata as a transformer, and MQTT as a data sink is on GitHub DataBridge Example.

Back to the top