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.
Difference between revisions of "BaSyx / Developer / Extensions / Eventing"
< BaSyx
(Created page with "== MqttAASAggregator (Implements IAASAggregator) == '''Package:''' org.eclipse.basyx.extensions.aas.aggregator.mqtt '''Events list:''' {| class="wikitable" |'''Method Name'...") |
m (Fixes wrong table header) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 6: | Line 6: | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | |'''Method Name | + | |'''Method Name''' || '''Topic Name''' || '''Payload''' |
|- | |- | ||
| − | |createAAS(AssetAdministrationShell aas) | + | |createAAS(AssetAdministrationShell aas)||BaSyxAggregator_createdAAS||$AASId |
|- | |- | ||
| − | |updateAAS(AssetAdministrationShell aas) | + | |updateAAS(AssetAdministrationShell aas)||BaSyxAggregator_updatedAAS||$AASId |
|- | |- | ||
| − | |deleteAAS(IIdentifier aasId) | + | |deleteAAS(IIdentifier aasId)||BaSyxAggregator_deletedAAS||$AASId |
|} | |} | ||
| Line 23: | Line 23: | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | |'''Method Name | + | |'''Method Name''' || '''Topic Name''' || '''Payload''' |
|- | |- | ||
| − | |register(AASDescriptor deviceAASDescriptor) | + | |register(AASDescriptor deviceAASDescriptor)|| BaSyxRegistry_registeredAAS||$AASId |
|- | |- | ||
| − | |register(IIdentifier aas, SubmodelDescriptor smDescriptor) | + | |register(IIdentifier aas, SubmodelDescriptor smDescriptor)||BaSyxRegistry_registeredSubmodel||($AASId,$SMId) |
|- | |- | ||
| − | |delete(IIdentifier aasId) | + | |delete(IIdentifier aasId)||BaSyxRegistry_deletedAAS||$AASId |
|- | |- | ||
| − | |delete(IIdentifier aasId, IIdentifier smId) | + | |delete(IIdentifier aasId, IIdentifier smId)||BaSyxRegistry_deletedSubmodel||($AASId,$SMId) |
|} | |} | ||
| Line 42: | Line 42: | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | |'''Method Name | + | |'''Method Name''' || '''Topic Name''' || '''Payload''' |
|- | |- | ||
| − | |MqttSubmodelAPI(ISubmodelAPI observedAPI, String serverEndpoint, String clientId) | + | |MqttSubmodelAPI(ISubmodelAPI observedAPI, String serverEndpoint, String clientId)||BaSyxSubmodel_createdSubmodel||$SMId |
|- | |- | ||
| − | |MqttSubmodelAPI(ISubmodelAPI observedAPI, String serverEndpoint, String clientId, String user, char[] pw)|| | + | |MqttSubmodelAPI(ISubmodelAPI observedAPI, String serverEndpoint, String clientId, String user, char[] pw)||BaSyxSubmodel_createdSubmodel||$SMId |
|- | |- | ||
| − | |MqttSubmodelAPI(ISubmodelAPI observedAPI, MqttClient client)|| | + | |MqttSubmodelAPI(ISubmodelAPI observedAPI, MqttClient client)||BaSyxSubmodel_createdSubmodel||$SMId |
|- | |- | ||
| − | |addSubmodelElement(ISubmodelElement elem) | + | |addSubmodelElement(ISubmodelElement elem)||BaSyxSubmodel_addedSubmodelElement||($AASId, $SMId , $ElementId) |
|- | |- | ||
| − | |addSubmodelElement(String idShortPath, ISubmodelElement elem) | + | |addSubmodelElement(String idShortPath, ISubmodelElement elem)||BaSyxSubmodel_addedSubmodelElement||($AASId, $SMId , $ElementIdShortPath) |
|- | |- | ||
| − | |deleteSubmodelElement(String idShortPath) | + | |deleteSubmodelElement(String idShortPath)||BaSyxSubmodel_removedSubmodelElement||($AASId, $SMId , $ElementIdShortPath) |
|- | |- | ||
| − | |updateSubmodelElement(String idShortPath, Object newValue) | + | |updateSubmodelElement(String idShortPath, Object newValue)||BaSyxSubmodel_updatedSubmodelElement||($AASId, $SMId , $ElementIdShortPath) |
|} | |} | ||
Latest revision as of 07:21, 30 September 2021
MqttAASAggregator (Implements IAASAggregator)
Package: org.eclipse.basyx.extensions.aas.aggregator.mqtt
Events list:
| Method Name | Topic Name | Payload |
| createAAS(AssetAdministrationShell aas) | BaSyxAggregator_createdAAS | $AASId |
| updateAAS(AssetAdministrationShell aas) | BaSyxAggregator_updatedAAS | $AASId |
| deleteAAS(IIdentifier aasId) | BaSyxAggregator_deletedAAS | $AASId |
MqttAASRegistryService (Implements IAASRegistryService)
Package: org.eclipse.basyx.extensions.aas.registration.mqtt
Events list:
| Method Name | Topic Name | Payload |
| register(AASDescriptor deviceAASDescriptor) | BaSyxRegistry_registeredAAS | $AASId |
| register(IIdentifier aas, SubmodelDescriptor smDescriptor) | BaSyxRegistry_registeredSubmodel | ($AASId,$SMId) |
| delete(IIdentifier aasId) | BaSyxRegistry_deletedAAS | $AASId |
| delete(IIdentifier aasId, IIdentifier smId) | BaSyxRegistry_deletedSubmodel | ($AASId,$SMId) |
MqttSubmodelAPI (Implements ISubmodelAPI)
Package: org.eclipse.basyx.extensions.events.submodel.mqtt
Events list:
| Method Name | Topic Name | Payload |
| MqttSubmodelAPI(ISubmodelAPI observedAPI, String serverEndpoint, String clientId) | BaSyxSubmodel_createdSubmodel | $SMId |
| MqttSubmodelAPI(ISubmodelAPI observedAPI, String serverEndpoint, String clientId, String user, char[] pw) | BaSyxSubmodel_createdSubmodel | $SMId |
| MqttSubmodelAPI(ISubmodelAPI observedAPI, MqttClient client) | BaSyxSubmodel_createdSubmodel | $SMId |
| addSubmodelElement(ISubmodelElement elem) | BaSyxSubmodel_addedSubmodelElement | ($AASId, $SMId , $ElementId) |
| addSubmodelElement(String idShortPath, ISubmodelElement elem) | BaSyxSubmodel_addedSubmodelElement | ($AASId, $SMId , $ElementIdShortPath) |
| deleteSubmodelElement(String idShortPath) | BaSyxSubmodel_removedSubmodelElement | ($AASId, $SMId , $ElementIdShortPath) |
| updateSubmodelElement(String idShortPath, Object newValue) | 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