[Toolchain] STM32 MCU's mit State Machine Diagram in C

[Achim M. (Firma: Licht Kunst & Gestaltung) (artbody)]

Kurze Vorgeschichte
Ich war nun doch mehrere Tage auf der Suche, nach einem Tool mit dem man 
eine etwas komplexere Menüführung, als Finite State Machine einfach 
erstellen kann und welches C Code generiert.
Das Tool sollte auch einfach zu handeln sein
und sollte in einer einfachen Art und Weise in meine bestehende 
Toolchain integrierbar sein.

Meine Toolchain:
 STMCubeMX und SW4STM32 oder Atollic trueStudio
unter LINUX

Gefunden und ausprobiert hatte ich einiges, aber entweder Java, C++, ... 
oder so gut wie nicht integrierbar.

Im Bereich C Code wird es da echt mager.

Ok propriätäre Software gibt es ein paar, aber das meiste für die 
Windose
Fällt also aus wegen "isnich"

So nun will ich euch aber nicht weiter auf die Folter spannen.
Dieses Tool ist Open Source.

FW Profil Framework
https://github.com/pnp-software/fwprofile
Die Hauptfeatures sind:

    C language implementation suitable for safety-critical, real-time 
and embedded applications
    Web-based modeling tool with C code generation available

Zum Erstellen der Diagramme gibt es einen Online Editor
https://pnp-software.com/fwprofile/editor


Ein Screenshot habe ich oben angehängt.

Die Integration ist im Prinzip recht einfach.
über git clone FW Profil herunter laden und den Ordner fwprofil/Src und 
fwprofil/Inc in das eigene Projekt kopieren.

in ST4STM32
unter
Project->Porperties->C/C++ General->Paths and Symbols
-> Source Location
../fwprofil/Src
-> Library Paths
../fwprofil/Inc

unter
Project->Porperties->C/C++ Build->MCU GCC Compiler
-> Includes
../fwprofil/Inc

eintragen.

Nach dem Erstellen der FSM im Online Editor läd man sich die Zip Datei 
herunter. Diese entpacke man an die entsprechende Stelle und verlinke 
dann die 2 Dateien auf welche es ankommt.
mainFsm.zip wurde nach ./fwFsm entpackt
z.B. wie folgt
./fwFsm/mainFsm
./fwFsm/mainFsm/MainFsm.c   ->link nach ../../Src/MainFsm.c
./fwFsm/mainFsm/MainFsm.h   ->link nach ../../Irc/MainFsm.h
./fwFsm/mainFsm/MainFsmMain.c
./fwFsm/mainFsm/MainFsm.png
./fwFsm/mainFsm/MainFsm.json

Aus der Datei MainFsmMain.c kopiere man die #include *.h
und den benötigten Teil aus main() in die main.c, welche von STM32CubeMX 
generiert wurde

/**
 * @file MainFsmMain.c
 *
 * @author FW Profile code generator version 5.22
 * @date Created on: Jan 28 2019 23:30:11
 */

/** MainFsm function definitions */
#include "MainFsm.h"

/** FW Profile function definitions */
#include "FwSmConstants.h"
#include "FwSmSCreate.h"
#include "FwSmConfig.h"
#include "FwSmCore.h"

#include <stdio.h>
#include <stdlib.h>

int main(void)
{
/***************************************************COPPY START***/
  /** Define the state machine descriptor (SMD) */
  FwSmDesc_t smDesc = MainFsmCreate(NULL);

  /** Check that the SM is properly configured */
  if (FwSmCheckRec(smDesc) != smSuccess) {
    printf("The state machine MainFsm is NOT properly configured ... FAILURE\n");

    //do not use in STM!
                //you are in main()
                // _>>>>> return EXIT_FAILURE;
  }

  printf("The state machine MainFsm is properly configured ... SUCCESS\n");

  /** Start the SM, send a few transition commands to it, and execute it */
  FwSmStart(smDesc);
  FwSmMakeTrans(smDesc, TCLK);
  FwSmMakeTrans(smDesc, TCLAK);
/******************************************************COPPY END***/
  return EXIT_SUCCESS;
}

Das war es eigentlich schon.
main.c schaut dann ungefähr so aus.

...
/* USER CODE BEGIN Includes */
#include "stm32f4xx_hal.h"
/** MainFsm function definitions */
#include "MainFsm.h"

/** FW Profile function definitions */
#include "FwSmConstants.h"
#include "FwSmSCreate.h"
#include "FwSmConfig.h"
#include "FwSmCore.h"

#include <stdio.h>
#include <stdlib.h>

....
int main(void)
{
...
/* Infinite loop */
  /* USER CODE BEGIN WHILE */
  /** Define the state machine descriptor (SMD) */

  FwSmDesc_t smDesc = FwFsmCreate(NULL);
  printf("The state machine Example2 is properly configured ... SUCCESS\n");

  /** Start the SM, send a few transition commands to it, and execute it */
  FwSmStart(smDesc);
    while (1) {
      ...
        FwSmMakeTrans(smDesc, TriggerCLK);
  FwSmMakeTrans(smDesc, TriggerCLAK);
      .....
    }
}

Jetzt müsste sich das Ganze bereits compilieren lassen.


Ich hab mir zum entpacken der *.zip ein kurzes bash Script geschrieben, 
so dass nach dem Herunterladen nicht viel zu tun ist. Die gesetzten 
links bleiben ja bestehen.

Wenn man in dem Online Editor z.B. die Global Properties auf der rechten 
Seite benutzt kann man sehr einfach über z.B. #include "stm32l0xx_hal.h" 
die Funktionen der HAL einbinden.
Einen Datenaustausch zwischen FSM und main.c habe u.a. mit einem Typedef 
in einer externen Datei *.h realisiert.
und mit #include "fsmDefs.h" entsprechend eingebunden.

typedef struct {
  FwSmBool_t switcher_raised;
  uint32_t switcher_value;
        ....
    char tmp[32];
} FsmIFace ;
FsmIFace iface;

mit z.B. kann man wie gewohnt Funktionen einbinden
extern void Error_Handler(void);

Die meiste Funktionalität kann man direkt in der StateMachine über
das * Properties Fenster am rechten Rand
per
-> define function
GUARD1_IF_SW1
gefolgt von
-> run code

/*do not enter the STATE when sw1 is on */
if(piface->sw1_value == 0){
return 1;
}
return 0;

ALLES IN ALLEM sehr einfach einzubinden und die Einarbeitszeit bis zur 
Benutzbarkeit hält sich auch im Rahmen.

[Dr. Sommer (Gast)]

Achim M. schrieb:
> Gefunden und ausprobiert hatte ich einiges, aber entweder Java, C++, ...
> oder so gut wie nicht integrierbar.
>
> Im Bereich C Code wird es da echt mager.

Weil C++ noch schlimmer als Codegenerierung ist? Oje.