fix: Correct the protocol used for modern Hismith devices

This change is a bit of a cheat: legacy Hismith devices are hardcoded in the protocol and if the identifier doesn't match, the hismith-mini protocol is invoked instead.

Fixes #682

Author: blackspherefollower

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

@@ -9983,6 +9983,39 @@
             }
           ]
         },
+        {
+          "identifier": [
+            "1006"
+          ],
+          "name": "Hismith G011",
+          "features": [
+            {
+              "feature-type": "Oscillate",
+              "description": "Stroker Oscillation Speed",
+              "actuator": {
+                "step-range": [
+                  0,
+                  100
+                ],
+                "messages": [
+                  "ScalarCmd"
+                ]
+              }
+            },
+            {
+              "feature-type": "Vibrate",
+              "actuator": {
+                "step-range": [
+                  0,
+                  1
+                ],
+                "messages": [
+                  "ScalarCmd"
+                ]
+              }
+            }
+          ]
+        },
         {
           "identifier": [
             "3001"
@@ -10052,10 +10085,35 @@
         },
         {
           "identifier": [
-            "1005"
+            "1005",
+            "1102"
           ],
           "name": "Hismith Sex Machine"
         },
+        {
+          "identifier": [
+            "1004"
+          ],
+          "name": "Hismith Mini Sex Machine"
+        },
+        {
+          "identifier": [
+            "1101"
+          ],
+          "name": "Hismith Servo Sex Machine"
+        },
+        {
+          "identifier": [
+            "1402"
+          ],
+          "name": "Hismith Ukulele"
+        },
+        {
+          "identifier": [
+            "1501"
+          ],
+          "name": "Hismith PleasureDrive"
+        },
         {
           "identifier": [
             "2201"
@@ -10259,6 +10317,12 @@
               }
             }
           ]
+        },
+        {
+          "identifier": [
+            "2205"
+          ],
+          "name": "Sinloli Aston"
         }
       ],
       "communication": [
@@ -10270,53 +10334,11 @@
               "Sinloli-Sherry",
               "Eropair *",
               "HISMITH S1",
+              "HISMITH S2",
+              "HISMITH S3",
               "Sinloli Cosima",
-              "Sinloli-Ethel"
-            ],
-            "services": {
-              "0000ffe5-0000-1000-8000-00805f9b34fb": {
-                "tx": "0000ffe9-0000-1000-8000-00805f9b34fb"
-              },
-              "0000ff90-0000-1000-8000-00805f9b34fb": {
-                "rxblemodel": "0000ff96-0000-1000-8000-00805f9b34fb"
-              }
-            }
-          }
-        }
-      ]
-    },
-    "hismith-servo": {
-      "defaults": {
-        "name": "Hismith servo device",
-        "features": [
-          {
-            "feature-type": "Position",
-            "description": "Fucking Machine Position",
-            "actuator": {
-              "step-range": [
-                0,
-                100
-              ],
-              "messages": [
-                "LinearCmd"
-              ]
-            }
-          }
-        ]
-      },
-      "configurations": [
-        {
-          "identifier": [
-            "1101"
-          ],
-          "name": "Hismith Servo"
-        }
-      ],
-      "communication": [
-        {
-          "btle": {
-            "names": [
-              "HISMITH S2"
+              "Sinloli-Ethel",
+              "Sinloli Aston"
             ],
             "services": {
               "0000ffe5-0000-1000-8000-00805f9b34fb": {

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

@@ -5686,6 +5686,25 @@ protocols:
                 - 1
               messages:
                 - ScalarCmd
+      - identifier:
+          - '1006'
+        name: Hismith G011
+        features:
+          - feature-type: Oscillate
+            description: Stroker Oscillation Speed
+            actuator:
+              step-range:
+                - 0
+                - 100
+              messages:
+                - ScalarCmd
+          - feature-type: Vibrate
+            actuator:
+              step-range:
+                - 0
+                - 1
+              messages:
+                - ScalarCmd
       - identifier:
           - '3001'
         name: Wildolo Device
@@ -5726,7 +5745,20 @@ protocols:
         name: Auxfun Sex Machine
       - identifier:
           - '1005'
+          - '1102'
         name: Hismith Sex Machine
+      - identifier:
+          - '1004'
+        name: Hismith Mini Sex Machine
+      - identifier:
+          - '1101'
+        name: Hismith Servo Sex Machine
+      - identifier:
+          - '1402'
+        name: Hismith Ukulele
+      - identifier:
+          - '1501'
+        name: Hismith PleasureDrive
       - identifier:
           - '2201'
         name: Sinloli Automatic Sex Doll
@@ -5847,6 +5879,9 @@ protocols:
                 - 100
               messages:
                 - ScalarCmd
+      - identifier:
+          - '2205'
+        name: Sinloli Aston
     communication:
       - btle:
           names:
@@ -5855,33 +5890,11 @@ protocols:
             - Sinloli-Sherry
             - Eropair *
             - HISMITH S1
+            - HISMITH S2 # Servo
+            - HISMITH S3
             - Sinloli Cosima
             - Sinloli-Ethel
-          services:
-            0000ffe5-0000-1000-8000-00805f9b34fb:
-              tx: 0000ffe9-0000-1000-8000-00805f9b34fb
-            0000ff90-0000-1000-8000-00805f9b34fb:
-              rxblemodel: 0000ff96-0000-1000-8000-00805f9b34fb
-  hismith-servo:
-    defaults:
-      name: Hismith servo device
-      features:
-        - feature-type: Position
-          description: Fucking Machine Position
-          actuator:
-            step-range:
-              - 0
-              - 100
-            messages:
-              - LinearCmd
-    configurations:
-      - identifier:
-          - '1101'
-        name: Hismith Servo
-    communication:
-      - btle:
-          names:
-            - HISMITH S2
+            - Sinloli Aston
           services:
             0000ffe5-0000-1000-8000-00805f9b34fb:
               tx: 0000ffe9-0000-1000-8000-00805f9b34fb

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

@@ -16,6 +16,7 @@ use crate::{
 };
 use async_trait::async_trait;
 use std::sync::Arc;
+use crate::server::device::protocol::hismith_mini::HismithMiniInitializer;
 
 pub mod setup {
   use crate::server::device::protocol::{ProtocolIdentifier, ProtocolIdentifierFactory};
@@ -36,6 +37,8 @@ pub mod setup {
 #[derive(Default)]
 pub struct HismithIdentifier {}
 
+const LEGACY_HISMITHS: [&'static str; 6] = ["1001", "1002", "1003", "3001", "2001", "1006"];
+
 #[async_trait]
 impl ProtocolIdentifier for HismithIdentifier {
   async fn identify(
@@ -54,6 +57,14 @@ impl ProtocolIdentifier for HismithIdentifier {
       .collect::<String>();
     info!("Hismith Device Identifier: {}", identifier);
 
+    if !LEGACY_HISMITHS.contains(&identifier.as_str()) {
+      info!("Not a legacy Hismith, using hismith-mini protocol");
+      return Ok((
+        UserDeviceIdentifier::new(hardware.address(), "hismith-mini", &Some(identifier)),
+        Box::new(HismithMiniInitializer::default()),
+      ));
+    }
+
     Ok((
       UserDeviceIdentifier::new(hardware.address(), "hismith", &Some(identifier)),
       Box::new(HismithInitializer::default()),

buttplug/tests/test_device_protocols.rs

@@ -24,6 +24,7 @@ async fn load_test_case(test_file: &str) -> DeviceTestCase {
 #[test_case("test_cachito_protocol.yaml" ; "Cachito Protocol")]
 #[test_case("test_fredorch_protocol.yaml" ; "Fredorch Protocol")]
 #[test_case("test_hismith_auxfun_box.yaml" ; "Hismith Mini Protocol - Auxfun Box")]
+#[test_case("test_hismith_v4.yaml" ; "Hismith Mini Protocol - Hismith v4")]
 #[test_case("test_hismith_sinloli.yaml" ; "Hismith Mini Protocol - Sinloli")]
 #[test_case("test_hismith_thrusting_cup.yaml" ; "Hismith Protocol - Thrusting Cup")]
 #[test_case("test_hismith_wildolo.yaml" ; "Hismith Protocol - Wildolo")]
@@ -129,6 +130,7 @@ async fn test_device_protocols_embedded_v3(test_file: &str) {
 #[test_case("test_cachito_protocol.yaml" ; "Cachito Protocol")]
 #[test_case("test_fredorch_protocol.yaml" ; "Fredorch Protocol")]
 #[test_case("test_hismith_auxfun_box.yaml" ; "Hismith Mini Protocol - Auxfun Box")]
+#[test_case("test_hismith_v4.yaml" ; "Hismith Mini Protocol - Hismith v4")]
 #[test_case("test_hismith_sinloli.yaml" ; "Hismith Mini Protocol - Sinloli")]
 #[test_case("test_hismith_thrusting_cup.yaml" ; "Hismith Protocol - Thrusting Cup")]
 #[test_case("test_hismith_wildolo.yaml" ; "Hismith Protocol - Wildolo")]

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

@@ -0,0 +1,52 @@
+devices:
+  - identifier: 
+      name: "HISMITH"
+    expected_name: "Hismith Sex Machine"
+device_init:
+  - !Events
+    device_index: 0
+    events:
+      - !Reads
+        - endpoint: rxblemodel
+          data: [0x10, 0x05]
+device_commands:
+  # Commands
+  - !Messages
+    device_index: 0
+    messages:
+      - !Scalar
+        - Index: 0
+          Scalar: 0.5
+          ActuatorType: Oscillate
+  - !Commands
+    device_index: 0
+    commands:
+      - !Write
+        endpoint: tx
+        data: [0xCC, 0x03, 0x32, 0x35]
+        write_with_response: false
+  - !Messages
+    device_index: 0
+    messages:
+      - !Scalar
+        - Index: 0
+          Scalar: 0.1
+          ActuatorType: Oscillate
+  - !Commands
+    device_index: 0
+    commands:
+      - !Write
+        endpoint: tx
+        data: [0xCC, 0x03, 0x0a, 0x0d]
+        write_with_response: false
+  - !Messages
+    device_index: 0
+    messages:
+      - !Stop
+  - !Commands
+    device_index: 0
+    commands:
+      - !Write
+        endpoint: tx
+        data: [0xCC, 0x03, 0x00, 0x03]
+        write_with_response: false