File ns_peripherals_button.h

FileList > includes-api > ns_peripherals_button.h

Go to the source code of this file

• #include "ns_core.h"

Classes

Type	Name
struct	ns_button_config_t

Public Attributes

Type	Name
const ns_core_api_t	ns_button_V0_0_1
const ns_core_api_t	ns_button_V1_0_0
const ns_core_api_t	ns_button_current_version
const ns_core_api_t	ns_button_oldest_supported_version

Public Functions

Type	Name
uint32_t	ns_peripheral_button_init (ns_button_config_t * cfg) Initialize button monitoring per the configuration struct.

Macros

Type	Name
define	NS_BUTTON_API_ID 0xCA0003
define	NS_BUTTON_CURRENT_VERSION NS_BUTTON_V1_0_0
define	NS_BUTTON_OLDEST_SUPPORTED_VERSION NS_BUTTON_V0_0_1
define	NS_BUTTON_V0_0_1 { .major = 0, .minor = 0, .revision = 1 }
define	NS_BUTTON_V1_0_0 { .major = 1, .minor = 0, .revision = 0 }

Public Attributes Documentation

variable ns_button_V0_0_1

const ns_core_api_t ns_button_V0_0_1;

variable ns_button_V1_0_0

const ns_core_api_t ns_button_V1_0_0;

variable ns_button_current_version

const ns_core_api_t ns_button_current_version;

variable ns_button_oldest_supported_version

const ns_core_api_t ns_button_oldest_supported_version;

Public Functions Documentation

function ns_peripheral_button_init

Initialize button monitoring per the configuration struct.

uint32_t ns_peripheral_button_init (
    ns_button_config_t * cfg
) 

Parameters:

• ns_button_config_t* : button configuration struct

Returns:

uint32_t

Macro Definition Documentation

define NS_BUTTON_API_ID

#define NS_BUTTON_API_ID 0xCA0003

define NS_BUTTON_CURRENT_VERSION

#define NS_BUTTON_CURRENT_VERSION NS_BUTTON_V1_0_0

define NS_BUTTON_OLDEST_SUPPORTED_VERSION

#define NS_BUTTON_OLDEST_SUPPORTED_VERSION NS_BUTTON_V0_0_1

define NS_BUTTON_V0_0_1

#define NS_BUTTON_V0_0_1 { .major = 0, .minor = 0, .revision = 1 }

define NS_BUTTON_V1_0_0

#define NS_BUTTON_V1_0_0 { .major = 1, .minor = 0, .revision = 0 }

---

The documentation for this class was generated from the following file neuralSPOT/neuralspot/ns-peripherals/includes-api/ns_peripherals_button.h