Ultra-lightweight, event-driven C++11 finite state machine library for IoT, embedded, and automation projects

📚 Documentation •🐛 Report Bug •✨ Request Feature

📋 Table of Contents

🚀 Features

✨ Key Benefits

🎯 Perfect For

⚡ Quick Start

#include"uFsm.hpp"#include"uEventHandler.hpp"// Define your states#defineIDLE_STATE0x0001#defineACTIVE_STATE0x0002#defineERROR_STATE0xFFFF// Define your events#defineSTART_EVENT0x0001#defineSTOP_EVENT0x0002#defineERROR_EVENT0x0003// Create your event handlerclassMyEventHandler :publicuEventHandler {public:MyEventHandler() : uEventHandler(3) {FillHandlersArray();    }private:voidFillHandlersArray()override {        functions_[0] = (TransitionFunc)&MyEventHandler::handleStart;        functions_[1] = (TransitionFunc)&MyEventHandler::handleStop;        functions_[2] = (TransitionFunc)&MyEventHandler::handleError;    }boolhandleStart(void* params) {        std::cout <<"Starting device..." << std::endl;returntrue;    }boolhandleStop(void* params) {        std::cout <<"Stopping device..." << std::endl;returntrue;    }boolhandleError(void* params) {        std::cout <<"Error occurred!" << std::endl;returnfalse;    }};intmain() {// Create event handler and FSM    MyEventHandler handler;    uFsmfsm(&handler,10, IDLE_STATE);// Define state transitions    fsm.defineTransition(IDLE_STATE, ACTIVE_STATE, START_EVENT,0);    fsm.defineTransition(ACTIVE_STATE, IDLE_STATE, STOP_EVENT,1);    fsm.defineTransition(IDLE_STATE, ERROR_STATE, ERROR_EVENT,2);// Process events    fsm.control(START_EVENT);// IDLE -> ACTIVE    fsm.control(STOP_EVENT);// ACTIVE -> IDLEreturn0;}

📦 Installation

Prerequisites

Build from Source

macOS

# Install CMake (if not already installed)brew install cmake# Clone the repositorygit clone https://github.com/hemonserrat/IoT-uFSM.gitcd IoT-uFSM# Create build directorymkdir -p build# Configure the projectcmake -S. -B build# Build the projectcmake --build build# Run tests (optional)ctest --test-dir build

Linux (Ubuntu/Debian)

# Install dependenciessudo apt-get updatesudo apt-get install build-essential cmake git# Clone and buildgit clone https://github.com/hemonserrat/IoT-uFSM.gitcd IoT-uFSMmkdir -p buildcmake -S. -B buildcmake --build build# Run testsctest --test-dir build

Windows (Visual Studio)

# Clone the repositorygit clone https://github.com/hemonserrat/IoT-uFSM.gitcd IoT-uFSM# Create build directorymkdir build# Configure with Visual Studiocmake -S . -B build -G"Visual Studio 16 2019"# Build the projectcmake --build build --config Release# Run testsctest --test-dir build --config Release

Integration with Your Project

Using CMake FetchContent

include(FetchContent)FetchContent_Declare(  IoT-uFSM  GIT_REPOSITORY https://github.com/hemonserrat/IoT-uFSM.git  GIT_TAG        master)FetchContent_MakeAvailable(IoT-uFSM)target_link_libraries(your_targetPRIVATE IoT-uFSM)

Manual Integration

💡 Usage Examples

IoT Sensor State Machine

// IoT temperature sensor with different operating modesclassTemperatureSensor :publicuEventHandler {enum States { SLEEP =1, MEASURING =2, TRANSMITTING =3, ERROR =0xFF };enum Events { WAKE_UP =1, MEASURE_COMPLETE =2, TRANSMIT_COMPLETE =3, SENSOR_ERROR =4 };public:TemperatureSensor() : uEventHandler(4) {        fsm_ =newuFsm(this,10, SLEEP);setupTransitions();FillHandlersArray();    }private:voidsetupTransitions() {        fsm_->defineTransition(SLEEP, MEASURING, WAKE_UP,0);        fsm_->defineTransition(MEASURING, TRANSMITTING, MEASURE_COMPLETE,1);        fsm_->defineTransition(TRANSMITTING, SLEEP, TRANSMIT_COMPLETE,2);        fsm_->defineTransition(MEASURING, ERROR, SENSOR_ERROR,3);    }voidFillHandlersArray()override {        functions_[0] = (TransitionFunc)&TemperatureSensor::startMeasurement;        functions_[1] = (TransitionFunc)&TemperatureSensor::startTransmission;        functions_[2] = (TransitionFunc)&TemperatureSensor::enterSleepMode;        functions_[3] = (TransitionFunc)&TemperatureSensor::handleSensorError;    }boolstartMeasurement(void* params) {// Initialize sensor and start measurementreturntrue;    }boolstartTransmission(void* params) {// Send data to IoT platformreturntrue;    }boolenterSleepMode(void* params) {// Enter low-power modereturntrue;    }boolhandleSensorError(void* params) {// Handle sensor malfunctionreturnfalse;    }        uFsm* fsm_;};

Home Automation Controller

// Smart home device controllerclassSmartDevice :publicuEventHandler {enum States { OFF =1, STANDBY =2, ACTIVE =3, MAINTENANCE =4 };enum Events { POWER_ON =1, ACTIVATE =2, DEACTIVATE =3, MAINTENANCE_MODE =4 };// Implementation details...};

🏗️ Architecture

Core Components

Key Design Principles

📖 Documentation

Key Classes

🧪 Testing

# Run all testsctest --test-dir build# Run with verbose outputctest --test-dir build --verbose# Run specific test./build/test_fsm

Test Coverage

🤝 Contributing

Ways to Contribute

Development Setup

Code Style

📄 License

What this means:

🔗 Links

Project Resources

Community

Related Projects

Made with ❤️ for the IoT and embedded systems community

⭐Star this repo if you find it useful! ⭐