cs_SafeSwitch.h

Go to the documentation of this file.

/*
 * Author: Crownstone Team
 * Copyright: Crownstone (https://crownstone.rocks)
 * Date: Jan 28, 2020
 * License: LGPLv3+, Apache License 2.0, and/or MIT (triple-licensed)
 */
#pragma once
 
#include <common/cs_Types.h>
#include <drivers/cs_Dimmer.h>
#include <drivers/cs_Relay.h>
#include <events/cs_EventListener.h>
#include <third/std/function.h>
 
class SafeSwitch : public EventListener {
public:
    void init(const boards_config_t& board);
 
    void start();
 
    cs_ret_code_t setRelay(bool value);
 
    cs_ret_code_t setDimmer(uint8_t intensity, bool fade = true);
 
    switch_state_t getState();
 
    bool isRelayStateAccurate();
 
    typedef function<void(switch_state_t newState)> callback_on_state_change_t;
 
    void onUnexpextedStateChange(const callback_on_state_change_t& closure);
 
    void handleEvent(event_t& evt) override;
 
private:
    Dimmer dimmer;
    Relay relay;
 
    bool initialized           = false;
 
    bool canTryDimmingOnBoot   = false;
 
    bool canDimOnWarmBoot      = false;
 
    bool dimmerOnWhenPinsFloat = true;
 
    switch_state_t currentState;
 
    callback_on_state_change_t callbackOnStateChange;
 
    bool relayPowered               = false;
 
    bool dimmerPowered              = false;
 
    uint32_t dimmerPowerUpCountDown = PWM_BOOT_DELAY_MS / TICK_INTERVAL_MS;
 
    uint32_t dimmerCheckCountDown   = 0;
 
    bool checkedDimmerPowerUsage    = false;
 
    bool allowStateChanges          = true;
 
    bool relayHasBeenSetBefore      = false;
 
    OperationMode operationMode     = OperationMode::OPERATION_MODE_UNINITIALIZED;
 
    cs_ret_code_t setRelayUnchecked(bool value);
 
    cs_ret_code_t setDimmerUnchecked(uint8_t intensity, bool fade);
 
    cs_ret_code_t startDimmerPowerCheck(uint8_t intensity, bool fade);
 
    void cancelDimmerPowerCheck();
 
    void checkDimmerPower();
 
    void dimmerPoweredUp();
 
    void setDimmerPowered(bool powered);
 
    void forceSwitchOff();
 
    void forceRelayOnAndDimmerOff();
 
    state_errors_t getErrorState();
 
    bool isSwitchOverLoaded(state_errors_t stateErrors);
 
    bool hasDimmerError(state_errors_t stateErrors);
 
    bool isSafeToDim(state_errors_t stateErrors);
 
    bool isSafeToTurnRelayOn(state_errors_t stateErrors);
 
    bool isSafeToTurnRelayOff(state_errors_t stateErrors);
 
    bool isDimmerStateChangeAllowed();
    bool isRelayStateChangeAllowed();
 
    bool isWarmBoot();
 
    void sendUnexpectedStateUpdate();
 
    void goingToDfu();
 
    void factoryReset();
 
    void handleGetBehaviourDebug(event_t& evt);
};