**Everything here is heavily WIP. Although an effort is made to meet academic standards I can not guarantee them at this stage! Until release everything here is but a draft! This is not a publication!**
**Everything here is heavily WIP. Although an effort is made to meet academic standards I can not guarantee them at this stage! Until release everything here is but a draft! This is not a publication!**
# About this project
This project went through the following stages:
This project went through the following stages:
1. Creating a list of requirements for the frameworks to meet
1. Creating a list of requirements for the frameworks to meet
2. Compiling a list of frameworks to be considered
2. Compiling a list of frameworks to be considered
...
@@ -9,5 +11,15 @@ This project went through the following stages:
...
@@ -9,5 +11,15 @@ This project went through the following stages:
6. Implementation
6. Implementation
7. Writeup
7. Writeup
Steps 1 through 3 can be found in [deciding on a framework](deciding-on-a-framework)
Steps 1 through 3 can be found in [deciding on a framework](initial considerations/Deciding-on-a-framework)
Step 4 happened in [BaSyx Adventures](basyx-adventures)
Step 4 happened in [BaSyx Adventures](initial considerations/BaSyx-Adventures)
\ No newline at end of file
For an overview and the top level design of the demo, see [What am I looking at here?](What-am-I-looking-at-here)
In-depth explanations of the implementation can be found in the `implementation` folder of this wiki.
# Getting Started
In case you need to setup the demo first, please refer to the setup guides for the [Raspberry PIs](setup/Setting-up-a-Raspberry-Pi-for-the-demo) and the [ESP32 Microcontrollers](setup/Setting-up-an-ESP32), as well as to the [network structure](What-am-I-looking-at-here#network-structure) and the [wiring guide](setup/Wiring-of-the-demo).
A good starting point for getting familiar with development for BaSyx are the `SubmodelProviders`, in particular the [LightControllerSubmodelProvider](implementation/Light-Controller-walkthrough#lightcontrollersubmodelprovider).
In both the code file (it is heavily commented) as well as the walkthrough, there is plenty of information on how to add a Property, do calls to other methods, host a Submodel, create and upload an AAS as well as registering AAS and Submodel.