add optional serde feature to serialize/deserialize

Author: rursprung

.github/workflows/CI.yml

@@ -10,27 +10,34 @@ env:
 
 jobs:
   build:
+    strategy:
+      fail-fast: false
+      matrix:
+        features: ['', '--features rgb,serde']
 
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v3
       - uses: actions-rs/cargo@v1
         with:
           command: build
+          args: ${{ matrix.features }}
       - uses: actions-rs/cargo@v1
         with:
           command: check
+          args: ${{ matrix.features }}
       - uses: actions-rs/cargo@v1
         with:
           command: test
+          args: ${{ matrix.features }}
       - uses: actions-rs/cargo@v1
         with:
           command: fmt
           args: --all -- --check
       - uses: actions-rs/cargo@v1
         with:
           command: clippy
+          args: ${{ matrix.features }}
       - uses: actions-rs/cargo@v1
         with:
           command: audit

Cargo.toml

@@ -11,7 +11,9 @@ license = "MIT OR Apache-2.0"
 [dependencies]
 defmt = { version = "0.3", optional = true }
 heapless = { version = "0.7" }
+
 rgb = { version = "0.8", optional = true }
+serde = { version = "1.0", features = ["derive"], optional = true }
 
 [features]
 default = ["accelerometer_event", "button_event", "color_event", "gyro_event", "location_event", "magnetometer_event", "quaternion_event"]

README.md

@@ -12,6 +12,7 @@ Note that this work is not affiliated with Adafruit.
 ## Optional features
 * `defmt`: you can enable the [`defmt`](https://defmt.ferrous-systems.com/) feature to get a `defmt::Format` implementation for all structs & enums and a `defmt::debug!` call for each command being parsed.
 * `rgb`: if enabled, the `ColorEvent` implements `Into<RGB8>` for the [RGB crate](https://crates.io/crates/rgb).
+* `serde`: if enabled, all events implement the [serde](https://serde.rs/) `#[derive(Serialize, Deserialize)]`.
 * All events can be selected as individual features. By default, they are all selected,
   but you can opt to only select the event(s) you are interested in which will result in a small binary size.
   If other events are received, a `ProtocolParseError::DisabledControllerDataPackageType` will be returned.

src/accelerometer_event.rs

@@ -5,6 +5,7 @@ use super::{try_f32_from_le_bytes, ProtocolParseError};
 /// Represents an accelerometer event from the protocol.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[allow(missing_docs)] // the names are already obvious enough
 pub struct AccelerometerEvent {
     x: f32,

src/button_event.rs

@@ -47,6 +47,7 @@ impl Button {
 /// The state of the button.
 #[derive(PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[allow(missing_docs)] // the names are already obvious enough
 pub enum ButtonState {
     Released,

src/color_event.rs

@@ -7,6 +7,7 @@ use rgb::RGB8;
 /// Represents a color event from the protocol.
 #[derive(PartialEq, Eq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[allow(missing_docs)] // the names are already obvious enough
 pub struct ColorEvent {
     red: u8,

src/gyro_event.rs

@@ -5,6 +5,7 @@ use super::{try_f32_from_le_bytes, ProtocolParseError};
 /// Represents a gyro event from the protocol.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[allow(missing_docs)] // the names are already obvious enough
 pub struct GyroEvent {
     x: f32,

src/lib.rs

@@ -4,6 +4,7 @@
 //! ## Optional features
 //! * `defmt`: you can enable the `defmt` feature to get a `defmt::Format` implementation for all structs & enums and a `defmt::debug!` call for each command being parsed.
 //! * `rgb`: if enabled, the `ColorEvent` implements `Into<RGB8>` for the [RGB crate](https://crates.io/crates/rgb).
+//! * `serde`: if enabled, all events implement the [serde](https://serde.rs/) `#[derive(Serialize, Deserialize)]`.
 //! * All events can be selected as individual features. By default, they are all selected,
 //!   but you can opt to only select the event(s) you are interested in which will result in a small binary size.
 //!   If other events are received, a [`ProtocolParseError::DisabledControllerDataPackageType`] will be returned.

src/location_event.rs

@@ -5,6 +5,7 @@ use super::{try_f32_from_le_bytes, ProtocolParseError};
 /// Represents a location event from the protocol.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[allow(missing_docs)] // the names are already obvious enough
 pub struct LocationEvent {
     latitude: f32,

src/magnetometer_event.rs

@@ -5,6 +5,7 @@ use super::{try_f32_from_le_bytes, ProtocolParseError};
 /// Represents a magnetometer event from the protocol.
 #[derive(PartialEq, Debug)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[allow(missing_docs)] // the names are already obvious enough
 pub struct MagnetometerEvent {
     x: f32,