Deprecate named hardware objects

Some boards used to provide the device object under an alias named after the
device itself. For the sake of consistency, we do not want to provide these
aliases in the future. As such, deprecate them, and update all users to use
`KeyboardHardware` instead.

Signed-off-by: Gergely Nagy <algernon@keyboard.io>

examples/Devices/KBDFans/KBD4x/KBD4x.ino

@@ -78,7 +78,7 @@ KALEIDOSCOPE_INIT_PLUGINS(Macros);
 const macro_t *macroAction(uint8_t macroIndex, uint8_t keyState) {
   switch (macroIndex) {
   case RESET:
-    KBD4x.resetDevice();
+    KeyboardHardware.resetDevice();
     break;
   default:
     break;

examples/Devices/Technomancy/Atreus/Atreus.ino

@@ -83,7 +83,7 @@ KALEIDOSCOPE_INIT_PLUGINS(Macros);
 const macro_t *macroAction(uint8_t macroIndex, uint8_t keyState) {
   switch (macroIndex) {
   case RESET:
-    Atreus.resetDevice();
+    KeyboardHardware.resetDevice();
     break;
   default:
     break;

src/kaleidoscope/device/ez/ErgoDox.h

@@ -156,6 +156,6 @@ class ErgoDox : public kaleidoscope::Hardware {
 }
 }
 
-extern kaleidoscope::device::ez::ErgoDox &ErgoDox;
+extern kaleidoscope::device::ez::ErgoDox DEPRECATED(NAMED_HARDWARE) &ErgoDox;
 
 #endif

src/kaleidoscope/device/kbdfans/KBD4x.h

@@ -67,6 +67,6 @@ class KBD4x: public kaleidoscope::device::ATMegaKeyboard {
 }
 }
 
-extern kaleidoscope::device::kbdfans::KBD4x &KBD4x;
+extern kaleidoscope::device::kbdfans::KBD4x DEPRECATED(NAMED_HARDWARE) &KBD4x;
 
 #endif

src/kaleidoscope/device/olkb/Planck.h

@@ -63,6 +63,6 @@ class Planck: public kaleidoscope::device::ATMegaKeyboard {
 }
 }
 
-extern kaleidoscope::device::olkb::Planck &Planck;
+extern kaleidoscope::device::olkb::Planck DEPRECATED(NAMED_HARDWARE) &Planck;
 
 #endif

src/kaleidoscope/device/softhruf/Splitography.h

@@ -88,6 +88,6 @@ class Splitography: public kaleidoscope::device::ATMegaKeyboard {
 }
 }
 
-extern kaleidoscope::device::softhruf::Splitography &Splitography;
+extern kaleidoscope::device::softhruf::Splitography DEPRECATED(NAMED_HARDWARE) &Splitography;
 
 #endif

src/kaleidoscope/device/technomancy/Atreus.h

@@ -105,6 +105,6 @@ class Atreus: public kaleidoscope::device::ATMegaKeyboard {
 }
 }
 
-extern kaleidoscope::device::technomancy::Atreus &Atreus;
+extern kaleidoscope::device::technomancy::Atreus DEPRECATED(NAMED_HARDWARE) &Atreus;
 
 #endif

src/kaleidoscope/device/technomancy/Atreus2.h

@@ -82,6 +82,6 @@ class Atreus2: public kaleidoscope::device::ATMegaKeyboard {
 }
 }
 
-extern kaleidoscope::device::technomancy::Atreus2 &Atreus2;
+extern kaleidoscope::device::technomancy::Atreus2 DEPRECATED(NAMED_HARDWARE) &Atreus2;
 
 #endif

src/kaleidoscope_internal/deprecations.h

@@ -26,3 +26,7 @@
   "------------------------------------------------------------------------\n" \
 
 /* Messages */
+
+#define _DEPRECATED_MESSAGE_NAMED_HARDWARE                                 __NL__ \
+  "Named hardware objects are deprecated, please use `KeyboardHardware`\n" __NL__ \
+  "instead."