XDK API  3.6.0
Documentation
Typedefs | Enumerations
BSP_BUTTON enums

List of Enums used for the BUTTON module. More...

+ Collaboration diagram for BSP_BUTTON enums:

Typedefs

typedef enum BSP_ButtonPress_E BSP_ButtonPress_T
 
typedef enum BSP_ButtonStatus_E BSP_ButtonStatus_T
 

Enumerations

enum  BSP_Button_E
 
enum  BSP_ButtonPress_E
 
enum  BSP_ButtonStatus_E
 

Detailed Description

Typedef Documentation

type definition for the button status.

Enumeration Type Documentation

Enumeration representing on board buttons.

Enumerator
BSP_XDK_BUTTON_1 

User button 1

BSP_XDK_BUTTON_2 

user button 2

BSP_XDK_BUTTON_MAX 

Boundary check macro for type BSP_Button_E

Enumeration used to report the press nature either short press or long press

  • A button press is evaluated as short if it has been steady for minimum specified duration, the event is reported when the button is released
  • A Button Press is evaluated as long if it has lasted for longer than a specified time duration e.g. 5 seconds, the event is reported during the button press.
Enumerator
BSP_XDK_BUTTON_PRESS 

Button has been pressed and debounced

BSP_XDK_BUTTON_RELEASE 

Button has been released

Enumeration used to report the button logic state (pressed or released).

Enumerator
BSP_XDK_BUTTON_ERROR 

invalid parameter passed or button not enabled

BSP_XDK_BUTTON_PRESSED 

Button is pressed

BSP_XDK_BUTTON_RELEASED 

Button is released


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:51 by doxygen 1.8.8