HardCopy

SCPI Commands :

HCOPy:DATA
HCOPy:WBKG
HCOPy:SSD
HCOPy:ISBA
HCOPy:DESTination

Commands in total: 9

Subgroups: 2

Direct child commands: 5

get_data() → bytes

# HCOPy:DATA
value: bytes = driver.hardCopy.get_data()

Creates a PNG screenshot and returns the data of the image file in a binary data stream. When receiving the data, write them into a PNG file which you can open later.

get_destination() → PrintTarget

# HCOPy:DESTination
value: enums.PrintTarget = driver.hardCopy.get_destination()

Selects the output medium: file or clipboard.

Returns:

medium: MMEM: saves image to a file. CLIPBOARD: directs the image to the clipboard.

get_isba() → bool

# HCOPy:ISBA
value: bool = driver.hardCopy.get_isba()

If enabled, the screenshot shows the signal bar below the diagram area.

Returns:

include_sign_bar_scpi: OFF | ON

get_ssd() → bool

# HCOPy:SSD
value: bool = driver.hardCopy.get_ssd()

If enabled, the currently open dialog box is included in the screenshot.

get_wbkg() → bool

# HCOPy:WBKG
value: bool = driver.hardCopy.get_wbkg()

Inverts the background color, so you can picture waveforms with normal waveform colors on white background. If both method RsMxo.hardCopy.wbkg() and method RsMxo.hardCopy.device.inverse() are ON, the instrument inverts the background twice, and it appears black.

set_destination(medium: PrintTarget) → None

# HCOPy:DESTination
driver.hardCopy.set_destination(medium = enums.PrintTarget.CLIPBOARD)

Selects the output medium: file or clipboard.

Parameters:

medium – MMEM: saves image to a file. CLIPBOARD: directs the image to the clipboard.

set_isba(include_sign_bar_scpi: bool) → None

# HCOPy:ISBA
driver.hardCopy.set_isba(include_sign_bar_scpi = False)

If enabled, the screenshot shows the signal bar below the diagram area.

Parameters:

include_sign_bar_scpi – OFF | ON

set_ssd(shw_set_dialog_scpi: bool) → None

# HCOPy:SSD
driver.hardCopy.set_ssd(shw_set_dialog_scpi = False)

If enabled, the currently open dialog box is included in the screenshot.

Parameters:

shw_set_dialog_scpi – OFF | ON

set_wbkg(white_background_scpi: bool) → None

# HCOPy:WBKG
driver.hardCopy.set_wbkg(white_background_scpi = False)

Inverts the background color, so you can picture waveforms with normal waveform colors on white background. If both method RsMxo.hardCopy.wbkg() and method RsMxo.hardCopy.device.inverse() are ON, the instrument inverts the background twice, and it appears black.

Parameters:

white_background_scpi – OFF | ON

Cloning the Group

# Create a copy of the original group, that exists independently
hardCopy_copy = driver.hardCopy.clone()

Subgroups

• Device
• Immediate