LedDriver.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 __LEDDRIVER_H__
#define __LEDDRIVER_H__

#include <stdint.h>
#include "Connector.h"
#include "ShiftRegister.h"

namespace ClearCore {

class LedDriver : public Connector {
    friend class SysManager;

public:
#ifndef HIDE_FROM_DOXYGEN

    LedDriver() {};

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

    bool Mode(ConnectorModes newMode) override {
        return newMode == ConnectorModes::OUTPUT_DIGITAL;
    }
#endif

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

    bool IsWritable() override {
        return true;
    }

    int16_t State() override;

    bool State(int16_t newState) override;

#ifndef HIDE_FROM_DOXYGEN
    bool IsInHwFault() override {
        return false;
    }
#endif

private:
    ShiftRegister::Masks m_ledMask;
    void Refresh() override {}

    void Initialize(ClearCorePins clearCorePin) override {
        m_clearCorePin = clearCorePin;
        m_mode = OUTPUT_DIGITAL;
    }

    explicit LedDriver(ShiftRegister::Masks ledMask);
}; // LedDriver

} // ClearCore namespace

#endif // __LEDDRIVER_H__