helyOS Developer’s Manual

January 22, 2024

(version 2.2)

Fraunhofer IVI Zeunerstrasse 38 01069 Dresden Germany

• The helyOS Framework
  • Overview
  • Definitions
  • How It works
  • Software Components
  • Data Formats
• helyOS Configuration
  • Getting Started
  • How to Configure helyOS Core as Backend
  • Implementation of a Yard Automation Application
  • Admin Dashboard
• helyOS and Client Apps
  • Application accounts
  • Communication
  • Requesting Missions
  • Handling the Mission Execution
  • Working with Mission Queues
  • Examples
• helyOS and Microservices
  • Missions Request: from App to helyOS core
  • Service Requests: from helyOS to Microservices
  • Service Response: from Microservices to helyOS
  • Models Description
• helyOS and Agents
  • Exchange, Routing-keys and Queues in RabbitMQ
  • Code Examples
  • Check in agent in helyOS
  • Agent and Assignment Status Update
  • helyOS Reserves Agent for Mission
  • helyOS Sends Assignment to Agent
  • Canceling a Running Mission
  • Agent Reports Position and/or Sensor Data
  • Agent Requests a Mission
  • Assistant Agents and Data Retrieval
• Applications
  • Complex Mission Orchestration
  • More Examples of Missions using helyOS
  • Security in helyOS Framework
• FAQ
  • Why not code everything in a single backend? Why do I need helyOS?
  • What are microservices?
  • What does it means that “helyOS orchestrates microservices”?
  • What does it means that “helyOS orchestrates assignments”?
  • Can helyOS calculate trajectory paths?
  • Can I send several missions at once to one automated vehicle?
  • What is the difference between mission and assignment?
  • What is the data format for the agent sensors?
  • I want to use an online server for path calculation (or map information) which has its own API. How can I integrate with helyOS?
  • What is the difference between helyOS and Automation App?