Add optional serde feature (#12)

nyurik · Jul 1, 2024 · f4ae6c7 · f4ae6c7
1 parent 90bdc5c
commit f4ae6c7
Show file tree

Hide file tree

Showing 26 changed files with 61 additions and 2 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -8,7 +8,7 @@ edition = "2021"
 license = "MIT OR Apache-2.0"
 keywords = ["uds", "kwp2000", "obd", "automotive", "no_std"]
 categories = ["embedded", "no-std", "encoding", "parsing"]
-rust-version = "1.61.0"
+rust-version = "1.63.0"
 
 [features]
 default = ["std", "iter", "display", "with-kwp2000", "with-obd2", "with-uds"]
@@ -24,13 +24,17 @@ with-kwp2000 = []
 with-obd2 = []
 # Include support for Unified Diagnostic Services
 with-uds = []
+# Include support for serde serialization
+serde = ["dep:serde"]
 
 [dependencies]
 displaydoc = { version = "0.2", optional = true }
+serde = { version = "1", features = ["derive"], optional = true }
 strum = { version = "0.26.3", features = ["derive"] }
 
 [dev-dependencies]
 cargo-husky = { version = "1", features = ["user-hooks"], default-features = false }
+serde_json = { version = "1", features = ["preserve_order"] }
 
 [lints.rust]
 unsafe_code = "forbid"

diff --git a/justfile b/justfile
@@ -37,6 +37,7 @@ test:
     RUSTFLAGS='-D warnings' cargo test --no-default-features --features with-kwp2000
     RUSTFLAGS='-D warnings' cargo test --no-default-features --features with-obd2
     RUSTFLAGS='-D warnings' cargo test --no-default-features --features with-uds
+    RUSTFLAGS='-D warnings' cargo test --features serde
 
 # Test documentation
 test-doc:

diff --git a/src/kwp2000/commands.rs b/src/kwp2000/commands.rs
@@ -7,6 +7,7 @@ crate::utils::enum_wrapper!(kwp2000, KwpCommand, KwpCommandByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum KwpCommand {
     /// Start or change ECU diagnostic session mode.
     StartDiagnosticSession = 0x10,

diff --git a/src/kwp2000/errors.rs b/src/kwp2000/errors.rs
@@ -4,6 +4,7 @@ crate::utils::enum_wrapper!(kwp2000, KwpError, KwpErrorByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum KwpError {
     /// ECU rejected the request for unknown reason
     GeneralReject = 0x10,

diff --git a/src/kwp2000/reset_types.rs b/src/kwp2000/reset_types.rs
@@ -14,6 +14,7 @@ crate::utils::enum_wrapper!(kwp2000, ResetType, ResetTypeByte);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum ResetType {
     /// Simulates a power off/on reset of the ECU.
     PowerOnReset = 0x01,

diff --git a/src/kwp2000/routine_exit_status.rs b/src/kwp2000/routine_exit_status.rs
@@ -3,6 +3,7 @@ crate::utils::enum_wrapper!(kwp2000, RoutineExitStatus, RoutineExitStatusByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum RoutineExitStatus {
     /// Normal exit with results available
     NormalExitWithResults = 0x61,

diff --git a/src/kwp2000/session_types.rs b/src/kwp2000/session_types.rs
@@ -14,6 +14,7 @@ crate::utils::enum_wrapper!(kwp2000, KwpSessionType, KwpSessionTypeByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum KwpSessionType {
     /// Normal session. The ECU will typically boot in this state.
     /// In this mode, only non-intrusive functions are supported.

diff --git a/src/obd2/command_2nd_air_status.rs b/src/obd2/command_2nd_air_status.rs
@@ -9,6 +9,7 @@ crate::utils::enum_wrapper!(
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum CommandedSecondaryAirStatus {
     /// Upstream
     Upstream = 0x01,

diff --git a/src/obd2/commands.rs b/src/obd2/commands.rs
@@ -5,6 +5,7 @@ crate::utils::enum_wrapper!(obd2, Obd2Command, Obd2CommandByte);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Obd2Command {
     /// Service 01 - Show current data
     Service01 = 0x01,

diff --git a/src/obd2/data_pids.rs b/src/obd2/data_pids.rs
@@ -4,6 +4,7 @@ crate::utils::enum_wrapper!(obd2, DataPid, DataPidByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum DataPid {
     PidSupport0120 = 0x00,
     StatusSinceDTCCleared = 0x01,

diff --git a/src/obd2/errors.rs b/src/obd2/errors.rs
@@ -5,6 +5,7 @@ crate::utils::enum_wrapper!(obd2, Obd2Error, Obd2ErrorByte);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Obd2Error {
     /// ECU general reject
     GeneralReject = 0x10,

diff --git a/src/obd2/fuel_system_status.rs b/src/obd2/fuel_system_status.rs
@@ -5,6 +5,7 @@ crate::utils::enum_wrapper!(obd2, FuelSystemStatus, FuelSystemStatusByte);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum FuelSystemStatus {
     /// The motor is off
     Off = 0x00,

diff --git a/src/obd2/fuel_types.rs b/src/obd2/fuel_types.rs
@@ -6,6 +6,7 @@ crate::utils::enum_wrapper!(obd2, FuelTypeCoding, FuelTypeCodingByte);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum FuelTypeCoding {
     /// Fuel type unavailable
     NotAvailable = 0,

diff --git a/src/obd2/obd_standard.rs b/src/obd2/obd_standard.rs
@@ -6,6 +6,7 @@ crate::utils::enum_wrapper!(obd2, ObdStandard, ObdStandardByte);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[allow(clippy::doc_markdown)]
 pub enum ObdStandard {
     /// OBD-II as defined by the CARB

diff --git a/src/obd2/service09.rs b/src/obd2/service09.rs
@@ -5,6 +5,7 @@ crate::utils::enum_wrapper!(obd2, Service09Pid, Service09PidByte);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum Service09Pid {
     /// VIN message count (Only for LIN)
     VinMsgCount = 0x01,

diff --git a/src/uds/comm_level.rs b/src/uds/comm_level.rs
@@ -4,6 +4,7 @@ crate::utils::enum_wrapper!(uds, CommunicationLevel, CommunicationLevelByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum CommunicationLevel {
     /// This value indicates that the reception and transmission of messages
     /// shall be enabled for the specified communicationType.

diff --git a/src/uds/commands.rs b/src/uds/commands.rs
@@ -5,6 +5,7 @@ crate::utils::enum_wrapper!(uds, UdsCommand, UdsCommandByte);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum UdsCommand {
     /// The client requests to control a diagnostic session with a server(s).
     DiagnosticSessionControl = 0x10,
@@ -59,3 +60,33 @@ pub enum UdsCommand {
     /// The client requests the negotiation of a file transfer between server and client.
     RequestFileTransfer = 0x38,
 }
+
+#[cfg(all(test, feature = "serde"))]
+mod tests {
+    use super::*;
+
+    #[derive(serde::Serialize, serde::Deserialize)]
+    struct TestStruct {
+        command: UdsCommand,
+        command_byte: UdsCommandByte,
+    }
+
+    #[test]
+    fn test_serde() {
+        let test = TestStruct {
+            command: UdsCommand::DiagnosticSessionControl,
+            command_byte: UdsCommandByte::from(UdsCommand::DiagnosticSessionControl),
+        };
+
+        let json = serde_json::to_string(&test).unwrap();
+        assert_eq!(
+            json,
+            r###"{"command":"DiagnosticSessionControl","command_byte":{"Standard":"DiagnosticSessionControl"}}"###
+        );
+
+        let deserialized: TestStruct = serde_json::from_str(&json).unwrap();
+
+        assert_eq!(test.command, deserialized.command);
+        assert_eq!(test.command_byte, deserialized.command_byte);
+    }
+}
diff --git a/src/uds/errors.rs b/src/uds/errors.rs
@@ -8,6 +8,7 @@ enum_wrapper!(uds, UdsError, UdsErrorByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum UdsError {
     /// ECU rejected the request (No specific error)
     GeneralReject = 0x10,

diff --git a/src/uds/read_dtc_information.rs b/src/uds/read_dtc_information.rs
@@ -9,6 +9,7 @@ enum_wrapper!(uds, DtcSubFunction, DtcSubFunctionByte);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[allow(clippy::doc_markdown)]
 pub enum DtcSubFunction {
     /// This function takes a 1 byte DTCStatusMask

diff --git a/src/uds/reset_types.rs b/src/uds/reset_types.rs
@@ -4,6 +4,7 @@ crate::utils::enum_wrapper!(uds, ResetType, ResetTypeByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum ResetType {
     /// Signals the ECU to perform a hard-reset,
     /// simulating a forceful power off/on cycle

diff --git a/src/uds/routine.rs b/src/uds/routine.rs
@@ -5,6 +5,7 @@ crate::utils::enum_wrapper!(uds, RoutineControlType, RoutineControlTypeByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum RoutineControlType {
     /// Launches a routine on the ECU
     StartRoutine = 0x01,

diff --git a/src/uds/scaling_byte.rs b/src/uds/scaling_byte.rs
@@ -6,6 +6,7 @@ crate::utils::enum_impls!(uds, ScalingType);
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
 #[cfg_attr(feature = "display", derive(displaydoc::Display))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum ScalingType {
     /// Unsigned numeric integer. Must be followed by 1..4 bytes, given as a low nibble of the byte.
     UnsignedNumeric = 0x00,

diff --git a/src/uds/scaling_byte_ext.rs b/src/uds/scaling_byte_ext.rs
@@ -63,7 +63,8 @@ generate_enum! {
     /// or [`ScalingExtension::get_prefix`] to return the optional prefix of the scaling byte.
     #[repr(u8)]
     #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
-#[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+    #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+    #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
     pub enum ScalingExtension {
         /// No unit or presentation
         NoUnit = 0x00,

diff --git a/src/uds/security_access.rs b/src/uds/security_access.rs
@@ -9,6 +9,7 @@ crate::utils::enum_wrapper!(uds, SecurityOperation, SecurityOperationByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum SecurityOperation {
     /// Asks the ECU for a security seed
     RequestSeed = 0x01,

diff --git a/src/uds/session_types.rs b/src/uds/session_types.rs
@@ -4,6 +4,7 @@ crate::utils::enum_wrapper!(uds, UdsSessionType, UdsSessionTypeByte);
 #[repr(u8)]
 #[derive(strum::FromRepr, Debug, Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
 #[cfg_attr(feature = "iter", derive(strum::EnumIter))]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum UdsSessionType {
     /// Default diagnostic session mode (ECU is normally in this mode on startup)
     /// This session type does not require the diagnostic server to sent `TesterPresent` messages

diff --git a/src/utils.rs b/src/utils.rs
@@ -3,6 +3,7 @@ use core::fmt::Debug;
 /// A wrapper around a byte, which can be either an ISO-standardized value for a specific enum,
 /// or an implementation-specific/invalid `Extended` value wrapping original byte.
 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 pub enum ByteWrapper<T> {
     Standard(T),
     Extended(u8),