ksAppRotator.h

/*
 *  Copyright (c) 2021-2025, Krzysztof Strehlau
 *
 *  This file is a part of the ksIotFramework library.
 *  All licensing information can be found inside LICENSE.md file.
 *
 *  https://github.com/cziter15/ksIotFrameworkLib/blob/master/LICENSE
 */
 
#pragma once
 
#include <memory>
#include <stdint.h>
#include <Arduino.h>
 
#include "ksApplication.h"
 
#define KSF_IMPLEMENT_APP_ROTATOR(...)              \
    ksf::ksAppRotator<__VA_ARGS__> appRotator;      \
    void setup() { KSF_FRAMEWORK_INIT() }           \
    void loop() { appRotator.loop(1); }
 
#define KSF_IMPLEMENT_APP_ROTATOR_INTERVAL(delayBetweenLoops, ...)      \
    ksf::ksAppRotator<__VA_ARGS__> appRotator;                          \
    void setup() { KSF_FRAMEWORK_INIT() }                               \
    void loop() { appRotator.loop(delayBetweenLoops); }
 
namespace ksf
{
    template <class... AppTypes>
    class ksAppRotator
    {
        private:
            uint8_t appIndex{0};                                                
            std::unique_ptr<ksApplication> currentApplication{nullptr};         
            typedef std::unique_ptr<ksApplication> (*TSpawnerFunc)();           
 
            template <class TApplicationType>
            static std::unique_ptr<ksApplication> spawnApp() 
            {
                return std::make_unique<TApplicationType>();
            }
 
            static constexpr std::array<TSpawnerFunc, sizeof...(AppTypes)> appSpawners{spawnApp<AppTypes>...};      
 
        public:
            void loopNoDelay()
            {
                /* If current application is valid and we looped, then we're done. */
                if (currentApplication)
                {
                    /* If loop fails, then destroy and try to do our business next delay. */
                    if (!currentApplication->loop())
                        currentApplication.reset();
                    
                    /* If current application is valid, then we're done. */
                    return;
                }
 
                /* Spawn application. */
                currentApplication = appSpawners[appIndex]();
 
                /* If not initialized, then destroy and try to do our business next delay. */
                if (!currentApplication->init()) 
                    currentApplication.reset();
 
                /* Set next app index. */
                if (++appIndex >= appSpawners.size())
                    appIndex = 0;
            }
 
            void loop(unsigned long milliseconds)
            {
                loopNoDelay();
                delay(milliseconds);
            }
    };
}