DotNetFrameworkDev/GenericTeProgramLibrary
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Major upgrade

Browse Source
This commit is contained in:
Duc
2025-10-24 15:18:11 -07:00
parent fd85735c93
commit ce583d1664
478 changed files with 237518 additions and 47610 deletions
Download Patch File Download Diff File Expand all files Collapse all files

858
Source/TSRealLib/HAL/Implementations/Switch/SwitchKeysightScpi/SwitchKeysightScpi.cs
View File

@@ -22,11 +22,11 @@
// accordance with DoD-5220.22-M or OPNAVINST 5510.1h.
//>>***************************************************************************
using NLog;
using Raytheon.Common;
using System;
using System.Net.Sockets;
using System.Text;
using NLog;
using Raytheon.Common;
namespace Raytheon.Instruments
{
@@ -35,449 +35,413 @@ namespace Raytheon.Instruments
/// It only supports individual relay mode at this time.
/// </summary>
public class SwitchKeysightScpi : ISwitch
{
#region PrivateMemberVariables
private const string READ_ERROR_STATUS_CMD = "SYST:ERR?";
private const string _SELFTESTCMD = "*TST?";
private const string _RESETCMD = "*RST";
//@@@ add scpi commands here
private int _PORT = 5025;
private const int _READ_TIMEOUT = 5000;
private byte[] _readBuffer;
private NetworkStream _tcpStream;
private string _name;
/// <summary>
/// NLog logger
/// </summary>
private readonly ILogger _logger;
/// <summary>
/// Raytheon configuration
/// </summary>
private readonly IConfigurationManager _configurationManager;
private readonly IConfiguration _configuration;
#endregion
#region PrivateFunctions
/// <summary>
/// Dispose of this object's resources.
/// </summary>
/// <param name="disposing">True = currently disposing, False = not disposing.</param>
protected virtual void Dispose(bool disposing)
{
try
{
if (disposing && _tcpStream != null)
{
}
}
catch (Exception)
{
try
{
//ErrorLogger.Instance().Write(err.Message + "\r\n" + err.StackTrace);
}
catch (Exception)
{
//Do not rethrow. Exception from error logger that has already been garbage collected
}
}
}
/// <summary>
/// Convert scpi data to string
/// </summary>
/// <param name="data"></param>
/// <returns></returns>
private string ConvertToString(ref byte[] data)
{
string rsp = System.Text.Encoding.ASCII.GetString(data);
return rsp;
}
/// <summary>
/// Get the error code.
/// </summary>
/// <returns>The error code (number).</returns>
private int GetErrorCode()
{
// not calling IOQuery() here so IOQuery() can call GetErrorCode() after each query
string command = READ_ERROR_STATUS_CMD + "\n";
// convert to a byte array
byte[] commandBuffer = Encoding.ASCII.GetBytes(command);
// send the data out
_tcpStream.Write(commandBuffer, 0, commandBuffer.Length);
// clear our buffer
Array.Clear(_readBuffer, 0, _readBuffer.Length);
// read the response
int numBytesRead = _tcpStream.Read(_readBuffer, 0, _readBuffer.Length);
// convert to a string
string rspStr = ConvertToString(ref _readBuffer);
// parse the response
string[] tokens = rspStr.Split(',');
int ret = Util.ConvertStringToInt32(tokens[0]);
return ret;
}
/// <summary>
/// Send a command to the DMM and get the response
/// </summary>
/// <param name="commandString">The command to send</param>
/// <returns>The DMM response</returns>
private string IOQuery(string commandString)
{
// send the command
IOWrite(commandString);
// clear our buffer
Array.Clear(_readBuffer, 0, _readBuffer.Length);
// read from the response
int numBytesRead = _tcpStream.Read(_readBuffer, 0, _readBuffer.Length);
// convert response to a string
string rspStr = ConvertToString(ref _readBuffer);
// check for errors
int err = GetErrorCode();
if (err != 0)
{
throw new Exception("SwitchKeysightScpi:IOQuery() - returned error code: " + err.ToString());
}
return rspStr;
}
/// <summary>
/// Sends a SCPI Command to the instrument.
/// </summary>
/// <param name="commandString">The SCPI Command to be sent to the instrument.</param>
private void IOWrite(string commandString)
{
// convert to a byte array
byte[] commandBuffer = Encoding.ASCII.GetBytes(commandString);
// send the data out
_tcpStream.Write(commandBuffer, 0, commandBuffer.Length);
// check for errors
int err = GetErrorCode();
if (err != 0)
{
throw new Exception("SwitchKeysightScpi:IOQuery() - returned error code: " + err.ToString());
}
}
/// <summary>
/// Perform self-test.
/// </summary>
private void SelfTest()
{
try
{
// change the timeout to account for the long self test
_tcpStream.ReadTimeout = 30000;
// send the command and get the response
string command = _SELFTESTCMD + "\n";
string rspStr = IOQuery(command);
// parse the response
string[] tokens = rspStr.Split('\n');
int rsp = Util.ConvertStringToInt32(tokens[0]);
if (rsp != 0)
{
string errorMsg = "returned an error: " + rsp.ToString() + "," + rspStr;
throw new Exception(errorMsg);
}
}
catch (Exception)
{
throw;
}
finally
{
// restore the timeout
_tcpStream.ReadTimeout = _READ_TIMEOUT;
}
}
#endregion
#region PublicFunctions
/// <summary>
/// SwitchKeysightScpi factory constructor
/// </summary>
/// <param name="deviceName"></param>
/// <param name="configurationManager"></param>
public SwitchKeysightScpi(string deviceName, IConfigurationManager configurationManager, ILogger logger)
{
Name = deviceName;
_logger = logger;
_configurationManager = configurationManager;
_configuration = _configurationManager.GetConfiguration(Name);
var address = _configuration.GetConfigurationValue("SwitchKeysightScpi", "Address", "127.0.0.1");
_PORT = _configuration.GetConfigurationValue("SwitchKeysightScpi", "Port", 5025);
const int READ_BUFFER_SIZE = 512;
_readBuffer = new byte[READ_BUFFER_SIZE];
TcpClient dmmSocketConn = new TcpClient(address, _PORT);
_tcpStream = dmmSocketConn.GetStream();
_tcpStream.ReadTimeout = _READ_TIMEOUT;
SelfTest();
}
/// <summary>
/// Constructor for RelaySwitch card.
/// </summary>
/// <param name="address">The address of the RelaySwitch.</param>
/// <param name="options">The options used for setting up the instrument.</param>
public SwitchKeysightScpi(string name, string address)
{
const int READ_BUFFER_SIZE = 512;
_name = name;
_logger = LogManager.GetCurrentClassLogger();
_readBuffer = new byte[READ_BUFFER_SIZE];
TcpClient dmmSocketConn = new TcpClient(address, _PORT);
_tcpStream = dmmSocketConn.GetStream();
_tcpStream.ReadTimeout = _READ_TIMEOUT;
SelfTest();
}
/// <summary>
/// Finalizer.
/// </summary>
~SwitchKeysightScpi()
{
Dispose(false);
}
/// <summary>
///
/// </summary>
/// <returns></returns>
public bool ClearErrors()
{
throw new NotImplementedException();
}
/// <summary>
/// Close a single relay.
/// </summary>
/// <param name="relay">The relay to close.</param>
public void Connect(string path)
{
// send the command
//IOWrite(command);
//read back to verify state of relay?
//"ROUT:CLOS (@3923)"
}
/// <summary>
/// Open a single relay.
/// </summary>
/// <param name="relay">The relay to open.</param>
public void Disconnect(string path)
{
// send the command
//IOWrite(command);
//read back to verify state of relay?
//"ROUT:OPEN (@3923)")
}
/// <summary>
///
/// </summary>
public void DisconnectAll()
{
}
/// <summary>
/// Dispose of resources.
/// </summary>
public void Dispose()
{
try
{
Dispose(true);
GC.SuppressFinalize(this);
}
catch (Exception)
{
try
{
//ErrorLogger.Instance().Write(err.Message + "\r\n" + err.StackTrace);
}
catch (Exception)
{
//Do not rethrow. Exception from error logger that has already been garbage collected
}
}
}
/// <summary>
///
/// </summary>
public string DetailedStatus
{
get
{
return "This is a Keysight 34980A switch";
}
}
/// <summary>
///
/// </summary>
public bool DisplayEnabled
{
get
{
throw new NotSupportedException();
}
set
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public bool FrontPanelEnabled
{
get
{
throw new NotSupportedException();
}
set
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public InstrumentMetadata Info
{
get
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public void Initialize()
{
throw new NotSupportedException();
}
/// <summary>
///
/// </summary>
public bool IsDebounced
{
get
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public string Name
{
get { return _name; }
set { _name = value; }
}
/// <summary>
///
/// </summary>
public SelfTestResult SelfTestResult
{
get
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public State Status
{
get
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
/// <returns></returns>
public SelfTestResult PerformSelfTest()
{
throw new NotSupportedException();
}
/// <summary>
///
/// </summary>
public void Reset()
{
IOWrite(_RESETCMD + "\n");
}
/// <summary>
///
/// </summary>
public void Shutdown()
{
if (_tcpStream != null)
{
Reset();
_tcpStream.Dispose();
}
}
#endregion
}
{
#region PrivateMemberVariables
private const string READ_ERROR_STATUS_CMD = "SYST:ERR?";
private const string _SELFTESTCMD = "*TST?";
private const string _RESETCMD = "*RST";
//@@@ add scpi commands here
private int _PORT = 5025;
private const int _READ_TIMEOUT = 5000;
private byte[] _readBuffer;
private NetworkStream _tcpStream;
private string _name;
private readonly ILogger _logger;
private readonly IConfigurationManager _configurationManager;
private readonly IConfiguration _configuration;
#endregion
#region PrivateFunctions
/// <summary>
/// Dispose of this object's resources.
/// </summary>
/// <param name="disposing">True = currently disposing, False = not disposing.</param>
protected virtual void Dispose(bool disposing)
{
}
/// <summary>
/// Convert scpi data to string
/// </summary>
/// <param name="data"></param>
/// <returns></returns>
private string ConvertToString(ref byte[] data)
{
string rsp = System.Text.Encoding.ASCII.GetString(data);
return rsp;
}
/// <summary>
/// Get the error code.
/// </summary>
/// <returns>The error code (number).</returns>
private int GetErrorCode()
{
// not calling IOQuery() here so IOQuery() can call GetErrorCode() after each query
string command = READ_ERROR_STATUS_CMD + "\n";
// convert to a byte array
byte[] commandBuffer = Encoding.ASCII.GetBytes(command);
// send the data out
_tcpStream.Write(commandBuffer, 0, commandBuffer.Length);
// clear our buffer
Array.Clear(_readBuffer, 0, _readBuffer.Length);
// read the response
int numBytesRead = _tcpStream.Read(_readBuffer, 0, _readBuffer.Length);
// convert to a string
string rspStr = ConvertToString(ref _readBuffer);
// parse the response
string[] tokens = rspStr.Split(',');
int ret = Util.ConvertStringToInt32(tokens[0]);
return ret;
}
/// <summary>
/// Send a command to the DMM and get the response
/// </summary>
/// <param name="commandString">The command to send</param>
/// <returns>The DMM response</returns>
private string IOQuery(string commandString)
{
// send the command
IOWrite(commandString);
// clear our buffer
Array.Clear(_readBuffer, 0, _readBuffer.Length);
// read from the response
int numBytesRead = _tcpStream.Read(_readBuffer, 0, _readBuffer.Length);
// convert response to a string
string rspStr = ConvertToString(ref _readBuffer);
// check for errors
int err = GetErrorCode();
if (err != 0)
{
throw new Exception("SwitchKeysightScpi:IOQuery() - returned error code: " + err.ToString());
}
return rspStr;
}
/// <summary>
/// Sends a SCPI Command to the instrument.
/// </summary>
/// <param name="commandString">The SCPI Command to be sent to the instrument.</param>
private void IOWrite(string commandString)
{
// convert to a byte array
byte[] commandBuffer = Encoding.ASCII.GetBytes(commandString);
// send the data out
_tcpStream.Write(commandBuffer, 0, commandBuffer.Length);
// check for errors
int err = GetErrorCode();
if (err != 0)
{
throw new Exception("SwitchKeysightScpi:IOQuery() - returned error code: " + err.ToString());
}
}
/// <summary>
/// Perform self-test.
/// </summary>
private void SelfTest()
{
try
{
// change the timeout to account for the long self test
_tcpStream.ReadTimeout = 30000;
// send the command and get the response
string command = _SELFTESTCMD + "\n";
string rspStr = IOQuery(command);
// parse the response
string[] tokens = rspStr.Split('\n');
int rsp = Util.ConvertStringToInt32(tokens[0]);
if (rsp != 0)
{
string errorMsg = "returned an error: " + rsp.ToString() + "," + rspStr;
throw new Exception(errorMsg);
}
}
catch (Exception)
{
throw;
}
finally
{
// restore the timeout
_tcpStream.ReadTimeout = _READ_TIMEOUT;
}
}
#endregion
#region PublicFunctions
/// <summary>
/// SwitchKeysightScpi factory constructor
/// </summary>
/// <param name="deviceName"></param>
/// <param name="configurationManager"></param>
public SwitchKeysightScpi(string deviceName, IConfigurationManager configurationManager)
{
Name = deviceName;
_logger = LogManager.GetLogger($"{this.GetType().Name} - {deviceName}");
_configurationManager = configurationManager;
_configuration = _configurationManager.GetConfiguration(Name);
var address = _configuration.GetConfigurationValue("SwitchKeysightScpi", "Address", "127.0.0.1");
_PORT = _configuration.GetConfigurationValue("SwitchKeysightScpi", "Port", 5025);
const int READ_BUFFER_SIZE = 512;
_readBuffer = new byte[READ_BUFFER_SIZE];
TcpClient dmmSocketConn = new TcpClient(address, _PORT);
_tcpStream = dmmSocketConn.GetStream();
_tcpStream.ReadTimeout = _READ_TIMEOUT;
SelfTest();
}
/// <summary>
/// Constructor for RelaySwitch card.
/// </summary>
/// <param name="address">The address of the RelaySwitch.</param>
/// <param name="options">The options used for setting up the instrument.</param>
public SwitchKeysightScpi(string deviceName, string address)
{
const int READ_BUFFER_SIZE = 512;
_name = deviceName;
_logger = LogManager.GetLogger($"{this.GetType().Name} - {deviceName}");
_readBuffer = new byte[READ_BUFFER_SIZE];
TcpClient dmmSocketConn = new TcpClient(address, _PORT);
_tcpStream = dmmSocketConn.GetStream();
_tcpStream.ReadTimeout = _READ_TIMEOUT;
SelfTest();
}
/// <summary>
/// Finalizer.
/// </summary>
~SwitchKeysightScpi()
{
Dispose(false);
}
/// <summary>
///
/// </summary>
/// <returns></returns>
public bool ClearErrors()
{
throw new NotImplementedException();
}
/// <summary>
/// Close a single relay.
/// </summary>
/// <param name="relay">The relay to close.</param>
public void Connect(string path)
{
// send the command
//IOWrite(command);
//read back to verify state of relay?
//"ROUT:CLOS (@3923)"
}
/// <summary>
/// Open a single relay.
/// </summary>
/// <param name="relay">The relay to open.</param>
public void Disconnect(string path)
{
// send the command
//IOWrite(command);
//read back to verify state of relay?
//"ROUT:OPEN (@3923)")
}
/// <summary>
///
/// </summary>
public void DisconnectAll()
{
}
/// <summary>
/// Dispose of resources.
/// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
/// <summary>
///
/// </summary>
public string DetailedStatus
{
get
{
return "This is a Keysight 34980A switch";
}
}
/// <summary>
///
/// </summary>
public bool DisplayEnabled
{
get
{
throw new NotSupportedException();
}
set
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public bool FrontPanelEnabled
{
get
{
throw new NotSupportedException();
}
set
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public InstrumentMetadata Info
{
get
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public void Initialize()
{
throw new NotSupportedException();
}
/// <summary>
///
/// </summary>
public bool IsDebounced
{
get
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public string Name
{
get { return _name; }
set { _name = value; }
}
/// <summary>
///
/// </summary>
public SelfTestResult SelfTestResult
{
get
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
public State Status
{
get
{
throw new NotSupportedException();
}
}
/// <summary>
///
/// </summary>
/// <returns></returns>
public SelfTestResult PerformSelfTest()
{
throw new NotSupportedException();
}
/// <summary>
///
/// </summary>
public void Reset()
{
IOWrite(_RESETCMD + "\n");
}
/// <summary>
///
/// </summary>
public void Shutdown()
{
if (_tcpStream != null)
{
Reset();
_tcpStream.Dispose();
}
}
#endregion
}
}

129
Source/TSRealLib/HAL/Implementations/Switch/SwitchKeysightScpi/SwitchKeysightScpiFactory.cs
View File

@@ -31,71 +31,64 @@
// POC: Alex Kravchenko (1118268)
// **********************************************************************************************************
using NLog;
using Raytheon.Common;
using System;
using System.Collections.Generic;
using System.ComponentModel.Composition;
using System.IO;
using System.Reflection;
using NLog;
using Raytheon.Common;
namespace Raytheon.Instruments
{
[ExportInstrumentFactory(ModelNumber = "SwitchKeysightScpiFactory")]
public class SwitchKeysightScpiFactory : IInstrumentFactory
{
/// <summary>
/// The supported interfaces
/// </summary>
private readonly List<Type> _supportedInterfaces = new List<Type>();
private ILogger _logger;
private readonly IConfigurationManager _configurationManager;
private const string DefaultConfigPath = @"C:\ProgramData\Raytheon\InstrumentManagerService";
private static string DefaultPath;
[ExportInstrumentFactory(ModelNumber = "SwitchKeysightScpiFactory")]
public class SwitchKeysightScpiFactory : IInstrumentFactory
{
private readonly List<Type> _supportedInterfaces = new List<Type>();
public SwitchKeysightScpiFactory(string defaultConfigPath = DefaultConfigPath)
: this(null, defaultConfigPath)
{
}
private readonly IConfigurationManager _configurationManager;
private const string DefaultConfigPath = @"C:\ProgramData\Raytheon\InstrumentManagerService";
private static string DefaultPath;
/// <summary>
/// COECommDeviceInstrumentFactory injection constructor
/// </summary>
/// <param name="configManager"></param>
/// <param name="simEngine"></param>
/// <param name="logger"></param>
[ImportingConstructor]
public SwitchKeysightScpiFactory([Import(AllowDefault = false)] IConfigurationManager configManager,
[Import(AllowDefault = true)] string defaultConfigPath = null)
{
DefaultPath = defaultConfigPath;
public SwitchKeysightScpiFactory(string defaultConfigPath = DefaultConfigPath)
: this(null, defaultConfigPath)
{
}
if (LogManager.Configuration == null)
{
var assemblyFolder = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
LogManager.Configuration = new NLog.Config.XmlLoggingConfiguration(assemblyFolder + "\\nlog.config");
}
/// <summary>
/// SwitchKeysightScpiFactory injection constructor
/// </summary>
[ImportingConstructor]
public SwitchKeysightScpiFactory([Import(AllowDefault = false)] IConfigurationManager configManager,
[Import(AllowDefault = true)] string defaultConfigPath = null)
{
DefaultPath = defaultConfigPath;
_configurationManager = configManager ?? GetConfigurationManager();
_supportedInterfaces.Add(typeof(ISwitch));
}
/// <summary>
/// Gets the instrument
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
public IInstrument GetInstrument(string name)
{
try
{
_logger = LogManager.GetLogger(name);
return new SwitchKeysightScpi(name, _configurationManager, _logger);
}
catch (Exception)
{
throw;
}
}
if (LogManager.Configuration == null)
{
var assemblyFolder = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
LogManager.Configuration = new NLog.Config.XmlLoggingConfiguration(assemblyFolder + "\\nlog.config");
}
_configurationManager = configManager ?? GetConfigurationManager();
_supportedInterfaces.Add(typeof(ISwitch));
}
/// <summary>
/// Gets the instrument
/// </summary>
/// <param name="name"></param>
/// <returns></returns>
public IInstrument GetInstrument(string name)
{
try
{
return new SwitchKeysightScpi(name, _configurationManager);
}
catch (Exception)
{
throw;
}
}
/// <summary>
/// Gets the instrument
@@ -106,12 +99,10 @@ namespace Raytheon.Instruments
{
try
{
_logger = LogManager.GetLogger(name);
if (simulateHw)
return new SwitchSim(name, _configurationManager, _logger);
return new SwitchSim(name, _configurationManager);
else
return new SwitchKeysightScpi(name, _configurationManager, _logger);
return new SwitchKeysightScpi(name, _configurationManager);
}
catch (Exception)
{
@@ -124,17 +115,17 @@ namespace Raytheon.Instruments
/// </summary>
/// <returns></returns>
public ICollection<Type> GetSupportedInterfaces()
{
return _supportedInterfaces.ToArray();
}
{
return _supportedInterfaces.ToArray();
}
/// <summary>
/// returns configuration based on the predefined path or default path c:/ProgramData/Raytheon/InstrumentManagerService
/// </summary>
/// <returns></returns>
private static IConfigurationManager GetConfigurationManager()
{
return string.IsNullOrEmpty(DefaultPath) ? new RaytheonConfigurationManager() : new RaytheonConfigurationManager(DefaultPath);
}
}
/// <summary>
/// returns configuration based on the predefined path or default path c:/ProgramData/Raytheon/InstrumentManagerService
/// </summary>
/// <returns></returns>
private static IConfigurationManager GetConfigurationManager()
{
return string.IsNullOrEmpty(DefaultPath) ? new RaytheonConfigurationManager() : new RaytheonConfigurationManager(DefaultPath);
}
}
}