add Connection Manager diagnostics using generic CIP object read API

Author: JaskRendix

src/client/traits.rs

@@ -2,7 +2,7 @@ use std::io;
 
 use crate::cip::CipError;
 use crate::client::ForwardOpenError;
-use crate::types::{CipValue, IdentityInfo, SymbolInfo};
+use crate::types::{CipValue, ConnectionManagerInfo, IdentityInfo, SymbolInfo};
 use crate::MultiResult;
 
 pub trait ConnectionManagement {
@@ -75,6 +75,22 @@ pub trait TagReadWrite {
         IdentityInfo::decode(&raw).map_err(|_| CipError::VendorSpecific(0xFC))
     }
 
+    async fn read_connection_manager_attribute(
+        &mut self,
+        attribute_id: u8,
+    ) -> Result<CipValue, CipError> {
+        self.read_object_attribute(0x06, 0x01, attribute_id).await
+    }
+
+    async fn read_connection_manager_attributes(&mut self) -> Result<Vec<u8>, CipError> {
+        self.read_object_attributes(0x06, 0x01).await
+    }
+
+    async fn read_connection_manager(&mut self) -> Result<ConnectionManagerInfo, CipError> {
+        let raw = self.read_connection_manager_attributes().await?;
+        ConnectionManagerInfo::decode(&raw).map_err(|_| CipError::VendorSpecific(0xFC))
+    }
+
     async fn read_bool(&mut self, tag: &str) -> Result<bool, CipError>;
     async fn read_sint(&mut self, tag: &str) -> Result<i8, CipError>;
     async fn read_int(&mut self, tag: &str) -> Result<i16, CipError>;
@@ -237,4 +253,24 @@ mod tests {
         assert_eq!(identity.product_name, "TestProduct");
         assert_eq!(identity.state, 0x05);
     }
+
+    #[tokio::test]
+    async fn test_read_connection_manager_default_impl() {
+        let mut raw = Vec::new();
+        raw.extend_from_slice(&0x0102u16.to_le_bytes());
+        raw.extend_from_slice(&0x0304u16.to_le_bytes());
+        raw.extend_from_slice(&0x0506u16.to_le_bytes());
+
+        let mut client = StubIdentityClient {
+            raw_attributes: raw,
+        };
+        let info = client
+            .read_connection_manager()
+            .await
+            .expect("read_connection_manager should succeed");
+
+        assert_eq!(info.revision, 0x0102);
+        assert_eq!(info.status, 0x0304);
+        assert_eq!(info.configuration_capability, 0x0506);
+    }
 }

src/lib.rs

@@ -18,4 +18,4 @@ pub use client::{
     SymbolBrowsing, TagReadWrite,
 };
 
-pub use types::{CipType, CipValue, IdentityInfo, MultiResult};
+pub use types::{CipType, CipValue, ConnectionManagerInfo, IdentityInfo, MultiResult};

src/types.rs

@@ -134,6 +134,31 @@ impl IdentityInfo {
     }
 }
 
+#[derive(Debug, Clone, PartialEq)]
+pub struct ConnectionManagerInfo {
+    pub revision: u16,
+    pub status: u16,
+    pub configuration_capability: u16,
+}
+
+impl ConnectionManagerInfo {
+    pub fn decode(data: &[u8]) -> Result<Self, &'static str> {
+        if data.len() < 6 {
+            return Err("not enough connection manager attribute data");
+        }
+
+        let revision = u16::from_le_bytes([data[0], data[1]]);
+        let status = u16::from_le_bytes([data[2], data[3]]);
+        let configuration_capability = u16::from_le_bytes([data[4], data[5]]);
+
+        Ok(Self {
+            revision,
+            status,
+            configuration_capability,
+        })
+    }
+}
+
 impl CipValue {
     pub fn type_name(&self) -> &'static str {
         match self {
@@ -199,4 +224,17 @@ mod tests {
         assert_eq!(identity.product_name, "TestProduct");
         assert_eq!(identity.state, 0x05);
     }
+
+    #[test]
+    fn test_connection_manager_info_decode() {
+        let mut raw = Vec::new();
+        raw.extend_from_slice(&0x0102u16.to_le_bytes());
+        raw.extend_from_slice(&0x0304u16.to_le_bytes());
+        raw.extend_from_slice(&0x0506u16.to_le_bytes());
+
+        let info = ConnectionManagerInfo::decode(&raw).expect("decode should succeed");
+        assert_eq!(info.revision, 0x0102);
+        assert_eq!(info.status, 0x0304);
+        assert_eq!(info.configuration_capability, 0x0506);
+    }
 }