NimBLE-Mode

This implements NimBLE-Mode to reduce memory consumption ArduinoIDE: Before including the library, insert the line #define USE_NIMBLE

#define USE_NIMBLE
#include <BleKeyboard.h>

PlatformIO: Change your platformio.ini to the following settings

lib_deps = 
  NimBLE-Arduino

build-flags = 
  -D USE_NIMBLE

Comparison (SendKeyStrokes.ino at run-time)

| | Standard | NimBLE mode | difference |---|--:|--:|--:| | ESP.getHeapSize() | 296.804 | 321.252 | + 24.448 | | ESP.getFreeHeap() | 143.572 | 260.764 | + 117.192 | | ESP.getSketchSize() | 994.224 | 579.264 | - 414.960 |

xTaskCreate

xTaskCreate was removed to fix stack issues.

Hi, kind of off-topic but do you know if this solution would work as a BT Remote Control for my Satellite Receiver? I've not found any good articles yet how to simulate a BT Remote Control. Now, sat receivers and a lot of new tv's are sold with BT controllers rather than IR...

In advance, thanx for any help/input.

I use M5StickC have Code include BleKeyboard.h. But they cannot find the device as ESP32 BLE keyboard. Win10 can find the device with Bluetooth. How iOS find the device with BleKeyboard?

#include <M5StickC.h>
#include <BleKeyboard.h>

BleKeyboard bleKeyboard;

enum ConfSystem {
  mic = 0,
  video
} conf;
int n_conf = 2;
bool on_air;

void setup() {
  M5.begin();
  bleKeyboard.begin();

  Serial.println("Webconf Mute button");
  Serial.println("Push Button A (M5) to toggle MUTE");
  Serial.println("Push Button B to switch VideoOn or VideoOFF");
  M5.Lcd.setRotation(3); // BtnA is left side to LCD

  // default
  conf = mic;
  on_air = true;
  update_display();
}

void loop() {
  M5.update();
  
  if(M5.BtnA.wasPressed()){
    Serial.println("BtnA was pressed");
    if(bleKeyboard.isConnected()){
      on_air = !on_air;
      if(conf==mic){
        send_mute_mic();
      }
      else if(conf==video){
      send_off_video();
      }
    }
    else {
      Serial.println("BLE is not connected");
    }
    update_display();
  }

  if(M5.BtnB.wasPressed()){
    Serial.println("BtnB was pressed");
    conf = ConfSystem((conf+1) % n_conf);
    Serial.print("New ConfSystem: ");
    Serial.println(conf);
    update_display();
  }
  delay(10);
}

void update_display(){
  Serial.println("update_display");
  Serial.print("On air?: ");
  Serial.println(on_air);
  if(on_air){
    show_onair();
  }
  else {
    show_inmute();
  }
}

void show_onair(){
  M5.Lcd.fillScreen(TFT_RED);
  M5.Lcd.setTextColor(TFT_WHITE, TFT_RED);
  M5.Lcd.setTextSize(3);
  M5.Lcd.setTextDatum(MC_DATUM);
  M5.Lcd.drawString("ON AIR",80,40);

  M5.Lcd.setTextSize(2);
  M5.Lcd.setTextDatum(BR_DATUM);
  if(conf==mic){
    M5.Lcd.drawString("Mic",158,78);
  }
  else if (conf==video){
    M5.Lcd.drawString("Video", 158,78);  
  }
}

void show_inmute(){
  M5.Lcd.fillScreen(TFT_DARKGREY);
  M5.Lcd.setTextColor(TFT_WHITE, TFT_DARKGREY);
  M5.Lcd.setTextSize(3);
  M5.Lcd.setTextDatum(MC_DATUM);
  M5.Lcd.drawString("Muted...",80,40);

  M5.Lcd.setTextSize(2);
  M5.Lcd.setTextDatum(BR_DATUM);
  if(conf==mic){
    M5.Lcd.drawString("Mic",158,78);
  }
  else if (conf==video){
    M5.Lcd.drawString("Video", 158,78);  
  }
}

void send_mute_mic(){
  // https://support.zoom.us/hc/en-us/articles/205683899-Hot-Keys-and-Keyboard-Shortcuts-for-Zoom
  // Command(⌘)+Shift+A: Mute/unmute audio
  Serial.println("Toggle Mic");
  bleKeyboard.press(KEY_LEFT_GUI);
  bleKeyboard.press(KEY_LEFT_SHIFT);
  bleKeyboard.press('a');
  delay(100);
  bleKeyboard.releaseAll();
}

void send_off_video(){
  // https://www.cisco.com/c/en/us/td/docs/collaboration/CWMS/2_5/b_manage_meetings/b_manage_meetings_chapter_0100.html
  Serial.println("Toggle Video");
  bleKeyboard.press(KEY_LEFT_GUI);
  bleKeyboard.press(KEY_LEFT_SHIFT);
  bleKeyboard.press('v');
  delay(100);
  bleKeyboard.releaseAll();
}

Hello T-vK!

I have forked your library to switch to the NimBLE-Arduino library to save memory. While editing I noticed that in the BleKeyboard::begin() function xTaskCreate is used. In the fork I removed this extra task and the library works fine.

I wonder what is the reason for this extra task? Can you explain it to me in more detail?

Hello Everyone. I have an android Samsung note 20 phone. The problem that when I reconnect my esp32 to my phone it won't control it any more. I have to delete connected device, reconnect again, and then it starts to control. I have tried both libraries 0.3.0 and 0.3.1

With library 0.2.3 everything works!

Thank you!

Hi, I would like to report a problem sending the keys F13 to F24. I am able to send all the keys otherwise but these keys are not going through.

I have just tested the key F13 and F6 specifically but have mentioned the 13 to 24 range as those are not the standard keys available on the keyboard.

Also posting a link to a similar problem faced by other people using the standard keyboard.h library. https://forum.arduino.cc/index.php?topic=324554.0 In the post it is mentioned that the Arduino keyboard code falsely translates the keycodes that are sent via Keyboard.press() It also has a few solutions implemented by people for the usb keyboard.h library.

Maybe that has something to do with this?

Thanks

Sorry for my complete ignorance, I'm new to this world of Arduino and ESP32. I thought this work was great and I'm trying to adapt it for a SNES control. For each button on the control I am assigning a key, for button "A" on the control for example, assign the key "x" and sending this data via BLE to the computer with ZSNS. My problem seems to be in the timing, because when pressing a button on the control there is no instant response on the emulator, I have to press several times to enter the command. Was there a way to sync the keyboard input?

Below my code.

#include <BleKeyboard.h>

BleKeyboard bleKeyboard;

//define where your pins are const int dataPin = 21; // RED const int latchPin = 19; // YELLOW const int clockPin = 18; // BLUE const int intervalo = 250; // atraso entre leituras

long buttonData, lastButtonData = 72; //01001000

// On NES Controller there are only 8 buttons, also B, Y swap to A and B const int n_buttons = 12; char* buttons[] = {"B", "Y", "SELECT", "START", "UP", "DOWN", "LEFT", "RIGHT", "A", "X", "L_BUTTON", "R_BUTTON"};

//Funções que serão chamadas por um array de pinteiros void Button_B() {/Serial.println("Apertou o B bruxo!!!!");/ bleKeyboard.print("z"); delay(intervalo);} void Button_Y(){/Serial.println("Apertou o Y bruxo!!!!");/ bleKeyboard.print("a"); delay(intervalo);} void Button_SELECT(){/Serial.println("Apertou o SELECT bruxo!!!!");/ bleKeyboard.write(KEY_RIGHT_SHIFT); delay(intervalo);} void Button_START(){/Serial.println("Apertou o START bruxo!!!!");/ bleKeyboard.write(KEY_RETURN); delay(intervalo);} void Button_UP(){/Serial.println("Apertou o UP bruxo!!!!");/ bleKeyboard.write(KEY_UP_ARROW); delay(intervalo);} void Button_DOWN(){/Serial.println("Apertou o DOWN bruxo!!!!");/ bleKeyboard.write(KEY_DOWN_ARROW); delay(intervalo);} void Button_LEFT(){/Serial.println("Apertou o LEFT bruxo!!!!");/ bleKeyboard.write(KEY_LEFT_ARROW); delay(intervalo);} void Button_RIGHT(){/Serial.println("Apertou o RIGHT bruxo!!!!");/ bleKeyboard.write(KEY_RIGHT_ARROW); delay(intervalo);} void Button_A(){/Serial.println("Apertou o A bruxo!!!!");/ bleKeyboard.print("x"); delay(intervalo);} void Button_X(){/Serial.println("Apertou o X bruxo!!!!");/ bleKeyboard.print("s"); delay(intervalo);} void Button_L_BUTTON(){/Serial.println("Apertou o L_BUTTON bruxo!!!!");/ bleKeyboard.print("d"); delay(intervalo);} void Button_R_BUTTON(){/Serial.println("Apertou o R_BUTTON bruxo!!!!");/ bleKeyboard.print("c"); delay(intervalo);}

//Array com os ponteiro que chamará as funções void (*ButtonPointer[])(void) = {Button_B, Button_Y, Button_SELECT, Button_START, Button_UP, Button_DOWN, Button_LEFT, Button_RIGHT, Button_A, Button_X, Button_L_BUTTON, Button_R_BUTTON};

void setup() { Serial.begin(115200); Serial.println("Starting BLE work!"); bleKeyboard.begin();

//define pin modes pinMode(latchPin, OUTPUT); pinMode(clockPin, OUTPUT); pinMode(dataPin, INPUT);

//Cria a Task para ler os botões do controle SNES **************************************************** xTaskCreate( taskControleSNES, /* Task function. / "TaskControleSNES", / String with name of task. / 10000, / Stack size in bytes. / NULL, / Parameter passed as input of the task / 1, / Priority of the task. / NULL); / Task handle. / //***************************************************************************************************

}

void loop() { if(bleKeyboard.isConnected()) {

//if (buttonData != lastButtonData){ lastButtonData = buttonData; //Print Raw Value of Registers //Serial.println(buttonData, BIN);

// Print String in Button Name Array
for (int n = 0; n < n_buttons; n++)
{
  if (buttonData & (1 << n) ){
    //Serial.print(buttons[n]);
    ButtonPointer[n]();
    //Serial.print(", ");
  }
}
//Serial.println("\n-------------------");

//}

//delay(10);
  
//bleKeyboard.releaseAll();

} }

void taskControleSNES( void * parameter ) {

while(1){

// Latch Signal

digitalWrite(latchPin, HIGH); delayMicroseconds(12); digitalWrite(latchPin, LOW);

int temp = 0; buttonData = 0; for (int i = 0; i < n_buttons; i++) { digitalWrite(clockPin, LOW); delayMicroseconds(0.2); temp = digitalRead(dataPin); // 0 Indicates button depressed for SNES controller if (!temp) { //temp = size_buttonData - i; buttonData = buttonData | ((long)1 << i); } digitalWrite(clockPin, HIGH); }

//if (buttonData != lastButtonData){ //lastButtonData = buttonData; // Print Raw Value of Registers //Serial.println(buttonData, BIN);

// Print String in Button Name Array

/* for (int n = 0; n < n_buttons; n++) { if (buttonData & (1 << n) ){ Serial.print(buttons[n]); Serial.print(", "); } } Serial.println("\n-------------------"); */ //} delay(10); }

vTaskDelete( NULL );

}

Disclaimer: This may very well be due to the fact I'm still fairly new to using Arduino controllers and the IDE in general.

I have the library is included in my project, but when I attempt to verify and upload I get the following error ...\Arduino\libraries\ESP32-BLE-Keyboard-0.1.0/BleConnectionStatus.h:3:10: fatal error: sdkconfig.h: No such file or directory.

I am trying to upload to a Arduino MKR WiFi 1010 which uses an esp32 chip. I'm using IDE 1.8.8, and I have the esp32 board package version 1.0.4.

Any help is appreciated.

For long strings, the write function skips a bunch of keys. This is on Windows 10, not sure if it affects other platforms or not.

Adding few millisecond delay between the key press and release solved it for me. I'm happy to make changes/corrections to my PR if needed!

Hello,

My task is to scan a Bluetooth and send a message to the monitor whenever the scanned Bluetooth device is found. For this purpose my ESP32 should act as a keyboard. Also I have an LED interfaced, that blinks whenever the Bluetooth is detected.

I am able to scan and detect the bluetooth, and also blink the LED. But however when I tried to use BLEkeyboard, the loop isnot executed with the condition bleKeyboard.isConnected(). My questions are how do I know why this "if condition" is not satisfied and where can I read my bleKeyboard.print output? I have posted my code below, please help me with your inputs. Thank you.

#include <BleKeyboard.h>

/* Based on Neil Kolban example for IDF: https://github.com/nkolban/esp32-snippets/blob/master/cpp_utils/tests/BLE%20Tests/SampleScan.cpp Ported to Arduino ESP32 by Evandro Copercini */

#include <BLEDevice.h> #include <BLEUtils.h> #include <BLEScan.h> #include <BLEAdvertisedDevice.h>

BleKeyboard bleKeyboard;

String Address = "58:ba:01:ef:ba:12"; const int Pin = 2; int scanTime = 5; //In seconds static BLEAddress pServerAddress; BLEScan pBLEScan;

class MyAdvertisedDeviceCallbacks: public BLEAdvertisedDeviceCallbacks { void onResult(BLEAdvertisedDevice advertisedDevice) { Serial.printf("Advertised Device: %s \n", advertisedDevice.toString().c_str()); if (advertisedDevice.getAddress().equals(*pServerAddress))
{ Serial.println("Device Match");
digitalWrite (Pin, HIGH);
advertisedDevice.getScan()->stop(); } // Found our server else { Serial.println("Device Mismatch"); digitalWrite (Pin, LOW); } } };

void setup() { Serial.begin(115200); Serial.println("Scanning..."); Serial.println("Starting BLE Keyboard"); //Begin the BLE keyboard/start advertising the keyboard (so phones can find it) bleKeyboard.begin();

pinMode(Pin, OUTPUT); pServerAddress = new BLEAddress(Address.c_str()); BLEDevice::init(""); pBLEScan = BLEDevice::getScan(); //create new scan pBLEScan->setAdvertisedDeviceCallbacks(new MyAdvertisedDeviceCallbacks()); pBLEScan->setActiveScan(true); //active scan uses more power, but get results faster pBLEScan->setInterval(100); pBLEScan->setWindow(99); // less or equal setInterval value }

void loop() { if (bleKeyboard.isConnected()) { Serial.println("Sending 'Hello world'..."); bleKeyboard.print("Hello world"); bleKeyboard.print(" "); pBLEScan->start(scanTime, false); pBLEScan->clearResults(); // delete results fromBLEScan buffer to release memory delay(2000); } }

Hi, I am using the 0.3.0 version with Windows 10 and I noticed, that when I add after I add the esp32 keyboard as a new bluetooth device on my windows computer, everything works just fine, the keys work and all, but if the bluetooth conenction is lost, because i turn the esp32 off and on for example, then even though the windows reconnects to the esp32 and it changes status from PAIRED to CONNECTED under the bluetooth devices, the keyboard no longer works and the only way to make it work again is to remove the esp32 keyboard from bluetooth devices on windows and then add it again, after which it works until the next time signal is lost.

I tried downgrading to 0.2.3 which works flawlessly and doesn't have this bug.

Hi, in my project i'm using ESP32 as a client with the library WiFiClientSecure. The problem is that my esp doesn't connect with my server in python because this library goes in conflict with blekeyboard.begin(). Is there a solution to disable blekeyboard and active its later?

When I use the BLE-Keyboard library with tft_eSPI library, , then only the BLE-Keyboard is working and the tft_eSPI is not working. When I remove "bleKeyboard.begin();" from the code then everything besides the Keyboard works, but it is not possible for me to get them working together for some reason.

For some reason my PC wakes up by itself from sleep. Sleep works normally when I unpair it from setting but when I repair it wakes up after 3-5 seconds.

The following imports conflict with eachother. This is an issue as I would like to use usb and bluetooth keyboards in the same program.

// Bluetooth Libraries
#include <BleKeyboard.h>

// USB Libraries
#include "USB.h"
#include "USBHIDKeyboard.h"

The full program looks somewhat like this

// Bluetooth Libraries
#include <BleKeyboard.h>
BleKeyboard bleKeyboard;

// USB Libraries
#include "USB.h"
#include "USBHIDKeyboard.h"
USBHIDKeyboard Keyboard;

// Button On Board Feather
const int buttonPin = 0;
int buttonState = 0;  // variable for reading the pushbutton status

String msg = "Hello Gamer";

void setup() {
  Serial.begin(115200);
  delay(1000);
  
  Serial.println("Starting BLE work!");
  bleKeyboard.begin();
  
  Keyboard.begin();
  USB.begin();

  pinMode(buttonPin, INPUT_PULLUP);
}

void loop() {
  bleKeyboard.setBatteryLevel(98);
  buttonState = digitalRead(buttonPin);
  // Serial.println("checking button");
  // Serial.println(buttonState == LOW);
  if (buttonState == LOW){
    if(bleKeyboard.isConnected()) {
      Serial.println("Using Bluetooth");
      bleKeyboard.print(msg);
    } 
    else {
      Serial.println("Using USB");
      Keyboard.print(msg);
    }
    delay(500);
  }
  delay(10);
}