From 10e1f252e673c2ffa29a089fbe4944cf46b79e9c Mon Sep 17 00:00:00 2001 From: ipa-nhg Date: Sun, 9 Jun 2024 18:07:22 +0200 Subject: [PATCH] Update minor issues on the documentation --- docu/CodeGeneration.md | 5 +++-- docu/LearnRosSystemModels.md | 4 ++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docu/CodeGeneration.md b/docu/CodeGeneration.md index 9f3a634..f0eb1e1 100644 --- a/docu/CodeGeneration.md +++ b/docu/CodeGeneration.md @@ -8,9 +8,10 @@ For the System model, the generation of code is automatic, which means if your m * CMakeLists.txt: a template of the package.xml which includes the required tags to install the newly created files. * launch/NameOfTheSystem.launch.py script: This is the core of the generator. This is a **ready-to-execute** file that based on the .rossystem description: * Add includes to all the defined nodes as components - * Define and set the value of the parameters. For packages containing more than 5 parameters an extra .yaml file will be created and launched from this launch file. + * Define and set the value of the parameters. For packages containing more than 5 parameters the .yaml file under the "config" folder will be loaded and launched. * Remap topics to force connections. This is only working for nodes that are part of the system as components, not for subsystems. See [known issues](RosTooling_issues.md#code-generators) * Include other launch files from subsystems. * resource/NameOfTheSystem.puml: [An example of a PlantUML implementation of the described system](SystemModelsVisualization.md#open-the-plantuml-auto-generated-description) +* config/NameOfTheSystem.yaml: this file contains the configuration of the parameters. It will only be used in case of the set of 5 parameters or more. -With the current implementation of RosTooling adding new code generators to the .rossystem representation is very easy, please report on our survey on the open-ended questions your wishes like for example, the generation of install scripts and/or Docker container configuration or ROS1-ROS2 bridges. \ No newline at end of file +With the current implementation of RosTooling adding new code generators to the .rossystem representation is very easy, please report on our survey on the open-ended questions your wishes like for example, the generation of install scripts and/or Docker container configuration or ROS1-ROS2 bridges. diff --git a/docu/LearnRosSystemModels.md b/docu/LearnRosSystemModels.md index a42dce4..60b1e8d 100644 --- a/docu/LearnRosSystemModels.md +++ b/docu/LearnRosSystemModels.md @@ -152,7 +152,7 @@ my_awesome_system: The compiler will give an error of mismatched type. ![](images/Attention.png) The validator has some parts not fully implemented, check the [Known issues](RosTooling_issues.md) site in case you have problems by following this tutorial. -Another feature included as part of the code generator is the generator of parameter files. This will be automatically done by the set of more than 5 parameters, for example for this example: +Another feature included as part of the code generator is the generator of parameter files. This will be automatically done and the launch file will by default load it by the set of more than 5 parameters, for example for this case: ``` my_awesome_system: @@ -187,4 +187,4 @@ my_awesome_system: In this case, a new file will be created under "src-gen/PackageName/config/" and it will contain the configuration of the node2. The launch file will be adapted to launch the configuration from a file. -With this very basic example, we hope you have understood how the models can be used and what kind of attributes they allow to represent. \ No newline at end of file +With this very basic example, we hope you have understood how the models can be used and what kind of attributes they allow to represent.