feat: Add F-Machine protocol for Gigolo BT-R

.github/workflows/main.yml

@@ -49,6 +49,7 @@ jobs:
       continue-on-error: true
       uses: actions-rs/cargo@v1
       with:
+        toolchain: nightly
         command: fmt
         args: --all -- --check
     - name: Build Debug

crates/buttplug_client/src/device/device.rs

@@ -10,15 +10,8 @@
 use crate::ButtplugClientError;
 use crate::device::ClientDeviceOutputCommand;
 
-use crate::{
-  ButtplugClientMessageSender,
-  ButtplugClientResultFuture,
-  device::ClientDeviceFeature,
-};
-use buttplug_core::message::{
-  InputType,
-  InputTypeReading,
-};
+use crate::{ButtplugClientMessageSender, ButtplugClientResultFuture, device::ClientDeviceFeature};
+use buttplug_core::message::{InputType, InputTypeReading};
 use buttplug_core::{
   errors::ButtplugDeviceError,
   message::{ButtplugServerMessageV4, DeviceFeature, DeviceMessageInfoV4, OutputType, StopCmdV4},
@@ -249,7 +242,10 @@ impl ButtplugClientDevice {
     }
   }
 
-  pub fn run_input_read(&self, input_type: InputType) -> ButtplugClientResultFuture<InputTypeReading> {
+  pub fn run_input_read(
+    &self,
+    input_type: InputType,
+  ) -> ButtplugClientResultFuture<InputTypeReading> {
     match self.input_feature(input_type) {
       Ok(dev) => dev.run_input_read(input_type).boxed(),
       Err(e) => future::ready(Err(e)).boxed(),

crates/buttplug_client/src/device/feature.rs

@@ -96,7 +96,10 @@ impl ClientDeviceFeature {
   ) -> Result<i32, ButtplugClientError> {
     if !(-1.0f64..=1.0f64).contains(&float_amt) {
       Err(ButtplugClientError::ButtplugOutputCommandConversionError(
-        format!("Float values must be between 0.0 and 1.0, received value was {}", float_amt),
+        format!(
+          "Float values must be between 0.0 and 1.0, received value was {}",
+          float_amt
+        ),
       ))
     } else {
       let mut val = float_amt * feature_output.step_count() as f64;
@@ -158,9 +161,12 @@ impl ClientDeviceFeature {
       ClientDeviceOutputCommand::Position(v) => {
         OutputCommand::Position(OutputValue::new(self.check_step_value(output, v)?))
       }
-      ClientDeviceOutputCommand::HwPositionWithDuration(v, d) => OutputCommand::HwPositionWithDuration(
-        OutputHwPositionWithDuration::new(self.check_step_value(output, v)? as u32, *d),
-      ),
+      ClientDeviceOutputCommand::HwPositionWithDuration(v, d) => {
+        OutputCommand::HwPositionWithDuration(OutputHwPositionWithDuration::new(
+          self.check_step_value(output, v)? as u32,
+          *d,
+        ))
+      }
     };
     Ok(OutputCmdV4::new(
       self.device_index,
@@ -219,7 +225,10 @@ impl ClientDeviceFeature {
     )
   }
 
-  pub fn run_input_read(&self, sensor_type: InputType) -> ButtplugClientResultFuture<InputTypeReading> {
+  pub fn run_input_read(
+    &self,
+    sensor_type: InputType,
+  ) -> ButtplugClientResultFuture<InputTypeReading> {
     if let Some(sensor_map) = self.feature.input()
       && let Some(sensor) = sensor_map.get(sensor_type)
       && sensor.command().contains(&InputCommandType::Read)

crates/buttplug_client/src/lib.rs

@@ -20,7 +20,17 @@ use buttplug_core::{
   connector::{ButtplugConnector, ButtplugConnectorError},
   errors::{ButtplugError, ButtplugHandshakeError},
   message::{
-    BUTTPLUG_CURRENT_API_MAJOR_VERSION, BUTTPLUG_CURRENT_API_MINOR_VERSION, ButtplugClientMessageV4, ButtplugServerMessageV4, InputType, PingV0, RequestDeviceListV0, RequestServerInfoV4, StartScanningV0, StopCmdV4, StopScanningV0
+    BUTTPLUG_CURRENT_API_MAJOR_VERSION,
+    BUTTPLUG_CURRENT_API_MINOR_VERSION,
+    ButtplugClientMessageV4,
+    ButtplugServerMessageV4,
+    InputType,
+    PingV0,
+    RequestDeviceListV0,
+    RequestServerInfoV4,
+    StartScanningV0,
+    StopCmdV4,
+    StopScanningV0,
   },
   util::{async_manager, stream::convert_broadcast_receiver_to_stream},
 };
@@ -103,7 +113,7 @@ pub enum ButtplugClientError {
   /// Error converting output command: {}
   ButtplugOutputCommandConversionError(String),
   /// Multiple inputs available for {}, must use specific feature
-  ButtplugMultipleInputAvailableError(InputType)
+  ButtplugMultipleInputAvailableError(InputType),
 }
 
 /// Enum representing different events that can be emitted by a client.
@@ -286,14 +296,11 @@ impl ButtplugClient {
 
     // Take the request receiver - if None, a previous connection consumed it and we can't reconnect
     // without creating a new client (the sender is tied to this receiver)
-    let request_receiver = self
-      .request_receiver
-      .lock()
-      .await
-      .take()
-      .ok_or(ButtplugConnectorError::ConnectorGenericError(
+    let request_receiver = self.request_receiver.lock().await.take().ok_or(
+      ButtplugConnectorError::ConnectorGenericError(
         "Cannot reconnect - request channel already consumed. Create a new client.".to_string(),
-      ))?;
+      ),
+    )?;
 
     info!("Connecting to server.");
     let (connector_sender, connector_receiver) = mpsc::channel(256);

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

@@ -22,8 +22,8 @@ pub fn create_message_validator() -> Validator {
   // SAFETY: MESSAGE_JSON_SCHEMA is embedded at compile time via include_str!() and validated by
   // build.rs before compilation. These expects can only fail if there's a build/packaging error,
   // not at runtime.
-  let schema: serde_json::Value =
-    serde_json::from_str(MESSAGE_JSON_SCHEMA).expect("schema must be valid JSON (validated by build.rs)");
+  let schema: serde_json::Value = serde_json::from_str(MESSAGE_JSON_SCHEMA)
+    .expect("schema must be valid JSON (validated by build.rs)");
   Validator::new(&schema).expect("schema must be valid JSON Schema (validated by build.rs)")
 }
 

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

@@ -5,11 +5,7 @@
 // Licensed under the BSD 3-Clause license. See LICENSE file in the project root
 // for full license information.
 
-use crate::message::{
-  ButtplugMessage,
-  ButtplugMessageError,
-  ButtplugMessageValidator,
-};
+use crate::message::{ButtplugMessage, ButtplugMessageError, ButtplugMessageValidator};
 use getset::CopyGetters;
 use serde::{Deserialize, Serialize};
 
@@ -36,7 +32,12 @@ pub struct StopCmdV4 {
 }
 
 impl StopCmdV4 {
-  pub fn new(device_index: Option<u32>, feature_index: Option<u32>, inputs: bool, outputs: bool) -> Self {
+  pub fn new(
+    device_index: Option<u32>,
+    feature_index: Option<u32>,
+    inputs: bool,
+    outputs: bool,
+  ) -> Self {
     Self {
       id: 1,
       device_index,
@@ -55,7 +56,7 @@ impl Default for StopCmdV4 {
       device_index: None,
       feature_index: None,
       inputs: true,
-      outputs: true
+      outputs: true,
     }
   }
 }

crates/buttplug_core/src/util/json.rs

@@ -28,8 +28,8 @@ impl JSONValidator {
     // These expects can only fail if there's a build/packaging error, not at runtime.
     let schema_json: serde_json::Value =
       serde_json::from_str(schema).expect("schema must be valid JSON (validated by build.rs)");
-    let schema =
-      Validator::new(&schema_json).expect("schema must be valid JSON Schema (validated by build.rs)");
+    let schema = Validator::new(&schema_json)
+      .expect("schema must be valid JSON Schema (validated by build.rs)");
     Self { schema }
   }
 

crates/buttplug_server/Cargo.toml

@@ -52,6 +52,7 @@ paste = "1.0.15"
 aes = { version = "0.8.4" }
 ecb = { version = "0.1.2", features = ["std"] }
 sha2 = { version = "0.10.9", features = ["std"] }
+md-5 = "0.10.6"
 byteorder = "1.5.0"
 # Used by several packages, but we need to bring in the JS feature for wasm. Pinned at 0.8 until
 # dependencies update

crates/buttplug_server/src/device/device_handle.rs

@@ -16,17 +16,30 @@ use buttplug_core::{
   ButtplugResultFuture,
   errors::{ButtplugDeviceError, ButtplugError},
   message::{
-    self, ButtplugMessage, ButtplugServerMessageV4, DeviceFeature, DeviceMessageInfoV4,
-    InputCommandType, InputType, OutputType, OutputValue, StopCmdV4,
+    self,
+    ButtplugMessage,
+    ButtplugServerMessageV4,
+    DeviceFeature,
+    DeviceMessageInfoV4,
+    InputCommandType,
+    InputType,
+    OutputType,
+    OutputValue,
+    StopCmdV4,
   },
   util::{async_manager, stream::convert_broadcast_receiver_to_stream},
 };
 use buttplug_server_device_config::{
-  DeviceConfigurationManager, ServerDeviceDefinition, UserDeviceIdentifier,
+  DeviceConfigurationManager,
+  ServerDeviceDefinition,
+  UserDeviceIdentifier,
 };
 use dashmap::DashMap;
 use futures::future::{self, BoxFuture, FutureExt};
-use tokio::sync::{mpsc::{channel, Sender}, oneshot};
+use tokio::sync::{
+  mpsc::{Sender, channel},
+  oneshot,
+};
 use tokio_stream::StreamExt;
 use uuid::Uuid;
 
@@ -43,7 +56,7 @@ use crate::{
 
 use super::{
   InternalDeviceEvent,
-  device_task::{spawn_device_task, DeviceTaskConfig},
+  device_task::{DeviceTaskConfig, spawn_device_task},
   hardware::{Hardware, HardwareCommand, HardwareConnector, HardwareEvent},
   protocol::{ProtocolHandler, ProtocolKeepaliveStrategy, ProtocolSpecializer},
 };
@@ -554,9 +567,7 @@ pub(super) async fn build_device_handle(
       strategy,
       ProtocolKeepaliveStrategy::RepeatLastPacketStrategyWithTiming(_)
     ))
-    && let Err(e) = device_handle
-      .stop(&StopCmdV4::default())
-      .await
+    && let Err(e) = device_handle.stop(&StopCmdV4::default()).await
   {
     return Err(ButtplugDeviceError::DeviceConnectionError(format!(
       "Error setting up keepalive: {e}"

crates/buttplug_server/src/device/device_task.rs

@@ -16,11 +16,7 @@ use std::{collections::VecDeque, sync::Arc, time::Duration};
 
 use buttplug_core::util::{self, async_manager};
 use futures::future;
-use tokio::{
-  select,
-  sync::mpsc::Receiver,
-  time::Instant,
-};
+use tokio::{select, sync::mpsc::Receiver, time::Instant};
 
 use super::{
   hardware::{Hardware, HardwareCommand, HardwareEvent, HardwareWriteCmd},

crates/buttplug_server/src/device/mod.rs

@@ -105,8 +105,8 @@ mod server_device_manager_event_loop;
 
 pub use device_handle::{DeviceCommand, DeviceEvent, DeviceHandle};
 
-use buttplug_server_device_config::UserDeviceIdentifier;
 use crate::message::ButtplugServerDeviceMessage;
+use buttplug_server_device_config::UserDeviceIdentifier;
 
 /// Internal event enum for device manager communication.
 /// Used by DeviceHandle to send events to the device manager event loop.