feat(A3040): Begin A3040 parser work and refactor "toggle" structs

gmallios · Dec 10, 2023 · 5230a52 · 5230a52
1 parent 638ebce
commit 5230a52
Show file tree

Hide file tree

Showing 23 changed files with 110 additions and 152 deletions.
diff --git a/soundcore-lib/Cargo.toml b/soundcore-lib/Cargo.toml
@@ -20,6 +20,7 @@ log = "0.4.17"
 typeshare = "1.0.1"
 phf = { version = "0.11", default-features = false, features = ["macros"] }
 dialoguer = { version = "0.10.4", features = ["fuzzy-select"] }
+derive_more = { version = "0.99", features = ["from"] }
 
 [dev-dependencies]
 test_data = { path = "../test_data/" }
diff --git a/soundcore-lib/src/models.rs b/soundcore-lib/src/models.rs
@@ -1,5 +1,4 @@
 mod a3909_button_model;
-mod age;
 mod anc_mode;
 mod auto_power;
 mod battery;
@@ -11,21 +10,16 @@ mod eq_configuration;
 mod eq_profile;
 mod feature_flags;
 mod fw;
-mod game_mode;
+mod misc;
 mod gender;
 mod hearid;
 mod packet_header;
 mod packet_kind;
 mod serial;
-mod side_tone;
 mod sound_mode;
-mod touch_tone;
 mod trans_mode;
-mod tws_status;
-mod wear_detection;
 
 pub use a3909_button_model::*;
-pub use age::*;
 pub use anc_mode::*;
 pub use auto_power::*;
 pub use battery::*;
@@ -37,15 +31,11 @@ pub use eq_configuration::*;
 pub use eq_profile::*;
 pub use feature_flags::*;
 pub use fw::*;
-pub use game_mode::*;
+pub use misc::*;
 pub use gender::*;
 pub use hearid::*;
 pub use packet_header::*;
 pub use packet_kind::*;
 pub use serial::*;
-pub use side_tone::*;
 pub use sound_mode::*;
-pub use touch_tone::*;
 pub use trans_mode::*;
-pub use tws_status::*;
-pub use wear_detection::*;
diff --git a/soundcore-lib/src/models/age.rs b/soundcore-lib/src/models/age.rs
diff --git a/soundcore-lib/src/models/game_mode.rs b/soundcore-lib/src/models/game_mode.rs
diff --git a/soundcore-lib/src/models/misc.rs b/soundcore-lib/src/models/misc.rs
@@ -0,0 +1,68 @@
+use serde::{Deserialize, Serialize};
+use derive_more::From;
+
+///
+/// "Toggle" types, booleans that represent a toggleable feature and are parsed using the bool_parser.
+///
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct GameMode(pub bool);
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct BassUp(pub bool);
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct LDAC(pub bool);
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct InEarBeep(pub bool);
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct SupportTwoCnn(pub bool);
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct ThreeDimensionalEffect(pub bool);
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct SideTone(pub bool);
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct PowerOnBatteryNotice(pub bool);
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct TwsStatus(pub bool);
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct WearDetection(pub bool);
+
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct TouchTone(pub bool);
+
+
+#[derive(
+    Debug, Serialize, Deserialize, Eq, PartialEq, Ord, PartialOrd, Clone, Copy, Default, Hash, From,
+)]
+pub struct AgeRange(pub u8);
diff --git a/soundcore-lib/src/models/side_tone.rs b/soundcore-lib/src/models/side_tone.rs
diff --git a/soundcore-lib/src/models/touch_tone.rs b/soundcore-lib/src/models/touch_tone.rs
diff --git a/soundcore-lib/src/models/tws_status.rs b/soundcore-lib/src/models/tws_status.rs
diff --git a/soundcore-lib/src/models/wear_detection.rs b/soundcore-lib/src/models/wear_detection.rs
diff --git a/soundcore-lib/src/packets.rs b/soundcore-lib/src/packets.rs
@@ -6,9 +6,9 @@ pub use command::*;
 pub use request::*;
 pub use response::*;
 
+const COMMAND_BYTE_SIZE: usize = 2;
+const PACKET_PREFIX: [u8; 5] = [0x08, 0xEE, 0x00, 0x00, 0x00];
 pub trait SoundcorePacket {
-    const COMMAND_BYTE_SIZE: usize = 2;
-    const PACKET_PREFIX: [u8; 5] = [0x08, 0xEE, 0x00, 0x00, 0x00];
 
     type ByteArr;
     /// Returns the packet's bytes + checksum
@@ -19,14 +19,14 @@ impl<T> SoundcorePacket for T
 where
     T: RequestPacket,
 {
-    type ByteArr = [u8; Self::COMMAND_BYTE_SIZE + Self::PACKET_PREFIX.len() + 3];
+    type ByteArr = [u8; COMMAND_BYTE_SIZE + PACKET_PREFIX.len() + 3];
 
     fn bytes(&self) -> Self::ByteArr {
-        let mut bytes = [0; COMMAND_BYTE_SIZE + Self::PACKET_PREFIX.len() + 3];
+        let mut bytes = [0; COMMAND_BYTE_SIZE + PACKET_PREFIX.len() + 3];
         // Add the prefix
-        bytes[..Self::PACKET_PREFIX.len()].copy_from_slice(&Self::PACKET_PREFIX);
+        bytes[..PACKET_PREFIX.len()].copy_from_slice(&PACKET_PREFIX);
         // Add the command bytes
-        bytes[Self::PACKET_PREFIX.len()..Self::PACKET_PREFIX.len() + COMMAND_BYTE_SIZE]
+        bytes[PACKET_PREFIX.len()..PACKET_PREFIX.len() + COMMAND_BYTE_SIZE]
             .copy_from_slice(&self.default_bytes());
 
         bytes

diff --git a/soundcore-lib/src/packets/response/state.rs b/soundcore-lib/src/packets/response/state.rs
@@ -55,9 +55,11 @@ mod a3028;
 mod a3029;
 mod a3930;
 mod a3951;
+mod a3040;
 
 use a3027::*;
 use a3028::*;
 use a3029::*;
 use a3930::*;
 use a3951::*;
+use a3040::*;
diff --git a/soundcore-lib/src/packets/response/state/a3027.rs b/soundcore-lib/src/packets/response/state/a3027.rs
@@ -16,12 +16,12 @@ use crate::{
     },
     parsers::{
         parse_base_hear_id, parse_bool, parse_dual_fw, parse_fw, parse_serial_number,
-        parse_single_battery,
+        parse_single_battery, u8_parser,
     },
 };
 
 use crate::parsers::{
-    bool_parser, parse_a3909_button_model, parse_age_range, parse_custom_hear_id,
+    bool_parser, parse_a3909_button_model, parse_custom_hear_id,
     parse_dual_battery, parse_gender, parse_sound_mode, parse_stereo_eq_configuration, ParseError,
     ParseResult,
 };
@@ -83,7 +83,7 @@ pub fn parse_a3027_state_response<'a, E: ParseError<'a>>(
                 parse_single_battery,
                 parse_stereo_eq_configuration,
                 parse_gender,
-                parse_age_range,
+                u8_parser::<AgeRange, E>,
                 parse_base_hear_id,
                 parse_sound_mode,
                 parse_dual_fw,

diff --git a/soundcore-lib/src/packets/response/state/a3028.rs b/soundcore-lib/src/packets/response/state/a3028.rs
@@ -16,12 +16,12 @@ use crate::{
     },
     parsers::{
         parse_base_hear_id, parse_bool, parse_dual_fw, parse_fw, parse_serial_number,
-        parse_single_battery,
+        parse_single_battery, u8_parser,
     },
 };
 
 use crate::parsers::{
-    bool_parser, parse_a3909_button_model, parse_age_range, parse_custom_hear_id,
+    bool_parser, parse_a3909_button_model, parse_custom_hear_id,
     parse_dual_battery, parse_gender, parse_sound_mode, parse_stereo_eq_configuration, ParseError,
     ParseResult,
 };
@@ -76,7 +76,7 @@ pub fn parse_a3028_state_response<'a, E: ParseError<'a>>(
                     parse_single_battery,
                     parse_stereo_eq_configuration,
                     parse_gender,
-                    parse_age_range,
+                    u8_parser::<AgeRange, E>,
                     parse_base_hear_id,
                     parse_sound_mode,
                     parse_dual_fw,

diff --git a/soundcore-lib/src/packets/response/state/a3029.rs b/soundcore-lib/src/packets/response/state/a3029.rs
@@ -16,12 +16,12 @@ use crate::{
     },
     parsers::{
         parse_base_hear_id, parse_bool, parse_dual_fw, parse_fw, parse_serial_number,
-        parse_single_battery,
+        parse_single_battery, u8_parser,
     },
 };
 
 use crate::parsers::{
-    bool_parser, parse_a3909_button_model, parse_age_range, parse_custom_hear_id,
+    bool_parser, parse_a3909_button_model, parse_custom_hear_id,
     parse_dual_battery, parse_gender, parse_sound_mode, parse_stereo_eq_configuration, ParseError,
     ParseResult,
 };
@@ -81,7 +81,7 @@ pub fn parse_a3029_state_response<'a, E: ParseError<'a>>(
                 parse_stereo_eq_configuration,
                 parse_gender,
                 le_u8,
-                parse_age_range,
+                u8_parser::<AgeRange, E>,
                 parse_base_hear_id,
                 parse_sound_mode,
                 parse_dual_fw,

diff --git a/soundcore-lib/src/packets/response/state/a3040.rs b/soundcore-lib/src/packets/response/state/a3040.rs
@@ -0,0 +1,12 @@
+use serde::{Serialize, Deserialize};
+
+use crate::models::{SingleBattery, FirmwareVer, SerialNumber};
+
+
+#[derive(Debug, Serialize, Deserialize, Clone, Eq, PartialEq, Hash)]
+pub struct A3040StateResponse {
+    pub battery: SingleBattery,
+    pub fw: FirmwareVer,
+    pub sn: SerialNumber,
+
+}
diff --git a/soundcore-lib/src/packets/response/state/a3930.rs b/soundcore-lib/src/packets/response/state/a3930.rs
@@ -7,14 +7,14 @@ use nom::{
 };
 use serde::{Deserialize, Serialize};
 
-use crate::models::{
+use crate::{models::{
     A3909ButtonModel, AgeRange, Battery, ButtonModel, CustomHearID, DualBattery, EQConfiguration,
     Gender, HearID, SideTone, SoundMode, SoundcoreFeatureFlags, StereoEQConfiguration, TouchTone,
     TwsStatus, WearDetection,
-};
+}, parsers::u8_parser};
 
 use crate::parsers::{
-    bool_parser, parse_a3909_button_model, parse_age_range, parse_custom_hear_id,
+    bool_parser, parse_a3909_button_model, parse_custom_hear_id,
     parse_dual_battery, parse_gender, parse_sound_mode, parse_stereo_eq_configuration, ParseError,
     ParseResult,
 };
@@ -96,7 +96,7 @@ pub fn parse_a3930_state_response<'a, E: ParseError<'a>>(
                 parse_stereo_eq_configuration,
                 parse_gender,
                 le_u8,
-                parse_age_range,
+                u8_parser::<AgeRange, E>,
                 parse_custom_hear_id,
                 parse_a3909_button_model,
                 parse_sound_mode,

diff --git a/soundcore-lib/src/packets/response/state/a3951.rs b/soundcore-lib/src/packets/response/state/a3951.rs
@@ -7,14 +7,14 @@ use nom::{
 };
 use serde::{Deserialize, Serialize};
 
-use crate::models::{
-    self, A3909ButtonModel, AgeRange, Battery, ButtonModel, CustomHearID, DualBattery,
+use crate::{models::{
+    A3909ButtonModel, AgeRange, Battery, ButtonModel, CustomHearID, DualBattery,
     EQConfiguration, Gender, HearID, SideTone, SoundMode, SoundcoreFeatureFlags,
     StereoEQConfiguration, TouchTone, TwsStatus, WearDetection,
-};
+}, parsers::u8_parser};
 
 use crate::parsers::{
-    bool_parser, parse_a3909_button_model, parse_age_range, parse_custom_hear_id,
+    bool_parser, parse_a3909_button_model, parse_custom_hear_id,
     parse_dual_battery, parse_gender, parse_sound_mode, parse_stereo_eq_configuration, ParseError,
     ParseResult,
 };
@@ -102,7 +102,7 @@ pub fn parse_a3951_state_response<'a, E: ParseError<'a>>(
                 parse_dual_battery,
                 parse_stereo_eq_configuration,
                 parse_gender,
-                parse_age_range,
+                u8_parser::<AgeRange, E>,
                 parse_custom_hear_id,
                 parse_a3909_button_model,
                 parse_sound_mode,