Holzworth

HS9000 Multichannel frequency synthesizer

class instruments.holzworth.HS9000(filelike, *args, **kwargs)[source]

Communicates with a Holzworth HS-9000 series multi-channel frequency synthesizer.

class Channel(hs, idx_chan)[source]

Class representing a physical channel on the Holzworth HS9000

Warning

This class should NOT be manually created by the user. It

is designed to be initialized by the HS9000 class.

query(cmd)[source]

Function used to send a command to the instrument while wrapping the command with the neccessary identifier for the channel.

Parameters:

cmd (str) – Command that will be sent to the instrument after being prefixed with the channel identifier

Returns:

The result from the query

Return type:

str

recall_state()[source]

Recalls the state of the specified channel from memory.

Example usage: >>> import instruments as ik >>> hs = ik.holzworth.HS9000.open_tcpip(“192.168.0.2”, 8080) >>> hs.channel[0].recall_state()

reset()[source]

Resets the setting of the specified channel

Example usage: >>> import instruments as ik >>> hs = ik.holzworth.HS9000.open_tcpip(“192.168.0.2”, 8080) >>> hs.channel[0].reset()

save_state()[source]

Saves the current state of the specified channel.

Example usage: >>> import instruments as ik >>> hs = ik.holzworth.HS9000.open_tcpip(“192.168.0.2”, 8080) >>> hs.channel[0].save_state()

sendcmd(cmd)[source]

Function used to send a command to the instrument while wrapping the command with the neccessary identifier for the channel.

Parameters:

cmd (str) – Command that will be sent to the instrument after being prefixed with the channel identifier

property frequency

Gets/sets the frequency of the specified channel. When setting, values are bounded between what is returned by frequency_min and frequency_max.

Example usage: >>> import instruments as ik >>> hs = ik.holzworth.HS9000.open_tcpip(“192.168.0.2”, 8080) >>> print(hs.channel[0].frequency) >>> print(hs.channel[0].frequency_min) >>> print(hs.channel[0].frequency_max)

Type:

Quantity

Units:

As specified or assumed to be of units GHz

property frequency_max
property frequency_min
property output

Gets/sets the output status of the channel. Setting to True will turn the channel’s output stage on, while a value of False will turn it off.

Example usage: >>> import instruments as ik >>> hs = ik.holzworth.HS9000.open_tcpip(“192.168.0.2”, 8080) >>> print(hs.channel[0].output) >>> hs.channel[0].output = True

Type:

bool

property phase

Gets/sets the output phase of the specified channel. When setting, values are bounded between what is returned by phase_min and phase_max.

Example usage: >>> import instruments as ik >>> hs = ik.holzworth.HS9000.open_tcpip(“192.168.0.2”, 8080) >>> print(hs.channel[0].phase) >>> print(hs.channel[0].phase_min) >>> print(hs.channel[0].phase_max)

Type:

Quantity

Units:

As specified or assumed to be of units degrees

property phase_max
property phase_min
property power

Gets/sets the output power of the specified channel. When setting, values are bounded between what is returned by power_min and power_max.

Example usage: >>> import instruments as ik >>> hs = ik.holzworth.HS9000.open_tcpip(“192.168.0.2”, 8080) >>> print(hs.channel[0].power) >>> print(hs.channel[0].power_min) >>> print(hs.channel[0].power_max)

Type:

Quantity

Units:

instruments.units.dBm

property power_max
property power_min
property temperature

Gets the current temperature of the specified channel.

Units:

As specified by the instrument.

Return type:

Quantity

property channel

Gets a specific channel on the HS9000. The desired channel is accessed like one would access a list.

Example usage:

>>> import instruments as ik
>>> hs = ik.holzworth.HS9000.open_tcpip("192.168.0.2", 8080)
>>> print(hs.channel[0].frequency)
Returns:

A channel object for the HS9000

Return type:

Channel

property name

Gets identification string of the HS9000

Returns:

The string as usually returned by *IDN? on SCPI instruments

Return type:

str

property ready

Gets the ready status of the HS9000.

Returns:

If the instrument is ready for operation

Return type:

bool