feat(hid-rp): add 3Dconnexion SpaceMouse HID report descriptor

components/hid-rp/README.md

@@ -6,7 +6,7 @@ The `hid-rp` component provides a wrapper around
 https://github.com/intergatedcircuits/hid-rp and also provides an example
 implementation of a configurable HID Gamepad using hid-rp.
 
-It also implements Switch Pro and Xbox gamepad reports.
+It also implements Switch Pro, Xbox gamepad, and 3Dconnexion SpaceMouse reports.
 
 ## Example
 

components/hid-rp/example/main/hid_rp_example.cpp

@@ -3,6 +3,7 @@
 
 #include "logger.hpp"
 
+#include "hid-rp-3dconnexion.hpp"
 #include "hid-rp-gamepad.hpp"
 #include "hid-rp-playstation.hpp"
 #include "hid-rp-ps4.hpp"
@@ -212,5 +213,28 @@ extern "C" void app_main(void) {
   logger.info("  Size: {}", report.size());
   logger.info("  Data: {::#02X}", report);
 
+  // 3Dconnexion SpaceMouse: translation (report id 1), rotation (report id
+  // 2), and buttons (report id 3) are all sent as separate input reports.
+  using SpaceMouseTranslation = espp::SpaceMouseTranslationInputReport<>;
+  using SpaceMouseRotation = espp::SpaceMouseRotationInputReport<>;
+  using SpaceMouseButtons = espp::SpaceMouseButtonsInputReport<>;
+  SpaceMouseTranslation spacemouse_translation_report;
+  SpaceMouseRotation spacemouse_rotation_report;
+  SpaceMouseButtons spacemouse_buttons_report;
+
+  auto sm_raw_descriptor = espp::spacemouse_descriptor<>();
+  auto sm_descriptor = std::vector<uint8_t>(sm_raw_descriptor.begin(), sm_raw_descriptor.end());
+  logger.info("SpaceMouse Report Descriptor:");
+  logger.info("  Size: {}", sm_descriptor.size());
+  logger.info("  Data: {::#04X}", sm_descriptor);
+
+  spacemouse_translation_report.set_translation(350, -350, 0);
+  spacemouse_rotation_report.set_rotation(0, 100, -100);
+  spacemouse_buttons_report.set_button(1, true);
+
+  logger.info("{}", spacemouse_translation_report);
+  logger.info("{}", spacemouse_rotation_report);
+  logger.info("{}", spacemouse_buttons_report);
+
   //! [hid rp example]
 }

components/hid-rp/include/hid-rp-3dconnexion-formatters.hpp

@@ -0,0 +1,58 @@
+#pragma once
+
+#include <bitset>
+#include <cstddef>
+#include <cstdint>
+
+#include "format.hpp"
+#include "hid-rp-3dconnexion.hpp"
+
+template <std::int16_t LOGICAL_MIN, std::int16_t LOGICAL_MAX, uint8_t REPORT_ID>
+struct fmt::formatter<espp::SpaceMouseTranslationInputReport<LOGICAL_MIN, LOGICAL_MAX, REPORT_ID>> {
+  template <typename ParseContext> constexpr auto parse(ParseContext &ctx) const {
+    return ctx.begin();
+  }
+
+  template <typename FormatContext>
+  auto
+  format(const espp::SpaceMouseTranslationInputReport<LOGICAL_MIN, LOGICAL_MAX, REPORT_ID> &report,
+         FormatContext &ctx) const {
+    return fmt::format_to(ctx.out(), "SpaceMouseTranslationInputReport {{x: {}, y: {}, z: {}}}",
+                          report.axes[0], report.axes[1], report.axes[2]);
+  }
+};
+
+template <std::int16_t LOGICAL_MIN, std::int16_t LOGICAL_MAX, uint8_t REPORT_ID>
+struct fmt::formatter<espp::SpaceMouseRotationInputReport<LOGICAL_MIN, LOGICAL_MAX, REPORT_ID>> {
+  template <typename ParseContext> constexpr auto parse(ParseContext &ctx) const {
+    return ctx.begin();
+  }
+
+  template <typename FormatContext>
+  auto
+  format(const espp::SpaceMouseRotationInputReport<LOGICAL_MIN, LOGICAL_MAX, REPORT_ID> &report,
+         FormatContext &ctx) const {
+    return fmt::format_to(ctx.out(), "SpaceMouseRotationInputReport {{rx: {}, ry: {}, rz: {}}}",
+                          report.axes[0], report.axes[1], report.axes[2]);
+  }
+};
+
+template <std::size_t BUTTON_COUNT, uint8_t REPORT_ID>
+struct fmt::formatter<espp::SpaceMouseButtonsInputReport<BUTTON_COUNT, REPORT_ID>> {
+  template <typename ParseContext> constexpr auto parse(ParseContext &ctx) const {
+    return ctx.begin();
+  }
+
+  template <typename FormatContext>
+  auto format(const espp::SpaceMouseButtonsInputReport<BUTTON_COUNT, REPORT_ID> &report,
+              FormatContext &ctx) const {
+    auto out = ctx.out();
+    out = fmt::format_to(out, "SpaceMouseButtonsInputReport<{}> {{buttons: [", BUTTON_COUNT);
+    std::bitset<BUTTON_COUNT> buttons;
+    for (size_t i = 1; i <= BUTTON_COUNT; i++) {
+      buttons.set(i - 1, report.buttons.test(hid::page::button(i)));
+    }
+    out = fmt::format_to(out, "{}", buttons);
+    return fmt::format_to(out, "]}}");
+  }
+};