Button Types

Data types used by the button module. More...

Collaboration diagram for Button Types:

Classes
struct	BUTTON_CFG_ts
	Configuration structure for initializing a button instance. More...

Typedefs
typedef struct button_handle_s	BUTTON_HANDLE_ts
	Opaque handle representing a button instance.

Enumerations
enum	BUTTON_PUSHED_TYPE_te { BUTTON_PUSHED_TYPE_LOW , BUTTON_PUSHED_TYPE_HIGH }
	Defines the active level of a button press. More...

Detailed Description

Data types used by the button module.

Typedef Documentation

BUTTON_HANDLE_ts

typedef struct button_handle_s BUTTON_HANDLE_ts

Opaque handle representing a button instance.

This handle is returned by button_init_handle and is used to interact with a specific button instance.

The internal structure is hidden and must not be accessed directly.

Definition at line 110 of file button.h.

Enumeration Type Documentation

BUTTON_PUSHED_TYPE_te

enum BUTTON_PUSHED_TYPE_te

Defines the active level of a button press.

This enum specifies which logic level represents a "pressed" state for the button input.

Enumerator
BUTTON_PUSHED_TYPE_LOW	Button is considered pressed when the GPIO pin reads LOW (active-low).
BUTTON_PUSHED_TYPE_HIGH	Button is considered pressed when the GPIO pin reads HIGH (active-high).

Definition at line 58 of file button.h.

             {

    BUTTON_PUSHED_TYPE_LOW,

    BUTTON_PUSHED_TYPE_HIGH
 
} BUTTON_PUSHED_TYPE_te;