feat: Adding support for Kiiroo ProWand

Author: blackspherefollower

buttplug/buttplug-device-config/build-config/buttplug-device-config-v3.json

@@ -4780,6 +4780,57 @@
         }
       ]
     },
+    "kiiroo-prowand": {
+      "defaults": {
+        "name": "Kiiroo ProWand",
+        "features": [
+          {
+            "feature-type": "Vibrate",
+            "actuator": {
+              "step-range": [
+                0,
+                255
+              ],
+              "messages": [
+                "ScalarCmd"
+              ]
+            }
+          },
+          {
+            "feature-type": "Battery",
+            "description": "Battery Level",
+            "sensor": {
+              "value-range": [
+                [
+                  0,
+                  100
+                ]
+              ],
+              "messages": [
+                "SensorReadCmd"
+              ]
+            }
+          }
+        ]
+      },
+      "communication": [
+        {
+          "btle": {
+            "names": [
+              "ProWand"
+            ],
+            "services": {
+              "00001400-0000-1000-8000-00805f9b34fb": {
+                "tx": "00001401-0000-1000-8000-00805f9b34fb"
+              },
+              "0000180f-0000-1000-8000-00805f9b34fb": {
+                "rxblebattery": "00002a19-0000-1000-8000-00805f9b34fb"
+              }
+            }
+          }
+        }
+      ]
+    },
     "vorze-cyclone-x": {
       "defaults": {
         "name": "Vorze Cyclone X10 Device",

buttplug/buttplug-device-config/device-config-v3/buttplug-device-config-v3.yml

@@ -2734,6 +2734,34 @@ protocols:
               whitelist: 00001901-0000-1000-8000-00805f9b34fb
               tx: 00001902-0000-1000-8000-00805f9b34fb
               rx: 00001903-0000-1000-8000-00805f9b34fb
+  kiiroo-prowand:
+    defaults:
+      name: Kiiroo ProWand
+      features:
+        - feature-type: Vibrate
+          actuator:
+            step-range:
+              - 0
+              - 255
+            messages:
+              - ScalarCmd
+        - feature-type: Battery
+          description: Battery Level
+          sensor:
+            value-range:
+              - - 0
+                - 100
+            messages:
+              - SensorReadCmd
+    communication:
+      - btle:
+          names:
+            - ProWand
+          services:
+            00001400-0000-1000-8000-00805f9b34fb:
+              tx: 00001401-0000-1000-8000-00805f9b34fb
+            0000180f-0000-1000-8000-00805f9b34fb:
+              rxblebattery: 00002a19-0000-1000-8000-00805f9b34fb
   vorze-cyclone-x:
     defaults:
       name: Vorze Cyclone X10 Device

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

@@ -0,0 +1,101 @@
+// 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 super::fleshlight_launch_helper::calculate_speed;
+use crate::{
+  core::{
+    errors::ButtplugDeviceError,
+    message::{
+      self,
+      ButtplugDeviceMessage,
+      ButtplugServerDeviceMessage,
+      Endpoint,
+      SensorReadingV4,
+      SensorType,
+    },
+  },
+  server::device::{
+    hardware::{
+      Hardware,
+      HardwareCommand,
+      HardwareEvent,
+      HardwareReadCmd,
+      HardwareSubscribeCmd,
+      HardwareUnsubscribeCmd,
+      HardwareWriteCmd,
+    },
+    protocol::{generic_protocol_setup, ProtocolHandler},
+  },
+  util::{async_manager, stream::convert_broadcast_receiver_to_stream},
+};
+use dashmap::DashSet;
+use futures::{
+  future::{self, BoxFuture},
+  FutureExt,
+  StreamExt,
+};
+use std::{
+  default::Default,
+  pin::Pin,
+  sync::{
+    atomic::{AtomicU8, Ordering::SeqCst},
+    Arc,
+  },
+};
+use tokio::sync::broadcast;
+
+generic_protocol_setup!(KiirooProWand, "kiiroo-prowand");
+
+#[derive(Default)]
+pub struct KiirooProWand {}
+
+impl ProtocolHandler for KiirooProWand {
+  fn handle_scalar_vibrate_cmd(
+    &self,
+    _: u32,
+    scalar: u32,
+  ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> {
+    Ok(vec![HardwareWriteCmd::new(
+      Endpoint::Tx,
+      vec![
+        0x00,
+        0x00,
+        0x64,
+        if scalar == 0 { 0x00 } else { 0xff },
+        scalar as u8,
+        scalar as u8,
+      ],
+      false,
+    )
+    .into()])
+  }
+
+  fn handle_battery_level_cmd(
+    &self,
+    device: Arc<Hardware>,
+    message: message::SensorReadCmdV4,
+  ) -> BoxFuture<Result<SensorReadingV4, ButtplugDeviceError>> {
+    debug!("Trying to get battery reading.");
+    let message = message.clone();
+    let msg = HardwareReadCmd::new(Endpoint::RxBLEBattery, 20, 0);
+    let fut = device.read_value(&msg);
+    async move {
+      let hw_msg = fut.await?;
+      let data = hw_msg.data();
+      let battery_level = data[0] as i32;
+      let battery_reading = message::SensorReadingV4::new(
+        message.device_index(),
+        *message.feature_index(),
+        *message.sensor_type(),
+        vec![battery_level],
+      );
+      debug!("Got battery reading: {}", battery_level);
+      Ok(battery_reading)
+    }
+    .boxed()
+  }
+}

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

@@ -43,6 +43,7 @@ pub mod joyhub_v3;
 pub mod joyhub_v4;
 pub mod joyhub_v5;
 pub mod kgoal_boost;
+pub mod kiiroo_prowand;
 pub mod kiiroo_v2;
 pub mod kiiroo_v21;
 pub mod kiiroo_v21_initialized;
@@ -310,6 +311,10 @@ pub fn get_default_protocol_map() -> HashMap<String, Arc<dyn ProtocolIdentifierF
     &mut map,
     joyhub_v5::setup::JoyHubV5IdentifierFactory::default(),
   );
+  add_to_protocol_map(
+    &mut map,
+    kiiroo_prowand::setup::KiirooProWandIdentifierFactory::default(),
+  );
   add_to_protocol_map(
     &mut map,
     kiiroo_v2::setup::KiirooV2IdentifierFactory::default(),

buttplug/tests/test_device_protocols.rs

@@ -116,6 +116,7 @@ async fn load_test_case(test_file: &str) -> DeviceTestCase {
 #[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")]
+#[test_case("test_kiiroo_prowand.yaml" ; "Kiiroo ProWand Protocol")]
 #[tokio::test]
 async fn test_device_protocols_embedded_v3(test_file: &str) {
   //tracing_subscriber::fmt::init();
@@ -222,6 +223,7 @@ async fn test_device_protocols_embedded_v3(test_file: &str) {
 #[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")]
+#[test_case("test_kiiroo_prowand.yaml" ; "Kiiroo ProWand Protocol")]
 #[tokio::test]
 async fn test_device_protocols_json_v3(test_file: &str) {
   //tracing_subscriber::fmt::init();
@@ -298,6 +300,7 @@ async fn test_device_protocols_json_v3(test_file: &str) {
 #[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")]
+#[test_case("test_kiiroo_prowand.yaml" ; "Kiiroo ProWand Protocol")]
 #[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)
@@ -373,6 +376,7 @@ async fn test_device_protocols_embedded_v2(test_file: &str) {
 #[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")]
+#[test_case("test_kiiroo_prowand.yaml" ; "Kiiroo ProWand Protocol")]
 #[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_kiiroo_prowand.yaml

@@ -0,0 +1,43 @@
+devices:
+  - identifier: 
+      name: "ProWand"
+    expected_name: "Kiiroo ProWand"
+device_commands:
+  # Commands
+  - !Messages
+      device_index: 0
+      messages: 
+        - !Vibrate
+          - Index: 0
+            Speed: 0.5
+  - !Commands
+      device_index: 0
+      commands: 
+        - !Write
+            endpoint: tx
+            data: [0x00, 0x00, 0x64, 0xff, 0x80, 0x80]
+            write_with_response: false
+  - !Messages
+      device_index: 0
+      messages:
+        - !Vibrate
+          - Index: 0
+            Speed: 1.0
+  - !Commands
+      device_index: 0
+      commands:
+        - !Write
+            endpoint: tx
+            data: [0x00, 0x00, 0x64, 0xff, 0xff, 0xff]
+            write_with_response: false
+  - !Messages
+      device_index: 0
+      messages:
+        - !Stop
+  - !Commands
+      device_index: 0
+      commands:
+        - !Write
+            endpoint: tx
+            data: [0x00, 0x00, 0x64, 0x00, 0x00, 0x00]
+            write_with_response: false