+7 -7

buttplug-schema/schema/buttplug-schema.json

··· 377 377 "Command": { 378 378 "type": "object", 379 379 "patternProperties": { 380 380 - "^(Vibrate|Rotate|Oscillate|Constrict|Inflate|Position|Heater|Led)$": { 380 380 + "^(Vibrate|Rotate|Oscillate|Constrict|Spray|Position|Heater|Led)$": { 381 381 "type": "object", 382 382 "properties": { 383 383 "Value": { ··· 584 584 "description": "Name of the client software.", 585 585 "type": "string" 586 586 }, 587 587 - "ApiVersionMajor": { 587 587 + "ProtocolVersionMajor": { 588 588 "description": "Message template version of the server software.", 589 589 "type": "integer", 590 590 "minimum": 0 591 591 }, 592 592 - "ApiVersionMinor": { 592 592 + "ProtocolVersionMinor": { 593 593 "description": "Message template version of the server software.", 594 594 "type": "integer", 595 595 "minimum": 0 ··· 599 599 "required": [ 600 600 "Id", 601 601 "ClientName", 602 602 - "ApiVersionMajor", 603 603 - "ApiVersionMinor" 602 602 + "ProtocolVersionMajor", 603 603 + "ProtocolVersionMinor" 604 604 ] 605 605 }, 606 606 "ServerInfo": { ··· 612 612 "description": "Name of the server. Can be 0-length.", 613 613 "type": "string" 614 614 }, 615 615 - "ApiVersionMajor": { 615 615 + "ProtocolVersionMajor": { 616 616 "description": "Message template version of the server software.", 617 617 "type": "integer", 618 618 "minimum": 0 619 619 }, 620 620 - "ApiVersionMinor": { 620 620 + "ProtocolVersionMinor": { 621 621 "description": "Message template version of the server software.", 622 622 "type": "integer", 623 623 "minimum": 0

+2 -2

crates/buttplug_client/src/client_device_feature.rs

··· 143 143 self.check_and_set_actuator(OutputCommand::Rotate(OutputValue::new(level))) 144 144 } 145 145 146 146 - pub fn inflate(&self, level: u32) -> ButtplugClientResultFuture { 147 147 - self.check_and_set_actuator(OutputCommand::Inflate(OutputValue::new(level))) 146 146 + pub fn spray(&self, level: u32) -> ButtplugClientResultFuture { 147 147 + self.check_and_set_actuator(OutputCommand::Spray(OutputValue::new(level))) 148 148 } 149 149 150 150 pub fn constrict(&self, level: u32) -> ButtplugClientResultFuture {

+7 -4

crates/buttplug_core/src/message/device_feature.rs

··· 24 24 Rotate, 25 25 Oscillate, 26 26 Constrict, 27 27 - Inflate, 27 27 + Spray, 28 28 Heater, 29 29 Led, 30 30 // For instances where we specify a position to move to ASAP. Usually servos, probably for the ··· 58 58 RotateWithDirection, 59 59 Oscillate, 60 60 Constrict, 61 61 - Inflate, 62 61 Heater, 63 62 Led, 64 63 // For instances where we specify a position to move to ASAP. Usually servos, probably for the 65 64 // OSR-2/SR-6. 66 65 Position, 67 66 PositionWithDuration, 67 67 + // Lube shooters 68 68 + Spray, 69 69 + // Things we might add in the future 70 70 + // Inflate, 68 71 } 69 72 70 73 impl TryFrom<FeatureType> for OutputType { ··· 80 83 FeatureType::PositionWithDuration => Ok(OutputType::PositionWithDuration), 81 84 FeatureType::Oscillate => Ok(OutputType::Oscillate), 82 85 FeatureType::Constrict => Ok(OutputType::Constrict), 83 83 - FeatureType::Inflate => Ok(OutputType::Inflate), 86 86 + FeatureType::Spray => Ok(OutputType::Spray), 84 87 FeatureType::Position => Ok(OutputType::Position), 85 88 _ => Err(format!( 86 89 "Feature type {value} not valid for OutputType conversion" ··· 129 132 OutputType::PositionWithDuration => FeatureType::PositionWithDuration, 130 133 OutputType::Oscillate => FeatureType::Oscillate, 131 134 OutputType::Constrict => FeatureType::Constrict, 132 132 - OutputType::Inflate => FeatureType::Inflate, 135 135 + OutputType::Spray => FeatureType::Spray, 133 136 OutputType::Position => FeatureType::Position, 134 137 } 135 138 }

+5 -5

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

··· 71 71 RotateWithDirection(OutputRotateWithDirection), 72 72 Oscillate(OutputValue), 73 73 Constrict(OutputValue), 74 74 - Inflate(OutputValue), 74 74 + Spray(OutputValue), 75 75 Heater(OutputValue), 76 76 Led(OutputValue), 77 77 // For instances where we specify a position to move to ASAP. Usually servos, probably for the ··· 84 84 pub fn value(&self) -> u32 { 85 85 match self { 86 86 OutputCommand::Constrict(x) 87 87 - | OutputCommand::Inflate(x) 87 87 + | OutputCommand::Spray(x) 88 88 | OutputCommand::Heater(x) 89 89 | OutputCommand::Led(x) 90 90 | OutputCommand::Oscillate(x) ··· 99 99 pub fn set_value(&mut self, value: u32) { 100 100 match self { 101 101 OutputCommand::Constrict(x) 102 102 - | OutputCommand::Inflate(x) 102 102 + | OutputCommand::Spray(x) 103 103 | OutputCommand::Heater(x) 104 104 | OutputCommand::Led(x) 105 105 | OutputCommand::Oscillate(x) ··· 118 118 Self::RotateWithDirection(_) => OutputType::RotateWithDirection, 119 119 Self::Oscillate(_) => OutputType::Oscillate, 120 120 Self::Constrict(_) => OutputType::Constrict, 121 121 - Self::Inflate(_) => OutputType::Inflate, 121 121 + Self::Spray(_) => OutputType::Spray, 122 122 Self::Led(_) => OutputType::Led, 123 123 Self::Position(_) => OutputType::Position, 124 124 Self::PositionWithDuration(_) => OutputType::PositionWithDuration, ··· 130 130 match output_type { 131 131 OutputType::Constrict => Ok(Self::Constrict(OutputValue::new(value))), 132 132 OutputType::Heater => Ok(Self::Heater(OutputValue::new(value))), 133 133 - OutputType::Inflate => Ok(Self::Inflate(OutputValue::new(value))), 133 133 + OutputType::Spray => Ok(Self::Spray(OutputValue::new(value))), 134 134 OutputType::Led => Ok(Self::Led(OutputValue::new(value))), 135 135 OutputType::Oscillate => Ok(Self::Oscillate(OutputValue::new(value))), 136 136 OutputType::Position => Ok(Self::Position(OutputValue::new(value))),

+8 -8

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

··· 36 36 #[serde(rename = "ClientName")] 37 37 #[getset(get = "pub")] 38 38 client_name: String, 39 39 - #[serde(rename = "ApiVersionMajor")] 39 39 + #[serde(rename = "ProtocolVersionMajor")] 40 40 #[getset(get_copy = "pub")] 41 41 - api_version_major: ButtplugMessageSpecVersion, 42 42 - #[serde(rename = "ApiVersionMinor")] 41 41 + protocol_version_major: ButtplugMessageSpecVersion, 42 42 + #[serde(rename = "ProtocolVersionMinor")] 43 43 #[getset(get_copy = "pub")] 44 44 - api_version_minor: u32, 44 44 + protocol_version_minor: u32, 45 45 } 46 46 47 47 impl RequestServerInfoV4 { 48 48 pub fn new( 49 49 client_name: &str, 50 50 - api_version_major: ButtplugMessageSpecVersion, 51 51 - api_version_minor: u32, 50 50 + protocol_version_major: ButtplugMessageSpecVersion, 51 51 + protocol_version_minor: u32, 52 52 ) -> Self { 53 53 Self { 54 54 id: 1, 55 55 client_name: client_name.to_string(), 56 56 - api_version_major, 57 57 - api_version_minor, 56 56 + protocol_version_major, 57 57 + protocol_version_minor, 58 58 } 59 59 } 60 60 }

+8 -8

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

··· 30 30 pub struct ServerInfoV4 { 31 31 #[serde(rename = "Id")] 32 32 id: u32, 33 33 - #[serde(rename = "ApiVersionMajor")] 33 33 + #[serde(rename = "ProtocolVersionMajor")] 34 34 #[getset(get_copy = "pub")] 35 35 - api_version_major: ButtplugMessageSpecVersion, 36 36 - #[serde(rename = "ApiVersionMinor")] 35 35 + protocol_version_major: ButtplugMessageSpecVersion, 36 36 + #[serde(rename = "ProtocolVersionMinor")] 37 37 #[getset(get_copy = "pub")] 38 38 - api_version_minor: u32, 38 38 + protocol_version_minor: u32, 39 39 #[serde(rename = "MaxPingTime")] 40 40 #[getset(get_copy = "pub")] 41 41 max_ping_time: u32, ··· 47 47 impl ServerInfoV4 { 48 48 pub fn new( 49 49 server_name: &str, 50 50 - api_version_major: ButtplugMessageSpecVersion, 51 51 - api_version_minor: u32, 50 50 + protocol_version_major: ButtplugMessageSpecVersion, 51 51 + protocol_version_minor: u32, 52 52 max_ping_time: u32, 53 53 ) -> Self { 54 54 Self { 55 55 id: 1, 56 56 - api_version_major, 57 57 - api_version_minor, 56 56 + protocol_version_major, 57 57 + protocol_version_minor, 58 58 max_ping_time, 59 59 server_name: server_name.to_string(), 60 60 }

+4 -4

crates/buttplug_server/src/device/protocol.rs

··· 226 226 OutputCommand::Constrict(x) => { 227 227 self.handle_output_constrict_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 228 228 } 229 229 - OutputCommand::Inflate(x) => { 230 230 - self.handle_output_inflate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 229 229 + OutputCommand::Spray(x) => { 230 230 + self.handle_output_spray_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) 231 231 } 232 232 OutputCommand::Oscillate(x) => { 233 233 self.handle_output_oscillate_cmd(cmd.feature_index(), cmd.feature_id(), x.value()) ··· 289 289 self.command_unimplemented("OutputCmd (Oscillate Actuator)") 290 290 } 291 291 292 292 - fn handle_output_inflate_cmd( 292 292 + fn handle_output_spray_cmd( 293 293 &self, 294 294 _feature_index: u32, 295 295 _feature_id: Uuid, 296 296 _level: u32, 297 297 ) -> Result<Vec<HardwareCommand>, ButtplugDeviceError> { 298 298 - self.command_unimplemented("OutputCmd (Inflate Actuator)") 298 298 + self.command_unimplemented("OutputCmd (Spray Actuator)") 299 299 } 300 300 301 301 fn handle_output_constrict_cmd(

+2 -2

crates/buttplug_server/src/device/server_device.rs

··· 410 410 stop_cmd(message::OutputCommand::Heater(OutputValue::new(0))); 411 411 break; 412 412 } 413 413 - OutputType::Inflate => { 414 414 - stop_cmd(message::OutputCommand::Inflate(OutputValue::new(0))); 413 413 + OutputType::Spray => { 414 414 + stop_cmd(message::OutputCommand::Spray(OutputValue::new(0))); 415 415 break; 416 416 } 417 417 OutputType::Led => {

+1 -1

crates/buttplug_server/src/message/v2/server_info.rs

··· 70 70 Self { 71 71 id: value.id(), 72 72 server_name: value.server_name().clone(), 73 73 - message_version: value.api_version_major(), 73 73 + message_version: value.protocol_version_major(), 74 74 max_ping_time: value.max_ping_time(), 75 75 } 76 76 }

+6 -6

crates/buttplug_server/src/server.rs

··· 357 357 info!( 358 358 "Performing server handshake check with client {} at message version {}.{}", 359 359 msg.client_name(), 360 360 - msg.api_version_major(), 361 361 - msg.api_version_minor() 360 360 + msg.protocol_version_major(), 361 361 + msg.protocol_version_minor() 362 362 ); 363 363 364 364 - if BUTTPLUG_CURRENT_API_MAJOR_VERSION < msg.api_version_major() { 364 364 + if BUTTPLUG_CURRENT_API_MAJOR_VERSION < msg.protocol_version_major() { 365 365 return ButtplugHandshakeError::MessageSpecVersionMismatch( 366 366 BUTTPLUG_CURRENT_API_MAJOR_VERSION, 367 367 - msg.api_version_major(), 367 367 + msg.protocol_version_major(), 368 368 ) 369 369 .into(); 370 370 } ··· 374 374 375 375 // Due to programming/spec errors in prior versions of the protocol, anything before v4 expected 376 376 // that it would be back a matching api version of the server. The correct response is to send back whatever the 377 377 - let output_version = if (msg.api_version_major() as u32) < 4 { 378 378 - msg.api_version_major() 377 377 + let output_version = if (msg.protocol_version_major() as u32) < 4 { 378 378 + msg.protocol_version_major() 379 379 } else { 380 380 BUTTPLUG_CURRENT_API_MAJOR_VERSION 381 381 };

+3 -3

crates/buttplug_server_device_config/device-config-v4/buttplug-device-config-schema-v4.json

··· 185 185 }, 186 186 "feature-type": { 187 187 "type": "string", 188 188 - "pattern": "^(Vibrate|Rotate|Oscillate|Constrict|Inflate|Position|Battery|RSSI|Pressure|RotateWithDirection|PositionWithDuration|Heater|Led)$" 188 188 + "pattern": "^(Vibrate|Rotate|Oscillate|Constrict|Spray|Position|Battery|RSSI|Pressure|RotateWithDirection|PositionWithDuration|Heater|Led)$" 189 189 }, 190 190 "output": { 191 191 "type": "object", 192 192 "patternProperties": { 193 193 - "^(Vibrate|Rotate|Oscillate|Constrict|Inflate|Position|RotateWithDirection|PositionWithDuration|Heater|Led)$": { 193 193 + "^(Vibrate|Rotate|Oscillate|Constrict|Spray|Position|RotateWithDirection|PositionWithDuration|Heater|Led)$": { 194 194 "type": "object", 195 195 "properties": { 196 196 "step-range": { ··· 269 269 "output": { 270 270 "type": "object", 271 271 "patternProperties": { 272 272 - "^(Vibrate|Rotate|Oscillate|Constrict|Inflate|Position|RotateWithDirection|PositionWithDuration|Heater|Led)$": { 272 272 + "^(Vibrate|Rotate|Oscillate|Constrict|Spray|Position|RotateWithDirection|PositionWithDuration|Heater|Led)$": { 273 273 "type": "object", 274 274 "properties": { 275 275 "step-limit": {