嵌入式框架Zorb Framework搭建四：状态机的实现

我是卓波，我是一名嵌入式工程师，我万万没想到我会在这里跟大家吹牛皮。

嵌入式框架Zorb Framework搭建过程

嵌入式框架Zorb Framework搭建一：嵌入式环境搭建、调试输出和建立时间系统

嵌入式框架Zorb Framework搭建二：环形缓冲区的实现

嵌入式框架Zorb Framework搭建三：列表的实现

嵌入式框架Zorb Framework搭建四：状态机的实现

嵌入式框架Zorb Framework搭建五：事件的实现

嵌入式框架Zorb Framework搭建六：定时器的实现

嵌入式框架Zorb Framework搭建七：任务的实现

一、前言

　　在这一篇中，我们将为Zorb Framework提供状态机功能。中小型嵌入式程序说白了就是由各种状态机组成，因此掌握了如何构建状态机，开发嵌入式应用程序可以说是手到拈来。简单的状态机可以用Switch-Case实现，但复杂一点的状态机再继续使用Switch-Case的话，层次会变得比较乱，不方便维护。因此我们为Zorb Framework提供了函数式状态机。

二、状态机设计

　　我们先来看看要实现的状态机提供什么功能：

　　初步要提供的功能如下：

　　1、可以设置初始状态

　　2、可以进行状态转换

　　3、可以进行信号调度

　　4、最好可以在进入和离开状态的时候可以做一些自定义的事情

　　5、最好可以有子状态机

　　因此，初步设计的数据结构如下：

 /* 状态机结构 */
 struct _Fsm
 {
     uint8_t Level;                  /* 嵌套层数，根状态机层数为1，子状态机层数自增 */
                                     /* 注：严禁递归嵌套和环形嵌套 */
     List *ChildList;                /* 子状态机列表 */
     Fsm *Owner;                     /* 父状态机 */
     IFsmState OwnerTriggerState;    /* 当父状态机为设定状态时，才触发当前状态机 */
                                     /* 若不设定，则当执行完父状态机，立即运行子状态机 */
     IFsmState CurrentState;         /* 当前状态 */
     bool IsRunning;                 /* 是否正在运行(默认关) */

     /* 设置初始状态 */
     void (*SetInitialState)(Fsm * const pFsm, IFsmState initialState);

     /* 运行当前状态机 */
     bool (*Run)(Fsm * const pFsm);

     /* 运行当前状态机和子状态机 */
     bool (*RunAll)(Fsm * const pFsm);

     /* 停止当前状态机 */
     bool (*Stop)(Fsm * const pFsm);

     /* 停止当前状态机和子状态机 */
     bool (*StopAll)(Fsm * const pFsm);

     /* 释放当前状态机 */
     bool (*Dispose)(Fsm * const pFsm);

     /* 释放当前状态机和子状态机 */
     bool (*DisposeAll)(Fsm * const pFsm);

     /* 添加子状态机 */
     bool (*AddChild)(Fsm * const pFsm, Fsm * const pChildFsm);

     /* 移除子状态机(不释放空间) */
     bool (*RemoveChild)(Fsm * const pFsm, Fsm * const pChildFsm);

     /* 调度状态机 */
     bool (*Dispatch)(Fsm * const pFsm, FsmSignal const signal);

     /* 状态转移 */
     void (*Transfer)(Fsm * const pFsm, IFsmState nextState);

     /* 状态转移(触发转出和转入事件) */
     void (*TransferWithEvent)(Fsm * const pFsm, IFsmState nextState);
 };

　　关于信号，Zorb Framework做了以下定义：

 /* 状态机信号0-31保留，用户信号在32以后定义 */
 enum {
     FSM_NULL_SIG = ,
     FSM_ENTER_SIG,
     FSM_EXIT_SIG,
     FSM_USER_SIG_START =
     /* 用户信号请在用户文件定义，不允许在此定义 */
 };

　　其中，0-31为框架信号，用户信号在32之后定义。

　　状态机已经设计好了，具体实现请看附件代码或在文末的github地址拉框架源码。

三、状态机结果测试

　　简单的测试代码如下：

 /**
   *****************************************************************************
   * @file    app_fsm.c
   * @author  Zorb
   * @version V1.0.0
   * @date    2018-06-28
   * @brief   状态机测试的实现
   *****************************************************************************
   * @history
   *
   * 1. Date:2018-06-28
   *    Author:Zorb
   *    Modification:建立文件
   *
   *****************************************************************************
   */

 #include "app_fsm.h"
 #include "zf_includes.h"

 /* 定义用户信号 */
 enum Signal
 {
     SAY_HELLO = FSM_USER_SIG_START
 };

 Fsm *pFsm;        /* 父状态机 */
 Fsm *pFsmSon;     /* 子状态机 */

 /* 父状态机状态1 */
 static void State1(Fsm * const pFsm, FsmSignal const fsmSignal);
 /* 父状态机状态2 */
 static void State2(Fsm * const pFsm, FsmSignal const fsmSignal);

 /******************************************************************************
  * 描述  ：父状态机状态1
  * 参数  ：-pFsm       当前状态机
  *         -fsmSignal  当前调度信号
  * 返回  ：无
 ******************************************************************************/
 static void State1(Fsm * const pFsm, FsmSignal const fsmSignal)
 {
     switch(fsmSignal)
     {
         case FSM_ENTER_SIG:
             ZF_DEBUG(LOG_D, "enter state1\r\n");
             break;

         case FSM_EXIT_SIG:
             ZF_DEBUG(LOG_D, "exit state1\r\n\r\n");
             break;

         case SAY_HELLO:
             ZF_DEBUG(LOG_D, "state1 say hello, and want to be state2\r\n");
             /* 切换到状态2 */
             pFsm->TransferWithEvent(pFsm, State2);
             break;
     }
 }

 /******************************************************************************
  * 描述  ：父状态机状态2
  * 参数  ：-pFsm       当前状态机
  *         -fsmSignal  当前调度信号
  * 返回  ：无
 ******************************************************************************/
 static void State2(Fsm * const pFsm, FsmSignal const fsmSignal)
 {
     switch(fsmSignal)
     {
         case FSM_ENTER_SIG:
             ZF_DEBUG(LOG_D, "enter state2\r\n");
             break;

         case FSM_EXIT_SIG:
             ZF_DEBUG(LOG_D, "exit state2\r\n\r\n");
             break;

         case SAY_HELLO:
             ZF_DEBUG(LOG_D, "state2 say hello, and want to be state1\r\n");
             /* 切换到状态1 */
             pFsm->TransferWithEvent(pFsm, State1);
             break;
     }
 }

 /******************************************************************************
  * 描述  ：子状态机状态
  * 参数  ：-pFsm       当前状态机
  *         -fsmSignal  当前调度信号
  * 返回  ：无
 ******************************************************************************/
 static void SonState(Fsm * const pFsm, FsmSignal const fsmSignal)
 {
     switch(fsmSignal)
     {
         case SAY_HELLO:
             ZF_DEBUG(LOG_D, "son say hello only in state2\r\n");
             break;
     }
 }

 /******************************************************************************
  * 描述  ：任务初始化
  * 参数  ：无
  * 返回  ：无
 ******************************************************************************/
 void App_Fsm_init(void)
 {
     /* 创建父状态机，并设初始状态 */
     Fsm_create(&pFsm);
     pFsm->SetInitialState(pFsm, State1);

     /* 创建子状态机，并设初始状态 */
     Fsm_create(&pFsmSon);
     pFsmSon->SetInitialState(pFsmSon, SonState);

     /* 设置子状态机仅在父状态State2触发 */
     pFsmSon->OwnerTriggerState = State2;

     /* 把子状态机添加到父状态机 */
     pFsm->AddChild(pFsm, pFsmSon);

     /* 运行状态机 */
     pFsm->RunAll(pFsm);
 }

 /******************************************************************************
  * 描述  ：任务程序
  * 参数  ：无
  * 返回  ：无
 ******************************************************************************/
 void App_Fsm_process(void)
 {
     ZF_DELAY_MS();
     /* 每1000ms调度状态机，发送SAY_HELLO信号 */
     pFsm->Dispatch(pFsm, SAY_HELLO);
 }

 /******************************** END OF FILE ********************************/

　　结果：

state1 say hello, and want to be state2
exit state1

enter state2
son say hello only in state2
state2 say hello, and want to be state1
exit state2

enter state1
state1 say hello, and want to be state2
exit state1

enter state2
son say hello only in state2
state2 say hello, and want to be state1
exit state2

enter state1
state1 say hello, and want to be state2
exit state1

省略...

四、最后

　　本篇为Zorb Framework提供了状态机功能，复杂的状态转换关系被分解成了一个个状态函数，然后在状态函数中仅仅需要处理本状态出现的情况，忽然感觉世界变得简单很多。后面再配上即将为框架添加的事件功能，会让状态机的功能发挥到极致。

　　Zorb Framework github：https://github.com/54zorb/Zorb-Framework

　　版权所有，转载请打赏哟

如果你喜欢我的文章，可以通过微信扫一扫给我打赏哟