Single button. More...

#include <InputHardware.hpp>

Public Member Functions
	DigitalButton (InputGPIO pinNumber, InputNumber buttonNumber)
	Construct a new Digital Button object.

virtual uint64_t	read (uint64_t lastState) override
	Read the current state of the inputs (pressed or released)

Public Member Functions inherited from DigitalInput

Protected Attributes
InputGPIO	pinNumber
	Configured input pin.

uint64_t	bitmap
	Input bitmap.

Additional Inherited Members
Public Attributes inherited from DigitalInput
uint64_t	mask = ~0ULL
	Input mask. For read-only.

Protected Member Functions inherited from DigitalInput
void	addToMask (uint64_t bitmap)
	Add an input bitmap to the current mask.

Detailed Description

Single button.

Definition at line 75 of file InputHardware.hpp.

Constructor & Destructor Documentation

◆ DigitalButton()

DigitalButton::DigitalButton	(	InputGPIO	pinNumber,
		InputNumber	buttonNumber )

Construct a new Digital Button object.

Parameters

[in]	pinNumber	GPIO pin where the button is attached to
[in]	buttonNumber	Assigned number for this button

Member Function Documentation

◆ read()

virtual uint64_t DigitalButton::read ( uint64_t lastState )

overridevirtual

Read the current state of the inputs (pressed or released)

Warning: This function must not set any bit outside of the input bitmask in the return value.

Parameters

lastState State of the same inputs as recorded in the previous iteration. Whether the current state is unknown, lastState must be returned (properly masked). Must be set to zero at first call.

Returns: uint64_t Current state of the inputs (a bit set to 1 means a pressed button).

Implements DigitalInput.

Member Data Documentation

◆ bitmap

uint64_t DigitalButton::bitmap

protected

Input bitmap.

Definition at line 81 of file InputHardware.hpp.

◆ pinNumber

InputGPIO DigitalButton::pinNumber

protected

Configured input pin.

Definition at line 79 of file InputHardware.hpp.

The documentation for this class was generated from the following file:

/github/workspace/src/include/InputHardware.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members