cs_SwitchAggregator.h

Go to the documentation of this file.

 
#pragma once
 
#include <behaviour/cs_BehaviourHandler.h>
#include <behaviour/cs_TwilightHandler.h>
#include <common/cs_Component.h>
#include <events/cs_EventListener.h>
#include <structs/buffer/cs_CircularBuffer.h>
#include <switch/cs_SmartSwitch.h>
#include <test/cs_TestAccess.h>
#include <optional>
 
class SwitchAggregator : public EventListener, public Component {
    friend class TestAccess<SwitchAggregator>;
public:
    SwitchAggregator();
 
    void init(const boards_config_t& board);
 
    virtual void handleEvent(event_t& evt) override;
 
    void switchPowered();
 
protected:
    std::vector<Component*> getChildren() override;
 
private:
    TwilightHandler _twilightHandler;
    BehaviourHandler _behaviourHandler;
    BehaviourStore* _behaviourStore;
 
    SmartSwitch _smartSwitch;
 
    // the latest states requested by other parts of the system.
    std::optional<uint8_t> _overrideState       = {};
    std::optional<uint8_t> _behaviourState      = {};
    std::optional<uint8_t> _twilightState       = {};
 
    // the last state that was aggregated and passed on towards the SoftwareSwitch.
    std::optional<uint8_t> _aggregatedState     = {};
 
    // Cache of previous time update.
    uint32_t _lastTimestamp                     = 0;
 
    uint16_t _switchcraftDoubleTapCountdown     = 0;
 
    uint8_t _lastSwitchcraftOnValue             = 0;
 
    cmd_source_with_counter_t _source           = cmd_source_with_counter_t(CS_CMD_SOURCE_NONE);
    uint32_t _ownerTimeoutCountdown             = 0;
 
    // Max number of switch commands to store in history.
    const static uint8_t _maxSwitchHistoryItems = 10;
 
    CircularBuffer<cs_switch_history_item_t> _switchHistory;
 
    // ================================== State updaters ==================================
 
    cs_ret_code_t updateState(bool allowOverrideReset, const cmd_source_with_counter_t& source);
 
    bool updateBehaviourHandlers();
 
    void update();
 
    // ================================== Event handling ==================================
 
    bool handleStateIntentionEvents(event_t& evt);
 
    void executeStateIntentionUpdate(uint8_t value, cmd_source_with_counter_t& source);
 
    bool registerSwitchcraftEvent(uint8_t currentValue);
 
    uint8_t getStateIntentionSwitchcraft(uint8_t currentValue, bool doubleTap);
 
    bool handleTimingEvents(event_t& evt);
 
    bool handlePresenceEvents(event_t& evt);
 
    bool handleSwitchAggregatorCommand(event_t& evt);
 
    bool handleBehaviourEvents(event_t& evt);
 
    void handleSwitchStateChange(uint8_t newIntensity);
 
    // ================================== Misc ==================================
 
    uint8_t aggregatedBehaviourIntensity();
 
    uint8_t resolveOverrideState(uint8_t overrideState);
 
    bool checkAndSetOwner(const cmd_source_with_counter_t& source);
 
    void handleGetBehaviourDebug(event_t& evt);
 
    void addToSwitchHistory(const cs_switch_history_item_t& cmd);
    void printSwitchHistory();
 
    void printStates(uint32_t lineNumber);
 
    void pushTestDataToHost();
};