Routine Diagrams

Introduction

This section contains sequence diagrams and execution flow diagrams automatically generated from the FLC routine configuration files. These diagrams help visualize the routine execution flow and provide a better understanding of how the different components interact.

The diagrams are organized by sections, corresponding to the subdirectories in the src/configs/routines directory (example):

  • NLOS: Routines specific to the NLOS subsystem

Types of Diagrams

For each section, the following diagrams are generated:

  1. Sequence Diagrams: Detailed diagrams showing the step-by-step execution of each API-registered routine

  2. API Summary: An overview diagram showing all API-registered routines in the section

  3. Execution Flow: A diagram showing the typical execution order of the routines

Interactive Features

The HTML versions of the diagrams are interactive:

  • You can click on any routine node in the summary or execution flow diagrams to open its detailed sequence diagram

  • The diagrams can be zoomed and panned for better visibility

Configuration

The execution flow diagrams are configured using the execution_flow.conf file. This file allows you to define the expected order of routine execution and add custom connections between steps.

[SectionName]
# Each line defines a step in the execution flow
Routine Name: Description
Another Routine: Another Description

# You can add connections between non-consecutive steps
Connection: source_number -> target_number

Diagrams