PBtnToggle
Public Member Functions | List of all members
PBtnToggle Class Reference

Single button connected directly to pin. More...

#include <PBtnToggle.h>

Inheritance diagram for PBtnToggle:
PBtnToggleBase

Public Member Functions

 PBtnToggle (int btn_pin, int pressed_state=HIGH)
 Initialize button handler by providing pin number and pin state on button press. More...
 
void onPress (ToggleFunc callback)
 Set optional callback function to be called on button press event. More...
 
void onLongPress (LongPressFunc callback)
 Set optional callback function to be called on button long press event. More...
 
void onRelease (ToggleFunc callback)
 Set optional callback function to be called on button release event. More...
 
void check ()
 Check button state and trigger event callback functions. More...
 
int getPin ()
 Get pin number. More...
 

Detailed Description

Single button connected directly to pin.

This is the simplest way to handle buttons. Wire push button to any digital pin with pull-up or pull-down resistor.

Constructor & Destructor Documentation

PBtnToggle::PBtnToggle ( int  btn_pin,
int  pressed_state = HIGH 
)

Initialize button handler by providing pin number and pin state on button press.

Parameters
btn_pinDigital pin number on Arduino where button is wired
pressed_statePin state HIGH or LOW when button is pressed

Member Function Documentation

void PBtnToggleBase::check ( )
inherited

Check button state and trigger event callback functions.

This method must be called in loop()

int PBtnToggleBase::getPin ( )
inherited

Get pin number.

void PBtnToggleBase::onLongPress ( LongPressFunc  callback)
inherited

Set optional callback function to be called on button long press event.

Parameters
callbackCallback function pointer
void PBtnToggleBase::onPress ( ToggleFunc  callback)
inherited

Set optional callback function to be called on button press event.

Parameters
callbackCallback function pointer
void PBtnToggleBase::onRelease ( ToggleFunc  callback)
inherited

Set optional callback function to be called on button release event.

Parameters
callbackCallback function pointer

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