Allow setting names for BT/BLE HID devices (#1260)

earlephilhower · web-flow · commit 173c44417c3e · 2023-03-04T12:38:34.000-08:00
diff --git a/libraries/JoystickBLE/src/JoystickBLE.cpp b/libraries/JoystickBLE/src/JoystickBLE.cpp
@@ -37,19 +37,26 @@ JoystickBLE_::JoystickBLE_(void) {
 
 #define REPORT_ID 0x01
 static const uint8_t desc_joystick[] = {TUD_HID_REPORT_DESC_GAMEPAD(HID_REPORT_ID(REPORT_ID))};
-void JoystickBLE_::begin(void) {
-    PicoBluetoothBLEHID.startHID("PicoW BLE Joystick", "PicoW BLE Joystick", 0x03c4, desc_joystick, sizeof(desc_joystick));
+
+void JoystickBLE_::begin(const char *localName, const char *hidName) {
+    if (!localName) {
+        localName = "PicoW BLE Joystick";
+    }
+    if (!hidName) {
+        hidName = localName;
+    }
+    PicoBluetoothBLEHID.startHID(localName, hidName, 0x03c4, desc_joystick, sizeof(desc_joystick));
 }
 
-void JoystickBLE_::end(void) {
+void JoystickBLE_::end() {
     PicoBluetoothBLEHID.end();
 }
 
 void JoystickBLE_::setBattery(int lvl) {
     PicoBluetoothBLEHID.setBattery(lvl);
 }
 
-void JoystickBLE_::send_now(void) {
+void JoystickBLE_::send_now() {
     PicoBluetoothBLEHID.send(&data, sizeof(data));
 }
 
diff --git a/libraries/JoystickBLE/src/JoystickBLE.h b/libraries/JoystickBLE/src/JoystickBLE.h
@@ -27,10 +27,10 @@
 //======================================================================
 class JoystickBLE_ : public HID_Joystick {
 public:
-    JoystickBLE_(void);
-    void begin(void);
-    void end(void);
-    virtual void send_now(void) override;
+    JoystickBLE_();
+    void begin(const char *localName = nullptr, const char *hidName = nullptr);
+    void end();
+    virtual void send_now() override;
     void setBattery(int lvl);
 };
 extern JoystickBLE_ JoystickBLE;
diff --git a/libraries/JoystickBT/examples/BTJoystick-AllFunctions/BTJoystick-AllFunctions.ino b/libraries/JoystickBT/examples/BTJoystick-AllFunctions/BTJoystick-AllFunctions.ino
@@ -10,7 +10,7 @@
 void setup() {
   Serial.begin(115200);
   Serial.println("Use BOOTSEL to start the Joystick demo.");
-  JoystickBT.begin();
+  JoystickBT.begin("PicoJoy Demo");
 }
 
 void loop() {
diff --git a/libraries/JoystickBT/src/JoystickBT.cpp b/libraries/JoystickBT/src/JoystickBT.cpp
@@ -31,22 +31,29 @@
 //================================================================================
 //	Joystick/Gamepad
 
-JoystickBT_::JoystickBT_(void) {
+JoystickBT_::JoystickBT_() {
     // HID_Joystick sets up all the member vars
 }
 
 #define REPORT_ID 0x01
 static const uint8_t desc_joystick[] = {TUD_HID_REPORT_DESC_GAMEPAD(HID_REPORT_ID(REPORT_ID))};
-void JoystickBT_::begin(void) {
-    PicoBluetoothHID.startHID("PicoW Joystick 00:00:00:00:00:00", "PicoW HID Joystick", 0x2508, 33, desc_joystick, sizeof(desc_joystick));
+
+void JoystickBT_::begin(const char *localName, const char *hidName) {
+    if (!localName) {
+        localName = "PicoW BT Joystick";
+    }
+    if (!hidName) {
+        hidName = localName;
+    }
+    PicoBluetoothHID.startHID(localName, hidName, 0x2508, 33, desc_joystick, sizeof(desc_joystick));
 }
 
-void JoystickBT_::end(void) {
+void JoystickBT_::end() {
     PicoBluetoothHID.end();
 }
 
 //immediately send an HID report
-void JoystickBT_::send_now(void) {
+void JoystickBT_::send_now() {
     PicoBluetoothHID.send(REPORT_ID, &data, sizeof(data));
 }
 
diff --git a/libraries/JoystickBT/src/JoystickBT.h b/libraries/JoystickBT/src/JoystickBT.h
@@ -27,9 +27,9 @@
 //======================================================================
 class JoystickBT_ : public HID_Joystick {
 public:
-    JoystickBT_(void);
-    void begin(void);
-    void end(void);
-    virtual void send_now(void) override;
+    JoystickBT_();
+    void begin(const char *localName = nullptr, const char *hidName = nullptr);
+    void end();
+    virtual void send_now() override;
 };
 extern JoystickBT_ JoystickBT;
diff --git a/libraries/KeyboardBLE/src/KeyboardBLE.cpp b/libraries/KeyboardBLE/src/KeyboardBLE.cpp
@@ -35,9 +35,16 @@ KeyboardBLE_::KeyboardBLE_(void) {
 #define REPORT_ID 0x01
 
 static const uint8_t desc_keyboard[] = {TUD_HID_REPORT_DESC_KEYBOARD(HID_REPORT_ID(REPORT_ID))};
-void KeyboardBLE_::begin(const uint8_t *layout) {
+
+void KeyboardBLE_::begin(const char *localName, const char *hidName, const uint8_t *layout) {
+    if (!localName) {
+        localName = "PicoW BLE Keyboard";
+    }
+    if (!hidName) {
+        hidName = localName;
+    }
     _asciimap = layout;
-    PicoBluetoothBLEHID.startHID("PicoW BLE Keyboard", "PicoW BLE Keyboard", 0x03c1, desc_keyboard, sizeof(desc_keyboard));
+    PicoBluetoothBLEHID.startHID(localName, hidName, 0x03c1, desc_keyboard, sizeof(desc_keyboard));
 }
 
 void KeyboardBLE_::end(void) {
diff --git a/libraries/KeyboardBLE/src/KeyboardBLE.h b/libraries/KeyboardBLE/src/KeyboardBLE.h
@@ -30,7 +30,7 @@ class KeyboardBLE_ : public HID_Keyboard {
     virtual void sendReport(KeyReport* keys) override;
 public:
     KeyboardBLE_(void);
-    void begin(const uint8_t *layout = KeyboardLayout_en_US);
+    void begin(const char *localName = nullptr, const char *hidName = nullptr, const uint8_t *layout = KeyboardLayout_en_US);
     void end(void);
     void setBattery(int lvl);
 };
diff --git a/libraries/KeyboardBT/examples/BTKeyboardPassword/BTKeyboardPassword.ino b/libraries/KeyboardBT/examples/BTKeyboardPassword/BTKeyboardPassword.ino
@@ -5,7 +5,7 @@
 
 void setup() {
   Serial.begin(115200);
-  KeyboardBT.begin();
+  KeyboardBT.begin("PicoW Password");
   delay(5000);
   Serial.printf("Arduino USB Password Typer\n");
   Serial.printf("Press BOOTSEL to enter your super-secure(not!) password\n\n");
diff --git a/libraries/KeyboardBT/src/KeyboardBT.cpp b/libraries/KeyboardBT/src/KeyboardBT.cpp
@@ -35,9 +35,16 @@ KeyboardBT_::KeyboardBT_(void) {
 #define REPORT_ID 0x01
 
 static const uint8_t desc_keyboard[] = {TUD_HID_REPORT_DESC_KEYBOARD(HID_REPORT_ID(REPORT_ID))};
-void KeyboardBT_::begin(const uint8_t *layout) {
+
+void KeyboardBT_::begin(const char *localName, const char *hidName, const uint8_t *layout) {
+    if (!localName) {
+        localName = "PicoW BT Keyboard";
+    }
+    if (!hidName) {
+        hidName = localName;
+    }
     _asciimap = layout;
-    PicoBluetoothHID.startHID("PicoW Keyboard 00:00:00:00:00:00", "PicoW HID Keyboard", 0x2540, 33, desc_keyboard, sizeof(desc_keyboard));
+    PicoBluetoothHID.startHID(localName, hidName, 0x2540, 33, desc_keyboard, sizeof(desc_keyboard));
 }
 
 void KeyboardBT_::end(void) {
diff --git a/libraries/KeyboardBT/src/KeyboardBT.h b/libraries/KeyboardBT/src/KeyboardBT.h
@@ -30,7 +30,7 @@ class KeyboardBT_ : public HID_Keyboard {
     virtual void sendReport(KeyReport* keys) override;
 public:
     KeyboardBT_(void);
-    void begin(const uint8_t *layout = KeyboardLayout_en_US);
+    void begin(const char *localName = nullptr, const char *hidName = nullptr, const uint8_t *layout = KeyboardLayout_en_US);
     void end(void);
 };
 extern KeyboardBT_ KeyboardBT;
diff --git a/libraries/MouseBLE/examples/BLECircle/BLECircle.ino b/libraries/MouseBLE/examples/BLECircle/BLECircle.ino
@@ -5,7 +5,7 @@
 
 void setup() {
   Serial.begin(115200);
-  MouseBLE.begin();
+  MouseBLE.begin("CircleBLE Mouse");
   delay(5000);
   Serial.printf("Press BOOTSEL to move the mouse in a circle\n");
 }
diff --git a/libraries/MouseBLE/src/MouseBLE.cpp b/libraries/MouseBLE/src/MouseBLE.cpp
@@ -28,8 +28,14 @@ MouseBLE_::MouseBLE_(void) {
 
 #define REPORT_ID 0x01
 const uint8_t desc_mouse[] = {TUD_HID_REPORT_DESC_MOUSE(HID_REPORT_ID(REPORT_ID))};
-void MouseBLE_::begin(void) {
-    PicoBluetoothBLEHID.startHID("PicoW BLE Mouse", "PicoW BLE Mouse", 0x03c2, desc_mouse, sizeof(desc_mouse));
+void MouseBLE_::begin(const char *localName, const char *hidName) {
+    if (!localName) {
+        localName = "PicoW BLE Mouse";
+    }
+    if (!hidName) {
+        hidName = localName;
+    }
+    PicoBluetoothBLEHID.startHID(localName, hidName, 0x03c2, desc_mouse, sizeof(desc_mouse));
 }
 
 void MouseBLE_::end(void) {
diff --git a/libraries/MouseBLE/src/MouseBLE.h b/libraries/MouseBLE/src/MouseBLE.h
@@ -27,7 +27,7 @@
 class MouseBLE_ : public HID_Mouse {
 public:
     MouseBLE_(void);
-    void begin(void);
+    void begin(const char *localName = nullptr, const char *hidName = nullptr);
     void end(void);
     virtual void move(int x, int y, signed char wheel = 0) override;
     void setBattery(int lvl);
diff --git a/libraries/MouseBT/examples/BTCircle/BTCircle.ino b/libraries/MouseBT/examples/BTCircle/BTCircle.ino
@@ -6,7 +6,7 @@
 
 void setup() {
   Serial.begin(115200);
-  MouseBT.begin();
+  MouseBT.begin("BarrelMouse");
   delay(5000);
   Serial.printf("Press BOOTSEL to move the mouse in a circle\n");
 }
diff --git a/libraries/MouseBT/src/MouseBT.cpp b/libraries/MouseBT/src/MouseBT.cpp
@@ -28,8 +28,15 @@ MouseBT_::MouseBT_(void) {
 
 #define REPORT_ID 0x01
 const uint8_t desc_mouse[] = {TUD_HID_REPORT_DESC_MOUSE(HID_REPORT_ID(REPORT_ID))};
-void MouseBT_::begin(void) {
-    PicoBluetoothHID.startHID("PicoW Mouse 00:00:00:00:00:00", "PicoW HID Mouse", 0x2580, 33, desc_mouse, sizeof(desc_mouse));
+
+void MouseBT_::begin(const char *localName, const char *hidName) {
+    if (!localName) {
+        localName = "PicoW Mouse 00:00:00:00:00:00";
+    }
+    if (!hidName) {
+        hidName = localName;
+    }
+    PicoBluetoothHID.startHID(localName, hidName, 0x2580, 33, desc_mouse, sizeof(desc_mouse));
 }
 
 void MouseBT_::end(void) {
diff --git a/libraries/MouseBT/src/MouseBT.h b/libraries/MouseBT/src/MouseBT.h
@@ -27,7 +27,7 @@
 class MouseBT_ : public HID_Mouse {
 public:
     MouseBT_(void);
-    void begin(void);
+    void begin(const char *localName = nullptr, const char *hidName = nullptr);
     void end(void);
     virtual void move(int x, int y, signed char wheel = 0) override;
 };

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`void setup() {`
`11`	`11`	`Serial.begin(115200);`
`12`	`12`	`Serial.println("Use BOOTSEL to start the Joystick demo.");`
`13`		`- JoystickBT.begin();`
	`13`	`+ JoystickBT.begin("PicoJoy Demo");`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`void loop() {`