home.md

@@ -10,11 +10,11 @@ This project went through the following stages:
 5. Writeup (this wiki)
 
 Step one and two are written as pretty much a diary, it's mostly there for possibly future reference and as part of the "Praktikumsprotokoll".  
-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 implementations are linked there, too.
+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 implementations are linked there, too.
 
 # 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).
+In case you need to set up 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).
 
 Please see [what am I looking at here?](What-am-I-looking-at-here) for a good overview of this Demo, in depth walkthroughs through the code are linked there, too.
 
@@ -26,21 +26,22 @@ I'll be part of this Group for a while. If you have any question to which you co
 
 # Future Projects
 
-This is a unsorted list of future projects for this Demo.
+This is an unsorted list of future projects for this Demo.
 
-1. Porting to [BaSyx v2](https://wiki.eclipse.org/BaSyx_/_Releases_and_Features#Java_Release_2.0) once it gets released. I've provided a branch with a blind port, but since there is [no AAS Server yet](https://github.com/eclipse-basyx/basyx-java-components/issues/25) it can't be tested.  
-The Changes I've made are pretty much self explanatory, see [here](https://gitlab.hrz.tu-chemnitz.de/vws-demo/vws-spielwiese/-/compare/main...basyx-v2?from_project_id=10357). Mostly renaming and the odd method requiring a list instead of just a bare String.
-2. Implementing the [BaSyx Submodel API](https://app.swaggerhub.com/apis/BaSyx/basyx_submodel_http_rest_api/v1) on an ESP32. This would eliminate the need for a way more poweful machine like the Raspberry Pi, especially, if pushing the relevant AAS and registering can be done, too. This might bring the cost of integration of existing gear into a I4.0 environment down by an order of magnitude.
+1. Porting to [BaSyx v2](https://wiki.eclipse.org/BaSyx_/_Releases_and_Features#Java_Release_2.0) once it gets released. I've provided a branch with a blind port, but since there is [no AAS Server, yet](https://github.com/eclipse-basyx/basyx-java-components/issues/25) it can't be tested.  
+The Changes I've made are pretty much self-explanatory, see [here](https://gitlab.hrz.tu-chemnitz.de/vws-demo/vws-spielwiese/-/compare/main...basyx-v2?from_project_id=10357). Mostly renaming and the odd method requiring a list instead of just a bare String.
+2. Implementing the [BaSyx Submodel API](https://app.swaggerhub.com/apis/BaSyx/basyx_submodel_http_rest_api/v1) on an ESP32. This would eliminate the need for a way more powerful machine like the Raspberry Pi, especially, if pushing the relevant AAS and registering can be done, too. This might bring the cost of integration of existing gear into a I4.0 environment down by an order of magnitude.
 3. ~Containerizing the components. I've worked extensively using environment variables here, so it should be quite suited for docker images.  
-At least for a "off the shelf" container to run the whole demo virtually on your local machine I can see good use.~
-4. ~Create a nice looking demonstration stand. Right now, the whole thing is basically a pile of wires and computers - not very appealing.~
+At least for an "off the shelf" container to run the whole demo virtually on your local machine, I can see good use.~
+4. ~Create a nice-looking demonstration stand. Right now, the whole thing is basically a pile of wires and computers – not very appealing.~
 5. Maybe create a PCB and case for the [Demonstration Controller](What-am-I-looking-at-here#demonstration-controller)
 5. Implement the lookup of relevant AAS and submodels for the [Light Controller](implementation/Light-Controller-walkthrough#lightcontroller) and [Light Animator](implementation/Light-Animator-walkthrough#lightanimator) by looking up implementations of types of AAS and Submodels instead of relying on a naming convention I made up.
-6. ~Reimplement the Demo using other frameworks - or at least evaluate their interoperability, especially after BaSyx v2 gets released.~
-7. Find a way to upload the AAS created in [C#](follow-up/C-Sharp-Module) to the Java AAS Server so it will work like the other lights.
-8. Properly debounce the switches on the [Demo Controller](/implementation/Demo-Controller-walkthrough). Currently some buttons get pressed "together" even when only one is pressed (especially the ones for stopping the light controller and update the lights). It could follow [these methods](http://www.ganssle.com/debouncing.htm).
+6. ~Reimplement the Demo using other frameworks – or at least evaluate their interoperability, especially after BaSyx v2 gets released.~
+7. Find a way to upload the AAS created in [C#](follow-up/C-Sharp-Module) to the Java AAS Server, so it will work like the other lights.
+8. Properly debounce the switches on the [Demo Controller](/implementation/Demo-Controller-walkthrough). Currently, some buttons get pressed "together" even when only one is pressed (especially the ones for stopping the light controller and update the lights). It could follow [these methods](http://www.ganssle.com/debouncing.htm).
+9. Make the host which the components think they are running on configurable. This way, the Docker containers do not need to use the host network stack.
 
 # Sources for the diagrams
 
-The source code for the diagrams is embedded in the svg files (for [PlantUML](https://plantuml.com/en/) diagrams) and/or available here: [diagram_sources.zip](uploads/9dbd9a4ab909b69f78f904e185e71ec3/diagram_sources.zip).
+The source code for the diagrams is embedded in the SVG files (for [PlantUML](https://plantuml.com/en/) diagrams) and/or available here: [diagram_sources.zip](uploads/9dbd9a4ab909b69f78f904e185e71ec3/diagram_sources.zip).
 Feel free to use them to further develop this documentation.
\ No newline at end of file