cs_SmartSwitch.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 <events/cs_EventListener.h>
#include <switch/cs_SafeSwitch.h>
 
class SmartSwitch : public EventListener {
public:
    void init(const boards_config_t& board);
 
    void start();
 
    cs_ret_code_t set(uint8_t intensity);
 
    uint8_t getCurrentIntensity();
 
    uint8_t getIntendedState();
 
    switch_state_t getActualState();
 
    typedef function<void(uint8_t newIntensity)> callback_on_intensity_change_t;
 
    void onUnexpextedIntensityChange(const callback_on_intensity_change_t& closure);
 
    void handleEvent(event_t& evt) override;
 
private:
    SafeSwitch _safeSwitch;
 
    uint8_t _intendedState;
 
    callback_on_intensity_change_t _callbackOnIntensityChange;
 
    TYPIFY(STATE_SWITCH_STATE) _storedState;
 
    TYPIFY(CONFIG_DIMMING_ALLOWED) _allowDimming = false;
 
    TYPIFY(CONFIG_SWITCH_LOCKED) _switchLocked   = false;
 
    bool _allowSwitchingOverride                 = false;
 
    bool allowSwitching();
 
    uint8_t getIntensityFromSwitchState(switch_state_t switchState);
 
    cs_ret_code_t resolveIntendedState();
 
    cs_ret_code_t setRelay(bool on);
 
    cs_ret_code_t setRelayUnchecked(bool on);
 
    cs_ret_code_t setDimmer(uint8_t intensity, bool fade = true);
 
    cs_ret_code_t setDimmerUnchecked(uint8_t intensity, bool fade);
 
    void handleUnexpectedStateChange(switch_state_t newState);
 
    void sendUnexpectedIntensityUpdate(uint8_t newIntensity);
 
    void store(switch_state_t newState);
 
    cs_ret_code_t setSwitchLock(bool lock);
 
    cs_ret_code_t setAllowDimming(bool allowed);
 
    void handleAllowDimmingSet();
 
    cs_ret_code_t handleCommandSetRelay(bool on);
 
    cs_ret_code_t handleCommandSetDimmer(uint8_t intensity);
};