chore: Change InputData to InputReading, simplify InputCmd field names

Author: qdot

crates/buttplug_client/src/device/feature.rs

@@ -5,7 +5,7 @@ use buttplug_core::{
   errors::{ButtplugDeviceError, ButtplugError, ButtplugMessageError},
   message::{
     ButtplugDeviceMessageNameV4, ButtplugServerMessageV4, DeviceFeature, DeviceFeatureOutputLimits,
-    InputCmdV4, InputCommandType, InputType, InputTypeData, OutputCmdV4, OutputCommand,
+    InputCmdV4, InputCommandType, InputType, InputTypeReading, OutputCmdV4, OutputCommand,
     OutputPositionWithDuration, OutputType, OutputValue,
   },
 };
@@ -244,7 +244,7 @@ impl ClientDeviceFeature {
     )
   }
 
-  fn read_sensor(&self, sensor_type: InputType) -> ButtplugClientResultFuture<InputTypeData> {
+  fn read_input(&self, sensor_type: InputType) -> ButtplugClientResultFuture<InputTypeReading> {
     if let Some(sensor_map) = self.feature.input()
       && let Some(sensor) = sensor_map.get(sensor_type)
       && sensor.input_commands().contains(&InputCommandType::Read)
@@ -259,8 +259,8 @@ impl ClientDeviceFeature {
       let reply = self.event_loop_sender.send_message(msg);
       return async move {
         if let ButtplugServerMessageV4::InputReading(data) = reply.await? {
-          if sensor_type == data.data().as_input_type() {
-            Ok(data.data())
+          if sensor_type == data.reading().into() {
+            Ok(data.reading())
           } else {
             Err(
               ButtplugError::ButtplugMessageError(ButtplugMessageError::UnexpectedMessageType(
@@ -295,10 +295,10 @@ impl ClientDeviceFeature {
       .unwrap()
       .contains(InputType::Battery)
     {
-      let send_fut = self.read_sensor(InputType::Battery);
+      let send_fut = self.read_input(InputType::Battery);
       Box::pin(async move {
         let data = send_fut.await?;
-        let battery_level = if let InputTypeData::Battery(level) = data {
+        let battery_level = if let InputTypeReading::Battery(level) = data {
           level.data()
         } else {
           0
@@ -322,10 +322,10 @@ impl ClientDeviceFeature {
       .unwrap()
       .contains(InputType::Rssi)
     {
-      let send_fut = self.read_sensor(InputType::Rssi);
+      let send_fut = self.read_input(InputType::Rssi);
       Box::pin(async move {
         let data = send_fut.await?;
-        let rssi_level = if let InputTypeData::Rssi(level) = data {
+        let rssi_level = if let InputTypeReading::Rssi(level) = data {
           level.data()
         } else {
           0

crates/buttplug_core/schema/buttplug-schema.json

@@ -507,10 +507,10 @@
           "FeatureIndex": {
             "type": "integer"
           },
-          "InputType": {
+          "Type": {
             "type": "string"
           },
-          "InputCommand": {
+          "Command": {
             "type": "string"
           }
         },
@@ -519,8 +519,8 @@
           "Id",
           "DeviceIndex",
           "FeatureIndex",
-          "InputType",
-          "InputCommand"
+          "Type",
+          "Command"
         ]
       },
       "InputReading": {
@@ -540,7 +540,7 @@
             "type": "object",
             "patternProperties": {
               "^Battery|Rssi|Pressure|Button": {
-                "type": "integer"
+                "type": "object"
               }
             },
             "maxProperties": 1

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

@@ -47,10 +47,10 @@ pub struct InputCmdV4 {
   #[serde(rename = "FeatureIndex")]
   feature_index: u32,
   #[getset(get_copy = "pub")]
-  #[serde(rename = "InputType")]
+  #[serde(rename = "Type")]
   input_type: InputType,
   #[getset(get_copy = "pub")]
-  #[serde(rename = "InputCommand")]
+  #[serde(rename = "Command")]
   input_command: InputCommandType,
 }
 

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

@@ -17,15 +17,15 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize, CopyGetters)]
 #[getset(get_copy = "pub")]
-pub struct InputData<T>
+pub struct InputValue<T>
 where
   T: Copy + Clone,
 {
-  #[serde(rename = "Data")]
+  #[serde(rename = "Value")]
   data: T,
 }
 
-impl<T> InputData<T>
+impl<T> InputValue<T>
 where
   T: Copy + Clone,
 {
@@ -35,15 +35,15 @@ where
 }
 
 #[derive(Debug, Display, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
-pub enum InputTypeData {
-  Battery(InputData<u8>),
-  Rssi(InputData<i8>),
-  Button(InputData<u8>),
-  Pressure(InputData<u32>),
+pub enum InputTypeReading {
+  Battery(InputValue<u8>),
+  Rssi(InputValue<i8>),
+  Button(InputValue<u8>),
+  Pressure(InputValue<u32>),
 }
 
-impl InputTypeData {
-  pub fn as_input_type(&self) -> InputType {
+impl Into<InputType> for InputTypeReading {
+  fn into(self) -> InputType {
     match self {
       Self::Battery(_) => InputType::Battery,
       Self::Rssi(_) => InputType::Rssi,
@@ -76,18 +76,18 @@ pub struct InputReadingV4 {
   #[serde(rename = "FeatureIndex")]
   #[getset[get_copy="pub"]]
   feature_index: u32,
-  #[serde(rename = "Data")]
+  #[serde(rename = "Reading")]
   #[getset[get_copy="pub"]]
-  data: InputTypeData,
+  reading: InputTypeReading,
 }
 
 impl InputReadingV4 {
-  pub fn new(device_index: u32, feature_index: u32, data: InputTypeData) -> Self {
+  pub fn new(device_index: u32, feature_index: u32, data: InputTypeReading) -> Self {
     Self {
       id: 0,
       device_index,
       feature_index,
-      data,
+      reading: data,
     }
   }
 }

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

@@ -18,7 +18,7 @@ pub use {
   device_list::DeviceListV4,
   device_message_info::DeviceMessageInfoV4,
   input_cmd::{InputCmdV4, InputCommandType},
-  input_reading::{InputData, InputReadingV4, InputTypeData},
+  input_reading::{InputValue, InputReadingV4, InputTypeReading},
   output_cmd::{OutputCmdV4, OutputCommand, OutputPositionWithDuration, OutputValue},
   request_server_info::RequestServerInfoV4,
   server_info::ServerInfoV4,

crates/buttplug_server/src/device/protocol.rs

@@ -9,7 +9,7 @@
 
 use buttplug_core::{
   errors::ButtplugDeviceError,
-  message::{InputData, InputReadingV4, InputType, OutputCommand},
+  message::{InputValue, InputReadingV4, InputType, OutputCommand},
 };
 use buttplug_server_device_config::{
   Endpoint,
@@ -432,7 +432,7 @@ pub trait ProtocolHandler: Sync + Send {
         let battery_reading = InputReadingV4::new(
           device_index,
           feature_index,
-          buttplug_core::message::InputTypeData::Battery(InputData::new(battery_level as u8)),
+          buttplug_core::message::InputTypeReading::Battery(InputValue::new(battery_level as u8)),
         );
         debug!("Got battery reading: {}", battery_level);
         Ok(battery_reading)

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

@@ -14,7 +14,7 @@ use futures_util::future::BoxFuture;
 use futures_util::{FutureExt, future};
 
 use buttplug_core::errors::ButtplugDeviceError;
-use buttplug_core::message::{InputData, InputReadingV4, InputType, InputTypeData};
+use buttplug_core::message::{InputValue, InputReadingV4, InputType, InputTypeReading};
 use buttplug_server_device_config::Endpoint;
 
 use buttplug_server_device_config::{
@@ -330,7 +330,7 @@ impl ProtocolHandler for Galaku {
             let battery_reading = InputReadingV4::new(
               device_index,
               feature_index,
-              InputTypeData::Battery(InputData::new(data[0])),
+              InputTypeReading::Battery(InputValue::new(data[0])),
             );
             Ok(battery_reading)
           }

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

@@ -14,7 +14,7 @@ use crate::{
 };
 use buttplug_core::{
   errors::ButtplugDeviceError,
-  message::{InputData, InputReadingV4, InputType},
+  message::{InputValue, InputReadingV4, InputType},
   util::{async_manager, stream::convert_broadcast_receiver_to_stream},
 };
 use buttplug_server_device_config::Endpoint;
@@ -105,7 +105,7 @@ impl ProtocolHandler for KGoalBoost {
                     InputReadingV4::new(
                       device_index,
                       feature_index,
-                      buttplug_core::message::InputTypeData::Pressure(InputData::new(normalized)),
+                      buttplug_core::message::InputTypeReading::Pressure(InputValue::new(normalized)),
                     )
                     .into(),
                   )
@@ -120,7 +120,7 @@ impl ProtocolHandler for KGoalBoost {
                     InputReadingV4::new(
                       device_index,
                       feature_index,
-                      buttplug_core::message::InputTypeData::Pressure(InputData::new(unnormalized)),
+                      buttplug_core::message::InputTypeReading::Pressure(InputValue::new(unnormalized)),
                     )
                     .into(),
                   )

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

@@ -11,7 +11,7 @@ use crate::device::{
 };
 use buttplug_core::{
   errors::ButtplugDeviceError,
-  message::{self, InputData, InputReadingV4, InputTypeData},
+  message::{self, InputValue, InputReadingV4, InputTypeReading},
 };
 use buttplug_server_device_config::Endpoint;
 use futures::{FutureExt, future::BoxFuture};
@@ -79,7 +79,7 @@ impl ProtocolHandler for KiirooPowerShot {
       let battery_reading = message::InputReadingV4::new(
         device_index,
         feature_index,
-        InputTypeData::Battery(InputData::new(data[0])),
+        InputTypeReading::Battery(InputValue::new(data[0])),
       );
       debug!("Got battery reading: {}", data[0]);
       Ok(battery_reading)

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

@@ -11,7 +11,7 @@ use crate::device::{
 };
 use buttplug_core::{
   errors::ButtplugDeviceError,
-  message::{self, InputData, InputReadingV4, InputTypeData},
+  message::{self, InputValue, InputReadingV4, InputTypeReading},
 };
 use buttplug_server_device_config::Endpoint;
 use futures::{FutureExt, future::BoxFuture};
@@ -64,7 +64,7 @@ impl ProtocolHandler for KiirooProWand {
       let battery_reading = message::InputReadingV4::new(
         device_index,
         feature_index,
-        InputTypeData::Battery(InputData::new(data[0])),
+        InputTypeReading::Battery(InputValue::new(data[0])),
       );
       debug!("Got battery reading: {}", data[0]);
       Ok(battery_reading)