Button API#

Generic Button API.

Introduction#

The button driver is a platfom level software module that manages the initialization and reading of various types of buttons. There is currently one type of button supported by the button driver:

• Simple Button Driver

All button functions are called through the generic driver, which then references functions in the simple button and other potential future button drivers.

Configuration#

All button instances are configured with an sl_button_t struct and a type specific context struct. These structs are automatically generated after a button is set up using Simplicity Studio's wizard, along with a function definition for initializing all LEDs of that type. Specific setup for the simple button is in the following section.

• Simple Button Configuration

Usage#

Once the button structs are defined, the common button functions can be called being passed an instance of sl_button_t, which will be redirected to calling the type specific version of that function. The common functions include the following:

• sl_button_init

• sl_button_get_state

• sl_button_poll_step

• sl_button_on_change

sl_button_init must be called before attempting to read the state of the button.

The button driver can either be used with interrupt mode, polling or polling with debounce. In the case of using interrupt mode, sl_button_on_change can be implemented by the application if required. This function can contain functionality to be executed in response to button event or callbacks to appropriate functionality. In the case of polling and polling with debounce mode, sl_button_poll_step is used to update the state, and needs to be called from a tick function or similar by the user. These mode can be configured per button instance in the instance specific config file.

Both the interrupt and polling methods obtain the button state for the user by calling sl_button_get_state.

Modules#

sl_button

Simple Button Driver

0xFFFF