Documentation of Standard Patterns

[LeStarch]

We are considering the idea of publishing standard patterns as part of F´ documentation. Thus far, we have come up with the following list.

Please comment and let us know what you'd like to see documented!

1. Implementation patterns (beginner) - Reference + Example
   1. Get/request pattern
   2. Callback pattern
   3. Memory allocation pattern
   4. Buffer manager pattern
   5. Sync cancel
   6. Internal interfaces
   7. Parallel ports
   8. Health
   9. State machines
2. Component Patterns: (beginner) - Reference + Example
   1. Central store
   2. Hub Pattern
   3. Manager/Worker pattern
   4. Rate group pattern
   5. Mode management patterns
   6. Interrupt handling
   7. Resource manager
3. Interface patterns (intermediate) - How To
   1. Generic interfaces - review guide
   2. Time/Tick
   3. Byte stream driver
   4. I2C
   5. SPI
   6. GPIO
   7. PWM
   8. Watchdog
4. Topology patterns (intermediate) - Decide by Item
   1. Custom configuration
   2. Reused component instances
   3. Sub topology
   4. Application/Driver/Manager pattern
   5. Fault protection
   6. Sequencer pooling
   7. Assert
   8. logger
   9. Security
   10. Simulation deployments
5. Integration patterns (advanced) - How To
   1. OS
   2. Hardware Platform
   3. New GDS
   4. Radio
   5. Framing protocol
   6. Vendor library
   7. Other framework
   8. Ground processing script
6. Modeling and build tool patterns (advanced) - How Guides
   1. Custom autocoder
   2. Custom model validation
   3. Custom model tool

[SterlingPeet]

Command registration and Dispatch as implemented in F Prime is often confusing for newcomers to the framework.

Telemetry handling can be equally confusing, but is generally easier to mimic and thus get it to work.

[SterlingPeet]

BTW, I am excited by the prospect of this documentation becoming available, I have had to explain a lot of it in situ for students. It would be great to be able to index into pattern documentation for learning purposes.

[ReggieMarr]

This is excellent, also fwiw I think the gold standard to strive for is documentation somewhat similar to what's provided by 0mq. Admittedly it's a massive amount of work but worth keeping in mind.

[thomas-bc]

Creating a thread to throw in ideas so as not to spam the main thread 🧵 ⬇️

[thomas-bc]

• FPP Pattern Graph specifiers and how to manually define one, say for a ModeManager component

[ReggieMarr]

speaking of threads, are there any examples of how to utilize thread virtualization or create custom threads os/task

[thomas-bc]

• Stop using PRIVATE: for UTs and use the test Friend class for whitebox testing instead

[SiboVG]

Hey! It would also be great to have an overview of the available built-in FPP types and their use case. I'm referring to something similar to the C++ documentation, but for FPP.

For example, in the Led Blinker workshop, you learn to add some ports to Led.fpp:

@ Port receiving calls from the rate group
async input port run: Svc.Sched

@ Port sending calls to the GPIO driver
output port gpioSet: Drv.GpioWrite

But I have no idea what other FPP port types exist or what their use case is.

[kevin-f-ortega]

Here are some ideas I have

• How to add a new toolchain
• How to integrate C/C++ libraries with F Prime
• How to port to a new operating system
• How to add CI
• How to structure your code to be reusable by other projects
• How to write drivers using the Interface paradigm

[LeStarch]

Some other ideas that came in via PR #3040:

1. Document the bytetreamdriver pattern
2. Document the buffer allocation/ownership pattern.

[SterlingPeet]

@zeroping may have some more recent experience with what would be helpful tutorials or cookbook recipes to help with onboarding developers

[LeStarch]

Recent experience or not, I'd love to hear @zeroping's suggestions!

[LeStarch]

#1844

[LeStarch]

#1688

[LeStarch]

#1487

[LeStarch]

#1251

[LeStarch]

#2689