button.h

Go to the documentation of this file.

/*
 * This file is part of RTLib.
 *
 * Copyright (C) 2017-2018 Derppening <david.18.19.21@gmail.com>
 *
 * RTLib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * RTLib is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with RTLib.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef RTLIB_LIB_BUTTON_H_
#define RTLIB_LIB_BUTTON_H_

#include <cstdint>

#include "config/config.h"
#include "core/gpio.h"

static_assert(LIB_USE_BUTTON > 0, "Button library is disabled in your configuration.");

class Button {
 public:
  struct Config {
    uint8_t id;
    uint8_t pullup;
  };

  explicit Button(const Config& config);
  
  ~Button() = default;

  Button(Button&& other) noexcept = default;
  Button& operator=(Button&& other) noexcept = default;

  Button(const Button&) = delete;
  Button& operator=(const Button&) = delete;

  bool Read();

 protected:
  CORE_NS::GPIO* GetGpio() { return &gpio_; }

 private:
  CORE_NS::GPIO gpio_;
  bool polarity_;
};

#endif  // RTLIB_LIB_BUTTON_H_