一個輕量級的開源嵌入式狀態(tài)機(jī)框架
加入技術(shù)交流群
Zorb Framework是一個基于面向?qū)ο蟮乃枷雭泶罱ㄒ粋€輕量級的嵌入式框架。
本次分享的是Zorb Framework的狀態(tài)機(jī)的實現(xiàn)。中小型嵌入式程序說白了就是由各種狀態(tài)機(jī)組成，因此掌握了如何構(gòu)建狀態(tài)機(jī)，開發(fā)嵌入式應(yīng)用程序可以說是手到拈來。
簡單的狀態(tài)機(jī)可以用Switch-Case實現(xiàn)，但復(fù)雜一點(diǎn)的狀態(tài)機(jī)再繼續(xù)使用Switch-Case的話，層次會變得比較亂，不方便維護(hù)。
因此我們?yōu)閆orb Framework提供了函數(shù)式狀態(tài)機(jī)。
狀態(tài)機(jī)的功能項目地址：https://github.com/54zorb/Zorb-Framework
我們先來看看要實現(xiàn)的狀態(tài)機(jī)提供什么功能：初步要提供的功能如下：
- 可以設(shè)置初始狀態(tài);
- 可以進(jìn)行狀態(tài)轉(zhuǎn)換;
- 可以進(jìn)行信號調(diào)度;
- 最好可以在進(jìn)入和離開狀態(tài)的時候可以做一些自定義的事情;
- 最好可以有子狀態(tài)機(jī);
因此，初步設(shè)計的數(shù)據(jù)結(jié)構(gòu)如下：
`/* 狀態(tài)機(jī)結(jié)構(gòu) */
struct _Fsm
{
uint8_t Level; /* 嵌套層數(shù)，根狀態(tài)機(jī)層數(shù)為1，子狀態(tài)機(jī)層數(shù)自增 */
/* 注：嚴(yán)禁遞歸嵌套和環(huán)形嵌套 */
List *ChildList; /* 子狀態(tài)機(jī)列表 */
Fsm *Owner; /* 父狀態(tài)機(jī) */
IFsmState OwnerTriggerState; /* 當(dāng)父狀態(tài)機(jī)為設(shè)定狀態(tài)時，才觸發(fā)當(dāng)前狀態(tài)機(jī) */
/* 若不設(shè)定，則當(dāng)執(zhí)行完父狀態(tài)機(jī)，立即運(yùn)行子狀態(tài)機(jī) */
IFsmState CurrentState; /* 當(dāng)前狀態(tài) */
bool IsRunning; /* 是否正在運(yùn)行(默認(rèn)關(guān)) */
/* 設(shè)置初始狀態(tài) */
void (*SetInitialState)(Fsm * const pFsm, IFsmState initialState);
/* 運(yùn)行當(dāng)前狀態(tài)機(jī) */
bool (*Run)(Fsm * const pFsm);
/* 運(yùn)行當(dāng)前狀態(tài)機(jī)和子狀態(tài)機(jī) */
bool (*RunAll)(Fsm * const pFsm);
/* 停止當(dāng)前狀態(tài)機(jī) */
bool (*Stop)(Fsm * const pFsm);
/* 停止當(dāng)前狀態(tài)機(jī)和子狀態(tài)機(jī) */
bool (*StopAll)(Fsm * const pFsm);
/* 釋放當(dāng)前狀態(tài)機(jī) */
bool (*Dispose)(Fsm * const pFsm);
/* 釋放當(dāng)前狀態(tài)機(jī)和子狀態(tài)機(jī) */
bool (*DisposeAll)(Fsm * const pFsm);
/* 添加子狀態(tài)機(jī) */
bool (*AddChild)(Fsm * const pFsm, Fsm * const pChildFsm);
/* 移除子狀態(tài)機(jī)(不釋放空間) */
bool (*RemoveChild)(Fsm * const pFsm, Fsm * const pChildFsm);
/* 調(diào)度狀態(tài)機(jī) */
bool (*Dispatch)(Fsm * const pFsm, FsmSignal const signal);
/* 狀態(tài)轉(zhuǎn)移 */
void (*Transfer)(Fsm * const pFsm, IFsmState nextState);
/* 狀態(tài)轉(zhuǎn)移(觸發(fā)轉(zhuǎn)出和轉(zhuǎn)入事件) */
void (*TransferWithEvent)(Fsm * const pFsm, IFsmState nextState);
};關(guān)于信號，Zorb Framework做了以下定義：
/* 狀態(tài)機(jī)信號0-31保留，用戶信號在32以后定義 */
enum {
FSM_NULL_SIG = 0,
FSM_ENTER_SIG,
FSM_EXIT_SIG,
FSM_USER_SIG_START = 32
/* 用戶信號請在用戶文件定義，不允許在此定義 */
};創(chuàng)建狀態(tài)機(jī)實現(xiàn)代碼如下：
bool Fsm_create(Fsm ** ppFsm) {
Fsm *pFsm;
ZF_ASSERT(ppFsm != (Fsm **)0)
/* 分配空間 */
pFsm = ZF_MALLOC(sizeof(Fsm));
if (pFsm == NULL)
{
ZF_DEBUG(LOG_E, "malloc fsm space errorrn");
return false;
}
/* 初始化成員 */
pFsm->Level = 1;
pFsm->ChildList = NULL;
pFsm->Owner = NULL;
pFsm->OwnerTriggerState = NULL;
pFsm->CurrentState = NULL;
pFsm->IsRunning = false;
/* 初始化方法 */
pFsm->SetInitialState = Fsm_setInitialState;
pFsm->Run = Fsm_run;
pFsm->RunAll = Fsm_runAll;
pFsm->Stop = Fsm_stop;
pFsm->StopAll = Fsm_stopAll;
pFsm->Dispose = Fsm_dispose;
pFsm->DisposeAll = Fsm_disposeAll;
pFsm->AddChild = Fsm_addChild;
pFsm->RemoveChild = Fsm_removeChild;
pFsm->Dispatch = Fsm_dispatch;
pFsm->Transfer = Fsm_transfer;
pFsm->TransferWithEvent = Fsm_transferWithEvent;
/* 輸出 */
*ppFsm = pFsm;
return true;
}調(diào)度狀態(tài)機(jī)實現(xiàn)代碼如下：
`/******************************************************************************
* 描述 ：調(diào)度狀態(tài)機(jī)
* 參數(shù) ：(in)-pFsm 狀態(tài)機(jī)指針
* (in)-signal 調(diào)度信號
* 返回 ：-true 成功
* -false 失敗
******************************************************************************/
bool Fsm_dispatch(Fsm * const pFsm, FsmSignal const signal) {
/* 返回結(jié)果 */
bool res = false;
ZF_ASSERT(pFsm != (Fsm *)0)
if (pFsm->IsRunning)
{
if (pFsm->ChildList != NULL && pFsm->ChildList->Count > 0)
{
uint32_t i;
Fsm * pChildFsm;
for (i = 0; i < pFsm->ChildList->Count; i++)
{
pChildFsm = (Fsm *)pFsm->ChildList
->GetElementDataAt(pFsm->ChildList, i);
if (pChildFsm != NULL)
{
Fsm_dispatch(pChildFsm, signal);
}
}
}
if (pFsm->CurrentState != NULL)
{
/* 1:根狀態(tài)機(jī)時調(diào)度
2:沒設(shè)置觸發(fā)狀態(tài)時調(diào)度
3:正在觸發(fā)狀態(tài)時調(diào)度
*/
if (pFsm->Owner == NULL || pFsm->OwnerTriggerState == NULL
|| pFsm->OwnerTriggerState == pFsm->Owner->CurrentState)
{
pFsm->CurrentState(pFsm, signal);
res = true;
}
}
}
return res;
}篇幅有限，其它接口實現(xiàn)可閱讀：
狀態(tài)機(jī)測試https://github.com/54zorb/Zorb-Framework
/**
*****************************************************************************
* @file app_fsm.c
* @author Zorb
* @version V1.0.0
* @date 2018-06-28
* @brief 狀態(tài)機(jī)測試的實現(xiàn)
*****************************************************************************
* @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; /* 父狀態(tài)機(jī) */
Fsm *pFsmSon; /* 子狀態(tài)機(jī) */
/* 父狀態(tài)機(jī)狀態(tài)1 */
static void State1(Fsm * const pFsm, FsmSignal const fsmSignal);
/* 父狀態(tài)機(jī)狀態(tài)2 */
static void State2(Fsm * const pFsm, FsmSignal const fsmSignal);
/******************************************************************************
* 描述 ：父狀態(tài)機(jī)狀態(tài)1
* 參數(shù) ：-pFsm 當(dāng)前狀態(tài)機(jī)
* -fsmSignal 當(dāng)前調(diào)度信號
* 返回 ：無
******************************************************************************/
static void State1(Fsm * const pFsm, FsmSignal const fsmSignal) {
switch(fsmSignal)
{
case FSM_ENTER_SIG:
ZF_DEBUG(LOG_D, "enter state1rn");
break;
case FSM_EXIT_SIG:
ZF_DEBUG(LOG_D, "exit state1rnrn");
break;
case SAY_HELLO:
ZF_DEBUG(LOG_D, "state1 say hello, and want to be state2rn");
/* 切換到狀態(tài)2 */
pFsm->TransferWithEvent(pFsm, State2);
break;
}
}
/******************************************************************************
* 描述 ：父狀態(tài)機(jī)狀態(tài)2
* 參數(shù) ：-pFsm 當(dāng)前狀態(tài)機(jī)
* -fsmSignal 當(dāng)前調(diào)度信號
* 返回 ：無
******************************************************************************/
static void State2(Fsm * const pFsm, FsmSignal const fsmSignal) {
switch(fsmSignal)
{
case FSM_ENTER_SIG:
ZF_DEBUG(LOG_D, "enter state2rn");
break;
case FSM_EXIT_SIG:
ZF_DEBUG(LOG_D, "exit state2rnrn");
break;
case SAY_HELLO:
ZF_DEBUG(LOG_D, "state2 say hello, and want to be state1rn");
/* 切換到狀態(tài)1 */
pFsm->TransferWithEvent(pFsm, State1);
break;
}
}
/******************************************************************************
* 描述 ：子狀態(tài)機(jī)狀態(tài)
* 參數(shù) ：-pFsm 當(dāng)前狀態(tài)機(jī)
* -fsmSignal 當(dāng)前調(diào)度信號
* 返回 ：無
******************************************************************************/
static void SonState(Fsm * const pFsm, FsmSignal const fsmSignal) {
switch(fsmSignal)
{
case SAY_HELLO:
ZF_DEBUG(LOG_D, "son say hello only in state2rn");
break;
}
}
/******************************************************************************
* 描述 ：任務(wù)初始化
* 參數(shù) ：無
* 返回 ：無
******************************************************************************/
void App_Fsm_init(void) {
/* 創(chuàng)建父狀態(tài)機(jī)，并設(shè)初始狀態(tài) */
Fsm_create(&pFsm);
pFsm->SetInitialState(pFsm, State1);
/* 創(chuàng)建子狀態(tài)機(jī)，并設(shè)初始狀態(tài) */
Fsm_create(&pFsmSon);
pFsmSon->SetInitialState(pFsmSon, SonState);
/* 設(shè)置子狀態(tài)機(jī)僅在父狀態(tài)State2觸發(fā) */
pFsmSon->OwnerTriggerState = State2;
/* 把子狀態(tài)機(jī)添加到父狀態(tài)機(jī) */
pFsm->AddChild(pFsm, pFsmSon);
/* 運(yùn)行狀態(tài)機(jī) */
pFsm->RunAll(pFsm);
}
/******************************************************************************
* 描述 ：任務(wù)程序
* 參數(shù) ：無
* 返回 ：無
******************************************************************************/
void App_Fsm_process(void) {
ZF_DELAY_MS(1000);
/* 每1000ms調(diào)度狀態(tài)機(jī)，發(fā)送SAY_HELLO信號 */
pFsm->Dispatch(pFsm, SAY_HELLO);
}
/******************************** END OF FILE ********************************/測試結(jié)果
測試結(jié)果
*博客內(nèi)容為網(wǎng)友個人發(fā)布，僅代表博主個人觀點(diǎn)，如有侵權(quán)請聯(lián)系工作人員刪除。
