feat: Add ServeU Protocol implementation

Author: qdot

buttplug/src/server/device/protocol/mod.rs

@@ -95,6 +95,7 @@ pub mod satisfyer;
 pub mod sensee;
 pub mod sensee_capsule;
 pub mod sensee_v2;
+pub mod serveu;
 pub mod svakom;
 pub mod svakom_alex;
 pub mod svakom_alex_v2;
@@ -486,6 +487,10 @@ pub fn get_default_protocol_map() -> HashMap<String, Arc<dyn ProtocolIdentifierF
     &mut map,
     sensee_v2::setup::SenseeV2IdentifierFactory::default(),
   );
+  add_to_protocol_map(
+    &mut map,
+    serveu::setup::ServeUIdentifierFactory::default(),
+  );
   add_to_protocol_map(&mut map, svakom::setup::SvakomIdentifierFactory::default());
   add_to_protocol_map(
     &mut map,

buttplug/src/server/device/protocol/serveu.rs

@@ -0,0 +1,58 @@
+// Buttplug Rust Source Code File - See https://buttplug.io for more info.
+//
+// Copyright 2016-2024 Nonpolynomial Labs LLC. All rights reserved.
+//
+// Licensed under the BSD 3-Clause license. See LICENSE file in the project root
+// for full license information.
+
+use crate::{
+  core::{errors::ButtplugDeviceError, message::Endpoint},
+  server::device::{
+    hardware::{HardwareCommand, HardwareWriteCmd},
+    protocol::{generic_protocol_setup, ProtocolHandler},
+  },
+};
+use std::sync::{Arc, atomic::{AtomicU8, Ordering}};
+
+generic_protocol_setup!(ServeU, "serveu");
+
+#[derive(Default)]
+pub struct ServeU {
+  last_position: Arc<AtomicU8>
+}
+
+impl ProtocolHandler for ServeU {
+
+  fn handle_linear_cmd(
+      &self,
+      message: crate::core::message::LinearCmdV4,
+    ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> {
+    let last_pos = self.last_position.load(Ordering::Relaxed);
+    let current_cmd = message.vectors().first().ok_or(ButtplugDeviceError::DeviceFeatureCountMismatch(1, 0))?;
+    // Need to get "units" (abstracted steps 0-100) per second, so calculate how far we need to move over our goal duration.
+    let goal_pos =(current_cmd.position() * 100f64).ceil() as u8;
+    self.last_position.store(goal_pos, Ordering::Relaxed);
+    let speed_threshold = ((((goal_pos as i8) - last_pos as i8).abs()) as f64 / ((current_cmd.duration() as f64) / 1000f64)).ceil();
+
+    let speed = if speed_threshold <= 0.00001 {
+      // Stop device
+      0
+    } else if speed_threshold <= 50.0 {
+      (speed_threshold / 2.0).ceil() as u8
+    } else if speed_threshold <= 750.0 {
+      ((speed_threshold - 50.0) / 4.0).ceil() as u8 + 25u8
+    } else if speed_threshold <= 2000.0 {
+      ((speed_threshold - 750.0) / 25.0).ceil() as u8 + 200u8
+    } else {
+      // If we're going faster than 2000u/s, just return max value (0xFA)
+      0xFA
+    };
+
+    Ok(vec![HardwareWriteCmd::new(
+      Endpoint::Tx,
+      vec![0x01, goal_pos, speed],
+      false,
+    )
+    .into()])
+  }
+}

buttplug/tests/test_device_protocols.rs

@@ -114,6 +114,7 @@ async fn load_test_case(test_file: &str) -> DeviceTestCase {
 #[test_case("test_deepsire.yaml" ; "DeepSire Protocol")]
 #[test_case("test_xuanhuan_protocol.yaml" ; "Xuanhuan Protocol")]
 #[test_case("test_tcode_linear_and_vibrate.yaml" ; "TCode (Linear + Vibrate)")]
+#[test_case("test_serveu_protocol.yaml" ; "ServeU")]
 #[tokio::test]
 async fn test_device_protocols_embedded_v3(test_file: &str) {
   //tracing_subscriber::fmt::init();
@@ -218,6 +219,7 @@ async fn test_device_protocols_embedded_v3(test_file: &str) {
 #[test_case("test_deepsire.yaml" ; "DeepSire Protocol")]
 #[test_case("test_xuanhuan_protocol.yaml" ; "Xuanhuan Protocol")]
 #[test_case("test_tcode_linear_and_vibrate.yaml" ; "TCode (Linear + Vibrate)")]
+#[test_case("test_serveu_protocol.yaml" ; "ServeU")]
 #[tokio::test]
 async fn test_device_protocols_json_v3(test_file: &str) {
   //tracing_subscriber::fmt::init();
@@ -293,6 +295,7 @@ async fn test_device_protocols_json_v3(test_file: &str) {
 #[test_case("test_deepsire.yaml" ; "DeepSire Protocol")]
 #[test_case("test_xuanhuan_protocol.yaml" ; "Xuanhuan Protocol")]
 #[test_case("test_tcode_linear_and_vibrate.yaml" ; "TCode (Linear + Vibrate)")]
+#[test_case("test_serveu_protocol.yaml" ; "ServeU")]
 #[tokio::test]
 async fn test_device_protocols_embedded_v2(test_file: &str) {
   util::device_test::client::client_v2::run_embedded_test_case(&load_test_case(test_file).await)
@@ -367,6 +370,7 @@ async fn test_device_protocols_embedded_v2(test_file: &str) {
 #[test_case("test_deepsire.yaml" ; "DeepSire Protocol")]
 #[test_case("test_xuanhuan_protocol.yaml" ; "Xuanhuan Protocol")]
 #[test_case("test_tcode_linear_and_vibrate.yaml" ; "TCode (Linear + Vibrate)")]
+#[test_case("test_serveu_protocol.yaml" ; "ServeU")]
 #[tokio::test]
 async fn test_device_protocols_json_v2(test_file: &str) {
   util::device_test::client::client_v2::run_json_test_case(&load_test_case(test_file).await).await;

buttplug/tests/util/device_test/device_test_case/test_serveu_protocol.yaml

@@ -0,0 +1,67 @@
+devices:
+  - identifier: 
+      name: "ServeU"
+    expected_name: "ServeU"
+device_commands:            
+  # Commands
+  #
+  # Test @ 30 u/s
+  - !Messages
+      device_index: 0
+      messages:
+        - !Linear
+          - Index: 0
+            Position: 0.30
+            Duration: 1000
+  - !Commands
+      device_index: 0
+      commands:
+        - !Write
+            endpoint: tx
+            data: [0x01, 30, 15]
+            write_with_response: false
+  # Test @ 250 u/s
+  - !Messages
+      device_index: 0
+      messages:
+        - !Linear
+          - Index: 0
+            Position: 0.80
+            Duration: 200
+  - !Commands
+      device_index: 0
+      commands:
+        - !Write
+            endpoint: tx
+            data: [0x01, 80, 75]
+            write_with_response: false
+  # Test @ 1000 u/s
+  - !Messages
+      device_index: 0
+      messages:
+        - !Linear
+          - Index: 0
+            Position: 1.0
+            Duration: 10
+  - !Commands
+      device_index: 0
+      commands:
+        - !Write
+            endpoint: tx
+            data: [0x01, 100, 250]
+            write_with_response: false
+  # Test same position/stop
+  - !Messages
+      device_index: 0
+      messages:
+        - !Linear
+          - Index: 0
+            Position: 1.0
+            Duration: 10
+  - !Commands
+      device_index: 0
+      commands:
+        - !Write
+            endpoint: tx
+            data: [0x01, 100, 0]
+            write_with_response: false