AStar32U4 library
Classes | Macros
Pushbutton.h File Reference
#include <Arduino.h>

Go to the source code of this file.

Classes

class  PushbuttonBase
 General pushbutton class that handles debouncing. More...
 
class  Pushbutton
 Main class for interfacing with pushbuttons. More...
 

Macros

#define PULL_UP_DISABLED   0
 
#define PULL_UP_ENABLED   1
 
#define DEFAULT_STATE_LOW   0
 
#define DEFAULT_STATE_HIGH   1
 
#define ZUMO_BUTTON   12
 

Detailed Description

This is the main header file for the Pushbutton library.

For an overview of the library's features, see https://github.com/pololu/pushbutton-arduino. That is the main repository for the library, though copies of the library may exist in other repositories.

Definition in file Pushbutton.h.

Macro Definition Documentation

◆ DEFAULT_STATE_HIGH

#define DEFAULT_STATE_HIGH   1

Indicates that the default (released) state of the button is when the I/O line reads high.

Definition at line 28 of file Pushbutton.h.

◆ DEFAULT_STATE_LOW

#define DEFAULT_STATE_LOW   0

Indicates that the default (released) state of the button is when the I/O line reads low.

Definition at line 24 of file Pushbutton.h.

◆ PULL_UP_DISABLED

#define PULL_UP_DISABLED   0

Indicates the that pull-up resistor should be disabled.

Definition at line 17 of file Pushbutton.h.

◆ PULL_UP_ENABLED

#define PULL_UP_ENABLED   1

Indicates the that pull-up resistor should be enabled.

Definition at line 20 of file Pushbutton.h.

◆ ZUMO_BUTTON

#define ZUMO_BUTTON   12

The pin used for the button on the Zumo Shield for Arduino.

This does not really belong here in this general pushbutton library and will probably be removed in the future.

Definition at line 35 of file Pushbutton.h.