system

List of supported commands:

class nardascripting.base.scpi.system.ScpiSystem(com: nardascripting.base.comm.CommBase)

SignalShark SYSTem SCPI subsystem class.

get_audio_mute()

Queries the system audio mute setting

Returns

Audio mute

Return type

bool

get_audio_volume()

Queries the system audio volume setting

Returns

Audio volume

Return type

float

get_command_filter()

Queries the filter flags of command processing

Returns

Filter Flags

Return type

int

get_command_progress()

Queries the progress of command processing

Returns

Progress data as ProgressData

Return type

ProgressData

get_command_progress_raw()

Queries the progress of command processing

Returns

Progress step number; Progress step count; Progress info

Return type

float, float, str

get_remote_display()

Queries the remote display state

Returns

Remote Display

Return type

bool

get_remote_log()

Queries the remote logfile state

Returns

Remote Logfile

Return type

bool

get_remote_log_config()

Queries the remote logfile configuration

Returns

True for showing receive data; True for showing transmit data; True for showing timestamp info; True for showing connection info; Maximum line size, 0 = disable line size limit; Maximum line count, 0 = disable line count limit

Return type

bool, bool, bool, bool, int, int

get_remote_sleep(stime: float)

Lets parser sleep for a specific timespan and returns true if successful.

Parameters

stime (float) – Timespan for sleeping

Returns

Returns 1 if succesfull

Return type

bool

get_remote_timeout()

Queries the SCPI default remote timeout

Returns

Remote timeout in s

Return type

float

get_startup_date()

Startup Date of the system

Returns

System startup Date

Return type

str

get_startup_seconds()

Seconds since last start of the system

Returns

Seconds since last start of the system

Return type

int

get_startup_time()

Startup Time of the system

Returns

System startup Time

Return type

str

remote_timeout_reset()

Resets remote timeout of all commands to the default value

set_audio_mute(value: bool)

Sets the system audio mute setting

Parameters

value (bool) – Audio mute

set_audio_volume(value: float)

Sets the system audio volume setting

Parameters

value (float) – Audio volume 0%…100%

set_remote_display(value: bool)

Enables or disables GUI views while remote on

Parameters

value (bool) – Remote Display

set_remote_log(value: bool)

Enables or disables remote logfile

Parameters

value (bool) – Remote Logfile

set_remote_log_config(receive: bool, transmit: bool, timestamp: bool, connection: bool, line_size: int, line_count: int)

Sets the remote logfile configuration

Parameters
  • receive (bool) – True for showing receive data

  • transmit (bool) – True for showing transmit data

  • timestamp (bool) – True for showing timestamp info

  • connection (bool) – True for showing connection info

  • line_size (int) – Maximum line size, 0 = disable line size limit

  • line_count (int) – Maximum line count, 0 = disable line count limit

set_remote_timeout(timeout: float)

SCPI default remote timeout (default factory setting = 3 seconds)

Parameters

timeout (float) – Remote timeout (s, ms)

shutdown(value: nardascripting.base.scpi.enums.ShutdownModes)

Shuts down or restarts the instrument

Parameters

value (ShutdownModes) – Shutdown Mode (SYSTEM_RESTART, SYSTEM_LOG_OFF, APP_QUIT, APP_RESTART)