+524

crates/buttplug_server/src/device/protocol.rs

··· 1 1 + // Buttplug Rust Source Code File - See https://buttplug.io for more info. 2 2 + // 3 3 + // Copyright 2016-2024 Nonpolynomial Labs LLC. All rights reserved. 4 4 + // 5 5 + // Licensed under the BSD 3-Clause license. See LICENSE file in the project root 6 6 + // for full license information. 7 7 + 8 8 + //! Implementations of communication protocols for hardware supported by Buttplug 9 9 + 10 10 + use buttplug_core::{ 11 11 + errors::ButtplugDeviceError, 12 12 + message::{Endpoint, InputReadingV4, InputType, OutputCommand}, 13 13 + }; 14 14 + use buttplug_server_device_config::{ 15 15 + DeviceDefinition, 16 16 + ProtocolCommunicationSpecifier, 17 17 + UserDeviceIdentifier, 18 18 + }; 19 19 + 20 20 + use crate::{ 21 21 + device::hardware::{Hardware, HardwareCommand, HardwareReadCmd}, 22 22 + message::{ 23 23 + checked_output_cmd::CheckedOutputCmdV4, 24 24 + spec_enums::ButtplugDeviceCommandMessageUnionV4, 25 25 + ButtplugServerDeviceMessage, 26 26 + }, 27 27 + }; 28 28 + use async_trait::async_trait; 29 29 + use futures::{ 30 30 + future::{self, BoxFuture, FutureExt}, 31 31 + StreamExt, 32 32 + }; 33 33 + use std::sync::Arc; 34 34 + use std::{pin::Pin, time::Duration}; 35 35 + use uuid::Uuid; 36 36 + 37 37 + /// Strategy for situations where hardware needs to get updates every so often in order to keep 38 38 + /// things alive. Currently this applies to iOS backgrounding with bluetooth devices, as well as 39 39 + /// some protocols like Satisfyer and Mysteryvibe that need constant command refreshing, but since 40 40 + /// we never know which of our hundreds of supported devices someone might connect, we need context 41 41 + /// as to which keepalive strategy to use. 42 42 + /// 43 43 + /// When choosing a keepalive strategy for a protocol: 44 44 + /// 45 45 + /// - If the protocol has a command that essentially does nothing to the actuators, set up 46 46 + /// RepeatPacketStrategy to use that. This is useful for devices that have info commands (like 47 47 + /// Lovense), ping commands (like The Handy), sensor commands that aren't yet subscribed to output 48 48 + /// notifications, etc... 49 49 + /// - If a protocol needs specific timing or keepalives, regardless of the OS/hardware manager being 50 50 + /// used, like Satisfyer or Mysteryvibe, use RepeatLastPacketStrategyWithTiming. 51 51 + /// - For many devices with only scalar actuators, RepeatLastPacketStrategy should work. You just 52 52 + /// need to make sure the protocol doesn't have a packet counter or something else that will trip 53 53 + /// if the same packet is replayed multiple times. 54 54 + #[derive(Debug)] 55 55 + pub enum ProtocolKeepaliveStrategy { 56 56 + /// Repeat a specific packet, such as a ping or a no-op. Only do this when the hardware manager 57 57 + /// requires it (currently only iOS bluetooth during backgrounding). 58 58 + HardwareRequiredRepeatPacketStrategy(HardwareWriteCmd), 59 59 + /// Repeat whatever the last packet sent was, and send Stop commands until first packet sent. Uses 60 60 + /// a default timing, suitable for most protocols that don't need constant device updates outside 61 61 + /// of OS requirements. Only do this when the hardware manager requires it (currently only iOS 62 62 + /// bluetooth during backgrounding). 63 63 + HardwareRequiredRepeatLastPacketStrategy, 64 64 + /// Repeat whatever the last packet sent was, and send Stop commands until first packet sent. Do 65 65 + /// this regardless of whether or not the hardware manager requires it. Useful for hardware that 66 66 + /// requires keepalives, like Satisfyer, Mysteryvibe, Leten, etc... 67 67 + RepeatLastPacketStrategyWithTiming(Duration), 68 68 + } 69 69 + 70 70 + pub trait ProtocolIdentifierFactory: Send + Sync { 71 71 + fn identifier(&self) -> &str; 72 72 + fn create(&self) -> Box<dyn ProtocolIdentifier>; 73 73 + } 74 74 + 75 75 + pub enum ProtocolValueCommandPrefilterStrategy { 76 76 + /// Drop repeated ValueCmd/ValueWithParameterCmd messages 77 77 + DropRepeats, 78 78 + /// No filter, send all value messages for processing 79 79 + None, 80 80 + } 81 81 + 82 82 + fn print_type_of<T>(_: &T) -> &'static str { 83 83 + std::any::type_name::<T>() 84 84 + } 85 85 + 86 86 + pub struct ProtocolSpecializer { 87 87 + specifiers: Vec<ProtocolCommunicationSpecifier>, 88 88 + identifier: Box<dyn ProtocolIdentifier>, 89 89 + } 90 90 + 91 91 + impl ProtocolSpecializer { 92 92 + pub fn new( 93 93 + specifiers: Vec<ProtocolCommunicationSpecifier>, 94 94 + identifier: Box<dyn ProtocolIdentifier>, 95 95 + ) -> Self { 96 96 + Self { 97 97 + specifiers, 98 98 + identifier, 99 99 + } 100 100 + } 101 101 + 102 102 + pub fn specifiers(&self) -> &Vec<ProtocolCommunicationSpecifier> { 103 103 + &self.specifiers 104 104 + } 105 105 + 106 106 + pub fn identify(self) -> Box<dyn ProtocolIdentifier> { 107 107 + self.identifier 108 108 + } 109 109 + } 110 110 + 111 111 + #[async_trait] 112 112 + pub trait ProtocolIdentifier: Sync + Send { 113 113 + async fn identify( 114 114 + &mut self, 115 115 + hardware: Arc<Hardware>, 116 116 + specifier: ProtocolCommunicationSpecifier, 117 117 + ) -> Result<(UserDeviceIdentifier, Box<dyn ProtocolInitializer>), ButtplugDeviceError>; 118 118 + } 119 119 + 120 120 + #[async_trait] 121 121 + pub trait ProtocolInitializer: Sync + Send { 122 122 + async fn initialize( 123 123 + &mut self, 124 124 + hardware: Arc<Hardware>, 125 125 + device_definition: &DeviceDefinition, 126 126 + ) -> Result<Arc<dyn ProtocolHandler>, ButtplugDeviceError>; 127 127 + } 128 128 + 129 129 + pub struct GenericProtocolIdentifier { 130 130 + handler: Option<Arc<dyn ProtocolHandler>>, 131 131 + protocol_identifier: String, 132 132 + } 133 133 + 134 134 + impl GenericProtocolIdentifier { 135 135 + pub fn new(handler: Arc<dyn ProtocolHandler>, protocol_identifier: &str) -> Self { 136 136 + Self { 137 137 + handler: Some(handler), 138 138 + protocol_identifier: protocol_identifier.to_owned(), 139 139 + } 140 140 + } 141 141 + } 142 142 + 143 143 + #[async_trait] 144 144 + impl ProtocolIdentifier for GenericProtocolIdentifier { 145 145 + async fn identify( 146 146 + &mut self, 147 147 + hardware: Arc<Hardware>, 148 148 + _: ProtocolCommunicationSpecifier, 149 149 + ) -> Result<(UserDeviceIdentifier, Box<dyn ProtocolInitializer>), ButtplugDeviceError> { 150 150 + let device_identifier = UserDeviceIdentifier::new( 151 151 + hardware.address(), 152 152 + &self.protocol_identifier, 153 153 + &Some(hardware.name().to_owned()), 154 154 + ); 155 155 + Ok(( 156 156 + device_identifier, 157 157 + Box::new(GenericProtocolInitializer::new( 158 158 + self.handler.take().unwrap(), 159 159 + )), 160 160 + )) 161 161 + } 162 162 + } 163 163 + 164 164 + pub struct GenericProtocolInitializer { 165 165 + handler: Option<Arc<dyn ProtocolHandler>>, 166 166 + } 167 167 + 168 168 + impl GenericProtocolInitializer { 169 169 + pub fn new(handler: Arc<dyn ProtocolHandler>) -> Self { 170 170 + Self { 171 171 + handler: Some(handler), 172 172 + } 173 173 + } 174 174 + } 175 175 + 176 176 + #[async_trait] 177 177 + impl ProtocolInitializer for GenericProtocolInitializer { 178 178 + async fn initialize( 179 179 + &mut self, 180 180 + _: Arc<Hardware>, 181 181 + _: &DeviceDefinition, 182 182 + ) -> Result<Arc<dyn ProtocolHandler>, ButtplugDeviceError> { 183 183 + Ok(self.handler.take().unwrap()) 184 184 + } 185 185 + } 186 186 + 187 187 + pub trait ProtocolHandler: Sync + Send { 188 188 + fn keepalive_strategy(&self) -> ProtocolKeepaliveStrategy { 189 189 + ProtocolKeepaliveStrategy::HardwareRequiredRepeatLastPacketStrategy 190 190 + } 191 191 + 192 192 + fn handle_message( 193 193 + &self, 194 194 + message: &ButtplugDeviceCommandMessageUnionV4, 195 195 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 196 196 + self.command_unimplemented(print_type_of(&message)) 197 197 + } 198 198 + 199 199 + // Allow here since this changes between debug/release 200 200 + #[allow(unused_variables)] 201 201 + fn command_unimplemented( 202 202 + &self, 203 203 + command: &str, 204 204 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 205 205 + #[cfg(debug_assertions)] 206 206 + unimplemented!("Command not implemented for this protocol"); 207 207 + #[cfg(not(debug_assertions))] 208 208 + Err(ButtplugDeviceError::UnhandledCommand(format!( 209 209 + "Command not implemented for this protocol: {}", 210 210 + command 211 211 + ))) 212 212 + } 213 213 + 214 214 + // The default scalar handler assumes that most devices require discrete commands per feature. If 215 215 + // a protocol has commands that combine multiple features, either with matched or unmatched 216 216 + // actuators, they should just implement their own version of this method. 217 217 + fn handle_output_cmd( 218 218 + &self, 219 219 + cmd: &CheckedOutputCmdV4, 220 220 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 221 221 + let output_command = cmd.output_command(); 222 222 + match output_command { 223 223 + OutputCommand::Constrict(x) => { 224 224 + self.handle_output_constrict_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 225 225 + } 226 226 + OutputCommand::Inflate(x) => { 227 227 + self.handle_output_inflate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 228 228 + } 229 229 + OutputCommand::Oscillate(x) => { 230 230 + self.handle_output_oscillate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 231 231 + } 232 232 + OutputCommand::Rotate(x) => { 233 233 + self.handle_output_rotate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 234 234 + } 235 235 + OutputCommand::Vibrate(x) => { 236 236 + self.handle_output_vibrate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 237 237 + } 238 238 + OutputCommand::Position(x) => { 239 239 + self.handle_output_position_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 240 240 + } 241 241 + OutputCommand::Heater(x) => { 242 242 + self.handle_output_heater_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 243 243 + } 244 244 + OutputCommand::Led(x) => { 245 245 + self.handle_output_led_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 246 246 + } 247 247 + OutputCommand::PositionWithDuration(x) => self.handle_position_with_duration_cmd( 248 248 + cmd.feature_index(), 249 249 + cmd.feature_id(), 250 250 + x.position(), 251 251 + x.duration(), 252 252 + ), 253 253 + OutputCommand::RotateWithDirection(x) => self.handle_rotation_with_direction_cmd( 254 254 + cmd.feature_index(), 255 255 + cmd.feature_id(), 256 256 + x.speed(), 257 257 + x.clockwise(), 258 258 + ), 259 259 + } 260 260 + } 261 261 + 262 262 + fn handle_output_vibrate_cmd( 263 263 + &self, 264 264 + _feature_index: u32, 265 265 + _feature_id: Uuid, 266 266 + _speed: u32, 267 267 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 268 268 + self.command_unimplemented("OutputCmd (Vibrate Actuator)") 269 269 + } 270 270 + 271 271 + fn handle_output_rotate_cmd( 272 272 + &self, 273 273 + _feature_index: u32, 274 274 + _feature_id: Uuid, 275 275 + _speed: u32, 276 276 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 277 277 + self.command_unimplemented("OutputCmd (Rotate Actuator)") 278 278 + } 279 279 + 280 280 + fn handle_output_oscillate_cmd( 281 281 + &self, 282 282 + _feature_index: u32, 283 283 + _feature_id: Uuid, 284 284 + _speed: u32, 285 285 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 286 286 + self.command_unimplemented("OutputCmd (Oscillate Actuator)") 287 287 + } 288 288 + 289 289 + fn handle_output_inflate_cmd( 290 290 + &self, 291 291 + _feature_index: u32, 292 292 + _feature_id: Uuid, 293 293 + _level: u32, 294 294 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 295 295 + self.command_unimplemented("OutputCmd (Inflate Actuator)") 296 296 + } 297 297 + 298 298 + fn handle_output_constrict_cmd( 299 299 + &self, 300 300 + _feature_index: u32, 301 301 + _feature_id: Uuid, 302 302 + _level: u32, 303 303 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 304 304 + self.command_unimplemented("OutputCmd (Constrict Actuator)") 305 305 + } 306 306 + 307 307 + fn handle_output_heater_cmd( 308 308 + &self, 309 309 + _feature_index: u32, 310 310 + _feature_id: Uuid, 311 311 + _level: u32, 312 312 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 313 313 + self.command_unimplemented("OutputCmd (Heater Actuator)") 314 314 + } 315 315 + 316 316 + fn handle_output_led_cmd( 317 317 + &self, 318 318 + _feature_index: u32, 319 319 + _feature_id: Uuid, 320 320 + _level: u32, 321 321 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 322 322 + self.command_unimplemented("OutputCmd (Led Actuator)") 323 323 + } 324 324 + 325 325 + fn handle_output_position_cmd( 326 326 + &self, 327 327 + _feature_index: u32, 328 328 + _feature_id: Uuid, 329 329 + _position: u32, 330 330 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 331 331 + self.command_unimplemented("OutputCmd (Position Actuator)") 332 332 + } 333 333 + 334 334 + fn handle_position_with_duration_cmd( 335 335 + &self, 336 336 + _feature_index: u32, 337 337 + _feature_id: Uuid, 338 338 + _position: u32, 339 339 + _duration: u32, 340 340 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 341 341 + self.command_unimplemented("OutputCmd (Position w/ Duration Actuator)") 342 342 + } 343 343 + 344 344 + fn handle_rotation_with_direction_cmd( 345 345 + &self, 346 346 + _feature_index: u32, 347 347 + _feature_id: Uuid, 348 348 + _speed: u32, 349 349 + _clockwise: bool, 350 350 + ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 351 351 + self.command_unimplemented("OutputCmd (Rotation w/ Direction Actuator)") 352 352 + } 353 353 + 354 354 + fn handle_input_subscribe_cmd( 355 355 + &self, 356 356 + _device_index: u32, 357 357 + _device: Arc<Hardware>, 358 358 + _feature_index: u32, 359 359 + _feature_id: Uuid, 360 360 + _sensor_type: InputType, 361 361 + ) -> BoxFuture<Result<(), ButtplugDeviceError>> { 362 362 + future::ready(Err(ButtplugDeviceError::UnhandledCommand( 363 363 + "Command not implemented for this protocol: InputCmd (Subscribe)".to_string(), 364 364 + ))) 365 365 + .boxed() 366 366 + } 367 367 + 368 368 + fn handle_input_unsubscribe_cmd( 369 369 + &self, 370 370 + _device: Arc<Hardware>, 371 371 + _feature_index: u32, 372 372 + _feature_id: Uuid, 373 373 + _sensor_type: InputType, 374 374 + ) -> BoxFuture<Result<(), ButtplugDeviceError>> { 375 375 + future::ready(Err(ButtplugDeviceError::UnhandledCommand( 376 376 + "Command not implemented for this protocol: InputCmd (Unsubscribe)".to_string(), 377 377 + ))) 378 378 + .boxed() 379 379 + } 380 380 + 381 381 + fn handle_input_read_cmd( 382 382 + &self, 383 383 + device_index: u32, 384 384 + device: Arc<Hardware>, 385 385 + feature_index: u32, 386 386 + feature_id: Uuid, 387 387 + sensor_type: InputType, 388 388 + ) -> BoxFuture<Result<InputReadingV4, ButtplugDeviceError>> { 389 389 + match sensor_type { 390 390 + InputType::Battery => { 391 391 + self.handle_battery_level_cmd(device_index, device, feature_index, feature_id) 392 392 + } 393 393 + _ => future::ready(Err(ButtplugDeviceError::UnhandledCommand( 394 394 + "Command not implemented for this protocol: InputCmd (Read)".to_string(), 395 395 + ))) 396 396 + .boxed(), 397 397 + } 398 398 + } 399 399 + 400 400 + // Handle Battery Level returns a SensorReading, as we'll always need to do a sensor index 401 401 + // conversion on it. 402 402 + fn handle_battery_level_cmd( 403 403 + &self, 404 404 + device_index: u32, 405 405 + device: Arc<Hardware>, 406 406 + feature_index: u32, 407 407 + feature_id: Uuid, 408 408 + ) -> BoxFuture<Result<InputReadingV4, ButtplugDeviceError>> { 409 409 + // If we have a standardized BLE Battery endpoint, handle that above the 410 410 + // protocol, as it'll always be the same. 411 411 + if device.endpoints().contains(&Endpoint::RxBLEBattery) { 412 412 + debug!("Trying to get battery reading."); 413 413 + let msg = HardwareReadCmd::new(feature_id, Endpoint::RxBLEBattery, 1, 0); 414 414 + let fut = device.read_value(&msg); 415 415 + async move { 416 416 + let hw_msg = fut.await?; 417 417 + let battery_level = hw_msg.data()[0] as i32; 418 418 + let battery_reading = InputReadingV4::new( 419 419 + device_index, 420 420 + feature_index, 421 421 + InputType::Battery, 422 422 + vec![battery_level], 423 423 + ); 424 424 + debug!("Got battery reading: {}", battery_level); 425 425 + Ok(battery_reading) 426 426 + } 427 427 + .boxed() 428 428 + } else { 429 429 + future::ready(Err(ButtplugDeviceError::UnhandledCommand( 430 430 + "Command not implemented for this protocol: SensorReadCmd".to_string(), 431 431 + ))) 432 432 + .boxed() 433 433 + } 434 434 + } 435 435 + 436 436 + fn handle_rssi_level_cmd( 437 437 + &self, 438 438 + _device: Arc<Hardware>, 439 439 + _feature_index: u32, 440 440 + _feature_id: Uuid, 441 441 + ) -> BoxFuture<Result<(), ButtplugDeviceError>> { 442 442 + future::ready(Err(ButtplugDeviceError::UnhandledCommand( 443 443 + "Command not implemented for this protocol: SensorReadCmd".to_string(), 444 444 + ))) 445 445 + .boxed() 446 446 + } 447 447 + 448 448 + fn event_stream( 449 449 + &self, 450 450 + ) -> Pin<Box<dyn tokio_stream::Stream<Item = ButtplugServerDeviceMessage> + Send>> { 451 451 + tokio_stream::empty().boxed() 452 452 + } 453 453 + } 454 454 + 455 455 + #[macro_export] 456 456 + macro_rules! generic_protocol_setup { 457 457 + ( $protocol_name:ident, $protocol_identifier:tt) => { 458 458 + paste::paste! { 459 459 + pub mod setup { 460 460 + use std::sync::Arc; 461 461 + use $crate::device::protocol::{ 462 462 + GenericProtocolIdentifier, ProtocolIdentifier, ProtocolIdentifierFactory, 463 463 + }; 464 464 + #[derive(Default)] 465 465 + pub struct [< $protocol_name IdentifierFactory >] {} 466 466 + 467 467 + impl ProtocolIdentifierFactory for [< $protocol_name IdentifierFactory >] { 468 468 + fn identifier(&self) -> &str { 469 469 + $protocol_identifier 470 470 + } 471 471 + 472 472 + fn create(&self) -> Box<dyn ProtocolIdentifier> { 473 473 + Box::new(GenericProtocolIdentifier::new( 474 474 + Arc::new(super::$protocol_name::default()), 475 475 + self.identifier(), 476 476 + )) 477 477 + } 478 478 + } 479 479 + } 480 480 + } 481 481 + }; 482 482 + } 483 483 + 484 484 + #[macro_export] 485 485 + macro_rules! generic_protocol_initializer_setup { 486 486 + ( $protocol_name:ident, $protocol_identifier:tt) => { 487 487 + paste::paste! { 488 488 + pub mod setup { 489 489 + use $crate::device::protocol::{ProtocolIdentifier, ProtocolIdentifierFactory}; 490 490 + #[derive(Default)] 491 491 + pub struct [< $protocol_name IdentifierFactory >] {} 492 492 + 493 493 + impl ProtocolIdentifierFactory for [< $protocol_name IdentifierFactory >] { 494 494 + fn identifier(&self) -> &str { 495 495 + $protocol_identifier 496 496 + } 497 497 + 498 498 + fn create(&self) -> Box<dyn ProtocolIdentifier> { 499 499 + Box::new(super::[< $protocol_name Identifier >]::default()) 500 500 + } 501 501 + } 502 502 + } 503 503 + 504 504 + #[derive(Default)] 505 505 + pub struct [< $protocol_name Identifier >] {} 506 506 + 507 507 + #[async_trait] 508 508 + impl ProtocolIdentifier for [< $protocol_name Identifier >] { 509 509 + async fn identify( 510 510 + &mut self, 511 511 + hardware: Arc<Hardware>, 512 512 + _: ProtocolCommunicationSpecifier, 513 513 + ) -> Result<(UserDeviceIdentifier, Box<dyn ProtocolInitializer>), ButtplugDeviceError> { 514 514 + Ok((UserDeviceIdentifier::new(hardware.address(), $protocol_identifier, &Some(hardware.name().to_owned())), Box::new([< $protocol_name Initializer >]::default()))) 515 515 + } 516 516 + } 517 517 + } 518 518 + }; 519 519 + } 520 520 + 521 521 + pub use generic_protocol_initializer_setup; 522 522 + pub use generic_protocol_setup; 523 523 + 524 524 + use super::hardware::HardwareWriteCmd;

crates/buttplug_server/src/device/protocol/activejoy.rs crates/buttplug_server/src/device/protocol_impl/activejoy.rs

crates/buttplug_server/src/device/protocol/adrienlastic.rs crates/buttplug_server/src/device/protocol_impl/adrienlastic.rs

crates/buttplug_server/src/device/protocol/amorelie_joy.rs crates/buttplug_server/src/device/protocol_impl/amorelie_joy.rs

crates/buttplug_server/src/device/protocol/aneros.rs crates/buttplug_server/src/device/protocol_impl/aneros.rs

crates/buttplug_server/src/device/protocol/ankni.rs crates/buttplug_server/src/device/protocol_impl/ankni.rs

crates/buttplug_server/src/device/protocol/bananasome.rs crates/buttplug_server/src/device/protocol_impl/bananasome.rs

crates/buttplug_server/src/device/protocol/cachito.rs crates/buttplug_server/src/device/protocol_impl/cachito.rs

crates/buttplug_server/src/device/protocol/cowgirl.rs crates/buttplug_server/src/device/protocol_impl/cowgirl.rs

crates/buttplug_server/src/device/protocol/cowgirl_cone.rs crates/buttplug_server/src/device/protocol_impl/cowgirl_cone.rs

crates/buttplug_server/src/device/protocol/cupido.rs crates/buttplug_server/src/device/protocol_impl/cupido.rs

crates/buttplug_server/src/device/protocol/deepsire.rs crates/buttplug_server/src/device/protocol_impl/deepsire.rs

crates/buttplug_server/src/device/protocol/feelingso.rs crates/buttplug_server/src/device/protocol_impl/feelingso.rs

crates/buttplug_server/src/device/protocol/fleshlight_launch_helper.rs crates/buttplug_server/src/device/protocol_impl/fleshlight_launch_helper.rs

crates/buttplug_server/src/device/protocol/fleshy_thrust.rs crates/buttplug_server/src/device/protocol_impl/fleshy_thrust.rs

crates/buttplug_server/src/device/protocol/foreo.rs crates/buttplug_server/src/device/protocol_impl/foreo.rs

crates/buttplug_server/src/device/protocol/fox.rs crates/buttplug_server/src/device/protocol_impl/fox.rs

crates/buttplug_server/src/device/protocol/fredorch.rs crates/buttplug_server/src/device/protocol_impl/fredorch.rs

crates/buttplug_server/src/device/protocol/fredorch_rotary.rs crates/buttplug_server/src/device/protocol_impl/fredorch_rotary.rs

crates/buttplug_server/src/device/protocol/galaku.rs crates/buttplug_server/src/device/protocol_impl/galaku.rs

crates/buttplug_server/src/device/protocol/galaku_pump.rs crates/buttplug_server/src/device/protocol_impl/galaku_pump.rs

crates/buttplug_server/src/device/protocol/hgod.rs crates/buttplug_server/src/device/protocol_impl/hgod.rs

crates/buttplug_server/src/device/protocol/hismith.rs crates/buttplug_server/src/device/protocol_impl/hismith.rs

crates/buttplug_server/src/device/protocol/hismith_mini.rs crates/buttplug_server/src/device/protocol_impl/hismith_mini.rs

crates/buttplug_server/src/device/protocol/htk_bm.rs crates/buttplug_server/src/device/protocol_impl/htk_bm.rs

crates/buttplug_server/src/device/protocol/itoys.rs crates/buttplug_server/src/device/protocol_impl/itoys.rs

crates/buttplug_server/src/device/protocol/jejoue.rs crates/buttplug_server/src/device/protocol_impl/jejoue.rs

crates/buttplug_server/src/device/protocol/joyhub.rs crates/buttplug_server/src/device/protocol_impl/joyhub.rs

crates/buttplug_server/src/device/protocol/joyhub_v2.rs crates/buttplug_server/src/device/protocol_impl/joyhub_v2.rs

crates/buttplug_server/src/device/protocol/joyhub_v3.rs crates/buttplug_server/src/device/protocol_impl/joyhub_v3.rs

crates/buttplug_server/src/device/protocol/joyhub_v4.rs crates/buttplug_server/src/device/protocol_impl/joyhub_v4.rs

crates/buttplug_server/src/device/protocol/joyhub_v5.rs crates/buttplug_server/src/device/protocol_impl/joyhub_v5.rs

crates/buttplug_server/src/device/protocol/joyhub_v6.rs crates/buttplug_server/src/device/protocol_impl/joyhub_v6.rs

crates/buttplug_server/src/device/protocol/kgoal_boost.rs crates/buttplug_server/src/device/protocol_impl/kgoal_boost.rs

crates/buttplug_server/src/device/protocol/kiiroo_prowand.rs crates/buttplug_server/src/device/protocol_impl/kiiroo_prowand.rs

crates/buttplug_server/src/device/protocol/kiiroo_spot.rs crates/buttplug_server/src/device/protocol_impl/kiiroo_spot.rs

crates/buttplug_server/src/device/protocol/kiiroo_v2.rs crates/buttplug_server/src/device/protocol_impl/kiiroo_v2.rs

crates/buttplug_server/src/device/protocol/kiiroo_v21.rs crates/buttplug_server/src/device/protocol_impl/kiiroo_v21.rs

crates/buttplug_server/src/device/protocol/kiiroo_v21_initialized.rs crates/buttplug_server/src/device/protocol_impl/kiiroo_v21_initialized.rs

crates/buttplug_server/src/device/protocol/kiiroo_v2_vibrator.rs crates/buttplug_server/src/device/protocol_impl/kiiroo_v2_vibrator.rs

crates/buttplug_server/src/device/protocol/kizuna.rs crates/buttplug_server/src/device/protocol_impl/kizuna.rs

crates/buttplug_server/src/device/protocol/lelo_harmony.rs crates/buttplug_server/src/device/protocol_impl/lelo_harmony.rs

crates/buttplug_server/src/device/protocol/lelof1s.rs crates/buttplug_server/src/device/protocol_impl/lelof1s.rs

crates/buttplug_server/src/device/protocol/lelof1sv2.rs crates/buttplug_server/src/device/protocol_impl/lelof1sv2.rs

crates/buttplug_server/src/device/protocol/leten.rs crates/buttplug_server/src/device/protocol_impl/leten.rs

crates/buttplug_server/src/device/protocol/libo_elle.rs crates/buttplug_server/src/device/protocol_impl/libo_elle.rs

crates/buttplug_server/src/device/protocol/libo_shark.rs crates/buttplug_server/src/device/protocol_impl/libo_shark.rs

crates/buttplug_server/src/device/protocol/libo_vibes.rs crates/buttplug_server/src/device/protocol_impl/libo_vibes.rs

crates/buttplug_server/src/device/protocol/lioness.rs crates/buttplug_server/src/device/protocol_impl/lioness.rs

crates/buttplug_server/src/device/protocol/loob.rs crates/buttplug_server/src/device/protocol_impl/loob.rs

crates/buttplug_server/src/device/protocol/lovedistance.rs crates/buttplug_server/src/device/protocol_impl/lovedistance.rs

crates/buttplug_server/src/device/protocol/lovehoney_desire.rs crates/buttplug_server/src/device/protocol_impl/lovehoney_desire.rs

crates/buttplug_server/src/device/protocol/lovense/lovense_max.rs crates/buttplug_server/src/device/protocol_impl/lovense/lovense_max.rs

crates/buttplug_server/src/device/protocol/lovense/lovense_multi_actuator.rs crates/buttplug_server/src/device/protocol_impl/lovense/lovense_multi_actuator.rs

crates/buttplug_server/src/device/protocol/lovense/lovense_rotate_vibrator.rs crates/buttplug_server/src/device/protocol_impl/lovense/lovense_rotate_vibrator.rs

crates/buttplug_server/src/device/protocol/lovense/lovense_single_actuator.rs crates/buttplug_server/src/device/protocol_impl/lovense/lovense_single_actuator.rs

crates/buttplug_server/src/device/protocol/lovense/lovense_stroker.rs crates/buttplug_server/src/device/protocol_impl/lovense/lovense_stroker.rs

crates/buttplug_server/src/device/protocol/lovense/mod.rs crates/buttplug_server/src/device/protocol_impl/lovense/mod.rs

crates/buttplug_server/src/device/protocol/lovense_connect_service.rs crates/buttplug_server/src/device/protocol_impl/lovense_connect_service.rs

crates/buttplug_server/src/device/protocol/lovenuts.rs crates/buttplug_server/src/device/protocol_impl/lovenuts.rs

crates/buttplug_server/src/device/protocol/luvmazer.rs crates/buttplug_server/src/device/protocol_impl/luvmazer.rs

crates/buttplug_server/src/device/protocol/magic_motion_v1.rs crates/buttplug_server/src/device/protocol_impl/magic_motion_v1.rs

crates/buttplug_server/src/device/protocol/magic_motion_v2.rs crates/buttplug_server/src/device/protocol_impl/magic_motion_v2.rs

crates/buttplug_server/src/device/protocol/magic_motion_v3.rs crates/buttplug_server/src/device/protocol_impl/magic_motion_v3.rs

crates/buttplug_server/src/device/protocol/magic_motion_v4.rs crates/buttplug_server/src/device/protocol_impl/magic_motion_v4.rs

crates/buttplug_server/src/device/protocol/mannuo.rs crates/buttplug_server/src/device/protocol_impl/mannuo.rs

crates/buttplug_server/src/device/protocol/maxpro.rs crates/buttplug_server/src/device/protocol_impl/maxpro.rs

crates/buttplug_server/src/device/protocol/meese.rs crates/buttplug_server/src/device/protocol_impl/meese.rs

crates/buttplug_server/src/device/protocol/metaxsire.rs crates/buttplug_server/src/device/protocol_impl/metaxsire.rs

crates/buttplug_server/src/device/protocol/metaxsire_v2.rs crates/buttplug_server/src/device/protocol_impl/metaxsire_v2.rs

crates/buttplug_server/src/device/protocol/metaxsire_v3.rs crates/buttplug_server/src/device/protocol_impl/metaxsire_v3.rs

crates/buttplug_server/src/device/protocol/metaxsire_v4.rs crates/buttplug_server/src/device/protocol_impl/metaxsire_v4.rs

crates/buttplug_server/src/device/protocol/mizzzee.rs crates/buttplug_server/src/device/protocol_impl/mizzzee.rs

crates/buttplug_server/src/device/protocol/mizzzee_v2.rs crates/buttplug_server/src/device/protocol_impl/mizzzee_v2.rs

crates/buttplug_server/src/device/protocol/mizzzee_v3.rs crates/buttplug_server/src/device/protocol_impl/mizzzee_v3.rs

-1092

crates/buttplug_server/src/device/protocol/mod.rs

··· 1 1 - // Buttplug Rust Source Code File - See https://buttplug.io for more info. 2 2 - // 3 3 - // Copyright 2016-2024 Nonpolynomial Labs LLC. All rights reserved. 4 4 - // 5 5 - // Licensed under the BSD 3-Clause license. See LICENSE file in the project root 6 6 - // for full license information. 7 7 - 8 8 - //! Implementations of communication protocols for hardware supported by Buttplug 9 9 - 10 10 - // Utility mods 11 11 - pub mod fleshlight_launch_helper; 12 12 - 13 13 - // Since users can pick and choose protocols, we need all of these to be public. 14 14 - pub mod activejoy; 15 15 - pub mod adrienlastic; 16 16 - pub mod amorelie_joy; 17 17 - pub mod aneros; 18 18 - pub mod ankni; 19 19 - pub mod bananasome; 20 20 - pub mod cachito; 21 21 - pub mod cowgirl; 22 22 - pub mod cowgirl_cone; 23 23 - pub mod cupido; 24 24 - pub mod deepsire; 25 25 - pub mod feelingso; 26 26 - pub mod fleshy_thrust; 27 27 - pub mod foreo; 28 28 - pub mod fox; 29 29 - pub mod fredorch; 30 30 - pub mod fredorch_rotary; 31 31 - pub mod galaku; 32 32 - pub mod galaku_pump; 33 33 - pub mod hgod; 34 34 - pub mod hismith; 35 35 - pub mod hismith_mini; 36 36 - pub mod htk_bm; 37 37 - pub mod itoys; 38 38 - pub mod jejoue; 39 39 - // pub mod joyhub; 40 40 - // pub mod joyhub_v2; 41 41 - pub mod joyhub_v3; 42 42 - // pub mod joyhub_v4; 43 43 - // pub mod joyhub_v5; 44 44 - // pub mod joyhub_v6; 45 45 - pub mod kgoal_boost; 46 46 - pub mod kiiroo_prowand; 47 47 - pub mod kiiroo_spot; 48 48 - pub mod kiiroo_v2; 49 49 - pub mod kiiroo_v21; 50 50 - pub mod kiiroo_v21_initialized; 51 51 - pub mod kiiroo_v2_vibrator; 52 52 - pub mod kizuna; 53 53 - pub mod lelo_harmony; 54 54 - pub mod lelof1s; 55 55 - pub mod lelof1sv2; 56 56 - pub mod leten; 57 57 - pub mod libo_elle; 58 58 - pub mod libo_shark; 59 59 - pub mod libo_vibes; 60 60 - pub mod lioness; 61 61 - pub mod loob; 62 62 - pub mod lovedistance; 63 63 - pub mod lovehoney_desire; 64 64 - pub mod lovense; 65 65 - // pub mod lovense_connect_service; 66 66 - pub mod lovenuts; 67 67 - pub mod luvmazer; 68 68 - pub mod magic_motion_v1; 69 69 - pub mod magic_motion_v2; 70 70 - pub mod magic_motion_v3; 71 71 - pub mod magic_motion_v4; 72 72 - pub mod mannuo; 73 73 - pub mod maxpro; 74 74 - pub mod meese; 75 75 - pub mod metaxsire; 76 76 - pub mod metaxsire_v2; 77 77 - pub mod metaxsire_v3; 78 78 - mod metaxsire_v4; 79 79 - pub mod mizzzee; 80 80 - pub mod mizzzee_v2; 81 81 - pub mod mizzzee_v3; 82 82 - pub mod monsterpub; 83 83 - pub mod motorbunny; 84 84 - pub mod mysteryvibe; 85 85 - pub mod mysteryvibe_v2; 86 86 - pub mod nextlevelracing; 87 87 - pub mod nexus_revo; 88 88 - pub mod nintendo_joycon; 89 89 - pub mod nobra; 90 90 - pub mod omobo; 91 91 - pub mod patoo; 92 92 - pub mod picobong; 93 93 - pub mod pink_punch; 94 94 - pub mod prettylove; 95 95 - pub mod raw_protocol; 96 96 - pub mod realov; 97 97 - pub mod sakuraneko; 98 98 - pub mod satisfyer; 99 99 - pub mod sensee; 100 100 - pub mod sensee_capsule; 101 101 - pub mod sensee_v2; 102 102 - pub mod serveu; 103 103 - pub mod sexverse_lg389; 104 104 - pub mod svakom; 105 105 - pub mod synchro; 106 106 - pub mod tcode_v03; 107 107 - pub mod thehandy; 108 108 - pub mod tryfun; 109 109 - pub mod tryfun_blackhole; 110 110 - pub mod tryfun_meta2; 111 111 - pub mod vibcrafter; 112 112 - pub mod vibratissimo; 113 113 - pub mod vorze_sa; 114 114 - pub mod wetoy; 115 115 - pub mod wevibe; 116 116 - pub mod wevibe8bit; 117 117 - pub mod wevibe_chorus; 118 118 - pub mod xibao; 119 119 - pub mod xinput; 120 120 - pub mod xiuxiuda; 121 121 - pub mod xuanhuan; 122 122 - pub mod youcups; 123 123 - pub mod youou; 124 124 - pub mod zalo; 125 125 - 126 126 - use buttplug_core::{ 127 127 - errors::ButtplugDeviceError, 128 128 - message::{Endpoint, InputReadingV4, InputType, OutputCommand}, 129 129 - }; 130 130 - use buttplug_server_device_config::{ 131 131 - DeviceDefinition, 132 132 - ProtocolCommunicationSpecifier, 133 133 - UserDeviceIdentifier, 134 134 - }; 135 135 - 136 136 - use crate::{ 137 137 - device::hardware::{Hardware, HardwareCommand, HardwareReadCmd}, 138 138 - message::{ 139 139 - checked_output_cmd::CheckedOutputCmdV4, 140 140 - spec_enums::ButtplugDeviceCommandMessageUnionV4, 141 141 - ButtplugServerDeviceMessage, 142 142 - }, 143 143 - }; 144 144 - use async_trait::async_trait; 145 145 - use futures::{ 146 146 - future::{self, BoxFuture, FutureExt}, 147 147 - StreamExt, 148 148 - }; 149 149 - use std::{collections::HashMap, sync::Arc}; 150 150 - use std::{pin::Pin, time::Duration}; 151 151 - use uuid::Uuid; 152 152 - 153 153 - /// Strategy for situations where hardware needs to get updates every so often in order to keep 154 154 - /// things alive. Currently this applies to iOS backgrounding with bluetooth devices, as well as 155 155 - /// some protocols like Satisfyer and Mysteryvibe that need constant command refreshing, but since 156 156 - /// we never know which of our hundreds of supported devices someone might connect, we need context 157 157 - /// as to which keepalive strategy to use. 158 158 - /// 159 159 - /// When choosing a keepalive strategy for a protocol: 160 160 - /// 161 161 - /// - If the protocol has a command that essentially does nothing to the actuators, set up 162 162 - /// RepeatPacketStrategy to use that. This is useful for devices that have info commands (like 163 163 - /// Lovense), ping commands (like The Handy), sensor commands that aren't yet subscribed to output 164 164 - /// notifications, etc... 165 165 - /// - If a protocol needs specific timing or keepalives, regardless of the OS/hardware manager being 166 166 - /// used, like Satisfyer or Mysteryvibe, use RepeatLastPacketStrategyWithTiming. 167 167 - /// - For many devices with only scalar actuators, RepeatLastPacketStrategy should work. You just 168 168 - /// need to make sure the protocol doesn't have a packet counter or something else that will trip 169 169 - /// if the same packet is replayed multiple times. 170 170 - #[derive(Debug)] 171 171 - pub enum ProtocolKeepaliveStrategy { 172 172 - /// Repeat a specific packet, such as a ping or a no-op. Only do this when the hardware manager 173 173 - /// requires it (currently only iOS bluetooth during backgrounding). 174 174 - HardwareRequiredRepeatPacketStrategy(HardwareWriteCmd), 175 175 - /// Repeat whatever the last packet sent was, and send Stop commands until first packet sent. Uses 176 176 - /// a default timing, suitable for most protocols that don't need constant device updates outside 177 177 - /// of OS requirements. Only do this when the hardware manager requires it (currently only iOS 178 178 - /// bluetooth during backgrounding). 179 179 - HardwareRequiredRepeatLastPacketStrategy, 180 180 - /// Repeat whatever the last packet sent was, and send Stop commands until first packet sent. Do 181 181 - /// this regardless of whether or not the hardware manager requires it. Useful for hardware that 182 182 - /// requires keepalives, like Satisfyer, Mysteryvibe, Leten, etc... 183 183 - RepeatLastPacketStrategyWithTiming(Duration), 184 184 - } 185 185 - 186 186 - pub trait ProtocolIdentifierFactory: Send + Sync { 187 187 - fn identifier(&self) -> &str; 188 188 - fn create(&self) -> Box<dyn ProtocolIdentifier>; 189 189 - } 190 190 - 191 191 - pub fn get_default_protocol_map() -> HashMap<String, Arc<dyn ProtocolIdentifierFactory>> { 192 192 - let mut map = HashMap::new(); 193 193 - fn add_to_protocol_map<T>( 194 194 - map: &mut HashMap<String, Arc<dyn ProtocolIdentifierFactory>>, 195 195 - factory: T, 196 196 - ) where 197 197 - T: ProtocolIdentifierFactory + 'static, 198 198 - { 199 199 - let factory = Arc::new(factory); 200 200 - map.insert(factory.identifier().to_owned(), factory); 201 201 - } 202 202 - 203 203 - add_to_protocol_map( 204 204 - &mut map, 205 205 - activejoy::setup::ActiveJoyIdentifierFactory::default(), 206 206 - ); 207 207 - add_to_protocol_map( 208 208 - &mut map, 209 209 - adrienlastic::setup::AdrienLasticIdentifierFactory::default(), 210 210 - ); 211 211 - add_to_protocol_map( 212 212 - &mut map, 213 213 - amorelie_joy::setup::AmorelieJoyIdentifierFactory::default(), 214 214 - ); 215 215 - add_to_protocol_map(&mut map, aneros::setup::AnerosIdentifierFactory::default()); 216 216 - add_to_protocol_map(&mut map, ankni::setup::AnkniIdentifierFactory::default()); 217 217 - add_to_protocol_map( 218 218 - &mut map, 219 219 - bananasome::setup::BananasomeIdentifierFactory::default(), 220 220 - ); 221 221 - add_to_protocol_map( 222 222 - &mut map, 223 223 - cachito::setup::CachitoIdentifierFactory::default(), 224 224 - ); 225 225 - add_to_protocol_map( 226 226 - &mut map, 227 227 - cowgirl::setup::CowgirlIdentifierFactory::default(), 228 228 - ); 229 229 - add_to_protocol_map( 230 230 - &mut map, 231 231 - cowgirl_cone::setup::CowgirlConeIdentifierFactory::default(), 232 232 - ); 233 233 - add_to_protocol_map(&mut map, cupido::setup::CupidoIdentifierFactory::default()); 234 234 - add_to_protocol_map( 235 235 - &mut map, 236 236 - deepsire::setup::DeepSireIdentifierFactory::default(), 237 237 - ); 238 238 - add_to_protocol_map( 239 239 - &mut map, 240 240 - lovense::setup::LovenseIdentifierFactory::default(), 241 241 - ); 242 242 - add_to_protocol_map( 243 243 - &mut map, 244 244 - hismith::setup::HismithIdentifierFactory::default(), 245 245 - ); 246 246 - add_to_protocol_map( 247 247 - &mut map, 248 248 - hismith_mini::setup::HismithMiniIdentifierFactory::default(), 249 249 - ); 250 250 - add_to_protocol_map(&mut map, htk_bm::setup::HtkBmIdentifierFactory::default()); 251 251 - add_to_protocol_map( 252 252 - &mut map, 253 253 - thehandy::setup::TheHandyIdentifierFactory::default(), 254 254 - ); 255 255 - 256 256 - add_to_protocol_map( 257 257 - &mut map, 258 258 - feelingso::setup::FeelingSoIdentifierFactory::default(), 259 259 - ); 260 260 - add_to_protocol_map( 261 261 - &mut map, 262 262 - fleshy_thrust::setup::FleshyThrustIdentifierFactory::default(), 263 263 - ); 264 264 - add_to_protocol_map(&mut map, foreo::setup::ForeoIdentifierFactory::default()); 265 265 - add_to_protocol_map(&mut map, fox::setup::FoxIdentifierFactory::default()); 266 266 - add_to_protocol_map( 267 267 - &mut map, 268 268 - fredorch::setup::FredorchIdentifierFactory::default(), 269 269 - ); 270 270 - add_to_protocol_map( 271 271 - &mut map, 272 272 - fredorch_rotary::setup::FredorchRotaryIdentifierFactory::default(), 273 273 - ); 274 274 - 275 275 - add_to_protocol_map(&mut map, hgod::setup::HgodIdentifierFactory::default()); 276 276 - 277 277 - add_to_protocol_map( 278 278 - &mut map, 279 279 - galaku_pump::setup::GalakuPumpIdentifierFactory::default(), 280 280 - ); 281 281 - 282 282 - add_to_protocol_map(&mut map, galaku::setup::GalakuIdentifierFactory::default()); 283 283 - 284 284 - add_to_protocol_map(&mut map, itoys::setup::IToysIdentifierFactory::default()); 285 285 - add_to_protocol_map(&mut map, jejoue::setup::JeJoueIdentifierFactory::default()); 286 286 - // add_to_protocol_map(&mut map, joyhub::setup::JoyHubIdentifierFactory::default()); 287 287 - // add_to_protocol_map( 288 288 - // &mut map, 289 289 - // joyhub_v2::setup::JoyHubV2IdentifierFactory::default(), 290 290 - // ); 291 291 - 292 292 - add_to_protocol_map( 293 293 - &mut map, 294 294 - joyhub_v3::setup::JoyHubV3IdentifierFactory::default(), 295 295 - ); 296 296 - 297 297 - // add_to_protocol_map( 298 298 - // &mut map, 299 299 - // joyhub_v4::setup::JoyHubV4IdentifierFactory::default(), 300 300 - // ); 301 301 - // add_to_protocol_map( 302 302 - // &mut map, 303 303 - // joyhub_v5::setup::JoyHubV5IdentifierFactory::default(), 304 304 - // ); 305 305 - // add_to_protocol_map( 306 306 - // &mut map, 307 307 - // joyhub_v6::setup::JoyHubV6IdentifierFactory::default(), 308 308 - // ); 309 309 - add_to_protocol_map( 310 310 - &mut map, 311 311 - kiiroo_prowand::setup::KiirooProWandIdentifierFactory::default(), 312 312 - ); 313 313 - add_to_protocol_map( 314 314 - &mut map, 315 315 - kiiroo_spot::setup::KiirooSpotIdentifierFactory::default(), 316 316 - ); 317 317 - add_to_protocol_map( 318 318 - &mut map, 319 319 - kiiroo_v2::setup::KiirooV2IdentifierFactory::default(), 320 320 - ); 321 321 - add_to_protocol_map( 322 322 - &mut map, 323 323 - kiiroo_v2_vibrator::setup::KiirooV2VibratorIdentifierFactory::default(), 324 324 - ); 325 325 - add_to_protocol_map( 326 326 - &mut map, 327 327 - kiiroo_v21::setup::KiirooV21IdentifierFactory::default(), 328 328 - ); 329 329 - add_to_protocol_map( 330 330 - &mut map, 331 331 - kiiroo_v21_initialized::setup::KiirooV21InitializedIdentifierFactory::default(), 332 332 - ); 333 333 - add_to_protocol_map(&mut map, kizuna::setup::KizunaIdentifierFactory::default()); 334 334 - add_to_protocol_map( 335 335 - &mut map, 336 336 - lelof1s::setup::LeloF1sIdentifierFactory::default(), 337 337 - ); 338 338 - add_to_protocol_map( 339 339 - &mut map, 340 340 - lelof1sv2::setup::LeloF1sV2IdentifierFactory::default(), 341 341 - ); 342 342 - add_to_protocol_map(&mut map, leten::setup::LetenIdentifierFactory::default()); 343 343 - add_to_protocol_map( 344 344 - &mut map, 345 345 - lelo_harmony::setup::LeloHarmonyIdentifierFactory::default(), 346 346 - ); 347 347 - add_to_protocol_map( 348 348 - &mut map, 349 349 - libo_elle::setup::LiboElleIdentifierFactory::default(), 350 350 - ); 351 351 - add_to_protocol_map( 352 352 - &mut map, 353 353 - libo_shark::setup::LiboSharkIdentifierFactory::default(), 354 354 - ); 355 355 - add_to_protocol_map( 356 356 - &mut map, 357 357 - libo_vibes::setup::LiboVibesIdentifierFactory::default(), 358 358 - ); 359 359 - add_to_protocol_map( 360 360 - &mut map, 361 361 - lioness::setup::LionessIdentifierFactory::default(), 362 362 - ); 363 363 - add_to_protocol_map(&mut map, loob::setup::LoobIdentifierFactory::default()); 364 364 - add_to_protocol_map( 365 365 - &mut map, 366 366 - lovehoney_desire::setup::LovehoneyDesireIdentifierFactory::default(), 367 367 - ); 368 368 - add_to_protocol_map( 369 369 - &mut map, 370 370 - lovedistance::setup::LoveDistanceIdentifierFactory::default(), 371 371 - ); 372 372 - // add_to_protocol_map( 373 373 - // &mut map, 374 374 - // lovense_connect_service::setup::LovenseConnectServiceIdentifierFactory::default(), 375 375 - // ); 376 376 - add_to_protocol_map( 377 377 - &mut map, 378 378 - lovenuts::setup::LoveNutsIdentifierFactory::default(), 379 379 - ); 380 380 - add_to_protocol_map( 381 381 - &mut map, 382 382 - luvmazer::setup::LuvmazerIdentifierFactory::default(), 383 383 - ); 384 384 - add_to_protocol_map( 385 385 - &mut map, 386 386 - magic_motion_v1::setup::MagicMotionV1IdentifierFactory::default(), 387 387 - ); 388 388 - add_to_protocol_map( 389 389 - &mut map, 390 390 - magic_motion_v2::setup::MagicMotionV2IdentifierFactory::default(), 391 391 - ); 392 392 - add_to_protocol_map( 393 393 - &mut map, 394 394 - magic_motion_v3::setup::MagicMotionV3IdentifierFactory::default(), 395 395 - ); 396 396 - add_to_protocol_map( 397 397 - &mut map, 398 398 - magic_motion_v4::setup::MagicMotionV4IdentifierFactory::default(), 399 399 - ); 400 400 - add_to_protocol_map(&mut map, mannuo::setup::ManNuoIdentifierFactory::default()); 401 401 - add_to_protocol_map(&mut map, maxpro::setup::MaxproIdentifierFactory::default()); 402 402 - add_to_protocol_map(&mut map, meese::setup::MeeseIdentifierFactory::default()); 403 403 - add_to_protocol_map( 404 404 - &mut map, 405 405 - metaxsire::setup::MetaXSireIdentifierFactory::default(), 406 406 - ); 407 407 - add_to_protocol_map( 408 408 - &mut map, 409 409 - metaxsire_v2::setup::MetaXSireV2IdentifierFactory::default(), 410 410 - ); 411 411 - add_to_protocol_map( 412 412 - &mut map, 413 413 - metaxsire_v3::setup::MetaXSireV3IdentifierFactory::default(), 414 414 - ); 415 415 - add_to_protocol_map( 416 416 - &mut map, 417 417 - metaxsire_v4::setup::MetaXSireV4IdentifierFactory::default(), 418 418 - ); 419 419 - add_to_protocol_map( 420 420 - &mut map, 421 421 - mizzzee::setup::MizzZeeIdentifierFactory::default(), 422 422 - ); 423 423 - add_to_protocol_map( 424 424 - &mut map, 425 425 - mizzzee_v2::setup::MizzZeeV2IdentifierFactory::default(), 426 426 - ); 427 427 - add_to_protocol_map( 428 428 - &mut map, 429 429 - mizzzee_v3::setup::MizzZeeV3IdentifierFactory::default(), 430 430 - ); 431 431 - add_to_protocol_map( 432 432 - &mut map, 433 433 - monsterpub::setup::MonsterPubIdentifierFactory::default(), 434 434 - ); 435 435 - add_to_protocol_map( 436 436 - &mut map, 437 437 - motorbunny::setup::MotorbunnyIdentifierFactory::default(), 438 438 - ); 439 439 - add_to_protocol_map( 440 440 - &mut map, 441 441 - mysteryvibe::setup::MysteryVibeIdentifierFactory::default(), 442 442 - ); 443 443 - add_to_protocol_map( 444 444 - &mut map, 445 445 - mysteryvibe_v2::setup::MysteryVibeV2IdentifierFactory::default(), 446 446 - ); 447 447 - add_to_protocol_map( 448 448 - &mut map, 449 449 - nexus_revo::setup::NexusRevoIdentifierFactory::default(), 450 450 - ); 451 451 - add_to_protocol_map( 452 452 - &mut map, 453 453 - nextlevelracing::setup::NextLevelRacingIdentifierFactory::default(), 454 454 - ); 455 455 - add_to_protocol_map( 456 456 - &mut map, 457 457 - nintendo_joycon::setup::NintendoJoyconIdentifierFactory::default(), 458 458 - ); 459 459 - add_to_protocol_map(&mut map, nobra::setup::NobraIdentifierFactory::default()); 460 460 - add_to_protocol_map(&mut map, omobo::setup::OmoboIdentifierFactory::default()); 461 461 - add_to_protocol_map(&mut map, patoo::setup::PatooIdentifierFactory::default()); 462 462 - add_to_protocol_map( 463 463 - &mut map, 464 464 - picobong::setup::PicobongIdentifierFactory::default(), 465 465 - ); 466 466 - add_to_protocol_map( 467 467 - &mut map, 468 468 - pink_punch::setup::PinkPunchIdentifierFactory::default(), 469 469 - ); 470 470 - add_to_protocol_map( 471 471 - &mut map, 472 472 - prettylove::setup::PrettyLoveIdentifierFactory::default(), 473 473 - ); 474 474 - add_to_protocol_map( 475 475 - &mut map, 476 476 - raw_protocol::setup::RawProtocolIdentifierFactory::default(), 477 477 - ); 478 478 - add_to_protocol_map(&mut map, realov::setup::RealovIdentifierFactory::default()); 479 479 - add_to_protocol_map( 480 480 - &mut map, 481 481 - sakuraneko::setup::SakuranekoIdentifierFactory::default(), 482 482 - ); 483 483 - add_to_protocol_map( 484 484 - &mut map, 485 485 - satisfyer::setup::SatisfyerIdentifierFactory::default(), 486 486 - ); 487 487 - add_to_protocol_map(&mut map, sensee::setup::SenseeIdentifierFactory::default()); 488 488 - add_to_protocol_map( 489 489 - &mut map, 490 490 - sensee_capsule::setup::SenseeCapsuleIdentifierFactory::default(), 491 491 - ); 492 492 - add_to_protocol_map( 493 493 - &mut map, 494 494 - sensee_v2::setup::SenseeV2IdentifierFactory::default(), 495 495 - ); 496 496 - add_to_protocol_map( 497 497 - &mut map, 498 498 - sexverse_lg389::setup::SexverseLG389IdentifierFactory::default(), 499 499 - ); 500 500 - add_to_protocol_map(&mut map, serveu::setup::ServeUIdentifierFactory::default()); 501 501 - //add_to_protocol_map( 502 502 - // &mut map, 503 503 - // svakom::svakom_avaneo::setup::SvakomAvaNeoIdentifierFactory::default(), 504 504 - //); 505 505 - add_to_protocol_map( 506 506 - &mut map, 507 507 - svakom::svakom_alex::setup::SvakomAlexIdentifierFactory::default(), 508 508 - ); 509 509 - add_to_protocol_map( 510 510 - &mut map, 511 511 - svakom::svakom_alex_v2::setup::SvakomAlexV2IdentifierFactory::default(), 512 512 - ); 513 513 - add_to_protocol_map( 514 514 - &mut map, 515 515 - svakom::svakom_barnard::setup::SvakomBarnardIdentifierFactory::default(), 516 516 - ); 517 517 - add_to_protocol_map( 518 518 - &mut map, 519 519 - svakom::svakom_barney::setup::SvakomBarneyIdentifierFactory::default(), 520 520 - ); 521 521 - add_to_protocol_map( 522 522 - &mut map, 523 523 - svakom::svakom_dice::setup::SvakomDiceIdentifierFactory::default(), 524 524 - ); 525 525 - //add_to_protocol_map( 526 526 - // &mut map, 527 527 - // svakom::svakom_dt250a::setup::SvakomDT250AIdentifierFactory::default(), 528 528 - //); 529 529 - add_to_protocol_map( 530 530 - &mut map, 531 531 - svakom::svakom_iker::setup::SvakomIkerIdentifierFactory::default(), 532 532 - ); 533 533 - add_to_protocol_map( 534 534 - &mut map, 535 535 - svakom::svakom_jordan::setup::SvakomJordanIdentifierFactory::default(), 536 536 - ); 537 537 - add_to_protocol_map( 538 538 - &mut map, 539 539 - svakom::svakom_pulse::setup::SvakomPulseIdentifierFactory::default(), 540 540 - ); 541 541 - add_to_protocol_map( 542 542 - &mut map, 543 543 - svakom::svakom_sam::setup::SvakomSamIdentifierFactory::default(), 544 544 - ); 545 545 - add_to_protocol_map( 546 546 - &mut map, 547 547 - svakom::svakom_sam2::setup::SvakomSam2IdentifierFactory::default(), 548 548 - ); 549 549 - //add_to_protocol_map( 550 550 - // &mut map, 551 551 - // svakom::svakom_suitcase::setup::SvakomSuitcaseIdentifierFactory::default(), 552 552 - //); 553 553 - //add_to_protocol_map( 554 554 - // &mut map, 555 555 - // svakom::svakom_tarax::setup::SvakomTaraXIdentifierFactory::default(), 556 556 - //); 557 557 - add_to_protocol_map( 558 558 - &mut map, 559 559 - svakom::svakom_v1::setup::SvakomV1IdentifierFactory::default(), 560 560 - ); 561 561 - add_to_protocol_map( 562 562 - &mut map, 563 563 - svakom::svakom_v2::setup::SvakomV2IdentifierFactory::default(), 564 564 - ); 565 565 - add_to_protocol_map( 566 566 - &mut map, 567 567 - svakom::svakom_v3::setup::SvakomV3IdentifierFactory::default(), 568 568 - ); 569 569 - add_to_protocol_map( 570 570 - &mut map, 571 571 - svakom::svakom_v4::setup::SvakomV4IdentifierFactory::default(), 572 572 - ); 573 573 - add_to_protocol_map( 574 574 - &mut map, 575 575 - svakom::svakom_v5::setup::SvakomV5IdentifierFactory::default(), 576 576 - ); 577 577 - add_to_protocol_map( 578 578 - &mut map, 579 579 - svakom::svakom_v6::setup::SvakomV6IdentifierFactory::default(), 580 580 - ); 581 581 - add_to_protocol_map( 582 582 - &mut map, 583 583 - synchro::setup::SynchroIdentifierFactory::default(), 584 584 - ); 585 585 - add_to_protocol_map(&mut map, tryfun::setup::TryFunIdentifierFactory::default()); 586 586 - add_to_protocol_map( 587 587 - &mut map, 588 588 - tryfun_blackhole::setup::TryFunBlackHoleIdentifierFactory::default(), 589 589 - ); 590 590 - add_to_protocol_map( 591 591 - &mut map, 592 592 - tryfun_meta2::setup::TryFunMeta2IdentifierFactory::default(), 593 593 - ); 594 594 - add_to_protocol_map( 595 595 - &mut map, 596 596 - tcode_v03::setup::TCodeV03IdentifierFactory::default(), 597 597 - ); 598 598 - add_to_protocol_map( 599 599 - &mut map, 600 600 - vibcrafter::setup::VibCrafterIdentifierFactory::default(), 601 601 - ); 602 602 - add_to_protocol_map( 603 603 - &mut map, 604 604 - vibratissimo::setup::VibratissimoIdentifierFactory::default(), 605 605 - ); 606 606 - add_to_protocol_map( 607 607 - &mut map, 608 608 - vorze_sa::setup::VorzeSAIdentifierFactory::default(), 609 609 - ); 610 610 - add_to_protocol_map(&mut map, wetoy::setup::WeToyIdentifierFactory::default()); 611 611 - add_to_protocol_map(&mut map, wevibe::setup::WeVibeIdentifierFactory::default()); 612 612 - add_to_protocol_map( 613 613 - &mut map, 614 614 - wevibe8bit::setup::WeVibe8BitIdentifierFactory::default(), 615 615 - ); 616 616 - add_to_protocol_map( 617 617 - &mut map, 618 618 - wevibe_chorus::setup::WeVibeChorusIdentifierFactory::default(), 619 619 - ); 620 620 - add_to_protocol_map(&mut map, xibao::setup::XibaoIdentifierFactory::default()); 621 621 - add_to_protocol_map(&mut map, xinput::setup::XInputIdentifierFactory::default()); 622 622 - add_to_protocol_map( 623 623 - &mut map, 624 624 - xiuxiuda::setup::XiuxiudaIdentifierFactory::default(), 625 625 - ); 626 626 - add_to_protocol_map( 627 627 - &mut map, 628 628 - xuanhuan::setup::XuanhuanIdentifierFactory::default(), 629 629 - ); 630 630 - add_to_protocol_map( 631 631 - &mut map, 632 632 - youcups::setup::YoucupsIdentifierFactory::default(), 633 633 - ); 634 634 - add_to_protocol_map(&mut map, youou::setup::YououIdentifierFactory::default()); 635 635 - add_to_protocol_map(&mut map, zalo::setup::ZaloIdentifierFactory::default()); 636 636 - add_to_protocol_map( 637 637 - &mut map, 638 638 - kgoal_boost::setup::KGoalBoostIdentifierFactory::default(), 639 639 - ); 640 640 - map 641 641 - } 642 642 - 643 643 - pub enum ProtocolValueCommandPrefilterStrategy { 644 644 - /// Drop repeated ValueCmd/ValueWithParameterCmd messages 645 645 - DropRepeats, 646 646 - /// No filter, send all value messages for processing 647 647 - None, 648 648 - } 649 649 - 650 650 - fn print_type_of<T>(_: &T) -> &'static str { 651 651 - std::any::type_name::<T>() 652 652 - } 653 653 - 654 654 - pub struct ProtocolSpecializer { 655 655 - specifiers: Vec<ProtocolCommunicationSpecifier>, 656 656 - identifier: Box<dyn ProtocolIdentifier>, 657 657 - } 658 658 - 659 659 - impl ProtocolSpecializer { 660 660 - pub fn new( 661 661 - specifiers: Vec<ProtocolCommunicationSpecifier>, 662 662 - identifier: Box<dyn ProtocolIdentifier>, 663 663 - ) -> Self { 664 664 - Self { 665 665 - specifiers, 666 666 - identifier, 667 667 - } 668 668 - } 669 669 - 670 670 - pub fn specifiers(&self) -> &Vec<ProtocolCommunicationSpecifier> { 671 671 - &self.specifiers 672 672 - } 673 673 - 674 674 - pub fn identify(self) -> Box<dyn ProtocolIdentifier> { 675 675 - self.identifier 676 676 - } 677 677 - } 678 678 - 679 679 - #[async_trait] 680 680 - pub trait ProtocolIdentifier: Sync + Send { 681 681 - async fn identify( 682 682 - &mut self, 683 683 - hardware: Arc<Hardware>, 684 684 - specifier: ProtocolCommunicationSpecifier, 685 685 - ) -> Result<(UserDeviceIdentifier, Box<dyn ProtocolInitializer>), ButtplugDeviceError>; 686 686 - } 687 687 - 688 688 - #[async_trait] 689 689 - pub trait ProtocolInitializer: Sync + Send { 690 690 - async fn initialize( 691 691 - &mut self, 692 692 - hardware: Arc<Hardware>, 693 693 - device_definition: &DeviceDefinition, 694 694 - ) -> Result<Arc<dyn ProtocolHandler>, ButtplugDeviceError>; 695 695 - } 696 696 - 697 697 - pub struct GenericProtocolIdentifier { 698 698 - handler: Option<Arc<dyn ProtocolHandler>>, 699 699 - protocol_identifier: String, 700 700 - } 701 701 - 702 702 - impl GenericProtocolIdentifier { 703 703 - pub fn new(handler: Arc<dyn ProtocolHandler>, protocol_identifier: &str) -> Self { 704 704 - Self { 705 705 - handler: Some(handler), 706 706 - protocol_identifier: protocol_identifier.to_owned(), 707 707 - } 708 708 - } 709 709 - } 710 710 - 711 711 - #[async_trait] 712 712 - impl ProtocolIdentifier for GenericProtocolIdentifier { 713 713 - async fn identify( 714 714 - &mut self, 715 715 - hardware: Arc<Hardware>, 716 716 - _: ProtocolCommunicationSpecifier, 717 717 - ) -> Result<(UserDeviceIdentifier, Box<dyn ProtocolInitializer>), ButtplugDeviceError> { 718 718 - let device_identifier = UserDeviceIdentifier::new( 719 719 - hardware.address(), 720 720 - &self.protocol_identifier, 721 721 - &Some(hardware.name().to_owned()), 722 722 - ); 723 723 - Ok(( 724 724 - device_identifier, 725 725 - Box::new(GenericProtocolInitializer::new( 726 726 - self.handler.take().unwrap(), 727 727 - )), 728 728 - )) 729 729 - } 730 730 - } 731 731 - 732 732 - pub struct GenericProtocolInitializer { 733 733 - handler: Option<Arc<dyn ProtocolHandler>>, 734 734 - } 735 735 - 736 736 - impl GenericProtocolInitializer { 737 737 - pub fn new(handler: Arc<dyn ProtocolHandler>) -> Self { 738 738 - Self { 739 739 - handler: Some(handler), 740 740 - } 741 741 - } 742 742 - } 743 743 - 744 744 - #[async_trait] 745 745 - impl ProtocolInitializer for GenericProtocolInitializer { 746 746 - async fn initialize( 747 747 - &mut self, 748 748 - _: Arc<Hardware>, 749 749 - _: &DeviceDefinition, 750 750 - ) -> Result<Arc<dyn ProtocolHandler>, ButtplugDeviceError> { 751 751 - Ok(self.handler.take().unwrap()) 752 752 - } 753 753 - } 754 754 - 755 755 - pub trait ProtocolHandler: Sync + Send { 756 756 - fn keepalive_strategy(&self) -> ProtocolKeepaliveStrategy { 757 757 - ProtocolKeepaliveStrategy::HardwareRequiredRepeatLastPacketStrategy 758 758 - } 759 759 - 760 760 - fn handle_message( 761 761 - &self, 762 762 - message: &ButtplugDeviceCommandMessageUnionV4, 763 763 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 764 764 - self.command_unimplemented(print_type_of(&message)) 765 765 - } 766 766 - 767 767 - // Allow here since this changes between debug/release 768 768 - #[allow(unused_variables)] 769 769 - fn command_unimplemented( 770 770 - &self, 771 771 - command: &str, 772 772 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 773 773 - #[cfg(debug_assertions)] 774 774 - unimplemented!("Command not implemented for this protocol"); 775 775 - #[cfg(not(debug_assertions))] 776 776 - Err(ButtplugDeviceError::UnhandledCommand(format!( 777 777 - "Command not implemented for this protocol: {}", 778 778 - command 779 779 - ))) 780 780 - } 781 781 - 782 782 - // The default scalar handler assumes that most devices require discrete commands per feature. If 783 783 - // a protocol has commands that combine multiple features, either with matched or unmatched 784 784 - // actuators, they should just implement their own version of this method. 785 785 - fn handle_output_cmd( 786 786 - &self, 787 787 - cmd: &CheckedOutputCmdV4, 788 788 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 789 789 - let output_command = cmd.output_command(); 790 790 - match output_command { 791 791 - OutputCommand::Constrict(x) => { 792 792 - self.handle_output_constrict_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 793 793 - } 794 794 - OutputCommand::Inflate(x) => { 795 795 - self.handle_output_inflate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 796 796 - } 797 797 - OutputCommand::Oscillate(x) => { 798 798 - self.handle_output_oscillate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 799 799 - } 800 800 - OutputCommand::Rotate(x) => { 801 801 - self.handle_output_rotate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 802 802 - } 803 803 - OutputCommand::Vibrate(x) => { 804 804 - self.handle_output_vibrate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 805 805 - } 806 806 - OutputCommand::Position(x) => { 807 807 - self.handle_output_position_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 808 808 - } 809 809 - OutputCommand::Heater(x) => { 810 810 - self.handle_output_heater_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 811 811 - } 812 812 - OutputCommand::Led(x) => { 813 813 - self.handle_output_led_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 814 814 - } 815 815 - OutputCommand::PositionWithDuration(x) => self.handle_position_with_duration_cmd( 816 816 - cmd.feature_index(), 817 817 - cmd.feature_id(), 818 818 - x.position(), 819 819 - x.duration(), 820 820 - ), 821 821 - OutputCommand::RotateWithDirection(x) => self.handle_rotation_with_direction_cmd( 822 822 - cmd.feature_index(), 823 823 - cmd.feature_id(), 824 824 - x.speed(), 825 825 - x.clockwise(), 826 826 - ), 827 827 - } 828 828 - } 829 829 - 830 830 - fn handle_output_vibrate_cmd( 831 831 - &self, 832 832 - _feature_index: u32, 833 833 - _feature_id: Uuid, 834 834 - _speed: u32, 835 835 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 836 836 - self.command_unimplemented("OutputCmd (Vibrate Actuator)") 837 837 - } 838 838 - 839 839 - fn handle_output_rotate_cmd( 840 840 - &self, 841 841 - _feature_index: u32, 842 842 - _feature_id: Uuid, 843 843 - _speed: u32, 844 844 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 845 845 - self.command_unimplemented("OutputCmd (Rotate Actuator)") 846 846 - } 847 847 - 848 848 - fn handle_output_oscillate_cmd( 849 849 - &self, 850 850 - _feature_index: u32, 851 851 - _feature_id: Uuid, 852 852 - _speed: u32, 853 853 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 854 854 - self.command_unimplemented("OutputCmd (Oscillate Actuator)") 855 855 - } 856 856 - 857 857 - fn handle_output_inflate_cmd( 858 858 - &self, 859 859 - _feature_index: u32, 860 860 - _feature_id: Uuid, 861 861 - _level: u32, 862 862 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 863 863 - self.command_unimplemented("OutputCmd (Inflate Actuator)") 864 864 - } 865 865 - 866 866 - fn handle_output_constrict_cmd( 867 867 - &self, 868 868 - _feature_index: u32, 869 869 - _feature_id: Uuid, 870 870 - _level: u32, 871 871 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 872 872 - self.command_unimplemented("OutputCmd (Constrict Actuator)") 873 873 - } 874 874 - 875 875 - fn handle_output_heater_cmd( 876 876 - &self, 877 877 - _feature_index: u32, 878 878 - _feature_id: Uuid, 879 879 - _level: u32, 880 880 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 881 881 - self.command_unimplemented("OutputCmd (Heater Actuator)") 882 882 - } 883 883 - 884 884 - fn handle_output_led_cmd( 885 885 - &self, 886 886 - _feature_index: u32, 887 887 - _feature_id: Uuid, 888 888 - _level: u32, 889 889 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 890 890 - self.command_unimplemented("OutputCmd (Led Actuator)") 891 891 - } 892 892 - 893 893 - fn handle_output_position_cmd( 894 894 - &self, 895 895 - _feature_index: u32, 896 896 - _feature_id: Uuid, 897 897 - _position: u32, 898 898 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 899 899 - self.command_unimplemented("OutputCmd (Position Actuator)") 900 900 - } 901 901 - 902 902 - fn handle_position_with_duration_cmd( 903 903 - &self, 904 904 - _feature_index: u32, 905 905 - _feature_id: Uuid, 906 906 - _position: u32, 907 907 - _duration: u32, 908 908 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 909 909 - self.command_unimplemented("OutputCmd (Position w/ Duration Actuator)") 910 910 - } 911 911 - 912 912 - fn handle_rotation_with_direction_cmd( 913 913 - &self, 914 914 - _feature_index: u32, 915 915 - _feature_id: Uuid, 916 916 - _speed: u32, 917 917 - _clockwise: bool, 918 918 - ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 919 919 - self.command_unimplemented("OutputCmd (Rotation w/ Direction Actuator)") 920 920 - } 921 921 - 922 922 - fn handle_input_subscribe_cmd( 923 923 - &self, 924 924 - _device_index: u32, 925 925 - _device: Arc<Hardware>, 926 926 - _feature_index: u32, 927 927 - _feature_id: Uuid, 928 928 - _sensor_type: InputType, 929 929 - ) -> BoxFuture<Result<(), ButtplugDeviceError>> { 930 930 - future::ready(Err(ButtplugDeviceError::UnhandledCommand( 931 931 - "Command not implemented for this protocol: InputCmd (Subscribe)".to_string(), 932 932 - ))) 933 933 - .boxed() 934 934 - } 935 935 - 936 936 - fn handle_input_unsubscribe_cmd( 937 937 - &self, 938 938 - _device: Arc<Hardware>, 939 939 - _feature_index: u32, 940 940 - _feature_id: Uuid, 941 941 - _sensor_type: InputType, 942 942 - ) -> BoxFuture<Result<(), ButtplugDeviceError>> { 943 943 - future::ready(Err(ButtplugDeviceError::UnhandledCommand( 944 944 - "Command not implemented for this protocol: InputCmd (Unsubscribe)".to_string(), 945 945 - ))) 946 946 - .boxed() 947 947 - } 948 948 - 949 949 - fn handle_input_read_cmd( 950 950 - &self, 951 951 - device_index: u32, 952 952 - device: Arc<Hardware>, 953 953 - feature_index: u32, 954 954 - feature_id: Uuid, 955 955 - sensor_type: InputType, 956 956 - ) -> BoxFuture<Result<InputReadingV4, ButtplugDeviceError>> { 957 957 - match sensor_type { 958 958 - InputType::Battery => { 959 959 - self.handle_battery_level_cmd(device_index, device, feature_index, feature_id) 960 960 - } 961 961 - _ => future::ready(Err(ButtplugDeviceError::UnhandledCommand( 962 962 - "Command not implemented for this protocol: InputCmd (Read)".to_string(), 963 963 - ))) 964 964 - .boxed(), 965 965 - } 966 966 - } 967 967 - 968 968 - // Handle Battery Level returns a SensorReading, as we'll always need to do a sensor index 969 969 - // conversion on it. 970 970 - fn handle_battery_level_cmd( 971 971 - &self, 972 972 - device_index: u32, 973 973 - device: Arc<Hardware>, 974 974 - feature_index: u32, 975 975 - feature_id: Uuid, 976 976 - ) -> BoxFuture<Result<InputReadingV4, ButtplugDeviceError>> { 977 977 - // If we have a standardized BLE Battery endpoint, handle that above the 978 978 - // protocol, as it'll always be the same. 979 979 - if device.endpoints().contains(&Endpoint::RxBLEBattery) { 980 980 - debug!("Trying to get battery reading."); 981 981 - let msg = HardwareReadCmd::new(feature_id, Endpoint::RxBLEBattery, 1, 0); 982 982 - let fut = device.read_value(&msg); 983 983 - async move { 984 984 - let hw_msg = fut.await?; 985 985 - let battery_level = hw_msg.data()[0] as i32; 986 986 - let battery_reading = InputReadingV4::new( 987 987 - device_index, 988 988 - feature_index, 989 989 - InputType::Battery, 990 990 - vec![battery_level], 991 991 - ); 992 992 - debug!("Got battery reading: {}", battery_level); 993 993 - Ok(battery_reading) 994 994 - } 995 995 - .boxed() 996 996 - } else { 997 997 - future::ready(Err(ButtplugDeviceError::UnhandledCommand( 998 998 - "Command not implemented for this protocol: SensorReadCmd".to_string(), 999 999 - ))) 1000 1000 - .boxed() 1001 1001 - } 1002 1002 - } 1003 1003 - 1004 1004 - fn handle_rssi_level_cmd( 1005 1005 - &self, 1006 1006 - _device: Arc<Hardware>, 1007 1007 - _feature_index: u32, 1008 1008 - _feature_id: Uuid, 1009 1009 - ) -> BoxFuture<Result<(), ButtplugDeviceError>> { 1010 1010 - future::ready(Err(ButtplugDeviceError::UnhandledCommand( 1011 1011 - "Command not implemented for this protocol: SensorReadCmd".to_string(), 1012 1012 - ))) 1013 1013 - .boxed() 1014 1014 - } 1015 1015 - 1016 1016 - fn event_stream( 1017 1017 - &self, 1018 1018 - ) -> Pin<Box<dyn tokio_stream::Stream<Item = ButtplugServerDeviceMessage> + Send>> { 1019 1019 - tokio_stream::empty().boxed() 1020 1020 - } 1021 1021 - } 1022 1022 - 1023 1023 - #[macro_export] 1024 1024 - macro_rules! generic_protocol_setup { 1025 1025 - ( $protocol_name:ident, $protocol_identifier:tt) => { 1026 1026 - paste::paste! { 1027 1027 - pub mod setup { 1028 1028 - use std::sync::Arc; 1029 1029 - use $crate::device::protocol::{ 1030 1030 - GenericProtocolIdentifier, ProtocolIdentifier, ProtocolIdentifierFactory, 1031 1031 - }; 1032 1032 - #[derive(Default)] 1033 1033 - pub struct [< $protocol_name IdentifierFactory >] {} 1034 1034 - 1035 1035 - impl ProtocolIdentifierFactory for [< $protocol_name IdentifierFactory >] { 1036 1036 - fn identifier(&self) -> &str { 1037 1037 - $protocol_identifier 1038 1038 - } 1039 1039 - 1040 1040 - fn create(&self) -> Box<dyn ProtocolIdentifier> { 1041 1041 - Box::new(GenericProtocolIdentifier::new( 1042 1042 - Arc::new(super::$protocol_name::default()), 1043 1043 - self.identifier(), 1044 1044 - )) 1045 1045 - } 1046 1046 - } 1047 1047 - } 1048 1048 - } 1049 1049 - }; 1050 1050 - } 1051 1051 - 1052 1052 - #[macro_export] 1053 1053 - macro_rules! generic_protocol_initializer_setup { 1054 1054 - ( $protocol_name:ident, $protocol_identifier:tt) => { 1055 1055 - paste::paste! { 1056 1056 - pub mod setup { 1057 1057 - use $crate::device::protocol::{ProtocolIdentifier, ProtocolIdentifierFactory}; 1058 1058 - #[derive(Default)] 1059 1059 - pub struct [< $protocol_name IdentifierFactory >] {} 1060 1060 - 1061 1061 - impl ProtocolIdentifierFactory for [< $protocol_name IdentifierFactory >] { 1062 1062 - fn identifier(&self) -> &str { 1063 1063 - $protocol_identifier 1064 1064 - } 1065 1065 - 1066 1066 - fn create(&self) -> Box<dyn ProtocolIdentifier> { 1067 1067 - Box::new(super::[< $protocol_name Identifier >]::default()) 1068 1068 - } 1069 1069 - } 1070 1070 - } 1071 1071 - 1072 1072 - #[derive(Default)] 1073 1073 - pub struct [< $protocol_name Identifier >] {} 1074 1074 - 1075 1075 - #[async_trait] 1076 1076 - impl ProtocolIdentifier for [< $protocol_name Identifier >] { 1077 1077 - async fn identify( 1078 1078 - &mut self, 1079 1079 - hardware: Arc<Hardware>, 1080 1080 - _: ProtocolCommunicationSpecifier, 1081 1081 - ) -> Result<(UserDeviceIdentifier, Box<dyn ProtocolInitializer>), ButtplugDeviceError> { 1082 1082 - Ok((UserDeviceIdentifier::new(hardware.address(), $protocol_identifier, &Some(hardware.name().to_owned())), Box::new([< $protocol_name Initializer >]::default()))) 1083 1083 - } 1084 1084 - } 1085 1085 - } 1086 1086 - }; 1087 1087 - } 1088 1088 - 1089 1089 - pub use generic_protocol_initializer_setup; 1090 1090 - pub use generic_protocol_setup; 1091 1091 - 1092 1092 - use super::hardware::HardwareWriteCmd;

crates/buttplug_server/src/device/protocol/monsterpub.rs crates/buttplug_server/src/device/protocol_impl/monsterpub.rs

crates/buttplug_server/src/device/protocol/motorbunny.rs crates/buttplug_server/src/device/protocol_impl/motorbunny.rs

crates/buttplug_server/src/device/protocol/mysteryvibe.rs crates/buttplug_server/src/device/protocol_impl/mysteryvibe.rs

crates/buttplug_server/src/device/protocol/mysteryvibe_v2.rs crates/buttplug_server/src/device/protocol_impl/mysteryvibe_v2.rs

crates/buttplug_server/src/device/protocol/nextlevelracing.rs crates/buttplug_server/src/device/protocol_impl/nextlevelracing.rs

crates/buttplug_server/src/device/protocol/nexus_revo.rs crates/buttplug_server/src/device/protocol_impl/nexus_revo.rs

crates/buttplug_server/src/device/protocol/nintendo_joycon.rs crates/buttplug_server/src/device/protocol_impl/nintendo_joycon.rs

crates/buttplug_server/src/device/protocol/nobra.rs crates/buttplug_server/src/device/protocol_impl/nobra.rs

crates/buttplug_server/src/device/protocol/omobo.rs crates/buttplug_server/src/device/protocol_impl/omobo.rs

crates/buttplug_server/src/device/protocol/patoo.rs crates/buttplug_server/src/device/protocol_impl/patoo.rs

crates/buttplug_server/src/device/protocol/picobong.rs crates/buttplug_server/src/device/protocol_impl/picobong.rs

crates/buttplug_server/src/device/protocol/pink_punch.rs crates/buttplug_server/src/device/protocol_impl/pink_punch.rs

crates/buttplug_server/src/device/protocol/prettylove.rs crates/buttplug_server/src/device/protocol_impl/prettylove.rs

crates/buttplug_server/src/device/protocol/raw_protocol.rs crates/buttplug_server/src/device/protocol_impl/raw_protocol.rs

crates/buttplug_server/src/device/protocol/realov.rs crates/buttplug_server/src/device/protocol_impl/realov.rs

crates/buttplug_server/src/device/protocol/sakuraneko.rs crates/buttplug_server/src/device/protocol_impl/sakuraneko.rs

crates/buttplug_server/src/device/protocol/satisfyer.rs crates/buttplug_server/src/device/protocol_impl/satisfyer.rs

crates/buttplug_server/src/device/protocol/sensee.rs crates/buttplug_server/src/device/protocol_impl/sensee.rs

crates/buttplug_server/src/device/protocol/sensee_capsule.rs crates/buttplug_server/src/device/protocol_impl/sensee_capsule.rs

crates/buttplug_server/src/device/protocol/sensee_v2.rs crates/buttplug_server/src/device/protocol_impl/sensee_v2.rs

crates/buttplug_server/src/device/protocol/serveu.rs crates/buttplug_server/src/device/protocol_impl/serveu.rs

crates/buttplug_server/src/device/protocol/sexverse_lg389.rs crates/buttplug_server/src/device/protocol_impl/sexverse_lg389.rs

crates/buttplug_server/src/device/protocol/svakom/mod.rs crates/buttplug_server/src/device/protocol_impl/svakom/mod.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_alex.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_alex.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_alex_v2.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_alex_v2.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_avaneo.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_avaneo.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_barnard.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_barnard.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_barney.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_barney.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_dice.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_dice.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_dt250a.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_dt250a.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_iker.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_iker.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_jordan.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_jordan.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_pulse.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_pulse.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_sam.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_sam.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_sam2.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_sam2.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_suitcase.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_suitcase.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_tarax.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_tarax.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_v1.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_v1.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_v2.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_v2.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_v3.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_v3.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_v4.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_v4.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_v5.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_v5.rs

crates/buttplug_server/src/device/protocol/svakom/svakom_v6.rs crates/buttplug_server/src/device/protocol_impl/svakom/svakom_v6.rs

crates/buttplug_server/src/device/protocol/synchro.rs crates/buttplug_server/src/device/protocol_impl/synchro.rs

crates/buttplug_server/src/device/protocol/tcode_v03.rs crates/buttplug_server/src/device/protocol_impl/tcode_v03.rs

crates/buttplug_server/src/device/protocol/thehandy/handyplug.proto crates/buttplug_server/src/device/protocol_impl/thehandy/handyplug.proto

crates/buttplug_server/src/device/protocol/thehandy/handyplug.rs crates/buttplug_server/src/device/protocol_impl/thehandy/handyplug.rs

crates/buttplug_server/src/device/protocol/thehandy/mod.rs crates/buttplug_server/src/device/protocol_impl/thehandy/mod.rs

crates/buttplug_server/src/device/protocol/thehandy/protocomm.proto crates/buttplug_server/src/device/protocol_impl/thehandy/protocomm.proto

crates/buttplug_server/src/device/protocol/thehandy/protocomm.rs crates/buttplug_server/src/device/protocol_impl/thehandy/protocomm.rs

crates/buttplug_server/src/device/protocol/tryfun.rs crates/buttplug_server/src/device/protocol_impl/tryfun.rs

crates/buttplug_server/src/device/protocol/tryfun_blackhole.rs crates/buttplug_server/src/device/protocol_impl/tryfun_blackhole.rs

crates/buttplug_server/src/device/protocol/tryfun_meta2.rs crates/buttplug_server/src/device/protocol_impl/tryfun_meta2.rs

crates/buttplug_server/src/device/protocol/vibcrafter.rs crates/buttplug_server/src/device/protocol_impl/vibcrafter.rs

crates/buttplug_server/src/device/protocol/vibratissimo.rs crates/buttplug_server/src/device/protocol_impl/vibratissimo.rs

crates/buttplug_server/src/device/protocol/vorze_sa/dual_rotator.rs crates/buttplug_server/src/device/protocol_impl/vorze_sa/dual_rotator.rs

crates/buttplug_server/src/device/protocol/vorze_sa/mod.rs crates/buttplug_server/src/device/protocol_impl/vorze_sa/mod.rs

crates/buttplug_server/src/device/protocol/vorze_sa/piston.rs crates/buttplug_server/src/device/protocol_impl/vorze_sa/piston.rs

crates/buttplug_server/src/device/protocol/vorze_sa/single_rotator.rs crates/buttplug_server/src/device/protocol_impl/vorze_sa/single_rotator.rs

crates/buttplug_server/src/device/protocol/vorze_sa/vibrator.rs crates/buttplug_server/src/device/protocol_impl/vorze_sa/vibrator.rs

crates/buttplug_server/src/device/protocol/wetoy.rs crates/buttplug_server/src/device/protocol_impl/wetoy.rs

crates/buttplug_server/src/device/protocol/wevibe.rs crates/buttplug_server/src/device/protocol_impl/wevibe.rs

crates/buttplug_server/src/device/protocol/wevibe8bit.rs crates/buttplug_server/src/device/protocol_impl/wevibe8bit.rs

crates/buttplug_server/src/device/protocol/wevibe_chorus.rs crates/buttplug_server/src/device/protocol_impl/wevibe_chorus.rs

crates/buttplug_server/src/device/protocol/xibao.rs crates/buttplug_server/src/device/protocol_impl/xibao.rs

crates/buttplug_server/src/device/protocol/xinput.rs crates/buttplug_server/src/device/protocol_impl/xinput.rs

crates/buttplug_server/src/device/protocol/xiuxiuda.rs crates/buttplug_server/src/device/protocol_impl/xiuxiuda.rs

crates/buttplug_server/src/device/protocol/xuanhuan.rs crates/buttplug_server/src/device/protocol_impl/xuanhuan.rs

crates/buttplug_server/src/device/protocol/youcups.rs crates/buttplug_server/src/device/protocol_impl/youcups.rs

crates/buttplug_server/src/device/protocol/youou.rs crates/buttplug_server/src/device/protocol_impl/youou.rs

crates/buttplug_server/src/device/protocol/zalo.rs crates/buttplug_server/src/device/protocol_impl/zalo.rs

+572

crates/buttplug_server/src/device/protocol_impl/mod.rs

··· 1 1 + use std::{collections::HashMap, sync::Arc}; 2 2 + 3 3 + use crate::device::protocol::ProtocolIdentifierFactory; 4 4 + 5 5 + 6 6 + // Utility mods 7 7 + pub mod fleshlight_launch_helper; 8 8 + 9 9 + // Since users can pick and choose protocols, we need all of these to be public. 10 10 + pub mod activejoy; 11 11 + pub mod adrienlastic; 12 12 + pub mod amorelie_joy; 13 13 + pub mod aneros; 14 14 + pub mod ankni; 15 15 + pub mod bananasome; 16 16 + pub mod cachito; 17 17 + pub mod cowgirl; 18 18 + pub mod cowgirl_cone; 19 19 + pub mod cupido; 20 20 + pub mod deepsire; 21 21 + pub mod feelingso; 22 22 + pub mod fleshy_thrust; 23 23 + pub mod foreo; 24 24 + pub mod fox; 25 25 + pub mod fredorch; 26 26 + pub mod fredorch_rotary; 27 27 + pub mod galaku; 28 28 + pub mod galaku_pump; 29 29 + pub mod hgod; 30 30 + pub mod hismith; 31 31 + pub mod hismith_mini; 32 32 + pub mod htk_bm; 33 33 + pub mod itoys; 34 34 + pub mod jejoue; 35 35 + // pub mod joyhub; 36 36 + // pub mod joyhub_v2; 37 37 + pub mod joyhub_v3; 38 38 + // pub mod joyhub_v4; 39 39 + // pub mod joyhub_v5; 40 40 + // pub mod joyhub_v6; 41 41 + pub mod kgoal_boost; 42 42 + pub mod kiiroo_prowand; 43 43 + pub mod kiiroo_spot; 44 44 + pub mod kiiroo_v2; 45 45 + pub mod kiiroo_v21; 46 46 + pub mod kiiroo_v21_initialized; 47 47 + pub mod kiiroo_v2_vibrator; 48 48 + pub mod kizuna; 49 49 + pub mod lelo_harmony; 50 50 + pub mod lelof1s; 51 51 + pub mod lelof1sv2; 52 52 + pub mod leten; 53 53 + pub mod libo_elle; 54 54 + pub mod libo_shark; 55 55 + pub mod libo_vibes; 56 56 + pub mod lioness; 57 57 + pub mod loob; 58 58 + pub mod lovedistance; 59 59 + pub mod lovehoney_desire; 60 60 + pub mod lovense; 61 61 + // pub mod lovense_connect_service; 62 62 + pub mod lovenuts; 63 63 + pub mod luvmazer; 64 64 + pub mod magic_motion_v1; 65 65 + pub mod magic_motion_v2; 66 66 + pub mod magic_motion_v3; 67 67 + pub mod magic_motion_v4; 68 68 + pub mod mannuo; 69 69 + pub mod maxpro; 70 70 + pub mod meese; 71 71 + pub mod metaxsire; 72 72 + pub mod metaxsire_v2; 73 73 + pub mod metaxsire_v3; 74 74 + mod metaxsire_v4; 75 75 + pub mod mizzzee; 76 76 + pub mod mizzzee_v2; 77 77 + pub mod mizzzee_v3; 78 78 + pub mod monsterpub; 79 79 + pub mod motorbunny; 80 80 + pub mod mysteryvibe; 81 81 + pub mod mysteryvibe_v2; 82 82 + pub mod nextlevelracing; 83 83 + pub mod nexus_revo; 84 84 + pub mod nintendo_joycon; 85 85 + pub mod nobra; 86 86 + pub mod omobo; 87 87 + pub mod patoo; 88 88 + pub mod picobong; 89 89 + pub mod pink_punch; 90 90 + pub mod prettylove; 91 91 + pub mod raw_protocol; 92 92 + pub mod realov; 93 93 + pub mod sakuraneko; 94 94 + pub mod satisfyer; 95 95 + pub mod sensee; 96 96 + pub mod sensee_capsule; 97 97 + pub mod sensee_v2; 98 98 + pub mod serveu; 99 99 + pub mod sexverse_lg389; 100 100 + pub mod svakom; 101 101 + pub mod synchro; 102 102 + pub mod tcode_v03; 103 103 + pub mod thehandy; 104 104 + pub mod tryfun; 105 105 + pub mod tryfun_blackhole; 106 106 + pub mod tryfun_meta2; 107 107 + pub mod vibcrafter; 108 108 + pub mod vibratissimo; 109 109 + pub mod vorze_sa; 110 110 + pub mod wetoy; 111 111 + pub mod wevibe; 112 112 + pub mod wevibe8bit; 113 113 + pub mod wevibe_chorus; 114 114 + pub mod xibao; 115 115 + pub mod xinput; 116 116 + pub mod xiuxiuda; 117 117 + pub mod xuanhuan; 118 118 + pub mod youcups; 119 119 + pub mod youou; 120 120 + pub mod zalo; 121 121 + 122 122 + pub fn get_default_protocol_map() -> HashMap<String, Arc<dyn ProtocolIdentifierFactory>> { 123 123 + let mut map = HashMap::new(); 124 124 + fn add_to_protocol_map<T>( 125 125 + map: &mut HashMap<String, Arc<dyn ProtocolIdentifierFactory>>, 126 126 + factory: T, 127 127 + ) where 128 128 + T: ProtocolIdentifierFactory + 'static, 129 129 + { 130 130 + let factory = Arc::new(factory); 131 131 + map.insert(factory.identifier().to_owned(), factory); 132 132 + } 133 133 + 134 134 + add_to_protocol_map( 135 135 + &mut map, 136 136 + activejoy::setup::ActiveJoyIdentifierFactory::default(), 137 137 + ); 138 138 + add_to_protocol_map( 139 139 + &mut map, 140 140 + adrienlastic::setup::AdrienLasticIdentifierFactory::default(), 141 141 + ); 142 142 + add_to_protocol_map( 143 143 + &mut map, 144 144 + amorelie_joy::setup::AmorelieJoyIdentifierFactory::default(), 145 145 + ); 146 146 + add_to_protocol_map(&mut map, aneros::setup::AnerosIdentifierFactory::default()); 147 147 + add_to_protocol_map(&mut map, ankni::setup::AnkniIdentifierFactory::default()); 148 148 + add_to_protocol_map( 149 149 + &mut map, 150 150 + bananasome::setup::BananasomeIdentifierFactory::default(), 151 151 + ); 152 152 + add_to_protocol_map( 153 153 + &mut map, 154 154 + cachito::setup::CachitoIdentifierFactory::default(), 155 155 + ); 156 156 + add_to_protocol_map( 157 157 + &mut map, 158 158 + cowgirl::setup::CowgirlIdentifierFactory::default(), 159 159 + ); 160 160 + add_to_protocol_map( 161 161 + &mut map, 162 162 + cowgirl_cone::setup::CowgirlConeIdentifierFactory::default(), 163 163 + ); 164 164 + add_to_protocol_map(&mut map, cupido::setup::CupidoIdentifierFactory::default()); 165 165 + add_to_protocol_map( 166 166 + &mut map, 167 167 + deepsire::setup::DeepSireIdentifierFactory::default(), 168 168 + ); 169 169 + add_to_protocol_map( 170 170 + &mut map, 171 171 + lovense::setup::LovenseIdentifierFactory::default(), 172 172 + ); 173 173 + add_to_protocol_map( 174 174 + &mut map, 175 175 + hismith::setup::HismithIdentifierFactory::default(), 176 176 + ); 177 177 + add_to_protocol_map( 178 178 + &mut map, 179 179 + hismith_mini::setup::HismithMiniIdentifierFactory::default(), 180 180 + ); 181 181 + add_to_protocol_map(&mut map, htk_bm::setup::HtkBmIdentifierFactory::default()); 182 182 + add_to_protocol_map( 183 183 + &mut map, 184 184 + thehandy::setup::TheHandyIdentifierFactory::default(), 185 185 + ); 186 186 + 187 187 + add_to_protocol_map( 188 188 + &mut map, 189 189 + feelingso::setup::FeelingSoIdentifierFactory::default(), 190 190 + ); 191 191 + add_to_protocol_map( 192 192 + &mut map, 193 193 + fleshy_thrust::setup::FleshyThrustIdentifierFactory::default(), 194 194 + ); 195 195 + add_to_protocol_map(&mut map, foreo::setup::ForeoIdentifierFactory::default()); 196 196 + add_to_protocol_map(&mut map, fox::setup::FoxIdentifierFactory::default()); 197 197 + add_to_protocol_map( 198 198 + &mut map, 199 199 + fredorch::setup::FredorchIdentifierFactory::default(), 200 200 + ); 201 201 + add_to_protocol_map( 202 202 + &mut map, 203 203 + fredorch_rotary::setup::FredorchRotaryIdentifierFactory::default(), 204 204 + ); 205 205 + 206 206 + add_to_protocol_map(&mut map, hgod::setup::HgodIdentifierFactory::default()); 207 207 + 208 208 + add_to_protocol_map( 209 209 + &mut map, 210 210 + galaku_pump::setup::GalakuPumpIdentifierFactory::default(), 211 211 + ); 212 212 + 213 213 + add_to_protocol_map(&mut map, galaku::setup::GalakuIdentifierFactory::default()); 214 214 + 215 215 + add_to_protocol_map(&mut map, itoys::setup::IToysIdentifierFactory::default()); 216 216 + add_to_protocol_map(&mut map, jejoue::setup::JeJoueIdentifierFactory::default()); 217 217 + // add_to_protocol_map(&mut map, joyhub::setup::JoyHubIdentifierFactory::default()); 218 218 + // add_to_protocol_map( 219 219 + // &mut map, 220 220 + // joyhub_v2::setup::JoyHubV2IdentifierFactory::default(), 221 221 + // ); 222 222 + 223 223 + add_to_protocol_map( 224 224 + &mut map, 225 225 + joyhub_v3::setup::JoyHubV3IdentifierFactory::default(), 226 226 + ); 227 227 + 228 228 + // add_to_protocol_map( 229 229 + // &mut map, 230 230 + // joyhub_v4::setup::JoyHubV4IdentifierFactory::default(), 231 231 + // ); 232 232 + // add_to_protocol_map( 233 233 + // &mut map, 234 234 + // joyhub_v5::setup::JoyHubV5IdentifierFactory::default(), 235 235 + // ); 236 236 + // add_to_protocol_map( 237 237 + // &mut map, 238 238 + // joyhub_v6::setup::JoyHubV6IdentifierFactory::default(), 239 239 + // ); 240 240 + add_to_protocol_map( 241 241 + &mut map, 242 242 + kiiroo_prowand::setup::KiirooProWandIdentifierFactory::default(), 243 243 + ); 244 244 + add_to_protocol_map( 245 245 + &mut map, 246 246 + kiiroo_spot::setup::KiirooSpotIdentifierFactory::default(), 247 247 + ); 248 248 + add_to_protocol_map( 249 249 + &mut map, 250 250 + kiiroo_v2::setup::KiirooV2IdentifierFactory::default(), 251 251 + ); 252 252 + add_to_protocol_map( 253 253 + &mut map, 254 254 + kiiroo_v2_vibrator::setup::KiirooV2VibratorIdentifierFactory::default(), 255 255 + ); 256 256 + add_to_protocol_map( 257 257 + &mut map, 258 258 + kiiroo_v21::setup::KiirooV21IdentifierFactory::default(), 259 259 + ); 260 260 + add_to_protocol_map( 261 261 + &mut map, 262 262 + kiiroo_v21_initialized::setup::KiirooV21InitializedIdentifierFactory::default(), 263 263 + ); 264 264 + add_to_protocol_map(&mut map, kizuna::setup::KizunaIdentifierFactory::default()); 265 265 + add_to_protocol_map( 266 266 + &mut map, 267 267 + lelof1s::setup::LeloF1sIdentifierFactory::default(), 268 268 + ); 269 269 + add_to_protocol_map( 270 270 + &mut map, 271 271 + lelof1sv2::setup::LeloF1sV2IdentifierFactory::default(), 272 272 + ); 273 273 + add_to_protocol_map(&mut map, leten::setup::LetenIdentifierFactory::default()); 274 274 + add_to_protocol_map( 275 275 + &mut map, 276 276 + lelo_harmony::setup::LeloHarmonyIdentifierFactory::default(), 277 277 + ); 278 278 + add_to_protocol_map( 279 279 + &mut map, 280 280 + libo_elle::setup::LiboElleIdentifierFactory::default(), 281 281 + ); 282 282 + add_to_protocol_map( 283 283 + &mut map, 284 284 + libo_shark::setup::LiboSharkIdentifierFactory::default(), 285 285 + ); 286 286 + add_to_protocol_map( 287 287 + &mut map, 288 288 + libo_vibes::setup::LiboVibesIdentifierFactory::default(), 289 289 + ); 290 290 + add_to_protocol_map( 291 291 + &mut map, 292 292 + lioness::setup::LionessIdentifierFactory::default(), 293 293 + ); 294 294 + add_to_protocol_map(&mut map, loob::setup::LoobIdentifierFactory::default()); 295 295 + add_to_protocol_map( 296 296 + &mut map, 297 297 + lovehoney_desire::setup::LovehoneyDesireIdentifierFactory::default(), 298 298 + ); 299 299 + add_to_protocol_map( 300 300 + &mut map, 301 301 + lovedistance::setup::LoveDistanceIdentifierFactory::default(), 302 302 + ); 303 303 + // add_to_protocol_map( 304 304 + // &mut map, 305 305 + // lovense_connect_service::setup::LovenseConnectServiceIdentifierFactory::default(), 306 306 + // ); 307 307 + add_to_protocol_map( 308 308 + &mut map, 309 309 + lovenuts::setup::LoveNutsIdentifierFactory::default(), 310 310 + ); 311 311 + add_to_protocol_map( 312 312 + &mut map, 313 313 + luvmazer::setup::LuvmazerIdentifierFactory::default(), 314 314 + ); 315 315 + add_to_protocol_map( 316 316 + &mut map, 317 317 + magic_motion_v1::setup::MagicMotionV1IdentifierFactory::default(), 318 318 + ); 319 319 + add_to_protocol_map( 320 320 + &mut map, 321 321 + magic_motion_v2::setup::MagicMotionV2IdentifierFactory::default(), 322 322 + ); 323 323 + add_to_protocol_map( 324 324 + &mut map, 325 325 + magic_motion_v3::setup::MagicMotionV3IdentifierFactory::default(), 326 326 + ); 327 327 + add_to_protocol_map( 328 328 + &mut map, 329 329 + magic_motion_v4::setup::MagicMotionV4IdentifierFactory::default(), 330 330 + ); 331 331 + add_to_protocol_map(&mut map, mannuo::setup::ManNuoIdentifierFactory::default()); 332 332 + add_to_protocol_map(&mut map, maxpro::setup::MaxproIdentifierFactory::default()); 333 333 + add_to_protocol_map(&mut map, meese::setup::MeeseIdentifierFactory::default()); 334 334 + add_to_protocol_map( 335 335 + &mut map, 336 336 + metaxsire::setup::MetaXSireIdentifierFactory::default(), 337 337 + ); 338 338 + add_to_protocol_map( 339 339 + &mut map, 340 340 + metaxsire_v2::setup::MetaXSireV2IdentifierFactory::default(), 341 341 + ); 342 342 + add_to_protocol_map( 343 343 + &mut map, 344 344 + metaxsire_v3::setup::MetaXSireV3IdentifierFactory::default(), 345 345 + ); 346 346 + add_to_protocol_map( 347 347 + &mut map, 348 348 + metaxsire_v4::setup::MetaXSireV4IdentifierFactory::default(), 349 349 + ); 350 350 + add_to_protocol_map( 351 351 + &mut map, 352 352 + mizzzee::setup::MizzZeeIdentifierFactory::default(), 353 353 + ); 354 354 + add_to_protocol_map( 355 355 + &mut map, 356 356 + mizzzee_v2::setup::MizzZeeV2IdentifierFactory::default(), 357 357 + ); 358 358 + add_to_protocol_map( 359 359 + &mut map, 360 360 + mizzzee_v3::setup::MizzZeeV3IdentifierFactory::default(), 361 361 + ); 362 362 + add_to_protocol_map( 363 363 + &mut map, 364 364 + monsterpub::setup::MonsterPubIdentifierFactory::default(), 365 365 + ); 366 366 + add_to_protocol_map( 367 367 + &mut map, 368 368 + motorbunny::setup::MotorbunnyIdentifierFactory::default(), 369 369 + ); 370 370 + add_to_protocol_map( 371 371 + &mut map, 372 372 + mysteryvibe::setup::MysteryVibeIdentifierFactory::default(), 373 373 + ); 374 374 + add_to_protocol_map( 375 375 + &mut map, 376 376 + mysteryvibe_v2::setup::MysteryVibeV2IdentifierFactory::default(), 377 377 + ); 378 378 + add_to_protocol_map( 379 379 + &mut map, 380 380 + nexus_revo::setup::NexusRevoIdentifierFactory::default(), 381 381 + ); 382 382 + add_to_protocol_map( 383 383 + &mut map, 384 384 + nextlevelracing::setup::NextLevelRacingIdentifierFactory::default(), 385 385 + ); 386 386 + add_to_protocol_map( 387 387 + &mut map, 388 388 + nintendo_joycon::setup::NintendoJoyconIdentifierFactory::default(), 389 389 + ); 390 390 + add_to_protocol_map(&mut map, nobra::setup::NobraIdentifierFactory::default()); 391 391 + add_to_protocol_map(&mut map, omobo::setup::OmoboIdentifierFactory::default()); 392 392 + add_to_protocol_map(&mut map, patoo::setup::PatooIdentifierFactory::default()); 393 393 + add_to_protocol_map( 394 394 + &mut map, 395 395 + picobong::setup::PicobongIdentifierFactory::default(), 396 396 + ); 397 397 + add_to_protocol_map( 398 398 + &mut map, 399 399 + pink_punch::setup::PinkPunchIdentifierFactory::default(), 400 400 + ); 401 401 + add_to_protocol_map( 402 402 + &mut map, 403 403 + prettylove::setup::PrettyLoveIdentifierFactory::default(), 404 404 + ); 405 405 + add_to_protocol_map( 406 406 + &mut map, 407 407 + raw_protocol::setup::RawProtocolIdentifierFactory::default(), 408 408 + ); 409 409 + add_to_protocol_map(&mut map, realov::setup::RealovIdentifierFactory::default()); 410 410 + add_to_protocol_map( 411 411 + &mut map, 412 412 + sakuraneko::setup::SakuranekoIdentifierFactory::default(), 413 413 + ); 414 414 + add_to_protocol_map( 415 415 + &mut map, 416 416 + satisfyer::setup::SatisfyerIdentifierFactory::default(), 417 417 + ); 418 418 + add_to_protocol_map(&mut map, sensee::setup::SenseeIdentifierFactory::default()); 419 419 + add_to_protocol_map( 420 420 + &mut map, 421 421 + sensee_capsule::setup::SenseeCapsuleIdentifierFactory::default(), 422 422 + ); 423 423 + add_to_protocol_map( 424 424 + &mut map, 425 425 + sensee_v2::setup::SenseeV2IdentifierFactory::default(), 426 426 + ); 427 427 + add_to_protocol_map( 428 428 + &mut map, 429 429 + sexverse_lg389::setup::SexverseLG389IdentifierFactory::default(), 430 430 + ); 431 431 + add_to_protocol_map(&mut map, serveu::setup::ServeUIdentifierFactory::default()); 432 432 + //add_to_protocol_map( 433 433 + // &mut map, 434 434 + // svakom::svakom_avaneo::setup::SvakomAvaNeoIdentifierFactory::default(), 435 435 + //); 436 436 + add_to_protocol_map( 437 437 + &mut map, 438 438 + svakom::svakom_alex::setup::SvakomAlexIdentifierFactory::default(), 439 439 + ); 440 440 + add_to_protocol_map( 441 441 + &mut map, 442 442 + svakom::svakom_alex_v2::setup::SvakomAlexV2IdentifierFactory::default(), 443 443 + ); 444 444 + add_to_protocol_map( 445 445 + &mut map, 446 446 + svakom::svakom_barnard::setup::SvakomBarnardIdentifierFactory::default(), 447 447 + ); 448 448 + add_to_protocol_map( 449 449 + &mut map, 450 450 + svakom::svakom_barney::setup::SvakomBarneyIdentifierFactory::default(), 451 451 + ); 452 452 + add_to_protocol_map( 453 453 + &mut map, 454 454 + svakom::svakom_dice::setup::SvakomDiceIdentifierFactory::default(), 455 455 + ); 456 456 + //add_to_protocol_map( 457 457 + // &mut map, 458 458 + // svakom::svakom_dt250a::setup::SvakomDT250AIdentifierFactory::default(), 459 459 + //); 460 460 + add_to_protocol_map( 461 461 + &mut map, 462 462 + svakom::svakom_iker::setup::SvakomIkerIdentifierFactory::default(), 463 463 + ); 464 464 + add_to_protocol_map( 465 465 + &mut map, 466 466 + svakom::svakom_jordan::setup::SvakomJordanIdentifierFactory::default(), 467 467 + ); 468 468 + add_to_protocol_map( 469 469 + &mut map, 470 470 + svakom::svakom_pulse::setup::SvakomPulseIdentifierFactory::default(), 471 471 + ); 472 472 + add_to_protocol_map( 473 473 + &mut map, 474 474 + svakom::svakom_sam::setup::SvakomSamIdentifierFactory::default(), 475 475 + ); 476 476 + add_to_protocol_map( 477 477 + &mut map, 478 478 + svakom::svakom_sam2::setup::SvakomSam2IdentifierFactory::default(), 479 479 + ); 480 480 + //add_to_protocol_map( 481 481 + // &mut map, 482 482 + // svakom::svakom_suitcase::setup::SvakomSuitcaseIdentifierFactory::default(), 483 483 + //); 484 484 + //add_to_protocol_map( 485 485 + // &mut map, 486 486 + // svakom::svakom_tarax::setup::SvakomTaraXIdentifierFactory::default(), 487 487 + //); 488 488 + add_to_protocol_map( 489 489 + &mut map, 490 490 + svakom::svakom_v1::setup::SvakomV1IdentifierFactory::default(), 491 491 + ); 492 492 + add_to_protocol_map( 493 493 + &mut map, 494 494 + svakom::svakom_v2::setup::SvakomV2IdentifierFactory::default(), 495 495 + ); 496 496 + add_to_protocol_map( 497 497 + &mut map, 498 498 + svakom::svakom_v3::setup::SvakomV3IdentifierFactory::default(), 499 499 + ); 500 500 + add_to_protocol_map( 501 501 + &mut map, 502 502 + svakom::svakom_v4::setup::SvakomV4IdentifierFactory::default(), 503 503 + ); 504 504 + add_to_protocol_map( 505 505 + &mut map, 506 506 + svakom::svakom_v5::setup::SvakomV5IdentifierFactory::default(), 507 507 + ); 508 508 + add_to_protocol_map( 509 509 + &mut map, 510 510 + svakom::svakom_v6::setup::SvakomV6IdentifierFactory::default(), 511 511 + ); 512 512 + add_to_protocol_map( 513 513 + &mut map, 514 514 + synchro::setup::SynchroIdentifierFactory::default(), 515 515 + ); 516 516 + add_to_protocol_map(&mut map, tryfun::setup::TryFunIdentifierFactory::default()); 517 517 + add_to_protocol_map( 518 518 + &mut map, 519 519 + tryfun_blackhole::setup::TryFunBlackHoleIdentifierFactory::default(), 520 520 + ); 521 521 + add_to_protocol_map( 522 522 + &mut map, 523 523 + tryfun_meta2::setup::TryFunMeta2IdentifierFactory::default(), 524 524 + ); 525 525 + add_to_protocol_map( 526 526 + &mut map, 527 527 + tcode_v03::setup::TCodeV03IdentifierFactory::default(), 528 528 + ); 529 529 + add_to_protocol_map( 530 530 + &mut map, 531 531 + vibcrafter::setup::VibCrafterIdentifierFactory::default(), 532 532 + ); 533 533 + add_to_protocol_map( 534 534 + &mut map, 535 535 + vibratissimo::setup::VibratissimoIdentifierFactory::default(), 536 536 + ); 537 537 + add_to_protocol_map( 538 538 + &mut map, 539 539 + vorze_sa::setup::VorzeSAIdentifierFactory::default(), 540 540 + ); 541 541 + add_to_protocol_map(&mut map, wetoy::setup::WeToyIdentifierFactory::default()); 542 542 + add_to_protocol_map(&mut map, wevibe::setup::WeVibeIdentifierFactory::default()); 543 543 + add_to_protocol_map( 544 544 + &mut map, 545 545 + wevibe8bit::setup::WeVibe8BitIdentifierFactory::default(), 546 546 + ); 547 547 + add_to_protocol_map( 548 548 + &mut map, 549 549 + wevibe_chorus::setup::WeVibeChorusIdentifierFactory::default(), 550 550 + ); 551 551 + add_to_protocol_map(&mut map, xibao::setup::XibaoIdentifierFactory::default()); 552 552 + add_to_protocol_map(&mut map, xinput::setup::XInputIdentifierFactory::default()); 553 553 + add_to_protocol_map( 554 554 + &mut map, 555 555 + xiuxiuda::setup::XiuxiudaIdentifierFactory::default(), 556 556 + ); 557 557 + add_to_protocol_map( 558 558 + &mut map, 559 559 + xuanhuan::setup::XuanhuanIdentifierFactory::default(), 560 560 + ); 561 561 + add_to_protocol_map( 562 562 + &mut map, 563 563 + youcups::setup::YoucupsIdentifierFactory::default(), 564 564 + ); 565 565 + add_to_protocol_map(&mut map, youou::setup::YououIdentifierFactory::default()); 566 566 + add_to_protocol_map(&mut map, zalo::setup::ZaloIdentifierFactory::default()); 567 567 + add_to_protocol_map( 568 568 + &mut map, 569 569 + kgoal_boost::setup::KGoalBoostIdentifierFactory::default(), 570 570 + ); 571 571 + map 572 572 + }