Code Monkey home page Code Monkey logo

active-object-fsm's Introduction

CI Status codecov Documentation GitHub release (with filter)

active-object-fsm

Minimalistic implementation of Active Object pattern + FSM for embedded systems. Static memory allocation only.

Features

  • Active Object pattern (Actors) wiki Actors
  • Finite State Machine (Moore+Mealy) wiki FSM
  • Transition table
  • State entry/transition/exit actions
  • 100% Code coverage

Documentation

Doxygen docs

Initialization

$ git submodule init && git submodule update --remote
$ make # compile to bin/

Examples

TODO: Blinky: simple LED on/off demo

TODO: Request: retry/timeout, transition table demo

TODO: Request: retry after delay + rety/timeout, transition table demo

Side notes

Naming conventions

  • file names
    • snake_case
  • variables
    • MODULE_camelCase for module global variables
    • camelCase for local variables
  • functions
    • MODULE_PascalCase for module public functions
    • _camelCase for module private functions
  • types
    • UPPER_CASE for #define or constants
    • UPPER_CASE for enums
    • TPascalCase for typedef struct
    • PascalCase for struct

Docs diagrams

Diagrams are generated with help of Graphviz .dot engine. To generate locally:

$ brew install graphviz # install Graphviz (MacOS)
$ for file in ./**/*.gv; do dot -Tsvg "$file" > "${file%.gv}.svg"; done # dot -Tsvg file.gv > file.svg  

Code coverage

Codecov Graph:

codecov

active-object-fsm's People

Contributors

polesskiy-dev avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.