How to auto-generate documentation/sdd.md from fpp file

[devKumarChandil15]

Query

How to auto-generate documentation from fpp file

Versions

Operating System: Linux
CPU Architecture: x86_64
Platform: Linux-6.8.0-52-generic-x86_64-with-glibc2.39
Python version: 3.12.3
CMake version: 3.28.3
Pip version: 25.0.1
Pip packages:
    fprime-tools==3.6.0
    fprime-gds==3.6.0
    fprime-fpp-*==2.3.0
Project submodules:
    /~https://github.com/nasa/fprime.git @ v3.6.0

Query

Hello All,
I was going through the FPP F Prime component creation. After modifying the fpp file, and using it. We can see that a sdd.md file is created. Only the description of the component is getting filled in the said sdd.md file. I want to know how can we generate the whole sdd.md file using the fpp file, which also uses the annotations provided in the fpp file.

Also, is it possible if I use a state machine in my fpp file, that can there be a visual representation of the state machine be created in the sdd.md file as provided in the explanation of the State Machine in the following link: https://nasa.github.io/fpp/fpp-users-guide.html#Defining-State-Machines

Example Image:

Reference Link

1. https://nasa.github.io/fpp/fpp-users-guide.html#Defining-State-Machines_States-Signals-and-Transitions

[thomas-bc]

@devKumarChandil15 This is a really good question! Currently, there's no mechanism that I know of that will generate SDDs from FPP. However:

• there are tools here and there to generate certain diagrams, such as fprime-util visualize which visualizes topologies, or I know there's a tool to generate component diagrams with input/output ports, but I think that's a manual thing
• it is on our roadmap to generate SDDs from FPP files, see for example ROSES - SDD Automation Tool #3136. This can be enabled by fpp-to-json

[devKumarChandil15]

Thanks @thomas-bc , I will be following the #3136 to understand more on my query