add 'visa' feature

Author: esarver

CHANGELOG.md

@@ -16,6 +16,12 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
     Security -- in case of vulnerabilities.
 -->
 
+## [0.17.1]
+
+### Added
+
+- VISA support
+
 ## [0.17.0]
 
 ### Changed
@@ -65,7 +71,8 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 - Using `read_password`instead of `prompt_password` of rpassword crate (TSP-517)
 
 <!--Version Comparison Links-->
-[Unreleased]: https://github.com/tektronix/tsp-toolkit-kic-lib/compare/v0.17.0..HEAD
+[Unreleased]: https://github.com/tektronix/tsp-toolkit-kic-lib/compare/v0.17.1..HEAD
+[0.17.1]: https://github.com/tektronix/tsp-toolkit-kic-lib/releases/tag/v0.17.1
 [0.17.0]: https://github.com/tektronix/tsp-toolkit-kic-lib/releases/tag/v0.17.0
 [0.16.1]: https://github.com/tektronix/tsp-toolkit-kic-lib/releases/tag/v0.16.1
 [0.15.1]: https://github.com/tektronix/tsp-toolkit-kic-lib/releases/tag/v0.15.1

Cargo.lock

@@ -1,7 +1,7 @@
 [package]
 name = "tsp-toolkit-kic-lib"
 description = "A library specifically enabling communication to the Keithley product-line of instruments"
-version = "0.17.0"
+version = "0.17.1"
 authors = ["Keithley Instruments, LLC"]
 edition = "2021"
 repository = "https://github.com/tektronix/tsp-toolkit-kic-lib"
@@ -19,7 +19,10 @@ rusb = "0.9"
 chrono = "0.4"
 minidom = "0.15"
 reqwest = { version = "0.12", features = ["blocking"] }
-visa-rs = "0.6.2"
+visa-rs = { version = "0.6.2", optional = true }
+
+[features]
+visa = ["dep:visa-rs"]
 
 [dev-dependencies]
 anyhow = "1"

Cargo.toml

@@ -129,6 +129,7 @@ pub enum InstrumentError {
         lang: String,
     },
 
+    #[cfg(feature = "visa")]
     /// An error from the visa driver
     #[error("visa error: {source}")]
     VisaError {

src/error.rs

@@ -22,3 +22,4 @@ pub use interface::{connection_addr::ConnectionAddr, usbtmc, Interface};
 pub use model::{ki2600, tti, versatest};
 
 pub mod protocol;
+pub use protocol::is_visa_installed;

src/lib.rs

@@ -194,6 +194,8 @@ impl NonBlock for Instrument {
     fn set_nonblocking(&mut self, enable: bool) -> crate::error::Result<()> {
         match &mut self.protocol {
             Protocol::Raw(r) => r.set_nonblocking(enable),
+
+            #[cfg(feature = "visa")]
             Protocol::Visa { .. } => Ok(()),
         }
     }

src/model/ki2600.rs

@@ -164,6 +164,8 @@ impl NonBlock for Instrument {
     fn set_nonblocking(&mut self, enable: bool) -> crate::error::Result<()> {
         match &mut self.protocol {
             Protocol::Raw(r) => r.set_nonblocking(enable),
+
+            #[cfg(feature = "visa")]
             Protocol::Visa { .. } => Ok(()),
         }
     }

src/model/ki3700.rs

@@ -194,6 +194,8 @@ impl NonBlock for Instrument {
     fn set_nonblocking(&mut self, enable: bool) -> crate::error::Result<()> {
         match &mut self.protocol {
             Protocol::Raw(r) => r.set_nonblocking(enable),
+
+            #[cfg(feature = "visa")]
             Protocol::Visa { .. } => Ok(()),
         }
     }

src/model/tti.rs

@@ -196,6 +196,8 @@ impl NonBlock for Instrument {
     fn set_nonblocking(&mut self, enable: bool) -> crate::error::Result<()> {
         match &mut self.protocol {
             Protocol::Raw(r) => r.set_nonblocking(enable),
+
+            #[cfg(feature = "visa")]
             Protocol::Visa { .. } => Ok(()),
         }
     }

src/model/versatest.rs

@@ -1,24 +1,85 @@
 use std::{
     error::Error,
     fmt::Display,
-    io::{ErrorKind, Read, Write},
+    io::{Read, Write},
+    path::Path,
 };
 
+#[cfg(target_os = "linux")]
+use std::path::PathBuff;
+
+use crate::{error::Result, instrument::Info, InstrumentError, Interface};
+
+#[cfg(feature = "visa")]
 use tracing::{trace, warn};
+
+#[cfg(feature = "visa")]
+use std::io::ErrorKind;
+
+#[cfg(feature = "visa")]
+use crate::instrument::info::get_info;
+
+#[cfg(feature = "visa")]
 use visa_rs::{
     enums::{assert::AssertTrigPro, status::ErrorCode},
     flags::{AccessMode, FlushMode},
     AsResourceManager, DefaultRM, VisaString, TIMEOUT_INFINITE,
 };
 
-use crate::{
-    error::Result,
-    instrument::{info::get_info, Info},
-    InstrumentError, Interface,
-};
+#[must_use]
+pub fn is_visa_installed() -> bool {
+    #[cfg(all(target_os = "windows", target_arch = "x86_64"))]
+    {
+        let search_path =
+            r"C:\Program Files (x86)\IVI Foundation\VISA\WinNT\Lib_x64\msc\visa64.lib";
+        Path::new(search_path).exists()
+    }
+    #[cfg(target_os = "linux")]
+    {
+        let Some(search_paths) = std::env::var_os("LD_LIBRARY_PATH") else {
+            return false;
+        };
+        let Ok(search_paths) = search_paths.into_string() else {
+            return false;
+        };
+        for p in search_paths.split(":") {
+            let Ok(dir) = Path::new(&p).read_dir() else {
+                return false;
+            };
+            if dir
+                .find(|e| {
+                    let Ok(e) = e else {
+                        return false;
+                    };
+                    let Ok(f) = e.file_name().into_string() else {
+                        return false;
+                    };
+
+                    //parse::<PathBuf> is infallible so unwrap is ok here.
+                    let path = p.parse::<PathBuf>().unwrap().join(f);
+
+                    path.file_stem()
+                        .unwrap()
+                        .to_string_lossy()
+                        .contains("libvisa")
+                })
+                .is_some()
+            {
+                return true;
+            }
+        }
+        false
+    }
+    #[cfg(target_os = "macos")]
+    {
+        false
+    }
+}
 
 pub enum Protocol {
     Raw(Box<dyn Interface>),
+
+    #[cfg(feature = "visa")]
     Visa {
         instr: visa_rs::Instrument,
         rm: DefaultRM,
@@ -107,6 +168,8 @@ impl Read for Protocol {
     fn read(&mut self, buf: &mut [u8]) -> std::io::Result<usize> {
         match self {
             Self::Raw(r) => r.read(buf),
+
+            #[cfg(feature = "visa")]
             Self::Visa { instr, .. } => {
                 let stb = Stb::Stb(instr.read_stb().map_err(|e| {
                     std::io::Error::new(ErrorKind::Other, format!("error reading STB: {e}"))
@@ -125,13 +188,17 @@ impl Write for Protocol {
     fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
         match self {
             Self::Raw(r) => r.write(buf),
+
+            #[cfg(feature = "visa")]
             Self::Visa { instr, .. } => instr.write(buf),
         }
     }
 
     fn flush(&mut self) -> std::io::Result<()> {
         match self {
             Self::Raw(r) => r.flush(),
+
+            #[cfg(feature = "visa")]
             Self::Visa { instr, .. } => match instr.visa_flush(FlushMode::IO_OUT_BUF) {
                 Ok(v) => Ok(v),
                 // viFlush(instrument, VI_IO_OUT_BUF) on USB throws this error, but we
@@ -150,6 +217,8 @@ impl Info for Protocol {
     fn info(&mut self) -> crate::error::Result<crate::instrument::info::InstrumentInfo> {
         match self {
             Self::Raw(r) => r.info(),
+
+            #[cfg(feature = "visa")]
             Self::Visa { instr, .. } => get_info(instr),
         }
     }
@@ -160,6 +229,8 @@ impl Clear for Protocol {
     fn clear(&mut self) -> core::result::Result<(), Self::Error> {
         match self {
             Self::Raw(r) => r.write_all(b"*CLS")?,
+
+            #[cfg(feature = "visa")]
             Self::Visa { instr, .. } => instr.clear()?,
         };
 
@@ -172,6 +243,8 @@ impl ReadStb for Protocol {
     fn read_stb(&mut self) -> core::result::Result<Stb, Self::Error> {
         match self {
             Self::Raw(_) => Ok(Stb::NotSupported),
+
+            #[cfg(feature = "visa")]
             Self::Visa { instr, .. } => Ok(Stb::Stb(instr.read_stb()?)),
         }
     }
@@ -184,6 +257,8 @@ impl Trigger for Protocol {
             Self::Raw(r) => {
                 r.write_all(b"*TRG\n")?;
             }
+
+            #[cfg(feature = "visa")]
             Self::Visa { instr, .. } => {
                 instr.assert_trigger(AssertTrigPro::TrigProtDefault)?;
             }
@@ -198,6 +273,7 @@ impl Protocol {
     ///
     /// # Errors
     /// Errors may occur from the system Visa drivers.
+    #[cfg(feature = "visa")]
     #[tracing::instrument]
     pub fn try_from_visa(visa_string: String) -> Result<Self> {
         trace!("Getting VISA Resource Manager");