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

Interface for Bluetooth LE keyboard functionality. More...

#include <i_ble_keyboard.h>

Inheritance diagram for IBleKeyboard:
BleKeyboardAdapter BleKeyboardAdapter

Public Member Functions

virtual ~IBleKeyboard ()=default
 
virtual void begin ()=0
 Initializes the BLE keyboard.
 
virtual bool isConnected ()=0
 Checks if BLE keyboard is connected to a host.
 
virtual void write (uint8_t key)=0
 Sends a single key press.
 
virtual void write (const MediaKeyReport key)=0
 Sends a media key report.
 
virtual void print (const char *text)=0
 Sends a text string.
 

Detailed Description

Interface for Bluetooth LE keyboard functionality.

Abstract interface that defines the contract for BLE keyboard operations. Allows for dependency injection and mocking in tests.

Definition at line 112 of file i_ble_keyboard.h.

Constructor & Destructor Documentation

◆ ~IBleKeyboard()

virtual IBleKeyboard::~IBleKeyboard ( )
virtualdefault

Member Function Documentation

◆ begin()

virtual void IBleKeyboard::begin ( )
pure virtual

Initializes the BLE keyboard.

Starts BLE advertising and sets up the keyboard service.

Implemented in BleKeyboardAdapter, and BleKeyboardAdapter.

◆ isConnected()

virtual bool IBleKeyboard::isConnected ( )
pure virtual

Checks if BLE keyboard is connected to a host.

Returns
true if connected, false otherwise

Implemented in BleKeyboardAdapter, and BleKeyboardAdapter.

◆ print()

virtual void IBleKeyboard::print ( const char *  text)
pure virtual

Sends a text string.

Parameters
textNull-terminated string to send as keyboard input

Implemented in BleKeyboardAdapter, and BleKeyboardAdapter.

◆ write() [1/2]

virtual void IBleKeyboard::write ( const MediaKeyReport  key)
pure virtual

Sends a media key report.

Parameters
keyMedia key report (2-byte array)

Implemented in BleKeyboardAdapter, and BleKeyboardAdapter.

◆ write() [2/2]

virtual void IBleKeyboard::write ( uint8_t  key)
pure virtual

Sends a single key press.

Parameters
keyUSB HID key code to send

Implemented in BleKeyboardAdapter, and BleKeyboardAdapter.


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