Detailed Description

This file defines the concrete implementation for the Button HAL that gets its raw inputs via a Driver::TPipe.

The driver assumes the following RX Command structure:

<verb> <b1> DN|up [<b2> DN|up [..<bN> DN|up]]
 
Where:
    <verb>      Command verb.  Default value is 'buttons'
    <b1>        Name of button 1 (no whitespace allowed)
    <b2>        Name of button 2 (no whitespace allowed)
    ...
    <bN>        Name of button N (no whitespace allowed)
 
NOTE: The state of All buttons must ALWAYS be sent.
    
    Example:
    buttons A up B up X DN Y up     // Only the X button is pressed
    buttons A DN B DN X up Y up     // Only the A & B buttons are pressed

#include "Driver/Button/Hal.h"
#include "Cpl/Container/Map.h"
#include "Driver/TPipe/RxFrameHandlerApi.h"

Include dependency graph for Hal.h:

Go to the source code of this file.

Macros
#define	OPTION_DRIVER_BUTTON_HAL_TPIPE_MAX_BUTTONS 32
	The maximum number of button/button-names the HAL layer supports.

#define	OPTION_DRIVER_BUTTON_HAL_TPIPE_SIZE_BUTTON_NAME 16
	The maximum size, in bytes, of button name (not including the null terminator.

#define	OPTION_DRIVER_BUTTON_HAL_TPIPE_COMMAND_VERB "buttons"
	Command verb for the TPipe RX frame handler.

Functions
void	driverButtonHalTPipe_initialize (Cpl::Container::Map< Driver::TPipe::RxFrameHandlerApi > &tpipeRxFrameHandlerList)
	This method is used to register the button driver with the TPipe to receive button events.

Macro Definition Documentation

◆ OPTION_DRIVER_BUTTON_HAL_TPIPE_COMMAND_VERB

#define OPTION_DRIVER_BUTTON_HAL_TPIPE_COMMAND_VERB "buttons"

Command verb for the TPipe RX frame handler.

◆ OPTION_DRIVER_BUTTON_HAL_TPIPE_MAX_BUTTONS

#define OPTION_DRIVER_BUTTON_HAL_TPIPE_MAX_BUTTONS 32

The maximum number of button/button-names the HAL layer supports.

◆ OPTION_DRIVER_BUTTON_HAL_TPIPE_SIZE_BUTTON_NAME

#define OPTION_DRIVER_BUTTON_HAL_TPIPE_SIZE_BUTTON_NAME 16

The maximum size, in bytes, of button name (not including the null terminator.

Function Documentation

◆ driverButtonHalTPipe_initialize()

void driverButtonHalTPipe_initialize ( Cpl::Container::Map< Driver::TPipe::RxFrameHandlerApi > & tpipeRxFrameHandlerList )

This method is used to register the button driver with the TPipe to receive button events.

This method is called once - NOT per button/button-handle.