MatrixMiniR4 1.1.5
Matrix Mini R4 Arduino Library API Documentation
Loading...
Searching...
No Matches
Public Member Functions | List of all members
MiniR4BTN< ID > Class Template Reference

A class template for handling button state retrieval for a specific button ID. More...

#include <MiniR4BTN.h>

Public Member Functions

 MiniR4BTN ()
 
bool getState (void)
 Retrieves the current state of the button.
 

Detailed Description

template<uint8_t ID>
class MiniR4BTN< ID >

A class template for handling button state retrieval for a specific button ID.

This class interacts with the MMLower library to get the state of a button identified by a unique ID.

Template Parameters
IDThe unique identifier for the button.

Definition at line 21 of file MiniR4BTN.h.

Constructor & Destructor Documentation

◆ MiniR4BTN()

template<uint8_t ID>
MiniR4BTN< ID >::MiniR4BTN ( )
inline

Definition at line 24 of file MiniR4BTN.h.

Member Function Documentation

◆ getState()

template<uint8_t ID>
bool MiniR4BTN< ID >::getState ( void )
inline

Retrieves the current state of the button.

This method calls the MMLower library to check the state of the button identified by the unique ID.

Returns
true if the button is pressed; false otherwise.

Definition at line 34 of file MiniR4BTN.h.

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