feat: Add support for Galaku Nebula

buttplug/buttplug-device-config/buttplug-device-config.json

···
           "name": "The Unicorn"
         }
       ]
+    },
+    "galaku-pump": {
+      "btle": {
+        "names": [
+          "V415"
+        ],
+        "services": {
+          "00001000-0000-1000-8000-00805f9b34fb": {
+            "tx": "00001001-0000-1000-8000-00805f9b34fb"
+          }
+        }
+      },
+      "defaults": {
+        "name": "Galaku Device",
+        "messages": {
+          "ScalarCmd": [
+            {
+              "StepRange": [
+                0,
+                100
+              ],
+              "ActuatorType": "Oscillate"
+            },
+            {
+              "StepRange": [
+                0,
+                100
+              ],
+              "ActuatorType": "Vibrate"
+            }
+          ]
+        }
+      },
+      "configurations": [
+        {
+          "identifier": [
+            "V415"
+          ],
+          "name": "Galaku Nebula"
+        }
+      ]
     }
   }
 }

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

···
       - identifier:
           - THE UNICORN
         name: The Unicorn
+  galaku-pump:
+    btle:
+      names:
+        - V415
+      services:
+        00001000-0000-1000-8000-00805f9b34fb:
+          tx: 00001001-0000-1000-8000-00805f9b34fb
+    defaults:
+      name: Galaku Device
+      messages:
+        ScalarCmd:
+          - StepRange: [0, 100]
+            ActuatorType: Oscillate
+          - StepRange: [0, 100]
+            ActuatorType: Vibrate
+    configurations:
+      - identifier:
+          - V415
+        name: Galaku Nebula
   # nintendo-joycon:
   #   hid:
   #     vendor-id: 0x057e

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

···
+// Buttplug Rust Source Code File - See https://buttplug.io for more info.
+//
+// Copyright 2016-2023 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::ProtocolSpecificError;
+use crate::core::message::ActuatorType;
+use crate::core::message::ActuatorType::{Oscillate, Vibrate};
+use crate::{
+  core::{errors::ButtplugDeviceError, message::Endpoint},
+  server::device::{
+    hardware::{HardwareCommand, HardwareWriteCmd},
+    protocol::{generic_protocol_setup, ProtocolHandler},
+  },
+};
+use std::num::Wrapping;
+
+static KEY_TAB: [[u8; 12]; 4] = [
+  [0, 24, 0x98, 0xf7, 0xa5, 61, 13, 41, 37, 80, 68, 70],
+  [0, 69, 110, 106, 111, 120, 32, 83, 45, 49, 46, 55],
+  [0, 101, 120, 32, 84, 111, 121, 115, 10, 0x8e, 0x9d, 0xa3],
+  [0, 0xc5, 0xd6, 0xe7, 0xf8, 10, 50, 32, 111, 98, 13, 10],
+];
+
+generic_protocol_setup!(GalakuPump, "galaku-pump");
+
+#[derive(Default)]
+pub struct GalakuPump {}
+
+impl ProtocolHandler for GalakuPump {
+  fn needs_full_command_set(&self) -> bool {
+    true
+  }
+
+  fn handle_scalar_cmd(
+    &self,
+    commands: &[Option<(ActuatorType, u32)>],
+  ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> {
+    if commands.len() != 2 {
+      return Err(ProtocolSpecificError(
+        "galaku-pump".to_owned(),
+        format!("Expected 2 attributes, got {}", commands.len()),
+      ));
+    }
+
+    let mut data: Vec<u8> = vec![
+      0x23,
+      0x5a,
+      0x00,
+      0x00,
+      0x01,
+      0x60,
+      0x03,
+      commands[0].unwrap_or((Oscillate, 0)).1 as u8,
+      commands[1].unwrap_or((Vibrate, 0)).1 as u8,
+      0x00,
+      0x00,
+    ];
+    data.push(data.iter().fold(0u8, |c, b| (Wrapping(c) + Wrapping(*b)).0));
+
+    let mut data2: Vec<u8> = vec![0x23];
+    for i in 1..data.len() {
+      let k = KEY_TAB[(data2[i - 1] & 3) as usize][i];
+      data2.push((Wrapping((k ^ 0x23) ^ data[i]) + Wrapping(k)).0);
+    }
+
+    Ok(vec![HardwareWriteCmd::new(Endpoint::Tx, data2, true).into()])
+  }
+}

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

···
 pub mod cachito;
 pub mod cowgirl;
 pub mod fredorch;
+pub mod galaku_pump;
 pub mod hgod;
 pub mod hismith;
 pub mod htk_bm;
···
   );
 
   add_to_protocol_map(&mut map, hgod::setup::HgodIdentifierFactory::default());
+
+  add_to_protocol_map(
+    &mut map,
+    galaku_pump::setup::GalakuPumpIdentifierFactory::default(),
+  );
 
   add_to_protocol_map(&mut map, jejoue::setup::JeJoueIdentifierFactory::default());
   add_to_protocol_map(

buttplug/tests/test_device_protocols.rs

···
 #[test_case("test_tryfun_protocol.yaml" ; "TryFun Protocol")]
 #[test_case("test_metaxsire_rex.yaml" ; "metaXsire Protocol - Rex")]
 #[test_case("test_cowgirl_protocol.yaml" ; "The Cowgirl Protocol")]
+#[test_case("test_galaku_nebula.yaml" ; "Galaku Pump Protocol - Nebula")]
 fn test_device_protocols_embedded_v3(test_file: &str) {
   //tracing_subscriber::fmt::init();
   async_manager::block_on(async {
···
 #[test_case("test_tryfun_protocol.yaml" ; "TryFun Protocol")]
 #[test_case("test_metaxsire_rex.yaml" ; "metaXsire Protocol - Rex")]
 #[test_case("test_cowgirl_protocol.yaml" ; "The Cowgirl Protocol")]
+#[test_case("test_galaku_nebula.yaml" ; "Galaku Pump Protocol - Nebula")]
 fn test_device_protocols_json_v3(test_file: &str) {
   //tracing_subscriber::fmt::init();
   async_manager::block_on(async {

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

···
+devices:
+  - identifier: 
+      name: "V415"
+    expected_name: "Galaku Nebula"
+device_commands:
+  - !Messages
+      device_index: 0
+      messages:
+        - !Vibrate
+          - Index: 0
+            Speed: 0.5
+  - !Commands
+      device_index: 0
+      commands:
+        - !Write
+            endpoint: tx
+            data: [0x23, 0x81, 0xBB, 0xAB, 0xD2, 0x9B, 0x44, 0x33, 0xED, 0x43, 0x3B, 0x44]
+            write_with_response: true
+  - !Messages
+      device_index: 0
+      messages:
+        - !Scalar
+          - Index: 0
+            Scalar: 0.75
+            ActuatorType: Oscillate
+          - Index: 1
+            Scalar: 0.5
+            ActuatorType: Vibrate
+  - !Commands
+      device_index: 0
+      commands:
+        - !Write
+            endpoint: tx
+            data: [0x23, 0x81, 0xBB, 0xAB, 0xD2, 0x9B, 0x44, 0x6A, 0x25, 0x43, 0x3B, 0x81]
+            write_with_response: true
+  - !Messages
+      device_index: 0
+      messages: 
+        - !Stop 
+  - !Commands
+      device_index: 0
+      commands: 
+        - !Write
+            endpoint: tx
+            data: [0x23, 0x81, 0xBB, 0xAB, 0xD2, 0x9B, 0x44, 0x33, 0xBB, 0xA3, 0x3B, 0xD2]
+            write_with_response: true