The filesystem commands module.
These commands are used in the following models: DPO5K, DPO5KB, DPO70KC, DPO70KD, DPO70KDX, DPO70KSX, DPO7K, DPO7KC, DSA70KC, DSA70KD, MSO5K, MSO5KB, MSO70KC, MSO70KDX
THIS FILE IS AUTO-GENERATED, IT SHOULD NOT BE MANUALLY MODIFIED.
Please report an issue if one is found.
Commands and Queries
- FILESystem:COPy {<source file path>,<destination file path>}
- FILESystem:CWD {<new working directory path>}
- FILESystem:DELEte <file path>
- FILESystem:DIR?
- FILESystem:MKDir <directory path>
- FILESystem:PRInt <filepath>, GPIb
- FILESystem:READFile <filepath>
- FILESystem:REName <old file path>,<new file path>
- FILESystem:RMDir <directory path>
- FILESystem:WRITEFile <file path>,<data>
- FILESystem?
Bases: SCPICmdRead
The FILESystem command.
Description
- This query-only command returns the directory listing of the current working directory.
This query is the same as the
FILESystem:DIR?query.
Usage
- Using the
.query()method will send theFILESystem?query. - Using the
.verify(value)method will send theFILESystem?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- FILESystem?
Properties
.copy: TheFILESystem:COPycommand..cwd: TheFILESystem:CWDcommand..delete: TheFILESystem:DELEtecommand..dir: TheFILESystem:DIRcommand..mkdir: TheFILESystem:MKDircommand..print: TheFILESystem:PRIntcommand..readfile: TheFILESystem:READFilecommand..rename: TheFILESystem:RENamecommand..rmdir: TheFILESystem:RMDircommand..writefile: TheFILESystem:WRITEFilecommand.
property
¶
copy: FilesystemCopy
Return the FILESystem:COPy command.
Description
- This command (no query form) copies a named file to a new file. The new file might be in a totally separate directory than the old file. You can only copy one file at a time using this command. Wild card characters are not allowed.
Usage
- Using the
.write(value)method will send theFILESystem:COPy valuecommand.
SCPI Syntax
- FILESystem:COPy {<source file path>,<destination file path>}
Info
<source file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.<destination file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.
property
¶
cwd: FilesystemCwd
Return the FILESystem:CWD command.
Description
- This command specifies the current working directory (CWD) for FILESystem commands. The default working directory is ‘E:/’. Anytime you use this command to change the directory, the directory that you specify is retained as the current working directory until you either change the directory or you delete the directory. If you delete the current working directory, the oscilloscope resets current working directory to the default directory the next time the oscilloscope is powered on or the next time you execute a file system command. This command supports the permutations of file and directory names supported by Microsoft Windows: Relative path names; for example, ‘./Temp’ Absolute path names; for example, ‘E:/MyWaveform’ Implied relative path names; for example ‘newfile.txt’ becomes ‘E:/TekScope/newfile.txt’ if the current working directory is ‘E:/TekScope’
Usage
- Using the
.write(value)method will send theFILESystem:CWD valuecommand.
SCPI Syntax
- FILESystem:CWD {<new working directory path>}
Info
<new working directory path>is a quoted string that defines the current working; a directory name can be up to 128 characters.
property
¶
delete: FilesystemDelete
Return the FILESystem:DELEte command.
Description
- This command deletes a named file. If you specify a directory name, it will delete the directory and all of its contents, the same as the RMDir command. You can also specify the filename as *.* to delete all of the files in the current or specified directory.
Usage
- Using the
.write(value)method will send theFILESystem:DELEte valuecommand.
SCPI Syntax
- FILESystem:DELEte <file path>
Info
<file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.*.*will delete all files and subdirectories within the current working directory.
property
¶
dir: FilesystemDir
Return the FILESystem:DIR command.
Description
- This query-only command returns a comma separated list of quoted strings. Each string
contains the name of a file or directory in the folder referred to by the
FILESYSTEM:CWDcommand.
Usage
- Using the
.query()method will send theFILESystem:DIR?query. - Using the
.verify(value)method will send theFILESystem:DIR?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- FILESystem:DIR?
property
¶
mkdir: FilesystemMkdir
Return the FILESystem:MKDir command.
Description
- Creates a new folder.
Usage
- Using the
.write(value)method will send theFILESystem:MKDir valuecommand.
SCPI Syntax
- FILESystem:MKDir <directory path>
Info
<directory path>is a quoted string that specifies the directory to create.
property
¶
print: FilesystemPrint
Return the FILESystem:PRInt command.
Description
- This command (no query form) prints a named file to a named port. This command is the
same as the
FILESYSTEM:READFILEcommand. This command is not IEEE 488.2 compliant for the following reasons: The command produces output on the 488.2 bus. Queries, not commands, are the only message units that should produce output on the 488.2 bus. Errors might not be recognized if they occur while data is being output in response to this command. This will be evident if a command is sent to the instrument before all of the data generated by this command is read. In such cases, you should send a device clear message to the instrument. The command does not use a standard 488.2 output format. The closest defined format is the indefinite format of ARBITRARY BLOCK PROGRAM DATA encoding. However, this command output omits the initial ‘#0’ characters needed for that format. Newlines, ASCII value 10, can be included in the output data. Output on the bus can be terminated by newlines. The output of this command is only terminated by.
Usage
- Using the
.write(value)method will send theFILESystem:PRInt valuecommand.
SCPI Syntax
- FILESystem:PRInt <filepath>, GPIb
Info
<file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.GPIbspecifies that the hard copy is sent out of the GPIB port. GPIb is the only port allowed for this command.
property
¶
readfile: FilesystemReadfile
Return the FILESystem:READFile command.
Description
- This command (no query form) prints a named file to a named port. It is identical to
the
FILESYSTEM:PRINTcommand. This command is not IEEE 488.2 compliant for the following reasons: The command produces output on the 488.2 bus. Queries, not commands, are the only message units that should produce output on the 488.2 bus. Errors might not be recognized if they occur while data is being output in response to this command. This will be evident if a command is sent to the instrument before all of the data generated by this command is read. In such cases, you should send a device clear message to the instrument. The command does not use a standard 488.2 output format. The closest defined format is the indefinite format of ARBITRARY BLOCK PROGRAM DATA encoding. However, this command output omits the initial ‘#0’ characters needed for that format. Newlines, ASCII value 10, can be included in the output data. Output on the bus can be terminated by newlines. The output of this command is only terminated by.
Usage
- Using the
.write(value)method will send theFILESystem:READFile valuecommand.
SCPI Syntax
- FILESystem:READFile <filepath>
Info
<file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.
property
¶
rename: FilesystemRename
Return the FILESystem:REName command.
Description
- Assigns a new name to an existing file.
Usage
- Using the
.write(value)method will send theFILESystem:REName valuecommand.
SCPI Syntax
- FILESystem:REName <old file path>,<new file path>
Info
<old file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.<new file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.
property
¶
rmdir: FilesystemRmdir
Return the FILESystem:RMDir command.
Description
- Deletes a named directory. This command deletes the specified directory and all of its contents. The directory must not be a read-only directory.
Usage
- Using the
.write(value)method will send theFILESystem:RMDir valuecommand.
SCPI Syntax
- FILESystem:RMDir <directory path>
Info
<directory path>is a quoted string that defines the directory name and path. If the file path is within the current working directory, you need only specify the file name.
property
¶
writefile: FilesystemWritefile
Return the FILESystem:WRITEFile command.
Description
- This command (no query form) copies the block data from the GPIB port to a named file.
Usage
- Using the
.write(value)method will send theFILESystem:WRITEFile valuecommand.
SCPI Syntax
- FILESystem:WRITEFile <file path>,<data>
Info
<file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.<data>can be either DEFINITE LENGTH or INDEFINITE LENGTH ARBITRARY BLOCK PROGRAM DATA encoding as described in IEEE 488.2.
Bases: SCPICmdWrite
The FILESystem:COPy command.
Description
- This command (no query form) copies a named file to a new file. The new file might be in a totally separate directory than the old file. You can only copy one file at a time using this command. Wild card characters are not allowed.
Usage
- Using the
.write(value)method will send theFILESystem:COPy valuecommand.
SCPI Syntax
- FILESystem:COPy {<source file path>,<destination file path>}
Info
<source file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.<destination file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.
Bases: SCPICmdWrite
The FILESystem:CWD command.
Description
- This command specifies the current working directory (CWD) for FILESystem commands. The default working directory is ‘E:/’. Anytime you use this command to change the directory, the directory that you specify is retained as the current working directory until you either change the directory or you delete the directory. If you delete the current working directory, the oscilloscope resets current working directory to the default directory the next time the oscilloscope is powered on or the next time you execute a file system command. This command supports the permutations of file and directory names supported by Microsoft Windows: Relative path names; for example, ‘./Temp’ Absolute path names; for example, ‘E:/MyWaveform’ Implied relative path names; for example ‘newfile.txt’ becomes ‘E:/TekScope/newfile.txt’ if the current working directory is ‘E:/TekScope’
Usage
- Using the
.write(value)method will send theFILESystem:CWD valuecommand.
SCPI Syntax
- FILESystem:CWD {<new working directory path>}
Info
<new working directory path>is a quoted string that defines the current working; a directory name can be up to 128 characters.
Bases: SCPICmdWrite
The FILESystem:DELEte command.
Description
- This command deletes a named file. If you specify a directory name, it will delete the directory and all of its contents, the same as the RMDir command. You can also specify the filename as *.* to delete all of the files in the current or specified directory.
Usage
- Using the
.write(value)method will send theFILESystem:DELEte valuecommand.
SCPI Syntax
- FILESystem:DELEte <file path>
Info
<file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.*.*will delete all files and subdirectories within the current working directory.
Bases: SCPICmdRead
The FILESystem:DIR command.
Description
- This query-only command returns a comma separated list of quoted strings. Each string
contains the name of a file or directory in the folder referred to by the
FILESYSTEM:CWDcommand.
Usage
- Using the
.query()method will send theFILESystem:DIR?query. - Using the
.verify(value)method will send theFILESystem:DIR?query and raise an AssertionError if the returned value does not matchvalue.
SCPI Syntax
- FILESystem:DIR?
Bases: SCPICmdWrite
The FILESystem:MKDir command.
Description
- Creates a new folder.
Usage
- Using the
.write(value)method will send theFILESystem:MKDir valuecommand.
SCPI Syntax
- FILESystem:MKDir <directory path>
Info
<directory path>is a quoted string that specifies the directory to create.
Bases: SCPICmdWrite
The FILESystem:PRInt command.
Description
- This command (no query form) prints a named file to a named port. This command is the same
as the
FILESYSTEM:READFILEcommand. This command is not IEEE 488.2 compliant for the following reasons: The command produces output on the 488.2 bus. Queries, not commands, are the only message units that should produce output on the 488.2 bus. Errors might not be recognized if they occur while data is being output in response to this command. This will be evident if a command is sent to the instrument before all of the data generated by this command is read. In such cases, you should send a device clear message to the instrument. The command does not use a standard 488.2 output format. The closest defined format is the indefinite format of ARBITRARY BLOCK PROGRAM DATA encoding. However, this command output omits the initial ‘#0’ characters needed for that format. Newlines, ASCII value 10, can be included in the output data. Output on the bus can be terminated by newlines. The output of this command is only terminated by.
Usage
- Using the
.write(value)method will send theFILESystem:PRInt valuecommand.
SCPI Syntax
- FILESystem:PRInt <filepath>, GPIb
Info
<file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.GPIbspecifies that the hard copy is sent out of the GPIB port. GPIb is the only port allowed for this command.
Bases: SCPICmdWrite
The FILESystem:READFile command.
Description
- This command (no query form) prints a named file to a named port. It is identical to the
FILESYSTEM:PRINTcommand. This command is not IEEE 488.2 compliant for the following reasons: The command produces output on the 488.2 bus. Queries, not commands, are the only message units that should produce output on the 488.2 bus. Errors might not be recognized if they occur while data is being output in response to this command. This will be evident if a command is sent to the instrument before all of the data generated by this command is read. In such cases, you should send a device clear message to the instrument. The command does not use a standard 488.2 output format. The closest defined format is the indefinite format of ARBITRARY BLOCK PROGRAM DATA encoding. However, this command output omits the initial ‘#0’ characters needed for that format. Newlines, ASCII value 10, can be included in the output data. Output on the bus can be terminated by newlines. The output of this command is only terminated by.
Usage
- Using the
.write(value)method will send theFILESystem:READFile valuecommand.
SCPI Syntax
- FILESystem:READFile <filepath>
Info
<file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.
Bases: SCPICmdWrite
The FILESystem:REName command.
Description
- Assigns a new name to an existing file.
Usage
- Using the
.write(value)method will send theFILESystem:REName valuecommand.
SCPI Syntax
- FILESystem:REName <old file path>,<new file path>
Info
<old file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.<new file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.
Bases: SCPICmdWrite
The FILESystem:RMDir command.
Description
- Deletes a named directory. This command deletes the specified directory and all of its contents. The directory must not be a read-only directory.
Usage
- Using the
.write(value)method will send theFILESystem:RMDir valuecommand.
SCPI Syntax
- FILESystem:RMDir <directory path>
Info
<directory path>is a quoted string that defines the directory name and path. If the file path is within the current working directory, you need only specify the file name.
Bases: SCPICmdWrite
The FILESystem:WRITEFile command.
Description
- This command (no query form) copies the block data from the GPIB port to a named file.
Usage
- Using the
.write(value)method will send theFILESystem:WRITEFile valuecommand.
SCPI Syntax
- FILESystem:WRITEFile <file path>,<data>
Info
<file path>is a quoted string that defines the file name and path. If the file path is within the current working directory, you need only specify the file name.<data>can be either DEFINITE LENGTH or INDEFINITE LENGTH ARBITRARY BLOCK PROGRAM DATA encoding as described in IEEE 488.2.