The chat responses are generated using Generative AI technology for intuitive search and may not be entirely accurate. They are not intended as professional advice. For full details, including our use rights, privacy practices and potential export control restrictions, please refer to our Generative AI Service Terms of Use and Generative AI Service Privacy Information. As this is a test version, please let us know if something irritating comes up. Like you get recommended a chocolate fudge ice cream instead of an energy managing application. If that occurs, please use the feedback button in our contact form!

Provide Feedback

Feedback sent

Thank you for your feedback!

Provide Feedback

Please log in to provide feedback
Skip to content
Siemens Xcelerator Marketplace

ROSie Setup

In case you haven't already, please refer to the Engineering System Setup in order to prepare all the necessary tools to use ROSie.
Once the Engineering System is configured, copy the installer in the directory where you want to locate the ROSie generator.

To execute the installer you need to change its rights.

sudo chmod +x <ROSie_installer_name>

Run the installer with sudo privileges.

sudo bash <ROSie_installer_name>

If you use the standard ROS 2 installation path e.g. /opt/ros/humble, it will be detected automatically. Otherwise you will be asked to provide the path to your ROS 2 installation.

Creating directory rosie_workspace
Verifying archive integrity...  100%   MD5 checksums are OK. All good.
Uncompressing Installer for ROSie version 0-2-0  100%  
Loaded image: cr.siemens.com/ros/projects/ros_oie/ros_plc_connector/deploy:0.2.0
Loaded image: cr.siemens.com/ros/projects/ros_oie/ros_plc_connector/deploy:0-2-0
Found ROS 2 installation at: /opt/ros/humble
Are you using custom ROS 2 message packages? (y/n):

Afterwards you will be asked if you are using any custom ROS 2 messages that are not part of the standard ROS 2 installation. If that is not the case answer with n and press enter.

Are you using custom ROS 2 message packages? (y/n): n

If you are using custom messages, answer with y and type in the path to the install folder of your compiled custom message package(s). Please note that the custom messages packages must already be built for said install folder to exist.

Are you using custom ROS 2 message packages? (y/n): y
Please provide the path to the install folder of the ROS 2 workspace that contains the built custom messages.
Path to custom message workspace install folder (e.g. ros2_ws/install): /home/user/ros2_ws/install
Found custom message packages at: /home/user/ros2_ws/install

The ROSie workspace path will be set automatically to the directory of the 'package' folder.

If the setup was successful, you will see the following message:

Successfully installed ROSie environment.

If you want to move the ROSie generator to another location in the future, please rerun the install binary in the new location.
After the installation process, the newly created rosie_workspace directory can be opened e.g. via Visual Studio Code.

The created rosie_workspace directory contains the following workspace structure:

Details 
rosie_workspace  # The main workspace directory containing all subfolders of ROSie.
    |-- application_example_ros2_deployment  # Contains helper script and docker setup for providing an example docker based deployment of generated ROS 2 packages including RIB libraries.
    |-- docker_images  # Contains the compressed docker image of the ROSie generator.
    |-- documentation  # Location of the user documentation containing the command line tool, usage workflow and YAML config file structure used to specify which data is exchanged between the PLC and ROS 2.
    |-- input  # Input directory where the YAML configuration file and the .psc files have to be located.
        |-- valid_config_example.yaml  # Example configuration file.
    |-- oss  # Contains the used open source libraries and a OSS license overview file.
    |-- output  # Directory where every generated PLC code and ROS 2 package will be generated by ROSie under the directory name "date + timestamp".
    |-- scripts  # Contains the installation script to set up the ROSie environment on the user's system and to start ROSie.
    |-- template  # Directory with example TIA project files which can be used as templates for the user's own TIA project.
    |-- .env  # Environment configuration file for the ROSie generator. This file will be automatically edited by the installation script and stores the following environment variables:
              # [required] USER_ROS2_INSTALLATION_PATH: Path to the the users ROS 2 installation e.g. /opt/ros/humble.
              # [optional] USER_ROS2_INTERFACE_INSTALLATION_PATH: Path to the users custom interface installation path if custom .msg types are specified within the YAML config.
              # [required] USER_ROSIE_WORKSPACE_PATH: The path to this directory where the `.env` and `docker-compose.yaml` files are located.
    |-- docker-compose.yaml  # Docker Compose setup with predefined user volume mounting -> does not need to be changed.
    |-- README.md  # Entrypoint README for workspace descriptions
Contact us