feat: Add StopDeviceCmdV4 and StopAllDevicesV4

Allows input/output choice in stopping, while also being backward compatible.

Author: qdot

crates/buttplug_client/src/device/device.rs

@@ -17,7 +17,7 @@ use buttplug_core::message::InputType;
 use buttplug_core::{
   errors::ButtplugDeviceError,
   message::{
-    ButtplugServerMessageV4, DeviceFeature, DeviceMessageInfoV4, OutputType, StopDeviceCmdV0,
+    ButtplugServerMessageV4, DeviceFeature, DeviceMessageInfoV4, OutputType, StopDeviceCmdV4,
   },
   util::stream::convert_broadcast_receiver_to_stream,
 };
@@ -308,7 +308,14 @@ impl ButtplugClientDevice {
     // All devices accept StopDeviceCmd
     self
       .event_loop_sender
-      .send_message_expect_ok(StopDeviceCmdV0::new(self.index).into())
+      .send_message_expect_ok(StopDeviceCmdV4::new(self.index, true, true).into())
+  }
+
+  pub fn stop_features(&self, inputs: bool, outputs: bool) -> ButtplugClientResultFuture {
+    // All devices accept StopDeviceCmd
+    self
+      .event_loop_sender
+      .send_message_expect_ok(StopDeviceCmdV4::new(self.index, inputs, outputs).into())
   }
 
   pub(crate) fn set_device_connected(&self, connected: bool) {

crates/buttplug_client/src/lib.rs

@@ -28,7 +28,7 @@ use buttplug_core::{
     RequestDeviceListV0,
     RequestServerInfoV4,
     StartScanningV0,
-    StopAllDevicesV0,
+    StopAllDevicesV4,
     StopScanningV0,
   },
   util::{
@@ -435,7 +435,7 @@ impl ButtplugClient {
   pub fn stop_all_devices(&self) -> ButtplugClientResultFuture {
     self
       .message_sender
-      .send_message_expect_ok(StopAllDevicesV0::default().into())
+      .send_message_expect_ok(StopAllDevicesV4::default().into())
   }
 
   pub fn event_stream(&self) -> impl Stream<Item = ButtplugClientEvent> + use<> {

crates/buttplug_core/schema/buttplug-schema.json

@@ -670,6 +670,48 @@
             "minimum": 0
           }
         }
+      },
+      "StopDeviceCmd": {
+        "type": "object",
+        "description": "Stops the all actions currently being taken by a device.",
+        "properties": {
+          "Id": {
+            "$ref": "#/components/ClientId"
+          },
+          "DeviceIndex": {
+            "$ref": "#/components/DeviceIndex"
+          },
+          "Inputs": {
+            "type": "boolean"
+          },
+          "Outputs": {
+            "type": "boolean"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "Id",
+          "DeviceIndex"
+        ]
+      },
+      "StopAllDevices": {
+        "type": "object",
+        "description": "Stops all actions currently being taken by all connected devices.",
+        "properties": {
+          "Id": {
+            "$ref": "#/components/ClientId"
+          },
+          "Inputs": {
+            "type": "boolean"
+          },
+          "Outputs": {
+            "type": "boolean"
+          }
+        },
+        "additionalProperties": false,
+        "required": [
+          "Id"
+        ]
       }
     },
     "SpecV3Messages": {
@@ -1997,10 +2039,10 @@
             "$ref": "#/messages/SpecV0Messages/StartScanning"
           },
           "StopAllDevices": {
-            "$ref": "#/messages/SpecV0Messages/StopAllDevices"
+            "$ref": "#/messages/SpecV4Messages/StopAllDevices"
           },
           "StopDeviceCmd": {
-            "$ref": "#/messages/SpecV0Messages/StopDeviceCmd"
+            "$ref": "#/messages/SpecV4Messages/StopDeviceCmd"
           },
           "StopScanning": {
             "$ref": "#/messages/SpecV0Messages/StopScanning"

crates/buttplug_core/src/message/device_feature.rs

@@ -52,6 +52,10 @@ pub enum InputType {
   Button,
   #[serde(alias = "pressure")]
   Pressure,
+  #[serde(alias = "depth")]
+  Depth,
+  #[serde(alias = "position")]
+  Position,
   // Temperature,
   // Accelerometer,
   // Gyro,
@@ -305,6 +309,10 @@ pub struct DeviceFeatureInput {
   pressure: Option<DeviceFeatureInputProperties>,
   #[serde(skip_serializing_if = "Option::is_none")]
   button: Option<DeviceFeatureInputProperties>,
+  #[serde(skip_serializing_if = "Option::is_none")]
+  depth: Option<DeviceFeatureInputProperties>,
+  #[serde(skip_serializing_if = "Option::is_none")]
+  position: Option<DeviceFeatureInputProperties>,
 }
 
 impl DeviceFeatureInput {
@@ -314,6 +322,8 @@ impl DeviceFeatureInput {
       InputType::Rssi => self.rssi.is_some(),
       InputType::Pressure => self.pressure.is_some(),
       InputType::Button => self.button.is_some(),
+      InputType::Depth => self.depth.is_some(),
+      InputType::Position => self.position.is_some(),
       InputType::Unknown => false,
     }
   }
@@ -324,6 +334,8 @@ impl DeviceFeatureInput {
       InputType::Rssi => self.rssi(),
       InputType::Pressure => self.pressure(),
       InputType::Button => self.button(),
+      InputType::Depth => self.depth(),
+      InputType::Position => self.position(),
       InputType::Unknown => &None,
     }
   }

crates/buttplug_core/src/message/serializer/json_serializer.rs

@@ -8,7 +8,6 @@
 use super::ButtplugSerializerError;
 use crate::{errors::{ButtplugError, ButtplugMessageError}, message::{ButtplugMessage, ButtplugMessageFinalizer, ErrorV0}};
 use jsonschema::Validator;
-use log::info;
 use serde::{Deserialize, Serialize};
 use serde_json::{Deserializer, Value};
 use std::fmt::{Debug, Display};
@@ -34,7 +33,6 @@ pub fn vec_to_protocol_json<T>(validator: &Validator, msg: &[T]) -> Result<Strin
 where
   T: ButtplugMessage + Serialize + Deserialize<'static> + Debug,
 {
-  info!("Serializing {:?}", msg);
   let return_error_msg = |e: &dyn Display| {
     let err = ButtplugMessageError::MessageSerializationError(ButtplugSerializerError::JsonSerializerError(e.to_string()));
     // Just return the error message. For the server, we'll need to wrap it. For the client, we'll just die.

crates/buttplug_core/src/message/v0/mod.rs

@@ -5,8 +5,6 @@ mod ping;
 mod request_device_list;
 mod scanning_finished;
 mod start_scanning;
-mod stop_all_devices;
-mod stop_device_cmd;
 mod stop_scanning;
 
 pub use device_removed::DeviceRemovedV0;
@@ -16,6 +14,4 @@ pub use ping::PingV0;
 pub use request_device_list::RequestDeviceListV0;
 pub use scanning_finished::ScanningFinishedV0;
 pub use start_scanning::StartScanningV0;
-pub use stop_all_devices::StopAllDevicesV0;
-pub use stop_device_cmd::StopDeviceCmdV0;
 pub use stop_scanning::StopScanningV0;

crates/buttplug_core/src/message/v4/mod.rs

@@ -13,6 +13,8 @@ mod output_cmd;
 mod request_server_info;
 mod server_info;
 mod spec_enums;
+mod stop_all_devices;
+mod stop_device_cmd;
 
 pub use {
   device_list::DeviceListV4,
@@ -23,4 +25,6 @@ pub use {
   request_server_info::RequestServerInfoV4,
   server_info::ServerInfoV4,
   spec_enums::{ButtplugClientMessageV4, ButtplugDeviceMessageNameV4, ButtplugServerMessageV4},
+  stop_all_devices::StopAllDevicesV4,
+  stop_device_cmd::StopDeviceCmdV4
 };

crates/buttplug_core/src/message/v4/spec_enums.rs

@@ -19,8 +19,8 @@ use crate::message::{
   ScanningFinishedV0,
   ServerInfoV4,
   StartScanningV0,
-  StopAllDevicesV0,
-  StopDeviceCmdV0,
+  StopAllDevicesV4,
+  StopDeviceCmdV4,
   StopScanningV0,
   v4::input_cmd::InputCmdV4,
 };
@@ -49,8 +49,8 @@ pub enum ButtplugClientMessageV4 {
   StopScanning(StopScanningV0),
   RequestDeviceList(RequestDeviceListV0),
   // Generic commands
-  StopDeviceCmd(StopDeviceCmdV0),
-  StopAllDevices(StopAllDevicesV0),
+  StopDeviceCmd(StopDeviceCmdV4),
+  StopAllDevices(StopAllDevicesV4),
   OutputCmd(OutputCmdV4),
   InputCmd(InputCmdV4),
 }

crates/buttplug_core/src/message/v4/stop_all_devices.rs

@@ -0,0 +1,43 @@
+// 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::message::{
+  ButtplugMessage,
+  ButtplugMessageError,
+  ButtplugMessageFinalizer,
+  ButtplugMessageValidator,
+};
+use serde::{Deserialize, Serialize};
+use getset::CopyGetters;
+
+fn mk_true() -> bool { true }
+
+#[derive(
+  Debug, ButtplugMessage, ButtplugMessageFinalizer, PartialEq, Eq, Clone, Serialize, Deserialize, CopyGetters
+)]
+#[serde(rename_all = "PascalCase")]
+pub struct StopAllDevicesV4 {
+  id: u32,
+  #[serde(default = "mk_true")]
+  #[getset(get_copy = "pub")]
+  inputs: bool,
+  #[serde(default = "mk_true")]
+  #[getset(get_copy = "pub")]
+  outputs: bool,
+}
+
+impl Default for StopAllDevicesV4 {
+  fn default() -> Self {
+    Self { id: 1, inputs: true, outputs: true }
+  }
+}
+
+impl ButtplugMessageValidator for StopAllDevicesV4 {
+  fn is_valid(&self) -> Result<(), ButtplugMessageError> {
+    self.is_not_system_id(self.id)
+  }
+}

crates/buttplug_core/src/message/v4/stop_device_cmd.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::message::{
+  ButtplugDeviceMessage,
+  ButtplugMessage,
+  ButtplugMessageError,
+  ButtplugMessageFinalizer,
+  ButtplugMessageValidator,
+};
+use getset::CopyGetters;
+use serde::{Deserialize, Serialize};
+
+fn mk_true() -> bool { true }
+
+#[derive(
+  Debug,
+  ButtplugDeviceMessage,
+  ButtplugMessageFinalizer,
+  PartialEq,
+  Eq,
+  Clone,
+  Serialize,
+  Deserialize,
+  CopyGetters
+)]
+#[serde(rename_all = "PascalCase")]
+pub struct StopDeviceCmdV4 {
+  id: u32,
+  device_index: u32,
+  #[serde(default = "mk_true")]
+  #[getset(get_copy = "pub")]
+  inputs: bool,
+  #[getset(get_copy = "pub")]
+  #[serde(default = "mk_true")]
+  outputs: bool,
+}
+
+impl StopDeviceCmdV4 {
+  pub fn new(device_index: u32, inputs: bool, outputs: bool) -> Self {
+    Self {
+      id: 1,
+      device_index,
+      inputs,
+      outputs
+    }
+  }
+}
+
+impl ButtplugMessageValidator for StopDeviceCmdV4 {
+  fn is_valid(&self) -> Result<(), ButtplugMessageError> {
+    self.is_not_system_id(self.id)
+  }
+}