AwesomeStudioPedal
A programmable, multi-profile foot controller for DAWs, score readers, and studio automation
Loading...
Searching...
No Matches
SendKeyAction Class Reference

Sends a USB HID key code via BLE keyboard. More...

#include <send_action.h>

Inheritance diagram for SendKeyAction:
SendAction Action

Public Member Functions

Action::Type getType () const override
 Gets the type of this action.
 
uint8_t getKey () const
 Gets the USB HID key code to be sent.
 
void send () override
 Executes the key send action.
 
 SendKeyAction (IBleKeyboard *bleKeyboard, uint8_t k)
 Constructs a SendKeyAction.
 
- Public Member Functions inherited from SendAction
void execute () override
 Executes the send action.
 
bool isSendAction () const override
 Checks if this action is a send action.
 
 ~SendAction () override=default
 
- Public Member Functions inherited from Action
void setName (const std::string &n)
 
const std::string & getName () const
 
bool hasName () const
 
virtual uint32_t getDelay () const
 
virtual bool isInProgress () const
 Returns true if the action is currently in progress (e.g.
 
virtual void getJsonProperties (JsonObject &json) const
 
virtual ~Action ()=default
 

Additional Inherited Members

- Public Types inherited from Action
enum class  Type : uint8_t {
  Unknown , SendString , SendChar , SendKey ,
  SendMediaKey , SerialOutput , Delayed
}
 
- Protected Member Functions inherited from SendAction
 SendAction (IBleKeyboard *bleKeyboard)
 Constructs a SendAction.
 
- Protected Attributes inherited from SendAction
IBleKeyboardbleKeyboard
 Pointer to BLE keyboard interface.
 

Detailed Description

Sends a USB HID key code via BLE keyboard.

Definition at line 144 of file send_action.h.

Constructor & Destructor Documentation

◆ SendKeyAction()

SendKeyAction::SendKeyAction ( IBleKeyboard bleKeyboard,
uint8_t  k 
)

Constructs a SendKeyAction.

Parameters
bleKeyboardPointer to BLE keyboard interface
kUSB HID key code to send

Definition at line 16 of file send_action.cpp.

Member Function Documentation

◆ getKey()

uint8_t SendKeyAction::getKey ( ) const
inline

Gets the USB HID key code to be sent.

Returns
The key code

Definition at line 169 of file send_action.h.

◆ getType()

Action::Type SendKeyAction::getType ( ) const
inlineoverridevirtual

Gets the type of this action.

Returns
Action type

Reimplemented from Action.

Definition at line 155 of file send_action.h.

◆ send()

void SendKeyAction::send ( )
overridevirtual

Executes the key send action.

Sends the configured USB HID key code to the BLE keyboard.

Implements SendAction.

Definition at line 25 of file send_action.cpp.


The documentation for this class was generated from the following files: