Hardware

Hardware#

class Hardware(resourceName, name)#

Bases: handle, matlab.mixin.SetGetExactNames

Hardware provides a common abstraction for controllable instruments.

Encapsulates identity, resource naming, upload data type, and optional logging of instrument snapshots via saveObject(). Concrete subclasses (e.g., AWGs, scopes, cameras, phase locks) implement vendor/model specifics.

Example:

awg = KeysightWaveformGenerator("TCPIP0::192.168.0.2::inst0::INSTR", name="AWG1");
% use awg-specific APIs here
Constructor Summary
Hardware(resourceName, name)#

Construct a Hardware object.

Parameters:
  • resourceName (string) – VISA/ethernet/COM resource identifier for the device.

  • name (string, optional) – Short device nickname used for logging folder names.

Property Summary
DataType string {mustBeMember(DataType,{'uint8','double'})} = "uint8"#
DisabledProperty string#

Properties that are not implemented for specific models

Manufacturer string#

Manufacturer of the device

Memory double#

How many sample points the device can store

Model string#

Model number

NChannel double = 1#

How many channels the device has

Name string#

Nickname of the device

ResourceName string#

Interfaces (like VISA) require a resource name to identify the device

Method Summary
convert2Table()#

Convert hardware configuration to a table for logging/serialization.

Gathers public settable properties (excluding dependent/hidden/ transient/private) and returns a table with device type, model, resource name, and per-channel settings.

Returns:

Table with columns: Name, Type, DeviceModel, ResourceName, Setting

Return type:

table