DigitalInAnalogIn.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Teknic, Inc.
 *
 * 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.
 */

#ifndef __DIGITALINANALOGIN_H__
#define __DIGITALINANALOGIN_H__

#include <stdint.h>
#include <sam.h>
#include "AdcManager.h"
#include "Connector.h"
#include "DigitalIn.h"
#include "IirFilter.h"
#include "PeripheralRoute.h"
#include "ShiftRegister.h"

namespace ClearCore {

class DigitalInAnalogIn : public DigitalIn {
    friend class SysManager;

public:
    static const uint16_t ANALOG_INPUT_FILTER_TC_MS_DEFAULT = 2;

#ifndef HIDE_FROM_DOXYGEN

    DigitalInAnalogIn() {};
#endif

    virtual ConnectorModes Mode() override {
        return Connector::Mode();
    }

    bool Mode(ConnectorModes newMode) override;

    Connector::ConnectorTypes Type() override {
        return Connector::ANALOG_IN_DIGITAL_IN_TYPE;
    }

    bool IsWritable() override {
        return false;
    }

    bool FilterTc(uint16_t tc, AdcManager::FilterUnits theUnits);

    int16_t State() override;

    float AnalogVoltage() {
        // If there is not a valid reading available, return zero.
        if (!m_analogValid) {
            return 0;
        }
        return AdcManager::Instance().AnalogVoltage(m_adcChannel);
    }

#ifndef HIDE_FROM_DOXYGEN

    bool State(int16_t newState) override {
        // ignore attempts to write state
        (void)newState;
        return false;
    }
#endif
private:
    // Control bit for the analog input circuit
    ShiftRegister::Masks m_modeControlBitMask;

    AdcManager::AdcChannels m_adcChannel;

    volatile const uint16_t *m_adcResultConvertedPtr;
    volatile const uint16_t *m_adcResultConvertedFilteredPtr;
    volatile bool m_analogValid;

#ifndef HIDE_FROM_DOXYGEN

    DigitalInAnalogIn(enum ShiftRegister::Masks ledMask,
                      enum ShiftRegister::Masks modeControlMask,
                      const PeripheralRoute *inputInfo,
                      AdcManager::AdcChannels adcChannel);
#endif

    void Refresh() override;

    void Initialize(ClearCorePins clearCorePin) override;

}; // DigitalInAnalogIn

} // ClearCore namespace

#endif // __ANALOGINDIGITALIN_H__