cs_BehaviourHandler.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Dec 20, 2019
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
#pragma once
 
#include <behaviour/cs_BehaviourStore.h>
#include <behaviour/cs_SwitchBehaviour.h>
#include <common/cs_Component.h>
#include <events/cs_EventListener.h>
#include <presence/cs_PresenceHandler.h>
#include <test/cs_TestAccess.h>
 
#include <optional>
 
class BehaviourHandler : public EventListener, public Component {
    friend class TestAccess<BehaviourHandler>;
 
public:
    virtual cs_ret_code_t init() override;
 
    virtual ~BehaviourHandler() = default;
    virtual void handleEvent(event_t& evt);
 
    bool update();
 
    std::optional<uint8_t> getValue();
 
    bool requiresPresence(Time t);
 
    bool requiresAbsence(Time t);
 
    bool validateBehaviour(Behaviour* behaviour) const;
 
private:
    PresenceHandler* _presenceHandler                              = nullptr;
 
    BehaviourStore* _behaviourStore                                = nullptr;
 
    std::optional<uint8_t> previousIntendedState                   = {};
 
    std::optional<uint8_t> currentIntendedState                    = {};
 
    bool _isActive                                                 = true;
 
    bool _behaviourSettingsSynced                                  = false;
 
    std::optional<behaviour_settings_t> _receivedBehaviourSettings = {};
 
    // -----------------------------------------------------------------------
    // --------------------------- private methods ---------------------------
    // -----------------------------------------------------------------------
 
    std::optional<uint8_t> computeIntendedState(Time currenttime, PresenceStateDescription currentpresence) const;
 
    SwitchBehaviour* resolveSwitchBehaviour(Time currentTime, PresenceStateDescription currentPresence) const;
 
    void handleGetBehaviourDebug(event_t& evt);
 
    SwitchBehaviour* validateSwitchBehaviour(
            Behaviour* behaviour, Time currentTime, PresenceStateDescription currentPresence) const;
 
    TwilightBehaviour* validateTwilightBehaviour(
            Behaviour* behaviour, Time currentTime, PresenceStateDescription currentPresence) const;
 
    // -----------------------------------------------------------------------
    // --------------------------- synchronization ---------------------------
    // -----------------------------------------------------------------------
 
    void onBehaviourSettingsMeshMsg(behaviour_settings_t settings);
 
    void onBehaviourSettingsChange(behaviour_settings_t settings);
 
    bool onBehaviourSettingsOutgoingSyncRequest();
 
    void onMeshSyncFailed();
 
    void tryFinalizeBehaviourSettingsSync();
 
    void onBehaviourSettingsIncomingSyncRequest();
};