AbstractAnalog.h

/*
 * Copyright (c) 2021, 2022 G. R. McDorman
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#pragma once
 
#include <Arduino.h>
#include <Ticker.h>
 
#include "grmcdorman/device/Device.h"
#include "grmcdorman/device/Accumulator.h"
 
namespace grmcdorman::device
{
    class AbstractAnalog: public Device
    {
        public:
            explicit AbstractAnalog(const __FlashStringHelper *device_name, const __FlashStringHelper *device_identifier,
                float defaultScale = 1.0f, float defaultOffset = 0.0f, bool invert = false);
 
            void setup() override;
            void loop() override;
            bool publish(DynamicJsonDocument &json) const override;
 
            float get_last_reading() const
            {
                return sensor_reading.get_last_reading();
            }
 
            float raw_value() const
            {
                return last_raw_value;
            }
 
            float get_current_average() const
            {
                return sensor_reading.get_current_average();
            }
 
            DynamicJsonDocument as_json() const override;
        protected:
            virtual float transform_raw_reading(int reading) = 0;
            FloatSetting scale;                 
            FloatSetting offset;                
            ToggleSetting invertReading;        
            UnsignedIntegerSetting readInterval;
            uint32_t last_read_millis = 0;      
            constexpr static uint32_t statusReadInterval = (30 / 5) * 1000;
            Accumulator<float, 5> sensor_reading;  
        private:
            void set_timer();                   
            Ticker ticker;                      
            uint32_t current_polling_seconds = 0;
            float last_raw_value = 0;           
    };
}