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.
BaSyx / Developer / Extensions / Eventing
< BaSyx
Revision as of 10:26, 3 February 2021 by Ashfaqul.haque.iese.fraunhofer.de (Talk | contribs)
MqttAASAggregator (Implements IAASAggregator)
Package: org.eclipse.basyx.extensions.aas.aggregator.mqtt
Events list:
| Method Name | Send Message? | Topic Name | Payload |
| createAAS(AssetAdministrationShell aas) | Yes | BaSyxAggregator_createdAAS | $AASId |
| updateAAS(AssetAdministrationShell aas) | Yes | BaSyxAggregator_updatedAAS | $AASId |
| deleteAAS(IIdentifier aasId) | Yes | BaSyxAggregator_deletedAAS | $AASId |
MqttAASRegistryService (Implements IAASRegistryService)
Package: org.eclipse.basyx.extensions.aas.registration.mqtt
Events list:
| Method Name | Send Message? | Topic Name | Payload |
| register(AASDescriptor deviceAASDescriptor) | Yes | BaSyxRegistry_registeredAAS | $AASId |
| register(IIdentifier aas, SubmodelDescriptor smDescriptor) | Yes | BaSyxRegistry_registeredSubmodel | ($AASId,$SMId) |
| delete(IIdentifier aasId) | Yes | BaSyxRegistry_deletedAAS | $AASId |
| delete(IIdentifier aasId, IIdentifier smId) | Yes | BaSyxRegistry_deletedSubmodel | ($AASId,$SMId) |
MqttSubmodelAPI (Implements ISubmodelAPI)
Package: org.eclipse.basyx.extensions.events.submodel.mqtt
Events list:
| Method Name | Send Message? | Topic Name | Payload |
| MqttSubmodelAPI(ISubmodelAPI observedAPI, String serverEndpoint, String clientId) | Yes | BaSyxSubmodel_createdSubmodel | $SMId |
| MqttSubmodelAPI(ISubmodelAPI observedAPI, String serverEndpoint, String clientId, String user, char[] pw) | Yes | BaSyxSubmodel_createdSubmodel | $SMId |
| MqttSubmodelAPI(ISubmodelAPI observedAPI, MqttClient client) | Yes | BaSyxSubmodel_createdSubmodel | $SMId |
| addSubmodelElement(ISubmodelElement elem) | Yes | BaSyxSubmodel_addedSubmodelElement | ($AASId, $SMId , $ElementId) |
| addSubmodelElement(String idShortPath, ISubmodelElement elem) | Yes | BaSyxSubmodel_addedSubmodelElement | ($AASId, $SMId , $ElementIdShortPath) |
| deleteSubmodelElement(String idShortPath) | Yes | BaSyxSubmodel_removedSubmodelElement | ($AASId, $SMId , $ElementIdShortPath) |
| updateSubmodelElement(String idShortPath, Object newValue) | Yes | BaSyxSubmodel_updatedSubmodelElement | ($AASId, $SMId , $ElementIdShortPath) |
In MqttSubmodelAPI, the event propagation only works if the class variable useWhiteList is true or only for whitelisted Submodel IdShort. The class has a class variable- Set<String> whitelist which maintains the whitelisted submodel IdShort.
In Every Class:
$AASId = Id of the Identifier of AAS
$SMId = Id of the Identifier of Submodel