c7222-development/api/button_8hpp_source.html

#ifndef C7222_BUTTON_HPP

#define C7222_BUTTON_HPP


#include <cstdint>

#include "gpio.hpp"


namespace c7222 {


class Button : public GpioIn {

  public:

    explicit Button(uint32_t pin, GpioPullMode pull = GpioPullMode::PullUp);

    virtual ~Button() = default;


    void Configure(const Config& config) = delete;


    void Reconfigure(GpioPullMode pull = GpioPullMode::PullUp);


    bool IsPressed() const;


};


} // namespace c7222


#endif // C7222_BUTTON_HPP

c7222::Button
Input-only GPIO wrapper intended for push-buttons.
Definition button.hpp:43

c7222::Button::Configure
void Configure(const Config &config)=delete
Disallow generic reconfiguration.

c7222::Button::IsPressed
bool IsPressed() const
Return true if the button is currently pressed (active-low).

c7222::Button::Button
Button(uint32_t pin, GpioPullMode pull=GpioPullMode::PullUp)
Construct a button pin in input mode.

c7222::Button::Reconfigure
void Reconfigure(GpioPullMode pull=GpioPullMode::PullUp)
Reconfigure the button pull mode.

c7222::Button::~Button
virtual ~Button()=default
Destructor unregisters the button from the platform map.

c7222::GpioIn
GPIO input-only wrapper with pull configuration and optional IRQ.
Definition gpio.hpp:129

gpio.hpp
GPIO abstraction split into explicit input and output classes.

c7222
C7222 course abstractions namespace.
Definition ble.hpp:20

c7222::GpioPullMode
GpioPullMode
GPIO pull configuration.
Definition gpio.hpp:65

c7222::GpioPullMode::PullUp
@ PullUp
Enable pull-up.

c7222::GpioIn::Config
Configuration structure for input GPIO setup.
Definition gpio.hpp:134