sdk: Add tutorial for Submodel navigation #411
Conversation
This file contains hidden or 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
Previously, we lacked a tutorial demonstrating how to navigate a Submodel's hierarchy using IdShorts and IdShortPaths. This adds a simple tutorial for Submodel navigation and updates the documentation to reference it. The end user is shown how to navigate SubmodelElements, such as simple Properties, Property Collections, Property Lists and Collection Lists. Fixes eclipse-basyx#351
|
I have two more questions about this topic:
|
s-heppner
requested changes
Sep 3, 2025
Comment on lines
-129
to
+131
| * [`tutorial_aasx`](./basyx/aas/examples/tutorial_aasx.py): Export Asset Administration Shells with related objects and auxiliary files to AASX package files | ||
| * [`tutorial_backend_couchdb`](./basyx/aas/examples/tutorial_backend_couchdb.py): Use the *Backends* interface (`update()/commit()` methods) to manage and retrieve AAS objects in a CouchDB document database | ||
| * [`tutorial_aasx`](./basyx/aas/examples/tutorial_aasx.py): Export Asset Administration Shells with related objects and auxiliary files to AASX package files |
There was a problem hiding this comment.
Why did you move the tutorial_aasx down? In my head, it'd be a more logical order to first cover AASX and then CouchDB.
| # through them using IdShorts and IdShortPaths. | ||
| # | ||
| # Step-by-Step Guide: | ||
| # Step 1: Create a Submodel with a Property, a Property Collection, a Property List and a Collection List |
There was a problem hiding this comment.
Suggested change
| # Step 1: Create a Submodel with a Property, a Property Collection, a Property List and a Collection List | |
| # Step 1: Create a Submodel with a Property, a SubmodelElementCollection of Properties, a SubmodelElementList of Properties and a SubmodelElementList of SubmodelElementCollections |
Comment on lines
+16
to
+17
| # Step 2: Navigate through the Submodel using IdShorts and IdShortPaths | ||
|
|
There was a problem hiding this comment.
Maybe we could add a little "directory-tree" here to show the final layout of the created Submodel? Something like:
Submodel
| -- Property "idShort1"
| -- SMC "idShort2"
| | -- Property "idShort3"
| -- SML
...
Comment on lines
9
to
14
| tutorial_create_simple_aas | ||
| tutorial_serialization_deserialization | ||
| tutorial_navigate_aas | ||
| tutorial_storage | ||
| tutorial_serialization_deserialization | ||
| tutorial_backend_couchdb | ||
| tutorial_aasx |
There was a problem hiding this comment.
Should follow the same order as in the README.
|
@moritzsommer wrote here:
ad 1.) I agree that this is ugly, but not every ad 2.) This should be covered by the tutorial_storage. Maybe you can refer in this tutorial to it? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we lacked a tutorial demonstrating how to navigate a Submodel's hierarchy using IdShorts and IdShortPaths.
This adds a simple tutorial for Submodel navigation and updates the documentation to reference it. The end user is shown how to navigate SubmodelElements, such as simple Properties, Property Collections, Property Lists and Collection Lists.
Fixes #351