[python source code]

message

The message commands module.

These commands are used in the following models: DPO2K, DPO2KB, DPO4K, DPO4KB, MDO3K, MDO4K, MDO4KB, MDO4KC, MSO2K, MSO2KB, MSO4K, MSO4KB

THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.

Please report an issue if one is found.

Commands and Queries 
- MESSage
- MESSage:BOX <X1>,<Y1>[,<X2>,<Y2>]
- MESSage:BOX?
- MESSage:CLEAR
- MESSage:SHOW <QString>
- MESSage:SHOW?
- MESSage:STATE {ON|OFF|<NR1>}
- MESSage:STATE?
- MESSage?

Message

Bases: SCPICmdWriteNoArguments, SCPICmdRead

The MESSage command.

Description
  • This command sets or queries message box (screen annotation) parameters.
Usage
  • Using the .query() method will send the MESSage? query.
  • Using the .verify(value) method will send the MESSage? query and raise an AssertionError if the returned value does not match value.
  • Using the .write() method will send the MESSage command.
SCPI Syntax 
- MESSage
- MESSage?
Properties
  • .box: The MESSage:BOX command.
  • .clear: The MESSage:CLEAR command.
  • .show: The MESSage:SHOW command.
  • .state: The MESSage:STATE command.

box property 

box: MessageBox

Return the MESSage:BOX command.

Description
  • This command specifies the co-ordinates of the message box. This command does not display the message unless MESSage:STATE is on. X1 and Y1 are the screen coordinates of the top left corner of the message box. X2 and Y2 are the screen coordinates of the bottom right corner of the message box. All four coordinates are returned by the query. Changing the text in the message box, using the MESSAGE:SHOW command, automatically resizes the message box. If you want a custom message box size, send the MESSAGE:BOX command after changing the text using the MESSAGE:SHOW command. Message box settings and data are saved and restored in saved setups.
Usage
  • Using the .query() method will send the MESSage:BOX? query.
  • Using the .verify(value) method will send the MESSage:BOX? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MESSage:BOX value command.
SCPI Syntax 
- MESSage:BOX <X1>,<Y1>[,<X2>,<Y2>]
- MESSage:BOX?
Info
  • <X1> and = 0 to 1023, and are pixel positions along the horizontal axis. defines the left and defines the right side of the window.
  • <Y1> and = 0 to 767, and are pixel positions along the vertical axis. defines the top and defines the bottom of the window. The reserved height of all characters is 16 pixels so the window must be at least that high to fully display characters. and are optional because the MESSAGE:SHOW command automatically sizes the box to fit the message. All four values are returned in a query.

clear property 

clear: MessageClear

Return the MESSage:CLEAR command.

Description
  • Clears the contents of the message box.
Usage
  • Using the .write() method will send the MESSage:CLEAR command.
SCPI Syntax 
- MESSage:CLEAR

show property 

show: MessageShow

Return the MESSage:SHOW command.

Description
  • This command specifies the contents of the message box. MESSage:SHOW defines the content of the message box. Change in string length causes automatic resize of the message box to fit the text. The box may be resized using the MESSAGE:BOX command. The MESSAGE:STATE command is used to turn on and off the message box display.
Usage
  • Using the .query() method will send the MESSage:SHOW? query.
  • Using the .verify(value) method will send the MESSage:SHOW? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MESSage:SHOW value command.
SCPI Syntax 
- MESSage:SHOW <QString>
- MESSage:SHOW?
Info
  • <QString> is the message and can include any of the characters shown in the Character Set.

state property 

state: MessageState

Return the MESSage:STATE command.

Description
  • Controls the display of the message box.
Usage
  • Using the .query() method will send the MESSage:STATE? query.
  • Using the .verify(value) method will send the MESSage:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MESSage:STATE value command.
SCPI Syntax 
- MESSage:STATE {ON|OFF|<NR1>}
- MESSage:STATE?
Info
  • OFF or <NR1> = 0 removes the message window from the screen.
  • ON or <NR1> ≠ 0 displays the message window and its contents on the screen.

MessageBox

Bases: SCPICmdWrite, SCPICmdRead

The MESSage:BOX command.

Description
  • This command specifies the co-ordinates of the message box. This command does not display the message unless MESSage:STATE is on. X1 and Y1 are the screen coordinates of the top left corner of the message box. X2 and Y2 are the screen coordinates of the bottom right corner of the message box. All four coordinates are returned by the query. Changing the text in the message box, using the MESSAGE:SHOW command, automatically resizes the message box. If you want a custom message box size, send the MESSAGE:BOX command after changing the text using the MESSAGE:SHOW command. Message box settings and data are saved and restored in saved setups.
Usage
  • Using the .query() method will send the MESSage:BOX? query.
  • Using the .verify(value) method will send the MESSage:BOX? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MESSage:BOX value command.
SCPI Syntax 
- MESSage:BOX <X1>,<Y1>[,<X2>,<Y2>]
- MESSage:BOX?
Info
  • <X1> and = 0 to 1023, and are pixel positions along the horizontal axis. defines the left and defines the right side of the window.
  • <Y1> and = 0 to 767, and are pixel positions along the vertical axis. defines the top and defines the bottom of the window. The reserved height of all characters is 16 pixels so the window must be at least that high to fully display characters. and are optional because the MESSAGE:SHOW command automatically sizes the box to fit the message. All four values are returned in a query.

MessageClear

Bases: SCPICmdWriteNoArguments

The MESSage:CLEAR command.

Description
  • Clears the contents of the message box.
Usage
  • Using the .write() method will send the MESSage:CLEAR command.
SCPI Syntax 
- MESSage:CLEAR

MessageShow

Bases: SCPICmdWrite, SCPICmdRead

The MESSage:SHOW command.

Description
  • This command specifies the contents of the message box. MESSage:SHOW defines the content of the message box. Change in string length causes automatic resize of the message box to fit the text. The box may be resized using the MESSAGE:BOX command. The MESSAGE:STATE command is used to turn on and off the message box display.
Usage
  • Using the .query() method will send the MESSage:SHOW? query.
  • Using the .verify(value) method will send the MESSage:SHOW? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MESSage:SHOW value command.
SCPI Syntax 
- MESSage:SHOW <QString>
- MESSage:SHOW?
Info
  • <QString> is the message and can include any of the characters shown in the Character Set.

MessageState

Bases: SCPICmdWrite, SCPICmdRead

The MESSage:STATE command.

Description
  • Controls the display of the message box.
Usage
  • Using the .query() method will send the MESSage:STATE? query.
  • Using the .verify(value) method will send the MESSage:STATE? query and raise an AssertionError if the returned value does not match value.
  • Using the .write(value) method will send the MESSage:STATE value command.
SCPI Syntax 
- MESSage:STATE {ON|OFF|<NR1>}
- MESSage:STATE?
Info
  • OFF or <NR1> = 0 removes the message window from the screen.
  • ON or <NR1> ≠ 0 displays the message window and its contents on the screen.