InputEvents v1.5.2
An easy to use but comprehensive Event Library for Buttons, Encoders, Encoder Buttons, Analog Inputs, Joysticks and Switches.
Public Member Functions | List of all members
PinAdapter Class Referenceabstract

Description

The interface specification for button, encoder button and switch pins.

#include <PinAdapter.h>

Inheritance diagram for PinAdapter:
Inheritance graph
[legend]

Public Member Functions

virtual void begin ()=0
 Initialise the pin adapter. Must be safe for repeated calls (Idempotent) More...
 
virtual bool read ()=0
 Read the current state of the pin. More...
 

Member Function Documentation

◆ begin()

virtual void PinAdapter::begin ( )
pure virtual

Initialise the pin adapter. Must be safe for repeated calls (Idempotent)

Implemented in Bounce2PinAdapter, DebounceAdapter, FoltmanDebounceAdapter, GpioPinAdapter, PinMixerAdapter, VirtualPinAdapter, and ExpanderPinAdapter.

◆ read()

virtual bool PinAdapter::read ( )
pure virtual

Read the current state of the pin.

Returns
true/HIGH
false/LOW

Implemented in Bounce2PinAdapter, GpioPinAdapter, PinMixerAdapter, VirtualPinAdapter, ExpanderPinAdapter, FoltmanDebounceAdapter, and DebounceAdapter.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.4