PlantCtrl/esp32/include/PlantCtrl.h

/**
 * @file PlantCtrl.h
 * @author your name (you@domain.com)
 * @brief Abstraction to handle the Sensors
 * @version 0.1
 * @date 2020-05-27
 * 
 * @copyright Copyright (c) 2020
 * 
 */

#ifndef PLANT_CTRL_H
#define PLANT_CTRL_H

#include "HomieTypes.h"
#include <HomieNode.hpp>
#include "ControllerConfiguration.h"
#include "RunningMedian.h"
#include "MathUtils.h"

#define MOISTURE_MEASUREMENT_DURATION  400  /** ms */
#define PWM_FREQ 50000
#define PWM_BITS 8


class Plant
{

private:
    HomieNode *mPlant = NULL;
    HomieInternals::PropertyInterface mPump;
    int32_t mMoisture_freq = 0;
    int mPinSensor = 0; /**< Pin of the moist sensor */
    int mPinPump = 0;   /**< Pin of the pump */
    bool mConnected = false;
    int mPlantId = -1;

public:
    PlantSettings_t *mSetting;
    /**
     * @brief Construct a new Plant object
     * 
     * @param pinSensor Pin of the Sensor to use to measure moist
     * @param pinPump   Pin of the Pump to use
     */
    Plant(int pinSensor, int pinPump,
          int plantId,
          HomieNode *plant,
          PlantSettings_t *setting);

    void postMQTTconnection(void);

    void advertise(void);

    /**
     * @brief Measure a new analog moister value
     * 
     */
    void startMoistureMeasurement(void);
    void stopMoistureMeasurement(void);

    void deactivatePump(void);

    void activatePump(void);


    bool isHydroponic(){
        long current = this->mSetting->pSensorDry->get();
        return equalish(current,HYDROPONIC_MODE);
    }

    /**
     * @brief Check if a plant is too dry and needs some water.
     * 
     * @return true 
     * @return false 
     */
    bool isPumpRequired()
    {
        if(isHydroponic()){
            //hydroponic only uses timer based controll
            return true;
        }
        bool isDry = getCurrentMoisture() > getSetting2Moisture();
        bool isActive = isPumpTriggerActive();
        return isDry && isActive;
    }  

    bool isPumpTriggerActive()
    {
        long current = this->mSetting->pSensorDry->get();
        return !equalish(current,DEACTIVATED_PLANT);
    }

    float getCurrentMoisture()
    {   
        if(mMoisture_freq < MOIST_SENSOR_MIN_FRQ){
            return MISSING_SENSOR;
        }
        return mMoisture_freq;
    }

    long getSetting2Moisture()
    {
        if (this->mSetting->pSensorDry != NULL)
        {
            //1 is totally wet, 0 is try, 0 is MOIST_SENSOR_MAX_FRQ, 1 is MOIST_SENSOR_MIN_FRQ
            float factor = (this->mSetting->pSensorDry->get());
            return map(factor,0,100,MOIST_SENSOR_MAX_FRQ,MOIST_SENSOR_MIN_FRQ);
        }
        else
        {
            return DEACTIVATED_PLANT;
        }
    }

    HomieInternals::SendingPromise &setProperty(const String &property) const
    {
        return mPlant->setProperty(property);
    }

    void init(void);

    long getCooldownInSeconds() {
        return this->mSetting->pPumpCooldownInMinutes->get()*60;
    }

    /**
     * @brief Get the Hours when pumping should start
     * 
     * @return hour 
     */
    int getHoursStart() {
        return this->mSetting->pPumpAllowedHourRangeStart->get();
    }

    /**
     * @brief Get the Hours when pumping should end
     * 
     * @return hour 
     */
    int getHoursEnd() {
        return this->mSetting->pPumpAllowedHourRangeEnd->get();
    }

    bool isAllowedOnlyAtLowLight(void)
    {
        if(this->isHydroponic()){
            return false;
        }
        return this->mSetting->pPumpOnlyWhenLowLight->get();
    }

    void publishState(String state);

    bool switchHandler(const HomieRange& range, const String& value);

    void setSwitchHandler(HomieInternals::PropertyInputHandler f);

    long getPumpDuration() {
        return this->mSetting->pPumpDuration->get();
    }
};

#endif