Merge pull request #17 from LechevSpace/feat/serde-feature

barafael · web-flow · commit d2d85885c42c · 2025-02-28T16:17:43.000+01:00
feat: optional serde feature
diff --git a/Cargo.toml b/Cargo.toml
@@ -16,11 +16,13 @@ readme = "README.md"
 [features]
 default = []
 defmt-03 = ["dep:defmt"]
+serde = ["dep:serde"]
 async = ["dep:embedded-hal-async"]
 
 [dependencies]
 embedded-hal = { version = "1" }
 embedded-hal-async = { version = "1", optional = true }
 libm = "0.2"
 
+serde = { version = "1", features = ["derive"], default-features = false, optional = true }
 defmt = { version = "0.3", optional = true }
diff --git a/src/accel.rs b/src/accel.rs
@@ -17,6 +17,7 @@
 /// - Must be scaled by full-scale range for g-force values
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Accel {
     pub(crate) x: i16,
     pub(crate) y: i16,
@@ -93,6 +94,7 @@ impl Accel {
 /// - Maximum measurable acceleration
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum AccelFullScale {
     /// ±2g range (16384 LSB/g)
     G2 = 0,
@@ -129,8 +131,9 @@ impl AccelFullScale {
 /// - ±16g in G16 mode
 ///
 /// Note: The Z axis will read ~1g when stationary due to gravity
-#[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
 #[derive(Debug, Clone, Copy)]
+#[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct AccelF32 {
     /// X-axis acceleration in g-force
     x: f32,
diff --git a/src/address.rs b/src/address.rs
@@ -20,6 +20,7 @@
 /// require left-shifting by 1 to create the 8-bit address.
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Address(pub u8);
 
 impl Default for Address {
diff --git a/src/calibration.rs b/src/calibration.rs
@@ -22,6 +22,7 @@ pub(crate) const DELAY_MS: u32 = 2;
 /// Maximum allowed deviation from zero after calibration
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct CalibrationThreshold {
     value: i16,
 }
@@ -108,6 +109,7 @@ impl CalibrationThreshold {
 /// - Zero: No gravity compensation
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum ReferenceGravity {
     Zero,
     XN,
@@ -150,6 +152,7 @@ impl ReferenceGravity {
 /// - Bits 3-5: Gyroscope (X,Y,Z)
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct CalibrationActions {
     flags: u8,
 }
@@ -248,6 +251,7 @@ impl CalibrationActions {
 /// - Gravity compensation direction
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct CalibrationParameters {
     /// Acceleration scale
     pub accel_scale: AccelFullScale,
@@ -325,6 +329,7 @@ impl CalibrationParameters {
 /// - Running sum of gyroscope readings
 /// - Gravity compensation vector
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct MeanAccumulator {
     pub ax: i32,
     pub ay: i32,
diff --git a/src/clock_source.rs b/src/clock_source.rs
@@ -20,6 +20,7 @@
 /// - External component availability
 #[derive(Debug, Copy, Clone)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum ClockSource {
     /// Internal 8MHz oscillator
     /// - Fastest startup
diff --git a/src/config.rs b/src/config.rs
@@ -19,6 +19,7 @@
 /// - Noise reduction: How much sensor noise is filtered out
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum DigitalLowPassFilter {
     /// Minimal filtering
     /// - Fastest response
diff --git a/src/euler.rs b/src/euler.rs
@@ -15,6 +15,7 @@ use crate::quaternion::Quaternion;
 /// 3. Yaw (ψ): Rotation around Z axis
 #[derive(Debug, Clone, Copy)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Euler {
     /// Yaw angle (ψ) in radians (-π to π)
     pub psi: f64,
diff --git a/src/fifo.rs b/src/fifo.rs
@@ -17,6 +17,7 @@
 /// of sensor data.
 #[derive(Debug, Default, Copy, Clone)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Fifo {
     pub temp: bool,
     pub xg: bool,
diff --git a/src/gravity.rs b/src/gravity.rs
@@ -23,6 +23,7 @@ use crate::quaternion::Quaternion;
 /// - The vector magnitude should always be approximately 1g
 #[derive(Debug, Copy, Clone)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Gravity {
     /// Forward/backward tilt component
     pub x: f32,
diff --git a/src/gyro.rs b/src/gyro.rs
@@ -10,6 +10,7 @@
 /// Values represent rotation rate in ADC units.
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Gyro {
     pub(crate) x: i16,
     pub(crate) y: i16,
@@ -69,6 +70,7 @@ impl Gyro {
 /// - Deg2000: ±2000 degrees/second
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum GyroFullScale {
     /// ±250°/s range (131 LSB/°/s)
     Deg250 = 0,
@@ -102,6 +104,7 @@ impl GyroFullScale {
 /// - Negative: Counter-clockwise rotation
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct GyroF32 {
     /// Roll rate (°/s)
     x: f32,
diff --git a/src/motion.rs b/src/motion.rs
@@ -22,6 +22,7 @@
 /// Motion detection configuration parameters
 #[derive(Debug, Clone, Copy)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct MotionConfig {
     /// Motion detection threshold in mg (1LSB = 2mg)
     /// Range: 0-255 (0-510mg)
@@ -47,6 +48,7 @@ impl Default for MotionConfig {
 /// Indicates if motion was detected based on the configured threshold and duration
 #[derive(Debug, Clone, Copy, PartialEq)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct MotionDetected(pub bool);
 
 impl From<u8> for MotionDetected {
diff --git a/src/quaternion.rs b/src/quaternion.rs
@@ -15,6 +15,7 @@
 /// - Magnitude should be 1 for a pure rotation (normalized)
 #[derive(Debug, Copy, Clone)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Quaternion {
     /// Scalar (real) component
     pub w: f32,
diff --git a/src/registers.rs b/src/registers.rs
@@ -14,6 +14,7 @@
 #[allow(non_camel_case_types)]
 #[derive(Copy, Clone, Debug)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Register {
     /// Configuration register (0x1A)
     /// Controls the digital low pass filter and external sync
diff --git a/src/temperature.rs b/src/temperature.rs
@@ -22,6 +22,7 @@
 /// ```
 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct Temperature {
     pub(crate) raw: i16,
 }
diff --git a/src/yaw_pitch_roll.rs b/src/yaw_pitch_roll.rs
@@ -23,6 +23,7 @@ use crate::quaternion::Quaternion;
 /// Note: These angles can experience gimbal lock when pitch approaches ±90°
 #[derive(Debug, Copy, Clone)]
 #[cfg_attr(feature = "defmt-03", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub struct YawPitchRoll {
     /// Rotation around vertical (Z) axis, -π to π radians
     pub yaw: f32,
