OPEnSampler Framework

Lightweight, header-only modularized framework for embeded Arduino aplications. This framework employ concepts and terminologies from finite-state-machine to provide the client application with a maintainable code structure. Using FSM, the client application is broken into a series of states (KPState) that implement lifecycle methods.

Example Projects

eDNA Server is an embeded application used in eDNA sampler for the purpose of extracting DNA from surrouding aqueous environments.

Getting Started

The easiest way to start using OPEnSamplerFramework is to use VSCode with PlatformIO extension. See Getting Started Guide.

• Getting Started
  • Installation
  • Configuring .ini file
  • Creating your first app
  • Using built-in classes: adding serial input
  • Upload your application
• Library API
  • Class Hierarchy
  • File Hierarchy
  • Full API
    • Classes and Structs
      • Struct KPStateSchedule
        • Struct Documentation
      • Struct Request
        • Struct Documentation
      • Struct RequestHandler
        • Struct Documentation
      • Struct Response
        • Struct Documentation
      • Class ActionScheduler
        • Inheritance Relationships
        • Class Documentation
      • Class KPComponent
        • Inheritance Relationships
        • Class Documentation
      • Class KPController
        • Class Documentation
      • Class KPDataStoreInterface
        • Inheritance Relationships
        • Class Documentation
      • Class KPFileLoader
        • Inheritance Relationships
        • Class Documentation
      • Class KPObserver
        • Inheritance Relationships
        • Class Documentation
      • Class KPSerialInput
        • Inheritance Relationships
        • Class Documentation
      • Class KPSerialInputObserver
        • Inheritance Relationships
        • Class Documentation
      • Class KPServer
        • Inheritance Relationships
        • Class Documentation
      • Class KPState
        • Class Documentation
      • Class KPStateMachine
        • Inheritance Relationships
        • Class Documentation
      • Class KPStateMachineObserver
        • Inheritance Relationships
        • Class Documentation
      • Class KPString
        • Class Documentation
      • Template Class KPStringBuilder
        • Inheritance Relationships
        • Class Documentation
      • Template Class KPSubject
        • Class Documentation
      • Class TimedAction
        • Class Documentation
    • Functions
      • Function cancel
        • Function Documentation
      • Function free_ram
        • Function Documentation
      • Function halt()
        • Function Documentation
      • Template Function halt(Types&&…)
        • Function Documentation
      • Function millisToSecs
        • Function Documentation
      • Template Function operator<<
        • Function Documentation
      • Template Function print
        • Function Documentation
      • Function printFreeRam
        • Function Documentation
      • Function println()
        • Function Documentation
      • Template Function println(Types…)
        • Function Documentation
      • Function printTo(Print&, time_t)
        • Function Documentation
      • Template Function printTo(Print&, std::pair<T0, T1>)
        • Function Documentation
      • Template Function printTo(Print&, T&&)
        • Function Documentation
      • Template Function printTo(Print&, Types&&…)
        • Function Documentation
      • Template Function run(T&&)
        • Function Documentation
      • Function run(long, std::function<void()>)
        • Function Documentation
      • Function runForever(long, const char *, std::function<void()>)
        • Function Documentation
      • Function runForever(TimedAction)
        • Function Documentation
      • Function sbrk
        • Function Documentation
      • Function secsToMillis
        • Function Documentation
      • Function strcmpi
        • Function Documentation
    • Defines
      • Define HTTP_GET
        • Define Documentation
      • Define HTTP_POST
        • Define Documentation
      • Define TRACE
        • Define Documentation
    • Typedefs
      • Typedef EndPointCallback
        • Typedef Documentation