Interface BodeAutomationInterface

Start class for the Automation interface. With this class it is possible to especially search and select the desired BodeDevice device.

Namespace: OmicronLab.VectorNetworkAnalysis.AutomationInterface.Interfaces

Assembly: OmicronLab.VectorNetworkAnalysis.AutomationInterface.dll

Syntax

[Guid("4274E200-3639-4D62-9F4F-66415A72EB3B")]
[InterfaceType(ComInterfaceType.InterfaceIsIDispatch)]
[ComVisible(true)]
public interface BodeAutomationInterface : IDisposable

Remarks

If only one device is available to connect it is easier to use the Bode100 class, this class will direct choose the first available device.

Properties

Version

Gets the version of the Automation interface.

Declaration

string Version { get; }

Property Value

Type	Description
string	The version number.

Methods

Connect()

Connect to a the first bode100 device which can be found. NOTE: This call can take up to 2 minutes if an internal calibration needs to be performed. ATTENTION: Do not call this method from GUI threads as this could cause dead-locks.

Declaration

BodeDevice Connect()

Returns

Type	Description
BodeDevice	A new instance of BodeDevice class.

Connect(Action<double>)

Connect to a the first BodeDevice device which can be found with an internal calibration callback. NOTE: This call can take up to 2 minutes if an internal calibration needs to be performed. ATTENTION: Do not call this method from GUI threads as this could cause dead-locks.

Declaration

[ComVisible(false)]
BodeDevice Connect(Action<double> internalCalibrationCallback)

Parameters

Type	Name	Description
Action<double>	internalCalibrationCallback	The internal calibration callback.

Returns

Type	Description
BodeDevice	A new instance of BodeDevice class.

ConnectWithSerialNumber(string)

Connects to a BodeDevice device by the given SerialNumber. NOTE: This call can take up to 2 minutes if an internal calibration needs to be performed. ATTENTION: Do not call this method from GUI threads as this could cause dead-locks.

Declaration

BodeDevice ConnectWithSerialNumber(string serialNumber)

Parameters

Type	Name	Description
string	serialNumber	The SerialNumber of the device to connect.

Returns

Type	Description
BodeDevice	A new instance of BodeDevice class.

ConnectWithSerialNumber(string, Action<double>)

Connect to a BodeDevice device by serial number with an internal calibration callback. NOTE: This call can take up to 2 minutes if an internal calibration needs to be performed. ATTENTION: Do not call this method from GUI threads as this could cause dead-locks.

Declaration

[ComVisible(false)]
BodeDevice ConnectWithSerialNumber(string serialNumber, Action<double> internalCalibrationCallback)

Parameters

Type	Name	Description
string	serialNumber	The serial number of the device to connect.
Action<double>	internalCalibrationCallback	The internal calibration callback.

Returns

Type	Description
BodeDevice	A new instance of BodeDevice class.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

void Dispose()

JoinCustomerExperienceImprovementProgram(bool)

For more information regarding the Customer Experience Improvement Program see BodeAnalyzerSuite.

Declaration

void JoinCustomerExperienceImprovementProgram(bool isTelemetryEnabled)

Parameters

Type	Name	Description
bool	isTelemetryEnabled	Indicates whether the telemetry is enabled or not.

ScanForAttachedDevices()

Scans for attached devices.

Declaration

string[] ScanForAttachedDevices()

Returns

Type	Description
string[]	An array containing the serial numbers of the found BodeDevice devices.

ScanForFreeDevices()

Scans for free connected devices.

Declaration

string[] ScanForFreeDevices()

Returns

Type	Description
string[]	An array containing the serial numbers of the found BodeDevice devices.

SetLogToFile(string, LogLevel)

Sets the path for the log file.

Declaration

void SetLogToFile(string path, LogLevel logLevel)

Parameters

Type	Name	Description
string	path	The user specified log file path.
LogLevel	logLevel	The log level. LogLevel.

Remarks

To use the logging option you have to set a path to a folder where the log messages shall be written.

SetLogToUdpStream(int, LogLevel)

Sets the port and loglevel for stream logging.

Declaration

void SetLogToUdpStream(int port, LogLevel logLevel)

Parameters

Type	Name	Description
int	port	The port.
LogLevel	logLevel	The log level.

Events

DeviceAdded

Occurs when a new BodeDevice device is plugged in.

Declaration

event DeviceAddedDelegate DeviceAdded

Event Type

Type	Description
DeviceAddedDelegate

DeviceRemoved

Occurs when a BodeDevice device is removed from the computer.

Declaration

event DeviceRemovedDelegate DeviceRemoved

Event Type

Type	Description
DeviceRemovedDelegate

InternalCalibrationUpdate

Occurs during internal device calibration.

Declaration

event InternalCalibrationCallbackDelegate InternalCalibrationUpdate

Event Type

Type	Description
InternalCalibrationCallbackDelegate