BLE_HOGPS_SetBootKeyboardOutputReport

C

uint16_t BLE_HOGPS_SetBootKeyboardOutputReport(uint8_t ledValue);

Description

Sets the output report for a HID boot keyboard.

Note

This function updates the LED status indicators on a HID boot keyboard, such as Num Lock, Caps Lock, and Scroll Lock LEDs. The state of each LED is represented by individual bits within the provided 'ledValue' parameter.

Parameters

ParameterDescription
[in] ledValueA bitmask where each bit corresponds to an LED on the keyboard:

- Bit 0: Num Lock LED - Bit 1: Caps Lock LED - Bit 2: Scroll Lock LED - Bit 3: Compose LED - Bit 4: Kana LED Bits 5 to 7 are reserved and should be set to 0.|

Return values

Return valueDescription
MBA_RES_SUCCESSThe output report was successfully set.
MBA_RES_INVALID_PARAThe input parameters are invalid.