xiaoxiang781216 commented on code in PR #17756: URL: https://github.com/apache/nuttx/pull/17756#discussion_r2659310140
########## Documentation/applications/examples/smf/index.rst: ########## @@ -0,0 +1,56 @@ +================================================== +``smf`` State Machine Framework HSM PSiCC2 Example +================================================== + +This example implements an event-driven hierarchical state machine using the +State Machine Framework (SMF). It reproduces the statechart shown in Figure 2.11 +of Practical UML Statecharts in C/C++, 2nd Edition, by Miro Samek (PSiCC2). +The ebook is available at https://www.state-machine.com/psicc2. + +For each state, the entry, run, and exit actions are logged to the console, as +well as logging when a state handles an event or explicitly ignores it and +passes it up to the parent state. + +It should be possible to build and run this demo on most boards or emulators +that support NSH, SMF, and message queues. + +Configuration +============= + +- ``CONFIG_EXAMPLES_SMF`` – Enables the SMF PSiCC2 demo. +- ``CONFIG_NSH_BUILTIN_APPS`` – Build the demo as an NSH built-in application. +- ``CONFIG_APPS_SMF`` – Enable the State Machine Framework support. Review Comment: let's update the document per the recent change in apps repo. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
